Grups de report

Actualitzar un grup d'informe

Actualitza la configuració d’un grup de reporte existent, incloent nom, descripció, destinació de política de pedaços, patró de cerca i dispositius intermedis. Aquest endpoint implementa semàntica de reemplaçament complet: tots els camps actualitzables han d’incloure’s en la sol·licitud. Ometre camps opcionals els netejarà (comportament idempotent). Pots configurar opcionalment dispositius intermedis (fins a 3) proporcionant identificadors de Workspace. Els dispositius intermedis s’utilitzen per a accions Wake-on-LAN en xarxes segures, permetent l’encesa remot de dispositius a través de passarel·les intermediàries. Els dispositius intermedis han de definir-se seqüencialment: no pots definir intermediate_device_2_id sense intermediate_device_1_id, ni intermediate_device_3_id sense intermediate_device_2_id. Tots els IDs de Workspace de dispositius intermedis han d’existir i pertànyer a l’organització. Retorna el recurs actualitzat (200) després d’una actualització exitosa.

PUT

organizations

{organization_id}

reporting-groups

{reporting_group_id}

curl --request PUT \
  --url https://api.flexxible.net/v1/organizations/{organization_id}/reporting-groups/{reporting_group_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Grupo de reporte de producción actualizado",
  "description": "Grupo de reporte actualizado para entornos de producción",
  "patch_policy_target_id": "507f1f77bcf86cd799439040",
  "fishing_pattern": "Estaciones de trabajo Windows",
  "fishing_pattern_field": "full_name",
  "intermediate_device_1_id": "507f1f77bcf86cd799439050",
  "intermediate_device_2_id": "507f1f77bcf86cd799439051",
  "intermediate_device_3_id": "507f1f77bcf86cd799439052"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "execute_flexx_analyzer_agent": true,
  "organization_id": "<string>",
  "product_config_id": "<string>",
  "fishing_pattern": "<string>",
  "patch_policy_target_id": "<string>",
  "policy_reporting_group": "<string>",
  "overridden_agent_settings": {
    "remote_support": "<string>",
    "collect_device_location": true,
    "auto_update_agents": true,
    "collect_event_logs": true,
    "event_log_ids": "<string>",
    "event_logs_recurrence": 123,
    "collect_disks": true,
    "collect_services": true,
    "collect_pnp_events": true,
    "collect_public_ip": true,
    "fra_system_actions_role": "<string>",
    "unified_reporting": "<string>",
    "unified_operations": "<string>",
    "web_apps": true
  },
  "effective_agent_settings": {
    "remote_support": "<string>",
    "collect_device_location": true,
    "auto_update_agents": true,
    "collect_event_logs": true,
    "event_log_ids": "<string>",
    "event_logs_recurrence": 123,
    "collect_disks": true,
    "collect_services": true,
    "collect_pnp_events": true,
    "collect_public_ip": true,
    "fra_system_actions_role": "<string>",
    "unified_reporting": "<string>",
    "resources_report_recurrence": 123,
    "profile_storage_report_recurrence": 123,
    "sync_broker_recurrence": 123,
    "detect_new_citrix_subscriptions": true,
    "proxy_type": "<string>",
    "can_enable_flexx_agent_per_group": true,
    "web_apps": true,
    "fra_simplified_security": "<string>"
  },
  "intermediate_device_1_id": "<string>",
  "intermediate_device_2_id": "<string>",
  "intermediate_device_3_id": "<string>"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

Autoritzacions

Authorization

string

header

requerit

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paràmetres de ruta

organization_id

string

requerit

El identificador únic de l'organització

Maximum string length: 24

Pattern: ^[0-9a-f]{24}$

reporting_group_id

string

requerit

L'identificador únic del grup de report a actualitzar

Maximum string length: 24

Pattern: ^[0-9a-f]{24}$

Cos

application/json

Cos de la sol·licitud per actualitzar un grup de reporte existent. Aquest endpoint implementa semàntica de reemplaçament complet: tots els camps actualitzables han d'incloure's. Ometre camps opcionals els netejarà (comportament idempotent). Els dispositius intermedis s'utilitzen per a accions Wake on LAN en xarxes segures, permetent l'encesa remot de dispositius a través de passarel·les intermediàries. Els dispositius intermedis han de definir-se seqüencialment: no pots definir intermediate_device_2_id sense intermediate_device_1_id, ni intermediate_device_3_id sense intermediate_device_2_id. Tots els IDs de Workspace de dispositius intermedis han d'existir i pertànyer a l'organització.

name

string

requerit

El nom del grup de reporte. Ha de ser únic dins de l'organització.

Maximum string length: 512

Exemple:

"Grupo de reporte de producción actualizado"

description

string

Opcional. Una descripció del propòsit i ús del grup de reporte.

Maximum string length: 1000

Exemple:

"Grupo de reporte actualizado para entornos de producción"

patch_policy_target_id

string

Opcional. L'identificador únic de la destinació de política de pegats que s'associarà amb aquest grup de report. Estableix-ho a null o omet aquest camp per eliminar l'associació.

Maximum string length: 24

Pattern: ^[0-9a-f]{24}$

Exemple:

"507f1f77bcf86cd799439040"

fishing_pattern

string

Opcional. Un patró d'expressió regular utilitzat per coincidir dispositius. Ha de ser un patró regex vàlid. Si es proporciona, també s'ha d'especificar fishing_pattern_field. Omiteix-lo per eliminar el patró.

Maximum string length: 250

Exemple:

"Estaciones de trabajo Windows"

fishing_pattern_field

enum<string>

Opcional. Camp sobre el qual s'aplica fishing_pattern. Obligatori si es proporciona fishing_pattern. Valors vàlids: full_name (nom complet del dispositiu), description (descripció del dispositiu), ou (unitat organitzativa), current_subnet (subxarxa actual).

Opcions disponibles:

full_name,

description,

ou,

current_subnet

Exemple:

"full_name"

intermediate_device_1_id

string

Opcional. L'identificador únic del Workspace del primer dispositiu intermedi. Els dispositius intermedis s'utilitzen per a accions Wake-on-LAN en xarxes segures, permetent l'encesa remot dels dispositius objectiu a través de passarel·les intermediàries. Els dispositius intermedis han de definir-se seqüencialment i sense buits. Si es omet, es netejaran tots els dispositius intermedis. Si es proporcionen intermediate_device_2_id o intermediate_device_3_id, aquest camp és obligatori.

Maximum string length: 24

Pattern: ^[0-9a-f]{24}$

Exemple:

"507f1f77bcf86cd799439050"

intermediate_device_2_id

string

Opcional. L'identificador únic del Workspace del segon dispositiu intermedi. S'utilitza per a accions Wake-on-LAN en xarxes segures. Requereix que es proporcioni intermediate_device_1_id. Si es omet mentre intermediate_device_1_id està proporcionat, aquest i intermediate_device_3_id es netejaran. Si es proporciona intermediate_device_3_id, aquest camp és obligatori.

Maximum string length: 24

Pattern: ^[0-9a-f]{24}$

Exemple:

"507f1f77bcf86cd799439051"

intermediate_device_3_id

string

Opcional. L'identificador únic del Workspace del tercer dispositiu intermedi. S'utilitza per a accions Wake on LAN en xarxes segures. Requereix que es proporcionin intermediate_device_1_id i intermediate_device_2_id. Si es omet mentre intermediate_device_1_id i intermediate_device_2_id estan proporcionats, aquest camp es netejarà.

Maximum string length: 24

Pattern: ^[0-9a-f]{24}$

Exemple:

"507f1f77bcf86cd799439052"

Resposta

Grup de reporte actualitzat correctament. La resposta conté el recurs actualitzat.

string

requerit

ID del grup de report

name

string

requerit

Nom del grup de report

execute_flexx_analyzer_agent

boolean

requerit

Si l'execució de l'agent Flexx Analyzer està habilitada

organization_id

string | null

Identificador de l'organització

product_config_id

string | null

Identificador de la configuració del producte

fishing_pattern

string | null

Nom del fishing pattern

fishing_pattern_field

enum<string> | null

Camp sobre el qual s'aplica fishing_pattern. Valors possibles: full_name, description, ou, current_subnet.

Opcions disponibles:

full_name,

description,

ou,

current_subnet

patch_policy_target_id

string | null

Identificador del destí de política de pegats

policy_reporting_group

string | null

Identificador del grup de reporte de política

overridden_agent_settings

object | null

Ajustaments de l'agent sobrescrits a nivell de grup de reporte

Show child attributes

effective_agent_settings

object | null

Ajustaments efectius de l'agent (combinats des de la configuració del producte i sobrescritures)

Show child attributes

intermediate_device_1_id

string | null

ID de Workspace del primer dispositiu intermedi (buscat per sysId)

intermediate_device_2_id

string | null

ID de Workspace del segon dispositiu intermedi (buscat per sysId)

intermediate_device_3_id

string | null

ID de Workspace del tercer dispositiu intermedi (buscat per sysId)

Recuperar un grup d'informe

Eliminar un grup de report

Següent

⌘I

curl --request PUT \
  --url https://api.flexxible.net/v1/organizations/{organization_id}/reporting-groups/{reporting_group_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Grupo de reporte de producción actualizado",
  "description": "Grupo de reporte actualizado para entornos de producción",
  "patch_policy_target_id": "507f1f77bcf86cd799439040",
  "fishing_pattern": "Estaciones de trabajo Windows",
  "fishing_pattern_field": "full_name",
  "intermediate_device_1_id": "507f1f77bcf86cd799439050",
  "intermediate_device_2_id": "507f1f77bcf86cd799439051",
  "intermediate_device_3_id": "507f1f77bcf86cd799439052"
}
'

{
  "id": "<string>",
  "name": "<string>",
  "execute_flexx_analyzer_agent": true,
  "organization_id": "<string>",
  "product_config_id": "<string>",
  "fishing_pattern": "<string>",
  "patch_policy_target_id": "<string>",
  "policy_reporting_group": "<string>",
  "overridden_agent_settings": {
    "remote_support": "<string>",
    "collect_device_location": true,
    "auto_update_agents": true,
    "collect_event_logs": true,
    "event_log_ids": "<string>",
    "event_logs_recurrence": 123,
    "collect_disks": true,
    "collect_services": true,
    "collect_pnp_events": true,
    "collect_public_ip": true,
    "fra_system_actions_role": "<string>",
    "unified_reporting": "<string>",
    "unified_operations": "<string>",
    "web_apps": true
  },
  "effective_agent_settings": {
    "remote_support": "<string>",
    "collect_device_location": true,
    "auto_update_agents": true,
    "collect_event_logs": true,
    "event_log_ids": "<string>",
    "event_logs_recurrence": 123,
    "collect_disks": true,
    "collect_services": true,
    "collect_pnp_events": true,
    "collect_public_ip": true,
    "fra_system_actions_role": "<string>",
    "unified_reporting": "<string>",
    "resources_report_recurrence": 123,
    "profile_storage_report_recurrence": 123,
    "sync_broker_recurrence": 123,
    "detect_new_citrix_subscriptions": true,
    "proxy_type": "<string>",
    "can_enable_flexx_agent_per_group": true,
    "web_apps": true,
    "fra_simplified_security": "<string>"
  },
  "intermediate_device_1_id": "<string>",
  "intermediate_device_2_id": "<string>",
  "intermediate_device_3_id": "<string>"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}