> ## 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. # Listar grupos de relatórios > Recupera uma lista paginada de grupos de relatório que pertencem à organização especificada. Suporta filtragem e ordenação sobre propriedades dos grupos de relatório. Os filtros são fornecidos como uma cadeia JSON seguindo a estrutura AST de FilterNode. Os resultados são devolvidos em páginas com metadados de paginação. ## OpenAPI ````yaml /pt-BR/api-reference/openapi.pt-v1.json get /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: get: tags: - Grupos de relatório summary: Listar grupos de relatórios description: >- Recupera uma lista paginada de grupos de relatório que pertencem à organização especificada. Suporta filtragem e ordenação sobre propriedades dos grupos de relatório. Os filtros são fornecidos como uma cadeia JSON seguindo a estrutura AST de FilterNode. Os resultados são devolvidos em páginas com metadados de paginação. operationId: listReportingGroups 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 - name: page in: query required: false schema: type: integer description: 'Número da página (padrão: 1)' - name: sort in: query required: false schema: type: string description: >- Campo de ordenação com sufixo de ordem opcional (:asc ou :desc). Campos de ordenação válidos: name, organization_id, product_config_id, fishing_pattern, fishing_pattern_field, patch_policy_target_id, policy_reporting_group, overridden_agent_settings.*, effective_agent_settings.*, execute_flexx_analyzer_agent, can_manage_agent_versions, intermediate_device_1_id, intermediate_device_2_id, intermediate_device_3_id. É ascendente por padrão se não for fornecido sufixo. - name: fields in: query required: false schema: type: string maxLength: 2048 description: >- Lista separada por vírgulas com campos para incluir em cada elemento de grupo de relatório. Campos selecionáveis: id, name, organization_id, product_config_id, fishing_pattern, fishing_pattern_field, patch_policy_target_id, policy_reporting_group, overridden_agent_settings, effective_agent_settings, execute_flexx_analyzer_agent, can_manage_agent_versions, flexx_agent_portal_download, intermediate_device_1_id, intermediate_device_2_id, intermediate_device_3_id. O campo id sempre é incluído. example: name,effective_agent_settings,execute_flexx_analyzer_agent - name: filters in: query required: false schema: type: string maxLength: 5120 description: >- Filtra grupos de relatório usando um objeto JSON. Especifica o campo a filtrar, o operador de comparação e o valor. Exemplo: {"field": "name", "op": "eq", "value": "Grupo de relatório 1"} example: '{"field": "name", "op": "eq", "value": "Grupo de reporte 1"}' description: >- Filtra grupos de relatório por um ou mais critérios. Fornece uma cadeia JSON com AST de filtros. Filtra por qualquer campo retornado na resposta. Para campos aninhados usa notação de ponto: overridden_agent_settings.remote_support, effective_agent_settings.remote_support, effective_agent_settings.uninstall_protection, etc. Operadores: eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between. Combina com and/or. Tamanho máximo: 5120 caracteres. examples: simple: summary: Filtrar por nome do grupo de relatório description: Retorna grupos de relatório cujo nome contém o texto fornecido. value: '{"field": "name", "op": "contains", "value": "producción"}' complex-and: summary: Filtrar por configuração aninhada e bandeira de execução description: >- Retorna grupos onde a proteção contra desinstalação está desativada e a execução do analisador está habilitada. value: >- {"and": [{"field": "effective_agent_settings.uninstall_protection", "op": "eq", "value": "off"}, {"field": "execute_flexx_analyzer_agent", "op": "eq", "value": true}]} complex-or-and: summary: Combinar condições OU e E description: >- Coincidir com múltiplos padrões de nome e requer suporte remoto interativo. value: >- {"and": [{"or": [{"field": "name", "op": "contains", "value": "prod"}, {"field": "name", "op": "contains", "value": "stage"}]}, {"field": "effective_agent_settings.remote_support", "op": "eq", "value": "INTERACTIVE"}]} - name: per_page in: query required: false schema: type: integer default: 100 maximum: 100 minimum: 1 description: Número de itens por página responses: '200': description: >- Lista paginada de grupos de relatório recuperada corretamente. A resposta inclui metadados de paginação e o conjunto de dados de grupos de relatório. content: application/json: schema: $ref: '#/components/schemas/ReportingGroupListItemV1ListResponseV1' '400': $ref: '#/components/responses/BadRequest' description: >- Solicitação incorreta. Causas comuns: - Parâmetros de paginação inválidos - Parâmetro de ordenação inválido - Parâmetros de filtro inválidos '401': $ref: '#/components/responses/Unauthorized' description: Não autorizado - é necessária autenticação '404': $ref: '#/components/responses/NotFound' description: Organização não encontrada '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' components: schemas: ReportingGroupListItemV1ListResponseV1: type: object properties: has_next: type: boolean data: type: array items: $ref: '#/components/schemas/ReportingGroupListItemV1' required: - has_next - data ReportingGroupListItemV1: 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 de configuração de produto fishing_pattern: type: string nullable: true description: Nome do padrão de fishing 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 de destino da política de patches policy_reporting_group: type: string nullable: true description: Identificador de grupo de relatório de política overridden_agent_settings: $ref: '#/components/schemas/ReportingGroupAgentSettingsV1' nullable: true description: Configuração do agente sobrescrita a nível de grupo de relatório effective_agent_settings: $ref: '#/components/schemas/ReportingGroupEffectiveAgentSettingsV1' nullable: true description: Configuração eficaz do agente execute_flexx_analyzer_agent: type: boolean description: Se a execução do agente FlexxAnalyzer está habilitada can_manage_agent_versions: type: boolean description: >- Indica se o grupo de relatório permite a autogestão de versões de agente conforme sua configuração de produto associada flexx_agent_portal_download: type: boolean description: >- Se o download do FlexxAgent do portal está habilitado para a organização do grupo intermediate_device_1_id: type: string nullable: true description: ID do Workspace do primeiro dispositivo intermediário intermediate_device_2_id: type: string nullable: true description: ID do Workspace do segundo dispositivo intermediário intermediate_device_3_id: type: string nullable: true description: ID do Workspace do terceiro dispositivo intermediário required: - id ErrorResponse: type: object properties: error: type: object properties: message: type: string code: type: string details: type: string required: - message - code required: - error 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 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' 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 ````