Grupos de relatório

Criar um grupo de relatórios

Cria um novo grupo de relatório para a organização especificada. Os grupos de relatório são usados para organizar e gerenciar configurações de dispositivos, ajustes de produto e políticas de patches. Você pode configurar opcionalmente dispositivos intermediários (até 3) fornecendo identificadores de workspace. Dispositivos intermediários são usados para ações de Wake on LAN em redes seguras, permitindo o ligamento remoto de dispositivos através de gateways intermediários. Dispositivos intermediários devem ser definidos sequencialmente: você não pode definir intermediate_device_2_id sem intermediate_device_1_id, nem intermediate_device_3_id sem intermediate_device_2_id. Todos os IDs de Workspace de dispositivos intermediários devem existir e pertencer à organização. Retorna o ID do grupo de relatório criado após uma criação bem-sucedida.

POST

organizations

{organization_id}

reporting-groups

curl --request POST \
  --url https://api.flexxible.net/v2/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>",
  "fishing_pattern_field": "full_name",
  "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>",
    "uninstall_protection": "off",
    "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>",
    "uninstall_protection": "off",
    "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>"
  }
}

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

organization_id

string

obrigatório

O identificador único da organização

Maximum string length: 24

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

Corpo

application/json

Corpo de solicitação para criar um novo grupo de relatório. Os grupos de relatório organizam dispositivos e gerenciam configurações, políticas de patches e roteamento de dispositivos intermediários.

name

string

obrigatório

O nome do grupo de relatório. Deve ser único dentro da organização.

Maximum string length: 512

Exemplo:

"Grupo de reporte de Producción"

product_config_id

string

obrigatório

O identificador único da configuração de produto que será associado a este grupo de relatório. A configuração de produto deve existir e pertencer à organização.

Maximum string length: 24

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

Exemplo:

"507f1f77bcf86cd799439030"

patch_policy_target_id

string

Opcional. O identificador único do destino da política de patches que será associado a este grupo de relatório.

Maximum string length: 24

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

Exemplo:

"507f1f77bcf86cd799439040"

fishing_pattern

string

Opcional. Um padrão de expressão regular usado para correspondência de dispositivos. Deve ser um padrão regex válido. Se fornecido, também deve ser especificado fishing_pattern_field.

Maximum string length: 250

Exemplo:

"Estaciones de trabajo Windows"

fishing_pattern_field

enum<string>

Opcional. Campo ao qual se aplica fishing_pattern. Obrigatório se fishing_pattern for fornecido. Valores válidos: full_name (nome completo do dispositivo), description (descrição do dispositivo), ou (unidade organizacional), current_subnet (sub-rede atual).

Opções disponíveis:

full_name,

description,

ou,

current_subnet

Exemplo:

"full_name"

intermediate_device_1_id

string

Opcional. O identificador único do primeiro Workspace de dispositivo intermediário. Dispositivos intermediários são usados para ações Wake on LAN em redes seguras, permitindo o ligamento remoto de dispositivos alvo através de gateways intermediários. Dispositivos intermediários devem ser definidos sequencialmente sem lacunas. Se intermediate_device_2_id ou intermediate_device_3_id forem fornecidos, este campo é obrigatório.

Maximum string length: 24

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

Exemplo:

"507f1f77bcf86cd799439050"

intermediate_device_2_id

string

Opcional. O identificador único do segundo Workspace de dispositivo intermediário. É usado para ações de Wake on LAN em redes seguras. Requer que o intermediate_device_1_id seja fornecido. Se intermediate_device_3_id for fornecido, este campo é obrigatório.

Maximum string length: 24

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

Exemplo:

"507f1f77bcf86cd799439051"

intermediate_device_3_id

string

Opcional. O identificador único do terceiro Workspace de dispositivo intermediário. É usado para ações de Wake on LAN em redes seguras. Requer que intermediate_device_1_id e intermediate_device_2_id sejam fornecidos.

Maximum string length: 24

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

Exemplo:

"507f1f77bcf86cd799439052"

Resposta

Grupo de relatório criado corretamente. A resposta contém o recurso criado.

string

obrigatório

ID do grupo de relatório

name

string

obrigatório

Nome do grupo de relatório

execute_flexx_analyzer_agent

boolean

obrigatório

Se a execução do agente Flexx Analyzer está habilitada

organization_id

string | null

Identificador da organização

product_config_id

string | null

Identificador da configuração do produto

fishing_pattern

string | null

Nome do fishing pattern

fishing_pattern_field

enum<string> | null

Campo ao qual se aplica fishing_pattern. Valores possíveis: full_name, description, ou, current_subnet.

Opções disponíveis:

full_name,

description,

ou,

current_subnet

patch_policy_target_id

string | null

Identificador do destino de política de patches

policy_reporting_group

string | null

Identificador do grupo de relatório de política

overridden_agent_settings

object | null

Configurações do agente sobrescritas a nível de grupo de relatório

Show child attributes

effective_agent_settings

object | null

Configurações efetivas do agente (combinadas a partir da configuração de produto e substituições)

Show child attributes

intermediate_device_1_id

string | null

ID do Workspace do primeiro dispositivo intermediário (procurado por sysId)

intermediate_device_2_id

string | null

ID do Workspace do segundo dispositivo intermediário (procurado por sysId)

intermediate_device_3_id

string | null

ID do Workspace do terceiro dispositivo intermediário (procurado por sysId)

⌘I

curl --request POST \
  --url https://api.flexxible.net/v2/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>",
  "fishing_pattern_field": "full_name",
  "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>",
    "uninstall_protection": "off",
    "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>",
    "uninstall_protection": "off",
    "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>"
  }
}

API Gen 2

Recursos API Gen 2 - v2

Recursos API Gen 2 - v1

Criar um grupo de relatórios

Autorizações

Parâmetros de caminho

Corpo

Resposta