Pular para o conteúdo principal

Encaminhamentos

Endpoints para gestão do fluxo de encaminhamentos, incluindo criação, resposta, reencaminhamento e complementação.

Fluxo de Integração (Assíncrono)

Para realizar ações de escrita, o sistema utiliza uma fila de eventos:

  1. Envio da Ação: O endpoint retorna um idEvento (status 202 Accepted).
  2. Consulta (Polling): Utilize GET /v2/eventos/{idEvento} para verificar a execução.
  3. Resultado: Uma vez processado, o evento retornará o ID do encaminhamento criado ou processado.

Autenticação​

A autenticação utiliza o padrão Bearer Token obtido via Acesso Cidadão.

  • api-sigades-encaminhamento: Escopo necessário para ações de encaminhamento.
  • api-sigades-consultar: Escopo necessário para consultas.

Requisitos​

  • O usuário deve possuir um papel cadastrado em um patriarca ativo no sistema ou atuar como Cidadão.
  • Se houver documentos associados ao encaminhamento, realize a captura previamente (consulte Documentos).
Fase de Assinatura

Caso o documento a ser anexado precise passar por assinatura eletrônica E-Docs, ele deve concluir a Fase de Assinatura antes de ser encaminhado — onde o Capturador informa o arquivo na nuvem, metadados e os assinantes.

Responsável pelo Encaminhamento​

O encaminhamento pode ser realizado como Cidadão ou como Papel de Servidor, informado no campo responsavel do payload. A distinção define a identidade jurídica do remetente no registro do encaminhamento:

  • Cidadão: utiliza a identificação pessoal do usuário autenticado.
  • Papel de Servidor: utiliza a lotação do servidor em um órgão/setor específico.

Endpoints​

Novo Encaminhamento​

Cria um encaminhamento original, sem vínculo anterior.

Exemplo de payload:

{
  "assunto": "Solicitação de análise de processo",
  "idsDestinos": ["<uuid-do-destino>"],
  "mensagem": "Encaminho para análise conforme solicitado.",
  "idResponsavel": "<uuid-do-responsavel>",
  "idsDocumentos": ["<uuid-do-documento>"],
  "enviarEmailNotificacoes": true,
  "restricaoAcesso": {
    "transparenciaAtiva": true,
    "idsFundamentosLegais": [],
    "classificacaoInformacao": null
  }
}

O campo idResponsavel define a identidade jurídica do remetente:

TipoComo obter o ID
CidadãoGET /v2/usuario — retorna o ID do usuário autenticado
Papel de ServidorGET /v2/usuario/papeis — lista os papéis ativos do usuário

Reencaminhamento​

Encaminha um encaminhamento recebido para um novo destino.

Responder​

Responde ao remetente de um encaminhamento.

Complementar​

Adiciona novas informações a um encaminhamento enviado (se não respondido ou reencaminhado).

Consultar​

Permite buscar encaminhamentos por destinatário, remetente, status e período, entre outros filtros.

Exemplos de payload​

Ilustrativo

Os campos exatos estão definidos no Swagger V2.

Novo encaminhamento​

POST /v2/encaminhamento/novo
Authorization: Bearer {token}
Content-Type: application/json
{
  "idPapelRemetente": "11111111-2222-3333-4444-555555555555",
  "destinatarios": [
    { "tipo": "Unidade", "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" },
    { "tipo": "Papel",   "id": "ffffffff-1111-2222-3333-444444444444" }
  ],
  "assunto": "Encaminhamento de documentação para análise",
  "mensagem": "Segue documentação solicitada.",
  "documentos": [
    "9b8a7c6d-5e4f-3a2b-1c0d-eeeeffff0000"
  ],
  "restricaoAcesso": {
    "transparenciaAtiva": false
  }
}

Resposta (202 Accepted):

{ "idEvento": "f1e2d3c4-b5a6-9876-5432-1f0e9d8c7b6a" }

Acompanhe o evento via GET /v2/eventos/{idEvento} — quando executado, o retorno conterá o idEncaminhamento.

Responder​

POST /v2/encaminhamento/responder
{
  "idEncaminhamentoOrigem": "ffffffff-...",
  "idPapelRemetente": "11111111-...",
  "mensagem": "Conforme solicitado, segue parecer.",
  "documentos": ["9b8a7c6d-..."]
}

Reencaminhar​

POST /v2/encaminhamento/reencaminhar
{
  "idEncaminhamentoOrigem": "ffffffff-...",
  "idPapelRemetente": "11111111-...",
  "destinatarios": [
    { "tipo": "Orgao", "id": "aaaaaaaa-..." }
  ],
  "mensagem": "Reencaminho para apreciação."
}

Recursos Auxiliares​