> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flexxible.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /pt-BR/api-reference/openapi.pt-v1.json post /v1/organizations/{organization_id}/reporting-groups
openapi: 3.0.3
info:
  title: API Publica Portal
  version: 1.0.0
  description: API pública REST para portal
servers:
  - url: https://api.flexxible.net
    description: Portal API (production)
security:
  - bearerAuth: []
tags: []
paths:
  /v1/organizations/{organization_id}/reporting-groups:
    post:
      tags:
        - Grupos de relatório
      summary: Criar um grupo de relatórios
      description: >-
        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.
      operationId: createReportingGroup
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            maxLength: 24
            pattern: ^[0-9a-f]{24}$
          description: O identificador único da organização
          example: 507f1f77bcf86cd799439011
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReportingGroupRequestV1'
            examples:
              create-reporting-group-with-minimal-fields:
                summary: Criar um grupo de relatório apenas com os campos obrigatórios
                value:
                  name: Grupo de reporte de Producción
                  product_config_id: 507f1f77bcf86cd799439030
              create-reporting-group-with-all-fields:
                summary: >-
                  Criar um grupo de relatório com todos os campos disponíveis,
                  incluindo dispositivos intermediários
                value:
                  name: Grupo de reporte de Desarrollo
                  product_config_id: 507f1f77bcf86cd799439030
                  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
              create-reporting-group-with-single-intermediate-device:
                summary: >-
                  Criar um grupo de relatório apenas com o primeiro dispositivo
                  intermediário
                value:
                  name: Grupo de reporte de dispositivo único
                  product_config_id: 507f1f77bcf86cd799439030
                  intermediate_device_1_id: 507f1f77bcf86cd799439050
      responses:
        '201':
          description: >-
            Grupo de relatório criado corretamente. A resposta contém o recurso
            criado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportingGroupByIdV1'
        '400':
          $ref: '#/components/responses/BadRequest'
          description: >-
            Requisição incorreta. Causas comuns: - Campos obrigatórios em falta
            (name, product_config_id) - Valores de campo inválidos - Formato de
            ID inválido para campos product_config_id, patch_policy_target_id ou
            intermediate_device_*_id - Valor de fishing_pattern_field inválido
            (deve ser um dos: full_name, description, ou, current_subnet) -
            Valor de fishing_pattern inválido (excede maxLength: 250) -
            Dispositivos intermediários não definidos sequencialmente
            (intermediate_device_2_id requer intermediate_device_1_id,
            intermediate_device_3_id requer intermediate_device_2_id)
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: Não autorizado - é necessária autenticação
        '404':
          $ref: '#/components/responses/NotFound'
          description: Organização não encontrada
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
          description: >-
            Entidade não processável. Causas comuns: - A configuração de produto
            não foi encontrada ou não pertence à organização - Os IDs de
            Workspace de dispositivos intermediários não existem ou não
            pertencem à organização
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    CreateReportingGroupRequestV1:
      type: object
      properties:
        name:
          type: string
          maxLength: 512
          description: O nome do grupo de relatório. Deve ser único dentro da organização.
          example: Grupo de reporte de Producción
        product_config_id:
          type: string
          maxLength: 24
          pattern: ^[0-9a-f]{24}$
          description: >-
            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.
          example: 507f1f77bcf86cd799439030
        patch_policy_target_id:
          type: string
          maxLength: 24
          pattern: ^[0-9a-f]{24}$
          description: >-
            Opcional. O identificador único do destino da política de patches
            que será associado a este grupo de relatório.
          example: 507f1f77bcf86cd799439040
        fishing_pattern:
          type: string
          maxLength: 250
          description: >-
            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.
          example: Estaciones de trabajo Windows
        fishing_pattern_field:
          type: string
          enum:
            - full_name
            - description
            - ou
            - current_subnet
          description: >-
            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).
          example: full_name
        intermediate_device_1_id:
          type: string
          maxLength: 24
          pattern: ^[0-9a-f]{24}$
          description: >-
            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.
          example: 507f1f77bcf86cd799439050
        intermediate_device_2_id:
          type: string
          maxLength: 24
          pattern: ^[0-9a-f]{24}$
          description: >-
            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.
          example: 507f1f77bcf86cd799439051
        intermediate_device_3_id:
          type: string
          maxLength: 24
          pattern: ^[0-9a-f]{24}$
          description: >-
            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.
          example: 507f1f77bcf86cd799439052
      required:
        - name
        - product_config_id
      description: >-
        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.
    ReportingGroupByIdV1:
      type: object
      properties:
        id:
          type: string
          description: ID do grupo de relatório
        name:
          type: string
          description: Nome do grupo de relatório
        organization_id:
          type: string
          nullable: true
          description: Identificador da organização
        product_config_id:
          type: string
          nullable: true
          description: Identificador da configuração do produto
        fishing_pattern:
          type: string
          nullable: true
          description: Nome do fishing pattern
        fishing_pattern_field:
          type: string
          enum:
            - full_name
            - description
            - ou
            - current_subnet
          nullable: true
          description: >-
            Campo ao qual se aplica fishing_pattern. Valores possíveis:
            full_name, description, ou, current_subnet.
        patch_policy_target_id:
          type: string
          nullable: true
          description: Identificador do destino de política de patches
        policy_reporting_group:
          type: string
          nullable: true
          description: Identificador do grupo de relatório de política
        overridden_agent_settings:
          $ref: '#/components/schemas/ReportingGroupAgentSettingsV1'
          nullable: true
          description: Configurações do agente sobrescritas a nível de grupo de relatório
        effective_agent_settings:
          $ref: '#/components/schemas/ReportingGroupEffectiveAgentSettingsV1'
          nullable: true
          description: >-
            Configurações efetivas do agente (combinadas a partir da
            configuração de produto e substituições)
        execute_flexx_analyzer_agent:
          type: boolean
          description: Se a execução do agente Flexx Analyzer está habilitada
        intermediate_device_1_id:
          type: string
          nullable: true
          description: >-
            ID do Workspace do primeiro dispositivo intermediário (procurado por
            sysId)
        intermediate_device_2_id:
          type: string
          nullable: true
          description: >-
            ID do Workspace do segundo dispositivo intermediário (procurado por
            sysId)
        intermediate_device_3_id:
          type: string
          nullable: true
          description: >-
            ID do Workspace do terceiro dispositivo intermediário (procurado por
            sysId)
      required:
        - id
        - name
        - execute_flexx_analyzer_agent
    ReportingGroupAgentSettingsV1:
      type: object
      properties:
        remote_support:
          type: string
          nullable: true
          description: Configuração de suporte remoto
        collect_device_location:
          type: boolean
          nullable: true
          description: Se a coleta de localização do dispositivo está habilitada
        auto_update_agents:
          type: boolean
          nullable: true
          description: Se a atualização automática de agentes está habilitada
        collect_event_logs:
          type: boolean
          nullable: true
          description: Se a coleta de logs de eventos está habilitada
        event_log_ids:
          type: string
          nullable: true
          description: IDs de logs de eventos
        event_logs_recurrence:
          type: number
          nullable: true
          description: Recorrência de logs de eventos
        collect_disks:
          type: boolean
          nullable: true
          description: Se a coleta de discos está habilitada
        collect_services:
          type: boolean
          nullable: true
          description: Se a coleta de serviços está habilitada
        collect_pnp_events:
          type: boolean
          nullable: true
          description: Se a coleta de eventos PnP está habilitada
        collect_public_ip:
          type: boolean
          nullable: true
          description: Se a coleta de IP público está habilitada
        fra_system_actions_role:
          type: string
          nullable: true
          description: Papel das ações do sistema FRA
        unified_reporting:
          type: string
          nullable: true
          description: Configuração de relatório unificado
        unified_operations:
          type: string
          nullable: true
          description: Configuração de operações unificadas
        uninstall_protection:
          type: string
          nullable: true
          enum:
            - 'off'
            - 'on'
          description: >-
            Valores possíveis: off, on. Se não houver um estado aplicável,
            retorna null.
        web_apps:
          type: boolean
          nullable: true
          description: Se as web apps estão habilitadas
    ReportingGroupEffectiveAgentSettingsV1:
      type: object
      description: >-
        Configurações efetivas do agente (inclui campos de configuração de
        produto mais sobrescrições)
      properties:
        remote_support:
          type: string
          nullable: true
        collect_device_location:
          type: boolean
          nullable: true
        auto_update_agents:
          type: boolean
          nullable: true
        collect_event_logs:
          type: boolean
          nullable: true
        event_log_ids:
          type: string
          nullable: true
        event_logs_recurrence:
          type: number
          nullable: true
        collect_disks:
          type: boolean
          nullable: true
        collect_services:
          type: boolean
          nullable: true
        collect_pnp_events:
          type: boolean
          nullable: true
        collect_public_ip:
          type: boolean
          nullable: true
        fra_system_actions_role:
          type: string
          nullable: true
        unified_reporting:
          type: string
          nullable: true
        uninstall_protection:
          type: string
          nullable: true
          enum:
            - 'off'
            - 'on'
          description: >-
            Valores possíveis: off, on. Se não houver um estado aplicável,
            retorna null.
        resources_report_recurrence:
          type: number
          nullable: true
        profile_storage_report_recurrence:
          type: number
          nullable: true
        sync_broker_recurrence:
          type: number
          nullable: true
        detect_new_citrix_subscriptions:
          type: boolean
          nullable: true
        proxy_type:
          type: string
          nullable: true
        can_enable_flexx_agent_per_group:
          type: boolean
          nullable: true
        web_apps:
          type: boolean
          nullable: true
        fra_simplified_security:
          type: string
          nullable: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details:
              type: string
          required:
            - message
            - code
      required:
        - error
  responses:
    BadRequest:
      description: Solicitação incorreta
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Não autorizado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    UnprocessableEntity:
      description: Entidade não processável
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Solicitações em excesso
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````