Pular para o conteúdo principal

Caixas

Consultas que informam quais papéis estão habilitados a praticar uma determinada ação a partir de uma caixa. São usadas por integrações que precisam oferecer ao usuário a escolha do papel antes de responder um encaminhamento ou de praticar um ato processual.

Autenticação

Utilize o escopo api-sigades-consultar. Para detalhes, consulte Autenticação.

Como a Lista é Montada​

A resposta depende da natureza do agente dono da caixa:

  • Caixa de unidade ou órgão: entram na lista o gestor do local, os papéis com delegação de acesso ao local e os papéis com permissão específica para aquela ação no local.
  • Caixa de grupo ou comissão: a lista é formada a partir dos papéis dos membros do grupo.

A lista é específica por ação. Um papel pode estar habilitado a responder um encaminhamento em uma caixa e não estar habilitado a despachar um processo na mesma caixa. As regras de negócio por trás desse comportamento estão descritas em Acesso Institucional e Delegação.

Endpoints​

Papéis para Responder Encaminhamento​

Retorna os papéis habilitados a responder ou reencaminhar um encaminhamento a partir da caixa informada.

  • Método: GET
  • Rota: /v2/caixas/{idCaixa}/encaminhamento/responder
  • Parâmetros: idCaixa (UUID)
  • Documentação Swagger

Papéis para Autuar Processo​

Retorna os papéis habilitados a autuar um processo a partir da caixa informada.

Papéis para Despachar Processo​

Retorna os papéis habilitados a despachar um processo a partir da caixa informada.

  • Método: GET
  • Rota: /v2/caixas/{idCaixa}/processo/despachar
  • Parâmetros: idCaixa (UUID)
  • Documentação Swagger

Papéis para Entranhar em Processo​

Retorna os papéis habilitados a entranhar documentos em um processo a partir da caixa informada.

  • Método: GET
  • Rota: /v2/caixas/{idCaixa}/processo/entranhar
  • Parâmetros: idCaixa (UUID)
  • Documentação Swagger

Recursos Auxiliares​