Pular para o conteúdo principal

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:

  1. Liste os Patriarcas (/v2/agente/patriarcas) para obter o idPatriarca.
  2. Use o idPatriarca para listar as Organizações (/v2/agente/{idPatriarca}/organizacoes).
  3. 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:

ValorDescrição
CidadaoPessoa física autenticada via Acesso Cidadão
PapelServidor em uma lotação específica
GrupoGrupo de trabalho
UnidadeSetor ou unidade organizacional
OrganizacaoÓrgão ou entidade
SistemaAplicação integrada
NaoIdentificadoTipo não determinado

Endpoints

Listar Patriarcas

Retorna a lista de patriarcas habilitados.

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.

Listar Grupos de Trabalho

Retorna grupos de trabalho ativos de uma organização.

Listar Comissões

Retorna comissões ativas de uma organização.


Recursos Auxiliares