Associação

Associações permitem agrupar múltiplos processos administrativos sob um tema ou contexto comum, facilitando a gestão e consulta de processos relacionados.

Autenticação

Utilize o escopo api-sigades-consultar. Compatível com Client Credentials (sem usuário logado).

Endpoints

Buscar Associações

Retorna a lista paginada de associações conforme os filtros aplicados.

• Método: POST
• Rota: /v2/associacoes/search
• Documentação Swagger

Filtros disponíveis (AssociacaoApiFilter):

{
  "idProprietario": "<uuid-do-agente-proprietario>",
  "pagina": 1,
  "tamanhoPagina": 20
}

Comportamento: os filtros informados são combinados entre si, ou seja, todos precisam ser satisfeitos ao mesmo tempo. Uma busca sem filtros retorna todas as associações, sempre respeitando a paginação.

Buscar Processos em uma Associação

Retorna a lista paginada de processos incluídos em uma associação específica.

• Método: POST
• Rota: /v2/associacoes/processos/search
• Documentação Swagger

Filtros disponíveis (AssociacaoProcessoApiFilter):

{
  "idAssociacao": "<uuid-da-associacao>",
  "pagina": 1,
  "tamanhoPagina": 20
}

Comportamento: a permissão do solicitante sobre a associação é verificada antes do retorno. Cada item traz o processo relacionado já embutido, dispensando uma consulta adicional por processo.

Buscar Associações de um Processo

Retorna as associações que contêm um processo específico.

• Método: GET
• Rota: /v2/processos/{idProcesso}/associacoes
• Documentação Swagger

Recursos Auxiliares

• Processos: Gestão de processos administrativos.
• Agente: Estruturas organizacionais para obter idProprietario.