Agente
Endpoints responsáveis pela consulta de estruturas organizacionais, patriarcas e agentes no sistema E-Docs.
Fluxo de Integração
Para buscar setores ou grupos de trabalho, siga a hierarquia do sistema:
- Liste os Patriarcas (
/v2/agente/patriarcas) para obter oidPatriarca. - Use o
idPatriarcapara listar as Organizações (/v2/agente/{idPatriarca}/organizacoes). - Com o
idOrgao(organização) em mãos, liste Setores, Grupos ou Comissões.
Tipos de Agente (AgenteTipoApi)
O campo tipo presente nas respostas identifica a natureza do agente retornado:
| Valor | Descrição |
|---|---|
Cidadao | Pessoa física autenticada via Acesso Cidadão |
Papel | Servidor em uma lotação específica |
Grupo | Grupo de trabalho |
Unidade | Setor ou unidade organizacional |
Organizacao | Órgão ou entidade |
Sistema | Aplicação integrada |
NaoIdentificado | Tipo não determinado |
Endpoints
Listar Patriarcas
Retorna a lista de patriarcas habilitados.
- Método:
GET - Rota:
/v2/agente/patriarcas - Documentação Swagger
Listar Organizações
Retorna organizações ativas de um patriarca.
- Método:
GET - Rota:
/v2/agente/{idPatriarca}/organizacoes - Parâmetros:
idPatriarca(UUID) - Documentação Swagger
Listar Setores
Retorna setores ativos de uma organização.
- Método:
GET - Rota:
/v2/agente/{idOrgao}/setores - Parâmetros:
idOrgao(UUID) - Documentação Swagger
Listar Grupos de Trabalho
Retorna grupos de trabalho ativos de uma organização.
- Método:
GET - Rota:
/v2/agente/{idOrgao}/grupos-trabalho - Parâmetros:
idOrgao(UUID) - Documentação Swagger
Listar Comissões
Retorna comissões ativas de uma organização.
- Método:
GET - Rota:
/v2/agente/{idOrgao}/comissoes - Parâmetros:
idOrgao(UUID) - Documentação Swagger
Recursos Auxiliares
- Todos os endpoints de Agente: Referência completa no Swagger.