Classificação Documental

Endpoints para consulta da árvore de classificação documental. O idClasse obtido aqui é utilizado para categorizar documentos e processos no momento do registro.

Autenticação

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

Hierarquia de Consulta

Para obter um idClasse válido:

1. Liste os Patriarcas via Agente para obter o idPatriarca.
2. Liste os Planos Ativos do patriarca para obter o idPlano.
3. Liste as Classes Ativas do plano para obter o idClasse.

Uso do idClasse

O idClasse é aceito nos seguintes endpoints:

Endpoint	Observação
POST /v2/documentos/capturar/nato-digital/auto-assinado/servidor	Captura por servidor com assinatura eletrônica
POST /v2/documentos/fase-assinatura/enviar/servidor	Documento com múltiplas assinaturas, iniciado por servidor
POST /v2/processos/autuar	Autuação de processo
POST /v2/processos/editar	Edição de processo

Os demais endpoints de captura (cidadão, ICP-Brasil, cópia, digitalizado comum) não aceitam idClasse.

Endpoints

Listar Planos Ativos

Retorna a lista de todos os planos de classificação ativos vinculados a um patriarca.

• Método: GET
• Rota: /v2/classificacao-documental/{idPatriarca}/planos-ativos
• Parâmetros:
  • idPatriarca (UUID): Identificador único do patriarca.
• Documentação Swagger

Listar Classes Ativas

Retorna a lista de todas as classes ativas pertencentes a um plano de classificação específico.

• Método: GET
• Rota: /v2/classificacao-documental/{idPlano}/classes-ativas
• Parâmetros:
  • idPlano (UUID): Identificador único do plano de classificação.
• Documentação Swagger

---

Recursos Auxiliares

• Agente: Utilizado para buscar os idPatriarca necessários.