Grupos de reporte

Crear un grupo de reporte

Crea un nuevo grupo de reporte para la organización especificada. Los grupos de reporte se usan para organizar y gestionar configuraciones de dispositivos, ajustes de producto y políticas de parches. Puedes 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 puedes 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 ID del grupo de reporte creado tras una creación satisfactoria.

POST

organizations

{organization_id}

reporting-groups

curl --request POST \
  --url https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/reporting-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Grupo de reporte de Producción",
  "product_config_id": "507f1f77bcf86cd799439030"
}
'

{
  "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}$

Cuerpo

application/json

Cuerpo de solicitud para crear un nuevo grupo de reporte. Los grupos de reporte organizan dispositivos y gestionan configuraciones, políticas de parches y enrutamiento de dispositivos intermedios.

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"

product_config_id

string

requerido

El identificador único de la configuración de producto que se asociará con este grupo de reporte. La configuración de producto debe existir y pertenecer a la organización.

Maximum string length: 24

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

Ejemplo:

"507f1f77bcf86cd799439030"

patch_policy_target_id

string

Opcional. El identificador único del destino de política de parches que se asociará con este grupo de reporte.

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.

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 primer Workspace de dispositivo intermedio. Los dispositivos intermedios se usan para acciones Wake on LAN en redes seguras, permitiendo el encendido remoto de dispositivos objetivo a través de puertas de enlace intermedias. Los dispositivos intermedios deben definirse secuencialmente sin huecos. 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 segundo Workspace de dispositivo intermedio. Se usa para acciones Wake on LAN en redes seguras. Requiere que se proporcione intermediate_device_1_id. 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 tercer Workspace de 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.

Maximum string length: 24

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

Ejemplo:

"507f1f77bcf86cd799439052"

Respuesta

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

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)

Listar grupos de reporte

Recuperar un grupo de reporte

⌘I

curl --request POST \
  --url https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/reporting-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Grupo de reporte de Producción",
  "product_config_id": "507f1f77bcf86cd799439030"
}
'

{
  "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>"
  }
}