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 o idPatriarca.
Use o idPatriarca para 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

Regras que afetam o conteúdo das respostas e valem para toda a integração:

Cache: as listas de estrutura organizacional são servidas de cache. A lista de patriarcas tem validade de 2 horas, portanto um patriarca recém-habilitado pode levar até esse tempo para aparecer na resposta.
Somente ativos: organizações temporariamente inativas são excluídas da lista de organizações. O mesmo vale para setores, grupos de trabalho e comissões, que retornam apenas os registros ativos.
Ordenação: grupos de trabalho e comissões vêm ordenados alfabeticamente pelo nome. Os demais endpoints não garantem ordem.
Subgrupos: a lista de grupos de trabalho inclui os subgrupos do conjunto informado, e cada grupo traz o conjunto pai quando houver.
Origem dos dados: setores vêm do Organograma; grupos de trabalho e comissões vêm do Acesso Cidadão, sendo que as comissões têm origem no sistema de recursos humanos do Estado.

Retorna a lista de patriarcas habilitados.

Retorna organizações ativas de um patriarca.

Retorna setores ativos de uma organização.

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

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