Grupos de reporte

Actualizar un grupo de reporte

Actualiza la configuración de un grupo de reporte existente, incluyendo nombre, descripción, destino de política de parches, patrón de búsqueda y dispositivos intermedios. Este endpoint implementa semántica de reemplazo completo: todos los campos actualizables deben incluirse en la solicitud. Omitir campos opcionales los limpiará (comportamiento idempotente). Puede configurar opcionalmente dispositivos intermedios (hasta 3) proporcionando identificadores de Workspace. Los dispositivos intermedios se usan para acciones Wake-on-LAN en redes seguras, permitiendo el encendido remoto de dispositivos a través de puertas de enlace intermedias. Los dispositivos intermedios deben definirse secuencialmente: no puede definir intermediate_device_2_id sin intermediate_device_1_id, ni intermediate_device_3_id sin intermediate_device_2_id. Todos los IDs de Workspace de dispositivos intermedios deben existir y pertenecer a la organización. Devuelve el recurso actualizado (200) tras una actualización exitosa.

PUT

organizations

{organization_id}

reporting-groups

{reporting_group_id}

curl --request PUT \
  --url https://api.staging.flxwvdexternal.com/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>"
  }
}

Autorizaciones

Authorization

string

header

requerido

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

Parámetros de ruta

organization_id

string

requerido

El identificador único de la organización

Maximum string length: 24

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

reporting_group_id

string

requerido

El identificador único del grupo de reporte a actualizar

Maximum string length: 24

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

Cuerpo

application/json

Cuerpo de la solicitud para actualizar un grupo de reporte existente. Este endpoint implementa semántica de reemplazo completo: todos los campos actualizables deben incluirse. Omitir campos opcionales los limpiará (comportamiento idempotente). Los dispositivos intermedios se usan para acciones Wake on LAN en redes seguras, permitiendo el encendido remoto de dispositivos a través de puertas de enlace intermedias. Los dispositivos intermedios deben definirse secuencialmente: no puede definir intermediate_device_2_id sin intermediate_device_1_id, ni intermediate_device_3_id sin intermediate_device_2_id. Todos los IDs de Workspace de dispositivos intermedios deben existir y pertenecer a la organización.

name

string

requerido

El nombre del grupo de reporte. Debe ser único dentro de la organización.

Maximum string length: 512

Ejemplo:

"Grupo de reporte de producción actualizado"

description

string

Opcional. Una descripción del propósito y uso del grupo de reporte.

Maximum string length: 1000

Ejemplo:

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

patch_policy_target_id

string

Opcional. El identificador único del destino de política de parches que se asociará con este grupo de reporte. Establézcalo en null u omítalo para eliminar la asociación.

Maximum string length: 24

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

Ejemplo:

"507f1f77bcf86cd799439040"

fishing_pattern

string

Opcional. Un patrón de expresión regular usado para hacer coincidir dispositivos. Debe ser un patrón regex válido. Si se proporciona, también se debe especificar fishing_pattern_field. Omítalo para eliminar el patrón.

Maximum string length: 250

Ejemplo:

"Estaciones de trabajo Windows"

fishing_pattern_field

enum<string>

Opcional. Campo sobre el que se aplica fishing_pattern. Obligatorio si se proporciona fishing_pattern. Valores válidos: full_name (nombre completo del dispositivo), description (descripción del dispositivo), ou (unidad organizativa), current_subnet (subred actual).

Opciones disponibles:

full_name,

description,

ou,

current_subnet

Ejemplo:

"full_name"

intermediate_device_1_id

string

Opcional. El identificador único del Workspace del primer dispositivo intermedio. Los dispositivos intermedios se usan para acciones Wake-on-LAN en redes seguras, permitiendo el encendido remoto de los dispositivos objetivo a través de puertas de enlace intermedias. Los dispositivos intermedios deben definirse secuencialmente y sin huecos. Si se omite, se limpiarán todos los dispositivos intermedios. Si se proporcionan intermediate_device_2_id o intermediate_device_3_id, este campo es obligatorio.

Maximum string length: 24

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

Ejemplo:

"507f1f77bcf86cd799439050"

intermediate_device_2_id

string

Opcional. El identificador único del Workspace del segundo dispositivo intermedio. Se usa para acciones Wake-on-LAN en redes seguras. Requiere que se proporcione intermediate_device_1_id. Si se omite mientras intermediate_device_1_id está proporcionado, este y intermediate_device_3_id se limpiarán. Si se proporciona intermediate_device_3_id, este campo es obligatorio.

Maximum string length: 24

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

Ejemplo:

"507f1f77bcf86cd799439051"

intermediate_device_3_id

string

Opcional. El identificador único del Workspace del tercer dispositivo intermedio. Se usa para acciones Wake on LAN en redes seguras. Requiere que se proporcionen intermediate_device_1_id e intermediate_device_2_id. Si se omite mientras intermediate_device_1_id e intermediate_device_2_id están proporcionados, este campo se limpiará.

Maximum string length: 24

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

Ejemplo:

"507f1f77bcf86cd799439052"

Respuesta

Grupo de reporte actualizado correctamente. La respuesta contiene el recurso actualizado.

string

requerido

ID del grupo de reporte

name

string

requerido

Nombre del grupo de reporte

execute_flexx_analyzer_agent

boolean

requerido

Si la ejecución del agente Flexx Analyzer está habilitada

organization_id

string | null

Identificador de la organización

product_config_id

string | null

Identificador de la configuración del producto

fishing_pattern

string | null

Nombre del fishing pattern

fishing_pattern_field

enum<string> | null

Campo sobre el que se aplica fishing_pattern. Valores posibles: full_name, description, ou, current_subnet.

Opciones disponibles:

full_name,

description,

ou,

current_subnet

patch_policy_target_id

string | null

Identificador del destino de política de parches

policy_reporting_group

string | null

Identificador del grupo de reporte de política

overridden_agent_settings

object | null

Ajustes del agente sobrescritos a nivel de grupo de reporte

Show child attributes

effective_agent_settings

object | null

Ajustes efectivos del agente (combinados desde la configuración del producto y sobrescrituras)

Show child attributes

intermediate_device_1_id

string | null

ID de Workspace del primer dispositivo intermedio (buscado por sysId)

intermediate_device_2_id

string | null

ID de Workspace del segundo dispositivo intermedio (buscado por sysId)

intermediate_device_3_id

string | null

ID de Workspace del tercer dispositivo intermedio (buscado por sysId)

Recuperar un grupo de reporte

Eliminar un grupo de reporte

⌘I

curl --request PUT \
  --url https://api.staging.flxwvdexternal.com/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>"
  }
}