Pular para o conteúdo principal

Processos

Endpoints para autuação, tramitação e gestão de Processos Administrativos, seguindo a formalidade da legislação vigente.

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 ato ou processo criado.

Autenticação​

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

  • api-sigades-processo: Escopo necessário para realizar atos processuais.
  • api-sigades-consultar: Escopo necessário para consultas.

Requisitos de Execução​

Para realizar atos processuais (Autuar, Despachar, Avocar, etc.), o usuário deve:

  1. Possuir um papel no Acesso Cidadão.
  2. Possuir uma lotação associada ao papel (servidores do estado têm isso via integração SIARHES; terceiros devem ser configurados via administrador).

O custodiante do processo pode ser: Organização (Órgão), Unidade (Setor), Grupo ou Papel (Servidor).

O campo responsavel nos payloads de atos processuais segue a mesma lógica de Encaminhamentos: deve ser informado o UUID do papel do servidor responsável pelo ato. Use GET /v2/usuario/papeis para listar os papéis disponíveis.

Endpoints​

Autuar​

Cria um novo Processo Administrativo.

Despachar​

Movimenta o processo alterando seu custodiante.

Avocar​

Retorna o processo para o custodiante anterior (caso não tenha sofrido novo ato).

Entranhar Documentos​

Adiciona um documento ao processo sem movimentação.

Desentranhar Documentos​

Remove um documento entranhado anteriormente. Este ato não movimenta o processo.

Importante

O desentranhamento não anula o ato original de entranhamento. Por motivos de segurança, o histórico de que o documento foi entranhado e posteriormente desentranhado é mantido no sistema.

Entranhar Encaminhamento​

Adiciona um encaminhamento e seus documentos associados sem movimentação.

Editar​

Edita informações do processo sem movimentação.

Encerrar​

Conclui os trâmites do processo.

Reabrir​

Reabre um processo previamente encerrado.

Consultar​

Permite buscar processos por assunto, status, custodiante e período, entre outros filtros.

Atos não cobertos pela API V2

Operações como Credenciamento, Geração de cópia, Sinalização, Entranhamento Especial e Gestão de Representante Legal estão disponíveis na aplicação WEB e podem ainda não estar expostas pela API V2. Verifique o Swagger V2 para a lista atual.

Garantir um processo para cada registro do sistema​

Quando uma regra de negócio exige que cada registro de um sistema (um auto de infração, por exemplo) tenha um processo no E-Docs, o desenho mais robusto é o próprio sistema de origem autuar o processo pela API no momento em que o registro é criado, com o escopo api-sigades-processo. A geração do processo passa a ser garantida pelo sistema, e deixa de ser necessário monitorar depois quais registros ficaram sem processo. Para conferir registros que já existem, a consulta por número de protocolo (escopo api-sigades-consultar) informa a situação e a localização atual de cada processo.

Exemplos de payload​

Ilustrativo

Os campos exatos estão definidos no Swagger V2.

Autuar​

POST /v2/processos/autuar
Authorization: Bearer {token}
Content-Type: application/json
{
  "idPapelAutuador": "11111111-2222-3333-4444-555555555555",
  "idClasseDocumental": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "resumo": "Solicitação de aquisição de equipamentos de TI",
  "interessados": [
    { "tipo": "Servidor", "idPapel": "22222222-..." },
    { "tipo": "Cidadao",  "cpf": "00000000000" }
  ],
  "documentos": [
    "9b8a7c6d-5e4f-3a2b-1c0d-eeeeffff0000"
  ],
  "restricaoAcesso": {
    "transparenciaAtiva": false
  }
}

Resposta (202 Accepted):

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

Após processado, o evento retorna idProcesso.

Despachar​

POST /v2/processos/despachar
{
  "idProcesso": "11112222-3333-4444-5555-666677778888",
  "idPapelAutor": "11111111-...",
  "destinoCustodiante": {
    "tipo": "Unidade",
    "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  },
  "mensagem": "Encaminho para análise técnica."
}

Entranhar Documentos​

POST /v2/processos/entranhar-documentos
{
  "idProcesso": "11112222-...",
  "idPapelAutor": "11111111-...",
  "documentos": [
    "9b8a7c6d-...",
    "0123abcd-..."
  ]
}

Encerrar​

POST /v2/processos/encerrar
{
  "idProcesso": "11112222-...",
  "idPapelAutor": "11111111-...",
  "motivo": "Objeto atendido."
}

Recursos Auxiliares​