{ "openapi": "3.0.1", "info": { "title": "E-Docs API", "description": "Para maiores informações veja a documentação da API clicando aqui", "version": "v2" }, "paths": { "/v2/agente/patriarcas": { "get": { "tags": [ "Agente" ], "summary": "Retorna a lista de todos os patriarcas habilitados no E-Docs", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Patriarca" } } } } } } } }, "/v2/agente/{idPatriarca}/organizacoes": { "get": { "tags": [ "Agente" ], "summary": "Retorna a lista de todos as organizações ativas de um patriarca", "parameters": [ { "name": "idPatriarca", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organizacao" } } } } } } } }, "/v2/agente/{idOrgao}/setores": { "get": { "tags": [ "Agente" ], "summary": "Retorna a lista de todos os setores ativos de uma organização", "parameters": [ { "name": "idOrgao", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Setor" } } } } } } } }, "/v2/agente/{idOrgao}/grupos-trabalho": { "get": { "tags": [ "Agente" ], "summary": "Retorna a lista de todos os grupos de trabalho ativos de uma organização", "parameters": [ { "name": "idOrgao", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GrupoTrabalho" } } } } } } } }, "/v2/agente/{idOrgao}/comissoes": { "get": { "tags": [ "Agente" ], "summary": "Retorna a lista de todos as comissões ativas de uma organização", "parameters": [ { "name": "idOrgao", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Comissao" } } } } } } } }, "/v2/associacoes/processos/search": { "post": { "tags": [ "Associacao" ], "summary": "Lista todos os Processos inclusos na Associação de forma paginada", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AssociacaoProcessoApiFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AssociacaoProcessoApiFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssociacaoProcessoApiFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AssociacaoProcessoApiFilter" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessoResultSearch" } } } } } } }, "/v2/associacoes/search": { "post": { "tags": [ "Associacao" ], "summary": "Lista todas as Associações de acordo com filtro de forma paginada", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AssociacaoApiFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AssociacaoApiFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssociacaoApiFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AssociacaoApiFilter" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociacaoResultSearch" } } } } } } }, "/v2/caixas/{idCaixa}/encaminhamento/responder": { "get": { "tags": [ "Caixas" ], "summary": "Retorna a lista de Papéis que podem responder/reencaminhar um Encaminhamento de acordo com a caixa informada", "parameters": [ { "name": "idCaixa", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agente" } } } } } } } }, "/v2/caixas/{idCaixa}/processo/autuar": { "get": { "tags": [ "Caixas" ], "summary": "Retorna a lista de Papéis que podem autuar um Processo de acordo com a caixa informada", "parameters": [ { "name": "idCaixa", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agente" } } } } } } } }, "/v2/caixas/{idCaixa}/processo/despachar": { "get": { "tags": [ "Caixas" ], "summary": "Retorna a lista de Papéis que podem despachar um Processo de acordo com a caixa informada", "parameters": [ { "name": "idCaixa", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agente" } } } } } } } }, "/v2/caixas/{idCaixa}/processo/entranhar": { "get": { "tags": [ "Caixas" ], "summary": "Retorna a lista de Papéis que podem entranhar em um Processo de acordo com a caixa informada", "parameters": [ { "name": "idCaixa", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agente" } } } } } } } }, "/v2/classificacao-documental/{idPatriarca}/planos-ativos": { "get": { "tags": [ "ClassificacaoDocumental" ], "summary": "Retorna a lista de todos os planos ativos de um patriarca", "parameters": [ { "name": "idPatriarca", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlanoClassificacao" } } } } } } } }, "/v2/classificacao-documental/{idPlano}/classes-ativas": { "get": { "tags": [ "ClassificacaoDocumental" ], "summary": "Retorna a lista de todos as classes ativas de um plano", "parameters": [ { "name": "idPlano", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Classe" } } } } } } } }, "/v2/documentos/digitalizado/original/{idDocumento}": { "get": { "tags": [ "DocumentoDigitalizadoOriginal" ], "summary": "Retorna o metadado exclusivo de um Documento Digitalizado com valor de Original Capturado dado um identificador\r\n\r\nEsse endpoint ainda está em fase de testes e assim não está liberado ao público", "parameters": [ { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoOriginal" } } } } } } }, "/v2/documentos/capturar/digitalizado/original": { "post": { "tags": [ "DocumentoDigitalizadoOriginal" ], "summary": "Captura um Documento digitalizado de um papel com valor de original, com inclusão de metadados especializados conforme legislação. Disponível apenas para servidores. \r\nO retorno é o identificador de um evento responsável pela ação\r\n\r\nEsse endpoint ainda está em fase de testes e assim não está liberado ao público", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoOriginalApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoOriginalApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoOriginalApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoOriginalApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/documentos/capturar/digitalizado/original/validar": { "post": { "tags": [ "DocumentoDigitalizadoOriginal" ], "summary": "Valida se é possível capturar um Documento de um arquivo digitalizado previamente enviado com valor de original - executado por servidor. \r\n\r\nEsse endpoint ainda está em fase de testes e assim não está liberado ao público", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoOriginalApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoOriginalApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoOriginalApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoOriginalApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiResponse" } } } } } } }, "/v2/documentos/upload-arquivo/gerar-url/{tamanhoArquivo}": { "get": { "tags": [ "Documentos" ], "summary": "OBSOLETO: este endpoint será descontinuado em breve. Favor passar a usar o endpoint 'upload-arquivo/gerar-url-upload';", "parameters": [ { "name": "tamanhoArquivo", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoArquivo" } } } } }, "deprecated": true } }, "/v2/documentos/upload-arquivo/gerar-url-upload/{tamanhoArquivo}": { "get": { "tags": [ "Documentos" ], "summary": "Cria um endereço na nuvem do E-Docs para o envio do arquivo que será capturado - o tamanho de arquivo enviado deve ser exato e em bytes", "parameters": [ { "name": "tamanhoArquivo", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoArquivo" } } } } } } }, "/v2/documentos/fase-assinatura/{IdDocumentoFaseAssinatura}": { "get": { "tags": [ "Documentos" ], "summary": "Retorna o Documento em Fase de Assinatura de um identificador", "parameters": [ { "name": "IdDocumentoFaseAssinatura", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinatura" } } } } } } }, "/v2/documentos/fase-assinatura/search": { "post": { "tags": [ "Documentos" ], "summary": "[OBSOLETE]Retorna a lista de Documentos em Fase de Assinatura de acordo com o filtro enviado. Utilizar o endpoint documentos/fase-assinatura/paginated-search", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinaturaApiFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinaturaApiFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinaturaApiFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinaturaApiFilter" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinaturaResultSearch" } } } } }, "deprecated": true } }, "/v2/documentos/fase-assinatura/paginated-search": { "post": { "tags": [ "Documentos" ], "summary": "Retorna a lista de Documentos em Fase de Assinatura de acordo com o filtro enviado", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinaturaApiFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinaturaApiFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinaturaApiFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinaturaApiFilter" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoFaseAssinaturaResultSearch" } } } } } } }, "/v2/documentos/fase-assinatura/enviar/servidor": { "post": { "tags": [ "Documentos" ], "summary": "Cria um Documento em Fase de Assinatura por um Servidor, sem nenhuma assinatura executada automaticamente. O retorno é o identificador externo do documento em fase de assinatura.", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalMultiplasAssinaturasServidorApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalMultiplasAssinaturasServidorApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalMultiplasAssinaturasServidorApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalMultiplasAssinaturasServidorApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/documentos/fase-assinatura/enviar/cidadao": { "post": { "tags": [ "Documentos" ], "summary": "Cria um Documento em Fase de Assinatura por um Cidadão, sem nenhuma assinatura executada automaticamente. O retorno é o identificador externo do documento em fase de assinatura.\r\n- Todos os assinantes devem ser cidadãos", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalMultiplasAssinaturasCidadaoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalMultiplasAssinaturasCidadaoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalMultiplasAssinaturasCidadaoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalMultiplasAssinaturasCidadaoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoAssinado" } } } } } } }, "/v2/documentos/fase-assinatura/assinar/{IdDocumentoFaseAssinatura}": { "get": { "tags": [ "Documentos" ], "parameters": [ { "name": "IdDocumentoFaseAssinatura", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoAssinado" } } } } }, "deprecated": true }, "post": { "tags": [ "Documentos" ], "summary": "Assinar um Documento em Fase de Assinatura", "parameters": [ { "name": "IdDocumentoFaseAssinatura", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoAssinado" } } } } } } }, "/v2/documentos/{idDocumento}": { "get": { "tags": [ "Documentos" ], "summary": "Retorna o Documento Capturado de um identificador", "parameters": [ { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documento" } } } } } } }, "/v2/documentos/{idDocumento}/metadados": { "get": { "tags": [ "Documentos" ], "summary": "Retorna o Documento Capturado de um identificador", "parameters": [ { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoMetadados" } } } } } } }, "/v2/documentos/search-by-fase-assinatura/{idDocumentoFaseAssinatura}": { "get": { "tags": [ "Documentos" ], "summary": "Retorna o Documento Capturado de um identificador de documento quando em fase de assinatura", "parameters": [ { "name": "idDocumentoFaseAssinatura", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documento" } } } } } } }, "/v2/documentos/search": { "post": { "tags": [ "Documentos" ], "summary": "[OBSOLETO]Retorna a lista de Documentos Capturados de acordo com o filtro enviado. Utilizar o endpoint documentos/paginated-search", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoApiFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoApiFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoApiFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoApiFilter" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoResultSearch" } } } } }, "deprecated": true } }, "/v2/documentos/paginated-search": { "post": { "tags": [ "Documentos" ], "summary": "Retorna a lista de Documentos Capturados de acordo com o filtro enviado", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoApiFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoApiFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoApiFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoApiFilter" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoResultSearch" } } } } } } }, "/v2/documentos/SearchByContent": { "post": { "tags": [ "Documentos" ], "summary": "[OBSOLETO] Retorna o Documento que está associado a um Arquivo previamente capturado no E-Docs - um arquivo previamente capturado no E-Docs não pode ser capturado novamente. Utilizar o endpoint documentos/search-by-content", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "documento": { "type": "string", "format": "binary" } } }, "encoding": { "documento": { "style": "form" } } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documento" } } } } }, "deprecated": true } }, "/v2/documentos/search-by-content": { "post": { "tags": [ "Documentos" ], "summary": "Retorna o Documento que está associado a um Arquivo previamente capturado no E-Docs - um arquivo previamente capturado no E-Docs não pode ser capturado novamente", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "documento": { "type": "string", "format": "binary" } } }, "encoding": { "documento": { "style": "form" } } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Documento" } } } } } } }, "/v2/documentos/{idDocumento}/processos": { "get": { "tags": [ "Documentos" ], "summary": "Lista todos os Processos que o Documento está entranhado", "parameters": [ { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Processo" } } } } } } } }, "/v2/documentos/{idDocumento}/encaminhamentos": { "get": { "tags": [ "Documentos" ], "summary": "Lista todos os ids de Encaminhamentos que o Documento está entranhado", "parameters": [ { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } } } }, "/v2/documentos/{idDocumento}/assinantes": { "get": { "tags": [ "Documentos" ], "summary": "Lista todos os Assinantes que devem se manifestar no Documento", "parameters": [ { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Assinante" } } } } } } } }, "/v2/documentos/{idDocumento}/url-para-download-arquivo": { "get": { "tags": [ "Documentos" ], "summary": "Retorna o endereço para se realizar o download do Documento", "parameters": [ { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/v2/documentos/{idDocumento}/sistemas/url-para-download-arquivo": { "get": { "tags": [ "Documentos" ], "summary": "Retorna o endereço para se realizar o download do Documento\r\nVersão para sistemas, com permissionamento próprio", "parameters": [ { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/v2/documentos/{idDocumento}/temp-content-url": { "get": { "tags": [ "Documentos" ], "summary": "[OBSOLETO] Retorna o endereço para se realizar o download do Documento - utilizar o endpoint documento/{idDocumento:guid}/url-para-download-arquivo", "parameters": [ { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } }, "deprecated": true } }, "/v2/documentos/{idDocumento}/pode-usar": { "get": { "tags": [ "Documentos" ], "summary": "Retorna se o usuário logado através do AccessToken tem permissão de utilizar o Documento - apenas usuários logados como Cidadão podem chamar este endpoint", "parameters": [ { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/v2/documentos/assinatura-digital-valida": { "post": { "tags": [ "Documentos" ], "summary": "Valida se o arquivo possui assinatura digital válida e não vencida (ICP-Brasil)", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "IdentificadorTemporarioArquivoNaNuvem": { "type": "string" }, "FileBytes": { "type": "string", "format": "binary" } } }, "encoding": { "IdentificadorTemporarioArquivoNaNuvem": { "style": "form" }, "FileBytes": { "style": "form" } } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificadoDigitalIEnumerableWebApiResponse" } } } } } } }, "/v2/documentos/capturar/nato-digital/icp-brasil/servidor": { "post": { "tags": [ "Documentos" ], "summary": "Captura um Documento de um arquivo assinado por padrão ICP-Brasil previamente enviado - executado por servidor. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalIcpBrasilServidorApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalIcpBrasilServidorApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalIcpBrasilServidorApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalIcpBrasilServidorApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/documentos/capturar/nato-digital/icp-brasil/cidadao": { "post": { "tags": [ "Documentos" ], "summary": "Captura um Documento de um arquivo assinado por padrão ICP-Brasil previamente enviado - executado por cidadão. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalIcpBrasilCidadaoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalIcpBrasilCidadaoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalIcpBrasilCidadaoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalIcpBrasilCidadaoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/documentos/capturar/nato-digital/copia/servidor": { "post": { "tags": [ "Documentos" ], "summary": "Captura um Documento de um arquivo nato-digital sem assinatura previamente enviado - executado por servidor. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaServidorApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaServidorApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaServidorApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaServidorApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/documentos/capturar/nato-digital/copia/servidor/validar": { "post": { "tags": [ "Documentos" ], "summary": "Valida se é possível capturar um Documento de um arquivo nato-digital sem assinatura previamente enviado - executado por servidor", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaServidorApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaServidorApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaServidorApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaServidorApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiResponse" } } } } } } }, "/v2/documentos/capturar/nato-digital/copia/cidadao": { "post": { "tags": [ "Documentos" ], "summary": "Captura um Documento de um arquivo nato-digital sem assinatura previamente enviado - executado por cidadão. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaCidadaoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaCidadaoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaCidadaoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaCidadaoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/documentos/capturar/nato-digital/copia/cidadao/validar": { "post": { "tags": [ "Documentos" ], "summary": "Valida se é possível capturar um Documento de um arquivo nato-digital sem assinatura previamente enviado\r\n- executado por cidadão", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaCidadaoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaCidadaoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaCidadaoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalCopiaCidadaoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiResponse" } } } } } } }, "/v2/documentos/capturar/nato-digital/auto-assinado/servidor": { "post": { "tags": [ "Documentos" ], "summary": "Captura um Documento de um arquivo nato-digital auto-assinado pelo capturador previamente enviado - executado por servidor. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaServidorApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaServidorApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaServidorApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaServidorApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/documentos/capturar/nato-digital/auto-assinado/servidor/validar": { "post": { "tags": [ "Documentos" ], "summary": "Valida se é possível capturar um Documento de um arquivo nato-digital auto-assinado pelo capturador previamente enviado - executado por servidor", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaServidorApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaServidorApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaServidorApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaServidorApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiResponse" } } } } } } }, "/v2/documentos/capturar/nato-digital/auto-assinado/cidadao": { "post": { "tags": [ "Documentos" ], "summary": "Captura um Documento de um arquivo nato-digital auto-assinado pelo capturador previamente enviado - executado por cidadão. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaCidadaoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaCidadaoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaCidadaoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaCidadaoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/documentos/capturar/nato-digital/auto-assinado/cidadao/validar": { "post": { "tags": [ "Documentos" ], "summary": "Valida se é possível capturar um Documento de um arquivo nato-digital auto-assinado pelo capturador previamente enviado - executado por cidadão", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaCidadaoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaCidadaoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaCidadaoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoNatoDigitalAssinaturaEletronicaCidadaoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiResponse" } } } } } } }, "/v2/documentos/capturar/digitalizado/servidor": { "post": { "tags": [ "Documentos" ], "summary": "Captura um Documento de um arquivo digitalizado previamente enviado - executado por servidor. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoServidorApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoServidorApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoServidorApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoServidorApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/documentos/capturar/digitalizado/servidor/validar": { "post": { "tags": [ "Documentos" ], "summary": "Valida se é possível capturar um Documento de um arquivo digitalizado previamente enviado - executado por servidor.", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoServidorApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoServidorApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoServidorApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoServidorApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiResponse" } } } } } } }, "/v2/documentos/capturar/digitalizado/cidadao": { "post": { "tags": [ "Documentos" ], "summary": "Captura um Documento de um arquivo digitalizado previamente enviado - executado por cidadão. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoCidadaoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoCidadaoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoCidadaoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoCidadaoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/documentos/capturar/digitalizado/cidadao/validar": { "post": { "tags": [ "Documentos" ], "summary": "Valida se é possível capturar um Documento de um arquivo digitalizado previamente enviado - executado por cidadão", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoCidadaoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoCidadaoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoCidadaoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentoDigitalizadoCidadaoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebApiResponse" } } } } } } }, "/v2/documentos/relatorio/classificados": { "get": { "tags": [ "Documentos" ], "summary": "Relatório com todos os documentos classificados e reclassificados que não foram desclassificados da base do E-Docs", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelatorioDocumentosClassificados" } } } } } } } }, "/v2/documentos/relatorio/desclassificados": { "get": { "tags": [ "Documentos" ], "summary": "Relatório com todos os documentos classificados que sofreram desclassificação da base do E-Docs", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelatorioDocumentosDesclassificados" } } } } } } } }, "/v2/documentos/AdicionarFundamentoLegal": { "post": { "tags": [ "Documentos" ], "summary": "Adicionar fundamento legal ao documento", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/v2/documentos/RemoverSigilo": { "post": { "tags": [ "Documentos" ], "summary": "Remover fundamento de sigilo do documento", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/v2/documentos/TornarPublico": { "post": { "tags": [ "Documentos" ], "summary": "Tornar o documento público", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RestringirAcessoEmLoteApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/v2/documentos/auto-credenciamento-documento": { "post": { "tags": [ "Documentos" ], "summary": "Auto credenciamento em documento que não foi possível capturar por ser um arquivo previamente capturado", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AutoCredenciamentoDocumentoEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutoCredenciamentoDocumentoEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutoCredenciamentoDocumentoEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AutoCredenciamentoDocumentoEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredenciamentoLeituraDocumento" } } } } } } }, "/v2/documentos/relatorio-quantitativos/mes/{mes}/ano/{ano}": { "get": { "tags": [ "Documentos" ], "summary": "Relatório de quantidade de documentos e páginas por mês/ano", "parameters": [ { "name": "mes", "in": "path", "description": "Mês do relatório", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ano", "in": "path", "description": "Ano do relatório", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelatorioQuantitativosDocumento" } } } } } } } }, "/v2/documentos/relatorio-quantitativos/{idPatriarca}/mes/{mes}/ano/{ano}": { "get": { "tags": [ "Documentos" ], "summary": "Relatório de quantidade de documentos e páginas por mês/ano por patriarca", "parameters": [ { "name": "idPatriarca", "in": "path", "description": "id do Patriarca", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mes", "in": "path", "description": "Mês do relatório", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ano", "in": "path", "description": "Ano do relatório", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelatorioQuantitativosDocumentoPorOrgao" } } } } } } } }, "/v2/encaminhamento/{idEncaminhamento}": { "get": { "tags": [ "Encaminhamentos" ], "summary": "Retorna o Encaminhamento de um identificador", "parameters": [ { "name": "idEncaminhamento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Encaminhamento" } } } } } } }, "/v2/encaminhamento/{idEncaminhamento}/inicial/protocolo": { "get": { "tags": [ "Encaminhamentos" ], "summary": "Retorna o protocolo do encaminhamento inicial de um identificador", "parameters": [ { "name": "idEncaminhamento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/v2/encaminhamento/search": { "post": { "tags": [ "Encaminhamentos" ], "summary": "[OBSOLETO]Retorna a lista de Encaminhamentos de acordo com o filtro enviado. Utilizar o endpoint encaminhamento/paginated-search", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoApiFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoApiFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoApiFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoApiFilter" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoResultSearch" } } } } }, "deprecated": true } }, "/v2/encaminhamento/paginated-search": { "post": { "tags": [ "Encaminhamentos" ], "summary": "Retorna a lista de Encaminhamentos de acordo com o filtro enviado", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoApiFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoApiFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoApiFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoApiFilter" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoResultSearch" } } } } } } }, "/v2/encaminhamento/{protocolo}/inicial": { "get": { "tags": [ "Encaminhamentos" ], "summary": "Retorna o encaminhamento inicial de um protocolo", "parameters": [ { "name": "protocolo", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Encaminhamento" } } } } } } }, "/v2/encaminhamento/{idEncaminhamento}/documentos": { "get": { "tags": [ "Encaminhamentos" ], "summary": "Retorna os documentos de um encaminhamento", "parameters": [ { "name": "idEncaminhamento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentoEncaminhamento" } } } } } } } }, "/v2/encaminhamento/{idEncaminhamento}/rastreio": { "get": { "tags": [ "Encaminhamentos" ], "summary": "Retorna todos os encaminhamentos de um encaminhamento inicial", "parameters": [ { "name": "idEncaminhamento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Encaminhamento" } } } } } } }, "/v2/encaminhamento/novo": { "post": { "tags": [ "Encaminhamentos" ], "summary": "Criar um novo encaminhamento original, sem que haja um vínculo com encaminhamento anterior. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoNovoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoNovoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoNovoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoNovoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/encaminhamento/reencaminhar": { "post": { "tags": [ "Encaminhamentos" ], "summary": "Criar um encaminhamento de um encaminhamento recebido. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoReencaminhamentoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoReencaminhamentoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoReencaminhamentoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoReencaminhamentoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/encaminhamento/complementar": { "post": { "tags": [ "Encaminhamentos" ], "summary": "Cria um encaminhamento complementando um encaminhamento anteriormente enviado com novas informações, se ele ainda não foi reencaminhado ou respondido pelo destinatário. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoComplementoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoComplementoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoComplementoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoComplementoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/encaminhamento/responder": { "post": { "tags": [ "Encaminhamentos" ], "summary": "Criar um encaminhamento de resposta ao remetente de um encaminhamento. O retorno é o identificador de um evento responsável pela ação", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoRespostaApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoRespostaApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoRespostaApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoRespostaApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/encaminhamento/marcar-como-resolvido": { "post": { "tags": [ "Encaminhamentos" ], "summary": "Marcar um encaminhamento como resolvido. A ação é online, não gerando um evento. O retorno é identificado pelo código HTTP 200 (OK)", "requestBody": { "description": "Informações da caixa e do encaminhamento que devem ser resolvidos", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoAcaoPendenteResolvidoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoAcaoPendenteResolvidoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoAcaoPendenteResolvidoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoAcaoPendenteResolvidoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" } } } }, "/v2/encaminhamento/marcar-como-pendente": { "post": { "tags": [ "Encaminhamentos" ], "summary": "Marcar um encaminhamento como pendente. A ação é online, não gerando um evento. O retorno é identificado pelo código HTTP 200 (OK)", "requestBody": { "description": "Informações da caixa e do encaminhamento que devem ser marcados como pendente", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoAcaoPendenteResolvidoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoAcaoPendenteResolvidoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoAcaoPendenteResolvidoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EncaminhamentoAcaoPendenteResolvidoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success" } } } }, "/v2/eventos/{idEvento}": { "get": { "tags": [ "Eventos" ], "summary": "Retorna o Evento de um identificador", "parameters": [ { "name": "idEvento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Evento" } } } } } } }, "/v2/fundamentos-legais/{idPatriarca}": { "get": { "tags": [ "FundamentosLegais" ], "summary": "Retorna a lista de todos os fundamentos legais de um patriarca", "parameters": [ { "name": "idPatriarca", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundamentoLegal" } } } } } } } }, "/v2/fundamentos-legais": { "get": { "tags": [ "FundamentosLegais" ], "summary": "Retorna a lista de todos os fundamentos legais para cidadão", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FundamentoLegal" } } } } } } } }, "/v2/processos/{idProcesso}": { "get": { "tags": [ "Processos" ], "summary": "Retorna o Processo de um identificador", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Processo" } } } } } } }, "/v2/processos/search": { "post": { "tags": [ "Processos" ], "summary": "[OBSOLETO] Retorna a lista de Processos de acordo com o filtro enviado - utilizar o endpoint processos/search-paginado", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProcessoApiFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcessoApiFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcessoApiFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProcessoApiFilter" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessoResultSearch" } } } } }, "deprecated": true } }, "/v2/processos/paginated-search": { "post": { "tags": [ "Processos" ], "summary": "Retorna a lista paginada de Processos de acordo com o filtro enviado", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProcessoApiFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcessoApiFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcessoApiFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProcessoApiFilter" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessoResultSearch" } } } } } } }, "/v2/processos/{idProcesso}/atos": { "get": { "tags": [ "Processos" ], "summary": "Lista todos os Atos do Processo", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ato" } } } } } } } }, "/v2/processos/{idProcesso}/atos/{idAto}": { "get": { "tags": [ "Processos" ], "summary": "Retorna os detalhes do ato de um processo", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "idAto", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ato" } } } } } } } }, "/v2/processos/{idProcesso}/atos/{idAto}/documentos": { "get": { "tags": [ "Processos" ], "summary": "Lista todos os Documentos de um Ato do Processo", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "idAto", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentoAto" } } } } } } } }, "/v2/processos/{idProcesso}/documentos/{idDocumento}/atos": { "get": { "tags": [ "Processos" ], "summary": "Lista todos os Atos relacionados a um documento, restrito a um Processo", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "idDocumento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } } } }, "/v2/processos/{idProcesso}/classe": { "get": { "tags": [ "Processos" ], "summary": "Retorna a Classe do Processo", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Classe" } } } } } } }, "/v2/processos/{idProcesso}/interessados": { "get": { "tags": [ "Processos" ], "summary": "Retorna a lista de Interessados do Processo", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Interessados" } } } } } } }, "/v2/processos/{idProcesso}/autuador": { "get": { "tags": [ "Processos" ], "summary": "Retorna o Autuador do Processo", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Autuador" } } } } } } }, "/v2/processos/{idProcesso}/local-custodia": { "get": { "tags": [ "Processos" ], "summary": "Retorna o Local de Custódia do Processo", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agente" } } } } } } }, "/v2/processos/{idProcesso}/sinalizacao": { "get": { "tags": [ "Processos" ], "summary": "Retorna a Sinalização do Processo", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sinalizacao" } } } } } } } }, "/v2/processos/{idProcesso}/associacoes": { "get": { "tags": [ "Processos" ], "summary": "Retorna as associações que contém o Processo", "parameters": [ { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Associacao" } } } } } } } }, "/v2/processos/relatorio-quantitativos/mes/{mes}/ano/{ano}": { "get": { "tags": [ "Processos" ], "summary": "Relatório de quantidade de processos por mês/ano", "parameters": [ { "name": "mes", "in": "path", "description": "Mês do relatório", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ano", "in": "path", "description": "Ano do relatório", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelatorioQuantitativosProcesso" } } } } } } } }, "/v2/processos/relatorio-quantitativos/{idPatriarca}/mes/{mes}/ano/{ano}": { "get": { "tags": [ "Processos" ], "summary": "Relatório de quantidade de processos por mês/ano por patriarca", "parameters": [ { "name": "idPatriarca", "in": "path", "description": "id do Patriarca", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mes", "in": "path", "description": "Mês do relatório", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ano", "in": "path", "description": "Ano do relatório", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelatorioQuantitativosProcessoPorOrgao" } } } } } } } }, "/v2/processos/autuar": { "post": { "tags": [ "Processos" ], "summary": "Cria um Processo Administrativo. O retorno é o identificador de um evento responsável pelo ato", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AutuacaoProcessoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AutuacaoProcessoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AutuacaoProcessoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AutuacaoProcessoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/processos/despachar": { "post": { "tags": [ "Processos" ], "summary": "Movimenta o Processo Administrativo, alterando seu custodiante. O retorno é o identificador de um evento responsável pelo ato", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DespachoProcessoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DespachoProcessoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DespachoProcessoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DespachoProcessoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/processos/avocar": { "post": { "tags": [ "Processos" ], "summary": "Retorna a custódia de um Processo para o Agente anterior, se o destinatário ainda não realizou nenhum Ato nesse Processo. O retorno é o identificador de um evento responsável pelo ato", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AvocamentoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AvocamentoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AvocamentoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AvocamentoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/processos/entranhar-documentos": { "post": { "tags": [ "Processos" ], "summary": "Entranha Documentos ao Processo, sem que esse se movimente. O retorno é o identificador de um evento responsável pelo ato", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EntranhamentoDocumentoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntranhamentoDocumentoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntranhamentoDocumentoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntranhamentoDocumentoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/processos/entranhar-encaminhamento": { "post": { "tags": [ "Processos" ], "summary": "Entranha Documentos de um Encaminhamento - inclusive Termo de Encaminhamento - ao Processo, sem que esse se movimente. O retorno é o identificador de um evento responsável pelo ato", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EntranhamentoEncaminhamentoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntranhamentoEncaminhamentoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntranhamentoEncaminhamentoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EntranhamentoEncaminhamentoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/processos/desentranhar": { "post": { "tags": [ "Processos" ], "summary": "Dentranha Documentos do Processo, sem que esse se movimente, mantendo histórico. O retorno é o identificador de um evento responsável pelo ato", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DesentranhamentoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DesentranhamentoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DesentranhamentoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DesentranhamentoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/processos/editar": { "post": { "tags": [ "Processos" ], "summary": "Edita informações do Processo, sem que esse se movimente. O retorno é o identificador de um evento responsável pelo ato", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EdicaoProcessoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EdicaoProcessoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EdicaoProcessoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EdicaoProcessoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/processos/encerrar": { "post": { "tags": [ "Processos" ], "summary": "Encerra o Processo. O retorno é o identificador de um evento responsável pelo ato", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EncerramentoApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EncerramentoApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EncerramentoApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EncerramentoApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/processos/reabrir": { "post": { "tags": [ "Processos" ], "summary": "Reabre o Processo, se este foi previamente encerrado. O retorno é o identificador de um evento responsável pelo ato", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReaberturaApiEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReaberturaApiEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReaberturaApiEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReaberturaApiEntry" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/v2/usuario/assinaturas": { "get": { "tags": [ "Usuario" ], "summary": "Retorna a lista de formas de assinar um documento (enquanto cidadão ou papéis de servidor) para o usuário logado através do AccessToken", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgenteInteressado" } } } } } } } }, "/v2/usuario/papeis": { "get": { "tags": [ "Usuario" ], "summary": "Retorna a lista de papéis habilitados no E-Docs para o usuário logado através do AccessToken", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgenteInteressado" } } } } } } } }, "/v2/usuario/gestor": { "get": { "tags": [ "Usuario" ], "summary": "Retorna o papel do Gestor Imediato para o usuário logado através do AccessToken, mediante papel informado", "parameters": [ { "name": "idPapel", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgenteInteressado" } } } } } } }, "/v2/usuario/papeis/ato/{atoTipo}/processo/{idProcesso}": { "get": { "tags": [ "Usuario" ], "summary": "Retorna a lista de papéis associados a um Ato de Processo para o usuário logado através do AccessToken", "parameters": [ { "name": "atoTipo", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/AtosGetPapeis" } }, { "name": "idProcesso", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgenteInteressado" } } } } } } } }, "/v2/usuario/papeis/encaminhamento/{idEncaminhamento}": { "get": { "tags": [ "Usuario" ], "summary": "Retorna a lista de papéis associados a um Encaminhamento para o usuário logado através do AccessToken", "parameters": [ { "name": "idEncaminhamento", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgenteInteressado" } } } } } } } }, "/v2/usuario/papeis/autuacao": { "get": { "tags": [ "Usuario" ], "summary": "Retorna a lista de papéis com permissão de Autuação de Processo para o usuário logado através do AccessToken", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgenteInteressado" } } } } } } }, "/v2/usuario/papeis/{idPapel}/locais/autuacao": { "get": { "tags": [ "Usuario" ], "summary": "Retorna a lista de locais com permissão de Autuação de Processo de um papel do usuário logado através do AccessToken", "parameters": [ { "name": "idPapel", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Localizacao" } } } } } } } }, "/v2/usuario/caixas-processo": { "get": { "tags": [ "Usuario" ], "summary": "Retorna a lista de Caixas de Processo que o usuário logado através do AccessToken tem permissão de visualização", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agente" } } } } } } } }, "/v2/usuario/caixas-encaminhamento": { "get": { "tags": [ "Usuario" ], "summary": "Retorna a lista de Caixas de Encaminhamento que o usuário logado através do AccessToken tem permissão de visualização", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agente" } } } } } } } } }, "components": { "schemas": { "Agente": { "type": "object", "properties": { "cidadao": { "$ref": "#/components/schemas/Cidadao" }, "papel": { "$ref": "#/components/schemas/Papel" }, "grupo": { "$ref": "#/components/schemas/GrupoTrabalho" }, "setor": { "$ref": "#/components/schemas/Setor" }, "organizacao": { "$ref": "#/components/schemas/Organizacao" }, "sistema": { "$ref": "#/components/schemas/Sistema" }, "id": { "type": "string", "description": "Identificador do papel", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipoAgente": { "type": "integer", "description": "Tipo do agente (código numérico)", "format": "int32" }, "descricaoTipoAgente": { "$ref": "#/components/schemas/AgenteTipoApi" } }, "additionalProperties": false, "description": "Dados de agente retornado pela API do E-Docs" }, "AgenteInteressado": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do agente", "format": "uuid", "nullable": true }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipo": { "type": "string", "description": "Tipo de agente", "nullable": true }, "siglaOrganizacao": { "type": "string", "description": "Sigla da Organização", "nullable": true }, "siglaUnidade": { "type": "string", "description": "Sigla da unidade", "nullable": true }, "nomeOrganizacaoUnidade": { "type": "string", "description": "Nome da organização se o agente é uma unidade", "nullable": true }, "siglaOrganizacaoUnidade": { "type": "string", "description": "Sigla da organização se o agente é uma unidade", "nullable": true }, "tipoLocalizacaoGrupo": { "type": "string", "description": "Tipo da Localização se o agente é um grupo de trabalho", "nullable": true }, "nomeUnidadeGrupo": { "type": "string", "description": "Nome da unidade se o agente é um grupo de trabalho", "nullable": true }, "siglaUnidadeGrupo": { "type": "string", "description": "Sigla da unidade se o agente é um grupo de trabalho", "nullable": true }, "nomeOrganizacaoGrupo": { "type": "string", "description": "Nome da organização se o agente é um grupo de trabalho", "nullable": true }, "siglaOrganizacaoGrupo": { "type": "string", "description": "Sigla da organização se o agente é um grupo de trabalho", "nullable": true }, "nomeServidorPapel": { "type": "string", "description": "Nome do servidor se o agente é um papel de servidor", "nullable": true }, "tipoLocalizacaoPapel": { "type": "string", "description": "Tipo da Localização se o agente é um papel de servidor", "nullable": true }, "nomeUnidadePapel": { "type": "string", "description": "Nome da unidade se o agente é um papel de servidor", "nullable": true }, "siglaUnidadePapel": { "type": "string", "description": "Sigla da unidade se o agente é um papel de servidor", "nullable": true }, "nomeOrganizacaoPapel": { "type": "string", "description": "Nome da organização se o agente é um papel de servidor", "nullable": true }, "siglaOrganizacaoPapel": { "type": "string", "description": "Sigla da organização se o agente é um papel de servidor", "nullable": true } }, "additionalProperties": false, "description": "Dados de agente interessado retornado pela API do E-Docs" }, "AgenteTipoApi": { "enum": [ "Cidadao", "Papel", "Grupo", "Unidade", "Organizacao", "Sistema", "NaoIdentificado" ], "type": "string", "description": "Tipo de agente (Cidadao = 1, Papel = 2, Grupo = 3, Unidade = 4, Organizacao = 5, Sistema = 6, NaoIdentificado = 99)" }, "Assinante": { "type": "object", "properties": { "agenteAssinante": { "$ref": "#/components/schemas/Agente" }, "dataHoraManifestacao": { "type": "string", "description": "Data e hora da manifestação", "format": "date-time" }, "tipoManifestacao": { "$ref": "#/components/schemas/ManifestacaoTipoApi" } }, "additionalProperties": false, "description": "Dados de assinante retornado pela API do E-Docs" }, "Associacao": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador da Associação", "format": "uuid" }, "nome": { "type": "string", "description": "Nome da Associação", "nullable": true }, "idProprietario": { "type": "string", "description": "Id do agente proprietário da Associação", "format": "uuid" } }, "additionalProperties": false, "description": "Associação de Processo" }, "AssociacaoApiFilter": { "type": "object", "properties": { "idProprietario": { "type": "string", "description": "Id do agente proprietário das associações", "format": "uuid", "nullable": true }, "pagina": { "type": "integer", "description": "Página atual da paginação", "format": "int32" }, "tamanhoPagina": { "type": "integer", "description": "Quantos registros por página", "format": "int32" } }, "additionalProperties": false, "description": "Filtros de busca de associações" }, "AssociacaoProcessoApiFilter": { "type": "object", "properties": { "idAssociacao": { "type": "string", "description": "Id da associação para filtro", "format": "uuid", "nullable": true }, "pagina": { "type": "integer", "description": "Página atual da paginação", "format": "int32" }, "tamanhoPagina": { "type": "integer", "description": "Quantos registros por página", "format": "int32" } }, "additionalProperties": false, "description": "Filtros de busca de processos em associações" }, "AssociacaoResultSearch": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Associacao" }, "description": "Resultado de busca", "nullable": true }, "count": { "type": "integer", "description": "Quantidade de resultados", "format": "int32" } }, "additionalProperties": false, "description": "Retorno de busca com paginação" }, "Ato": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do ato processual", "format": "uuid", "nullable": true, "readOnly": true }, "dataHora": { "type": "string", "description": "Data e hora do ato processual", "format": "date-time", "nullable": true, "readOnly": true }, "papel": { "$ref": "#/components/schemas/Papel" }, "tipo": { "type": "integer", "description": "Tipo do ato processual (código numérico)", "format": "int32" }, "descricaoTipo": { "$ref": "#/components/schemas/AtoTipoApi" }, "localizacao": { "$ref": "#/components/schemas/Localizacao" }, "destino": { "$ref": "#/components/schemas/Agente" }, "idEncaminhamento": { "type": "string", "description": "Identificador de encaminhamento associado ao entranhamento, se houver", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "AtosGetPapeis": { "enum": [ "Despacho", "Desentranhamento", "Entranhamento", "Avocamento", "Encerramento", "Reabertura", "Edicao" ], "type": "string", "description": "Atos de Papéis (Despacho = 2, Desentranhamento = 3, Entranhamento = 4, Avocamento = 5, Encerramento = 6, Reabertura = 7, Edicao = 11)" }, "AtoTipoApi": { "enum": [ "Autuacao", "Despacho", "Desentranhamento", "Entranhamento", "Avocamento", "Encerramento", "Reabertura", "AjusteCustodia", "Sobrestamento", "Prosseguimento", "Edicao" ], "type": "string", "description": "Tipos de Atos de Processo (Autuacao = 1, Despacho = 2, Desentranhamento = 3, Entranhamento = 4, Avocamento = 5, Encerramento = 6, Reabertura = 7, AjusteCustodia = 8, Sobrestamento = 9, Prosseguimento = 10, Edicao = 11)" }, "AutoCredenciamentoDocumentoEntry": { "type": "object", "properties": { "idPapelResponsavel": { "type": "string", "format": "uuid" }, "caminhoCompletoDocumento": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AutuacaoProcessoApiEntry": { "type": "object", "properties": { "idClasse": { "type": "string", "description": "Id da classe", "format": "uuid" }, "idPapelResponsavel": { "type": "string", "description": "Id do papel do servidor responsável pela autuação - o papel deve ter essa permissão de autuar na Organização", "format": "uuid" }, "idLocal": { "type": "string", "description": "Id do local de autuação - o papel deve ter essa permissão de autuação nesse local", "format": "uuid" }, "resumo": { "type": "string", "description": "Resumo ou título do processo", "nullable": true }, "idsAgentesInteressados": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de agentes públicos interessados no processo autuado", "nullable": true }, "pessoasJuridicasInteressadas": { "type": "array", "items": { "$ref": "#/components/schemas/PessoaJuridicaInteressadaApiEntry" }, "description": "Lista de ids de agentes privados jurídicos interessados no processo autuado", "nullable": true }, "interessadosSemIdentificacao": { "type": "array", "items": { "$ref": "#/components/schemas/InteressadoSemIdentificacaoApiEntry" }, "description": "Lista de ids de agentes interessados sem identificação no processo autuado", "nullable": true }, "idsDocumentosEntranhados": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de documentos capturados a serem entranhados no processo no momento da autuação", "nullable": true } }, "additionalProperties": false, "description": "Dados para autuação de processo" }, "Autuador": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do Autuador", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "papel": { "$ref": "#/components/schemas/Papel" }, "localizacao": { "$ref": "#/components/schemas/Localizacao" } }, "additionalProperties": false, "description": "Dados de autuador retornado pela API do E-Docs" }, "AvocamentoApiEntry": { "type": "object", "properties": { "justificativa": { "type": "string", "description": "Justificativa para o ato", "nullable": true }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "idProcesso": { "type": "string", "description": "Id do processo para o ato", "format": "uuid" }, "idPapelResponsavel": { "type": "string", "description": "Id do papel de servidor que irá realizar o ato - o papel deve ter permissão de executar o ato", "format": "uuid" } }, "additionalProperties": false, "description": "Dados para avocamento de processo" }, "CertificadoDigital": { "type": "object", "properties": { "validoAPartir": { "type": "string", "description": "Certificado válido a partir de", "format": "date-time" }, "validoAte": { "type": "string", "description": "Certificado válido até", "format": "date-time" }, "pkcs7SignDate": { "type": "string", "description": "Data da assinatura PKCS 7 Sign", "format": "date-time" }, "pessoaFisica": { "$ref": "#/components/schemas/PessoaFisica" }, "pessoaJuridica": { "$ref": "#/components/schemas/PessoaJuridica" } }, "additionalProperties": false, "description": "Dados de certificado digital retornado pela API do E-Docs" }, "CertificadoDigitalIEnumerableWebApiResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CertificadoDigital" }, "nullable": true }, "isSuccess": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cidadao": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do papel", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipoAgente": { "type": "integer", "description": "Tipo do agente (código numérico)", "format": "int32" }, "descricaoTipoAgente": { "$ref": "#/components/schemas/AgenteTipoApi" }, "sistema": { "$ref": "#/components/schemas/Sistema" } }, "additionalProperties": false, "description": "Dados do cidadão" }, "Classe": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador da classe", "format": "uuid", "nullable": true, "readOnly": true }, "codigo": { "type": "string", "description": "Código da Classe", "nullable": true, "readOnly": true }, "nome": { "type": "string", "description": "Nome", "nullable": true, "readOnly": true }, "observacao": { "type": "string", "description": "Observação", "nullable": true, "readOnly": true }, "ativo": { "type": "boolean", "description": "Se a classe está ativa", "nullable": true, "readOnly": true }, "unidadeArquivamento": { "type": "boolean", "description": "Se a classe é uma Unidade de Arquivamento", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Dados de classe retornado pela API do E-Docs" }, "ClassificacaoInformacaoApiEntry": { "type": "object", "properties": { "prazoAnos": { "type": "integer", "description": "Prazo em anos para a classificação da informação", "format": "int32" }, "prazoMeses": { "type": "integer", "description": "Prazo em meses para a classificação da informação", "format": "int32" }, "prazoDias": { "type": "integer", "description": "Prazo em dias para a classificação da informação", "format": "int32" }, "justificativa": { "type": "string", "description": "Justificativa para a classificação da informação", "nullable": true }, "idPapelAprovador": { "type": "string", "description": "Id do papel que será solicitado aprovação para a classificação da informação", "format": "uuid" } }, "additionalProperties": false, "description": "Dados para classificação da informação" }, "Comissao": { "type": "object", "properties": { "localizacao": { "$ref": "#/components/schemas/Localizacao" }, "id": { "type": "string", "description": "Identificador do papel", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipoAgente": { "type": "integer", "description": "Tipo do agente (código numérico)", "format": "int32" }, "descricaoTipoAgente": { "$ref": "#/components/schemas/AgenteTipoApi" }, "sistema": { "$ref": "#/components/schemas/Sistema" } }, "additionalProperties": false }, "CorDeclaradaApi": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "Cor declarada para o documento digitalizado (Monocromatico = 1, EscalaCinza = 2, Colorido = 3)", "format": "int32" }, "CredenciamentoLeituraDocumento": { "type": "object", "properties": { "idExternoDocumento": { "type": "string", "description": "Identificador do credenciamento de leitura", "format": "uuid" }, "dataSolicitacao": { "type": "string", "description": "Data de solicitação de credenciamento", "format": "date-time", "nullable": true }, "dataCancelamento": { "type": "string", "description": "Data de cancelamento da solicitação de credenciamento", "format": "date-time", "nullable": true }, "dataRevogacao": { "type": "string", "description": "Data de revogação da solicitação de credenciamento", "format": "date-time", "nullable": true }, "justificativaSolicitacao": { "type": "string", "description": "Justificativa da solicitação de credenciamento", "nullable": true }, "justificativaManifestacao": { "type": "string", "description": "Justificativa da manifestação do aprovador da solicitação de credenciamento", "nullable": true }, "justificativaCancelamento": { "type": "string", "description": "Justificativa do cancelamento da solicitação de credenciamento", "nullable": true }, "justificativaRevogacao": { "type": "string", "description": "Justificativa da revogação da solicitação de credenciamento", "nullable": true }, "situacao": { "$ref": "#/components/schemas/CredenciamentoLeituraDocumentoSituacaoTipo" }, "nivelAcesso": { "$ref": "#/components/schemas/NivelAcessoTipo" } }, "additionalProperties": false, "description": "Credenciamento de Leitura a Documento" }, "CredenciamentoLeituraDocumentoSituacaoTipo": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "DesentranhamentoApiEntry": { "type": "object", "properties": { "justificativa": { "type": "string", "description": "Justificativa para o ato", "nullable": true }, "sequenciais": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Lista com números sequenciais de documentos para o processo", "nullable": true }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "idProcesso": { "type": "string", "description": "Id do processo para o ato", "format": "uuid" }, "idPapelResponsavel": { "type": "string", "description": "Id do papel de servidor que irá realizar o ato - o papel deve ter permissão de executar o ato", "format": "uuid" } }, "additionalProperties": false, "description": "Dados para desentranhamento em processo" }, "DespachoProcessoApiEntry": { "type": "object", "properties": { "idDestino": { "type": "string", "description": "Id do destinatário do despacho", "format": "uuid" }, "mensagem": { "type": "string", "description": "Mensagem inserida no despacho", "nullable": true }, "idsDocumentosEntranhados": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids de documentos capturados anexados ao ato", "nullable": true }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "idProcesso": { "type": "string", "description": "Id do processo para o ato", "format": "uuid" }, "idPapelResponsavel": { "type": "string", "description": "Id do papel de servidor que irá realizar o ato - o papel deve ter permissão de executar o ato", "format": "uuid" } }, "additionalProperties": false, "description": "Dados para despacho de processo" }, "DestinacaoFinalPrevistaApi": { "enum": [ 1, 2 ], "type": "integer", "description": "Destinação prevista para o documento digitalizado (Eliminacao = 1, GuardaPermanente = 2)", "format": "int32" }, "Documento": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do documento capturado", "format": "uuid" }, "registro": { "type": "string", "description": "Registro do documento capturado", "nullable": true }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "extensao": { "type": "string", "description": "Extensão do arquivo", "nullable": true }, "nivelAcesso": { "$ref": "#/components/schemas/NivelAcessoTipoApi" } }, "additionalProperties": false, "description": "Dados de documento retornado pela API do E-Docs" }, "DocumentoApiFilter": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de identificadores de documentos capturados", "nullable": true }, "identificadoresExternos": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "[OBSOLETO] Lista de identificadores de documentos capturados", "nullable": true, "deprecated": true }, "registros": { "type": "array", "items": { "type": "string" }, "description": "Lista de registros de documentos capturados", "nullable": true }, "somenteDiretorio": { "type": "boolean", "description": "Pesquisar somente documentos na aba Diretório" }, "somenteMeusDocumentos": { "type": "boolean", "description": "Pesquisar somente documentos na aba Meus Documentos" }, "pesquisaLivre": { "type": "string", "description": "Termos livres que serão pesquisados em campos variados nos documentos", "nullable": true }, "pagina": { "type": "integer", "description": "Página atual da paginação", "format": "int32" }, "tamanhoPagina": { "type": "integer", "description": "Quantos registros por página", "format": "int32" } }, "additionalProperties": false, "description": "Filtros de busca de documentos" }, "DocumentoArquivo": { "type": "object", "properties": { "url": { "type": "string", "description": "Endereço que será utilizado para enviar o arquivo por método POST", "nullable": true }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true }, "body": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Lista de parâmetros do arquivo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados de arquivo de documento retornado pela API do E-Docs" }, "DocumentoAssinado": { "type": "object", "properties": { "capturado": { "type": "boolean", "description": "Se o documento foi capturado ao executar a manifestação" }, "idCapturaEvento": { "type": "string", "description": "Caso tenha havido a captura, o identificador do evento de captura de documento", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Dados de documento assinado retornado pela API do E-Docs" }, "DocumentoAto": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do ato", "format": "uuid", "nullable": true, "readOnly": true }, "documentoNome": { "type": "string", "description": "Nome do documento do ato", "nullable": true, "readOnly": true }, "documentoId": { "type": "string", "description": "Identificador do documento do ato, se houver", "format": "uuid", "nullable": true, "readOnly": true }, "desentranhamentoId": { "type": "string", "description": "Identificador do ato de desentranhamento do ato, se houver", "format": "uuid", "nullable": true, "readOnly": true }, "termo": { "type": "boolean", "description": "Se o documento é um termo do ato", "readOnly": true }, "sequencial": { "type": "integer", "description": "Senquencial do documento em um processo", "format": "int32" } }, "additionalProperties": false }, "DocumentoBase": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do documento capturado", "format": "uuid" }, "registro": { "type": "string", "description": "Registro do documento capturado", "nullable": true }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "extensao": { "type": "string", "description": "Extensão do arquivo", "nullable": true }, "nivelAcesso": { "$ref": "#/components/schemas/NivelAcessoTipoApi" } }, "additionalProperties": false, "description": "Dados básicos de documento retornado pela API do E-Docs" }, "DocumentoDigitalizadoCidadaoApiEntry": { "type": "object", "properties": { "valorLegal": { "$ref": "#/components/schemas/DocumentoValorLegalApi" }, "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados para documento digitalizado capturado por cidadão" }, "DocumentoDigitalizadoOriginal": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do documento capturado", "format": "uuid" }, "idPapelCapturador": { "type": "string", "description": "Id do papel do servidor capturou o documento", "format": "uuid" }, "idClasse": { "type": "string", "description": "Id da classe do documento", "format": "uuid" }, "assunto": { "type": "string", "description": "Palavras chave que representam o conteúdo do documento", "nullable": true }, "destinacaoFinalPrevista": { "$ref": "#/components/schemas/DestinacaoFinalPrevistaApi" }, "autorProducao": { "type": "string", "description": "Autor do documento original em papel (pessoa física ou jurídica que emitiu o documento)", "nullable": true }, "localProducao": { "type": "string", "description": "Local de produção do documento original em papel (pessoa física ou jurídica que emitiu o documento)", "nullable": true }, "dataProducao": { "type": "string", "description": "Data e hora da produção/autuação do documento", "format": "date-time" }, "responsavelDigitalizacao": { "type": "string", "description": "Responsável pela digitalização do documento (pessoa física ou jurídica)", "nullable": true }, "dataDigitalizacao": { "type": "string", "description": "Data e hora da digitalização do documento", "format": "date-time" }, "localDigitalizacao": { "type": "string", "description": "Local (registro tópico) da digitalização do documento em papel. Pode ser o órgão/setor que fez a digitalização", "nullable": true }, "dpiDeclarada": { "type": "integer", "description": "Resolução declarada da digitalização do documento papel para o digital", "format": "int32" }, "corDeclarada": { "$ref": "#/components/schemas/CorDeclaradaApi" } }, "additionalProperties": false }, "DocumentoDigitalizadoOriginalApiEntry": { "type": "object", "properties": { "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true }, "idPapelCapturador": { "type": "string", "description": "Id do papel do servidor que irá capturar o documento", "format": "uuid" }, "idClasse": { "type": "string", "description": "Id do classe do documento", "format": "uuid" }, "assunto": { "type": "string", "description": "Palavras chave que representam o conteúdo do documento", "nullable": true }, "destinacaoFinalPrevista": { "$ref": "#/components/schemas/DestinacaoFinalPrevistaApi" }, "autorProducao": { "type": "string", "description": "Autor do documento original em papel (pessoa física ou jurídica que emitiu o documento)", "nullable": true }, "dataProducao": { "type": "string", "description": "Data da produção/autuação (a hora não é utilizada)", "format": "date-time" }, "localProducao": { "type": "string", "description": "Nome do órgão ou entidade responsável pela produção do documento", "nullable": true }, "responsavelDigitalizacao": { "type": "string", "description": "Responsável pela digitalização do documento (pessoa física ou jurídica)", "nullable": true }, "dataDigitalizacao": { "type": "string", "description": "Data e hora da digitalização do documento", "format": "date-time" }, "localDigitalizacao": { "type": "string", "description": "Local (registro tópico) da digitalização do documento em papel. Pode ser o órgão/setor que fez a digitalização", "nullable": true }, "dpiDeclarada": { "$ref": "#/components/schemas/DpiDeclaradaApi" }, "corDeclarada": { "$ref": "#/components/schemas/CorDeclaradaApi" } }, "additionalProperties": false }, "DocumentoDigitalizadoServidorApiEntry": { "type": "object", "properties": { "idPapelCapturador": { "type": "string", "description": "Id do papel do servidor que irá capturar o documento", "format": "uuid" }, "valorLegalDocumentoConferencia": { "$ref": "#/components/schemas/DocumentoValorLegalApi" }, "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados para documento digitalizado capturados por servidor" }, "DocumentoEncaminhamento": { "type": "object", "properties": { "controle": { "type": "boolean", "description": "Se o documento é o termo do encaminhamento", "nullable": true }, "documento": { "$ref": "#/components/schemas/DocumentoBase" } }, "additionalProperties": false, "description": "Dados de documento de encaminhamento retornado pela API do E-Docs" }, "DocumentoFaseAssinatura": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do documento em fase de assinatura", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "idCarregadoPor": { "type": "string", "description": "Identificador do responsável pelo carregamento do documento em fase de assinatura", "format": "uuid" }, "assinantesIndicados": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista dos ids dos assinantes indicados para o documento", "nullable": true } }, "additionalProperties": false, "description": "Dados de documento em fase de assinatura retornado pela API do E-Docs" }, "DocumentoFaseAssinaturaApiFilter": { "type": "object", "properties": { "incluirPendentes": { "type": "boolean", "description": "Incluir documentos com pendência de manifestação pelo usuário logado por AccessToken" }, "incluirAssinados": { "type": "boolean", "description": "Incluir documentos assinados pelo usuário logado por AccessToken" }, "incluirRecusados": { "type": "boolean", "description": "Incluir documentos recusados de assinatura pelo usuário logado por AccessToken" }, "incluirCarregadosPorMim": { "type": "boolean", "description": "Incluir documentos carregados pelo usuário logado por AccessToken" }, "pagina": { "type": "integer", "description": "Página atual da paginação", "format": "int32" }, "tamanhoPagina": { "type": "integer", "description": "Quantos registros por página", "format": "int32" } }, "additionalProperties": false, "description": "Filtros de busca de documentos em fase de assinatura" }, "DocumentoFaseAssinaturaResultSearch": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentoFaseAssinatura" }, "description": "Resultado de busca", "nullable": true }, "count": { "type": "integer", "description": "Quantidade de resultados", "format": "int32" } }, "additionalProperties": false, "description": "Retorno de busca com paginação" }, "DocumentoGeneroBusiness": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "DocumentoMetadados": { "type": "object", "properties": { "nomeCapturador": { "type": "string", "nullable": true }, "capturadorPapelNome": { "type": "string", "nullable": true }, "capturadorUnidadeSigla": { "type": "string", "nullable": true }, "capturadorOrgaoSigla": { "type": "string", "nullable": true }, "capturadorPatriarcaSigla": { "type": "string", "nullable": true }, "guidCapturador": { "type": "string", "format": "uuid", "nullable": true }, "classe": { "type": "string", "nullable": true }, "dataEnvio": { "type": "string", "format": "date-time", "nullable": true }, "dataCaptura": { "type": "string", "format": "date-time", "nullable": true }, "nomeArquivo": { "type": "string", "nullable": true }, "guidDocumento": { "type": "string", "format": "uuid", "nullable": true }, "genero": { "$ref": "#/components/schemas/DocumentoGeneroBusiness" }, "numeroPaginas": { "type": "integer", "format": "int32", "nullable": true }, "tamanhoBytes": { "type": "integer", "format": "int64", "nullable": true }, "natureza": { "$ref": "#/components/schemas/DocumentoNatureza" }, "tipoAssinatura": { "$ref": "#/components/schemas/DocumentoTipoAssinatura" }, "valorLegal": { "$ref": "#/components/schemas/DocumentoValorLegal" }, "nivelAcesso": { "$ref": "#/components/schemas/NivelAcessoTipo" }, "assinantes": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentoMetadadosAssinante" }, "nullable": true } }, "additionalProperties": false }, "DocumentoMetadadosAssinante": { "type": "object", "properties": { "nome": { "type": "string", "nullable": true }, "papelNome": { "type": "string", "nullable": true }, "unidadeSigla": { "type": "string", "nullable": true }, "orgaoSigla": { "type": "string", "nullable": true }, "patriarcaSigla": { "type": "string", "nullable": true }, "guid": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "DocumentoNatoDigitalAssinaturaEletronicaCidadaoApiEntry": { "type": "object", "properties": { "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados para documento nato-digital assinado via E-Docs capturados por cidadão" }, "DocumentoNatoDigitalAssinaturaEletronicaServidorApiEntry": { "type": "object", "properties": { "idPapelCapturadorAssinante": { "type": "string", "description": "Id do papel do servidor que irá capturar e auto assinar o documento", "format": "uuid" }, "idClasse": { "type": "string", "description": "Id da classe do documento", "format": "uuid" }, "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados para documento nato-digital assinado via E-Docs capturados por servidor" }, "DocumentoNatoDigitalCopiaCidadaoApiEntry": { "type": "object", "properties": { "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados para documento nato-digital sem assinatura capturados por cidadão" }, "DocumentoNatoDigitalCopiaServidorApiEntry": { "type": "object", "properties": { "idPapelCapturador": { "type": "string", "description": "Id do papel do servidor que irá capturar o documento", "format": "uuid" }, "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados para documento nato-digital sem assinatura capturados por servidor" }, "DocumentoNatoDigitalIcpBrasilCidadaoApiEntry": { "type": "object", "properties": { "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados básico de documento nato-digital com assinatura ICP-Brasil capturado por cidadão" }, "DocumentoNatoDigitalIcpBrasilServidorApiEntry": { "type": "object", "properties": { "idPapelCapturador": { "type": "string", "description": "Id do papel do servidor que irá capturar o documento", "format": "uuid" }, "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados básico de documento nato-digital com assinatura ICP-Brasil capturado por servidor" }, "DocumentoNatoDigitalMultiplasAssinaturasCidadaoApiEntry": { "type": "object", "properties": { "assinantes": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de assinantes do documento", "nullable": true }, "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados para documento nato-digital com múltiplas assinaturas capturado por cidadão" }, "DocumentoNatoDigitalMultiplasAssinaturasServidorApiEntry": { "type": "object", "properties": { "idPapelCapturador": { "type": "string", "description": "Id do papel do servidor que irá capturar o documento", "format": "uuid" }, "idClasse": { "type": "string", "description": "Id da classe do documento", "format": "uuid" }, "assinantes": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de assinantes do documento", "nullable": true }, "nomeArquivo": { "type": "string", "description": "Nome do arquivo que o E-Docs sugerirá para download, substituindo o nome interno na nuvem do E-Docs, no formato do identificador", "nullable": true }, "credenciarCapturador": { "type": "boolean", "description": "Se o capturador de ser credenciado para visualizar o documento" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "identificadorTemporarioArquivoNaNuvem": { "type": "string", "description": "Identificador do arquivo temporário na nuvem do E-Docs no formato \"AAAA/M/D/{Guid}_{Guid}.temp\". Na prática esse será o nome interno do arquivo salvo na nuvem do E-Docs", "nullable": true } }, "additionalProperties": false, "description": "Dados para documento nato-digital com múltiplas assinaturas capturado por servidor" }, "DocumentoNatureza": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "DocumentoResultSearch": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Documento" }, "description": "Resultado de busca", "nullable": true }, "count": { "type": "integer", "description": "Quantidade de resultados", "format": "int32" } }, "additionalProperties": false, "description": "Retorno de busca com paginação" }, "DocumentoTipoAssinatura": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "DocumentoValorLegal": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "DocumentoValorLegalApi": { "enum": [ "Original", "CopiaAutenticadaCartorio", "CopiaAutenticadaAdministrativamente", "CopiaSimples" ], "type": "string", "description": "Valor Legal do Documento (Original = 1, CopiaAutenticadaCartorio = 2, CopiaAutenticadaAdministrativamente = 3, CopiaSimples = 4)" }, "DpiDeclaradaApi": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "EdicaoProcessoApiEntry": { "type": "object", "properties": { "idClasse": { "type": "string", "description": "Id da classe", "format": "uuid" }, "resumo": { "type": "string", "description": "Resumo ou título do processo", "nullable": true }, "idsAgentesInteressados": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de agentes públicos interessados no processo autuado", "nullable": true }, "pessoasJuridicasInteressadas": { "type": "array", "items": { "$ref": "#/components/schemas/PessoaJuridicaInteressadaApiEntry" }, "description": "Lista de ids de agentes privados jurídicos interessados no processo autuado", "nullable": true }, "interessadosSemIdentificacao": { "type": "array", "items": { "$ref": "#/components/schemas/InteressadoSemIdentificacaoApiEntry" }, "description": "Lista de ids de agentes interessados sem identificação no processo autuado", "nullable": true }, "idProcesso": { "type": "string", "description": "Id do processo para o ato", "format": "uuid" }, "idPapelResponsavel": { "type": "string", "description": "Id do papel de servidor que irá realizar o ato - o papel deve ter permissão de executar o ato", "format": "uuid" } }, "additionalProperties": false, "description": "Dados para edição de processo" }, "Encaminhamento": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do encaminhamento", "format": "uuid" }, "identificadorExterno": { "type": "string", "description": "[OBSOLETO] Identificador do encaminhamento", "format": "uuid", "deprecated": true }, "assunto": { "type": "string", "description": "Título ou assunto do encaminhamento", "nullable": true }, "dataHora": { "type": "string", "description": "Data e hora do encaminhamento", "format": "date-time", "nullable": true }, "destinos": { "type": "array", "items": { "$ref": "#/components/schemas/Agente" }, "description": "Lista de agentes a que se destina o encaminhamento", "nullable": true }, "idEncaminhamentoAnterior": { "type": "string", "description": "Id do encaminhamento anterior a que esse encaminhamento está atrelado", "format": "uuid", "nullable": true }, "encaminhamentosPosteriores": { "type": "array", "items": { "$ref": "#/components/schemas/Encaminhamento" }, "description": "Encaminhamentos Posteriores diretamente a esse encaminhamento", "nullable": true }, "idEncaminhamentoInicial": { "type": "string", "description": "Id do encaminhamento inicial a que esse encaminhamento está atrelado", "format": "uuid", "nullable": true }, "idResponsavel": { "type": "string", "description": "Id do responsável pelo envio desse encaminhamento", "format": "uuid" }, "responsavel": { "$ref": "#/components/schemas/Agente" } }, "additionalProperties": false, "description": "Dados de encaminhamento retornado pela API do E-Docs" }, "EncaminhamentoAcaoPendenteResolvidoApiEntry": { "type": "object", "properties": { "idExternoCaixaEntrada": { "type": "string", "format": "uuid" }, "idEncaminhamento": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "EncaminhamentoApiFilter": { "type": "object", "properties": { "assunto": { "type": "string", "description": "Título ou assunto do encaminhamento", "nullable": true }, "dataInicial": { "type": "string", "description": "Menor data que tenha ocorrido o encaminhamento", "format": "date-time", "nullable": true }, "dataFinal": { "type": "string", "description": "Maior data que tenha ocorrido o encaminhamento", "format": "date-time", "nullable": true }, "idsResponsaveis": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de responsáveis por criar o encaminhamento", "nullable": true }, "idsDestinos": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de destinatários de encaminhamentos", "nullable": true }, "responsaveis": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "[OBSOLETO] Lista de ids de responsáveis por criar o encaminhamento. Usar IdsResponsaveis", "nullable": true, "deprecated": true }, "destinos": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "[OBSOLETO] Lista de ids de destinatários de encaminhamentos. Usar IdsDestinos", "nullable": true, "deprecated": true }, "idSistemaOrigem": { "type": "string", "description": "O id do sistema que originou o encaminhamento", "format": "uuid", "nullable": true }, "inicial": { "type": "boolean", "description": "Se o encaminhamento é o primeiro ou se é um encaminhamento posterior (resposta, reencaminhamento, complemento)", "nullable": true }, "caixa": { "type": "boolean", "description": "Se o encaminhamento esta na caixa de entrada (true) ou na caixa de resolvidos. Padrão é TRUE", "nullable": true }, "pagina": { "type": "integer", "description": "Página atual da paginação", "format": "int32" }, "tamanhoPagina": { "type": "integer", "description": "Quantos registros por página", "format": "int32" } }, "additionalProperties": false, "description": "Filtros de busca de encaminhamentos" }, "EncaminhamentoComplementoApiEntry": { "type": "object", "properties": { "idEncaminhamentoAnterior": { "type": "string", "description": "Id do encaminhamento envolvido nessa execução", "format": "uuid" }, "mensagem": { "type": "string", "description": "Conteúdo ou mensagem do encaminhamento", "nullable": true }, "idResponsavel": { "type": "string", "description": "Id do responsável pelo encaminhamento", "format": "uuid" }, "idsDocumentos": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de documentos capturados que será anexado ao encaminhamento", "nullable": true }, "enviarEmailNotificacoes": { "type": "boolean", "description": "Se o sistema deve enviar um email de notificação para o destinatário" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" } }, "additionalProperties": false, "description": "Dados para complemento de encaminhamento" }, "EncaminhamentoNovoApiEntry": { "type": "object", "properties": { "assunto": { "type": "string", "description": "Título ou assunto do encaminhamento", "nullable": true }, "idsDestinos": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids dos destinatários do encaminhamento", "nullable": true }, "mensagem": { "type": "string", "description": "Conteúdo ou mensagem do encaminhamento", "nullable": true }, "idResponsavel": { "type": "string", "description": "Id do responsável pelo encaminhamento", "format": "uuid" }, "idsDocumentos": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de documentos capturados que será anexado ao encaminhamento", "nullable": true }, "enviarEmailNotificacoes": { "type": "boolean", "description": "Se o sistema deve enviar um email de notificação para o destinatário" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" } }, "additionalProperties": false, "description": "Dados para novo encaminhamento" }, "EncaminhamentoReencaminhamentoApiEntry": { "type": "object", "properties": { "idsDestinos": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids dos destinatários do encaminhamento", "nullable": true }, "idEncaminhamentoAnterior": { "type": "string", "description": "Id do encaminhamento envolvido nessa execução", "format": "uuid" }, "mensagem": { "type": "string", "description": "Conteúdo ou mensagem do encaminhamento", "nullable": true }, "idResponsavel": { "type": "string", "description": "Id do responsável pelo encaminhamento", "format": "uuid" }, "idsDocumentos": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de documentos capturados que será anexado ao encaminhamento", "nullable": true }, "enviarEmailNotificacoes": { "type": "boolean", "description": "Se o sistema deve enviar um email de notificação para o destinatário" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" } }, "additionalProperties": false, "description": "Dados para reencaminhamento" }, "EncaminhamentoRespostaApiEntry": { "type": "object", "properties": { "idEncaminhamentoAnterior": { "type": "string", "description": "Id do encaminhamento envolvido nessa execução", "format": "uuid" }, "mensagem": { "type": "string", "description": "Conteúdo ou mensagem do encaminhamento", "nullable": true }, "idResponsavel": { "type": "string", "description": "Id do responsável pelo encaminhamento", "format": "uuid" }, "idsDocumentos": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de documentos capturados que será anexado ao encaminhamento", "nullable": true }, "enviarEmailNotificacoes": { "type": "boolean", "description": "Se o sistema deve enviar um email de notificação para o destinatário" }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" } }, "additionalProperties": false, "description": "Dados para resposta de encaminhamento" }, "EncaminhamentoResultSearch": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Encaminhamento" }, "description": "Resultado de busca", "nullable": true }, "count": { "type": "integer", "description": "Quantidade de resultados", "format": "int32" } }, "additionalProperties": false, "description": "Retorno de busca com paginação" }, "EncerramentoApiEntry": { "type": "object", "properties": { "desfecho": { "type": "string", "description": "Desfecho para o encerramento do processo", "nullable": true }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "idProcesso": { "type": "string", "description": "Id do processo para o ato", "format": "uuid" }, "idPapelResponsavel": { "type": "string", "description": "Id do papel de servidor que irá realizar o ato - o papel deve ter permissão de executar o ato", "format": "uuid" } }, "additionalProperties": false, "description": "Dados para encerramento de processo" }, "EntranhamentoDocumentoApiEntry": { "type": "object", "properties": { "justificativa": { "type": "string", "description": "Justificativa do ato", "nullable": true }, "idsDocumentosEntranhados": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids de documentos capturados anexados ao ato", "nullable": true }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "idProcesso": { "type": "string", "description": "Id do processo para o ato", "format": "uuid" }, "idPapelResponsavel": { "type": "string", "description": "Id do papel de servidor que irá realizar o ato - o papel deve ter permissão de executar o ato", "format": "uuid" } }, "additionalProperties": false, "description": "Dados para entranhamento de documento em processo" }, "EntranhamentoEncaminhamentoApiEntry": { "type": "object", "properties": { "idEncaminhamento": { "type": "string", "description": "Id do encaminhamento a ser entranhado", "format": "uuid" }, "justificativa": { "type": "string", "description": "Justificativa do ato", "nullable": true }, "idsDocumentosEntranhados": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids de documentos capturados anexados ao ato", "nullable": true }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "idProcesso": { "type": "string", "description": "Id do processo para o ato", "format": "uuid" }, "idPapelResponsavel": { "type": "string", "description": "Id do papel de servidor que irá realizar o ato - o papel deve ter permissão de executar o ato", "format": "uuid" } }, "additionalProperties": false, "description": "Dados básicos para entranhamento de encaminhamento em processo" }, "ErrorResult": { "type": "object", "properties": { "error": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "issues": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": false }, "Evento": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do evento", "format": "uuid" }, "idCidadao": { "type": "string", "description": "id do cidadão relacionado ao evento", "format": "uuid" }, "situacao": { "$ref": "#/components/schemas/EventoSituacaoApi" }, "criacao": { "type": "string", "description": "Data e hora de criação do evento", "format": "date-time" }, "conclusao": { "type": "string", "description": "Data e hora de conclusão do evento", "format": "date-time", "nullable": true }, "tipo": { "$ref": "#/components/schemas/EventoTipoApi" }, "idProcesso": { "type": "string", "description": "Identificador do processo, se o evento for relacionado a processo", "format": "uuid", "nullable": true }, "idAto": { "type": "string", "description": "Identificador do ato de processo, se o evento for relacionado a ato de processo", "format": "uuid", "nullable": true }, "idTermo": { "type": "string", "description": "Identificador do termo, se o evento englobar criação de documento de termo de processo ou encaminhamento", "format": "uuid", "nullable": true }, "idEncaminhamento": { "type": "string", "description": "Identificador do encaminhamento, se o evento for relacionado a encaminhamento", "format": "uuid", "nullable": true }, "idDocumento": { "type": "string", "description": "Identificador do documento, se o evento for relacionado a documento", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "EventoSituacaoApi": { "enum": [ "Criado", "Enfileirado", "Processando", "Executado", "Concluido", "Cancelado" ], "type": "string", "description": "Situação de um Evento (Criado = 1, Enfileirado = 2, Processando = 3, Executado = 4, Concluido = 5, Cancelado = 9)" }, "EventoTipoApi": { "enum": [ "CapturaNatoDigitalICPBrasil", "CapturaNatoDigitalCopia", "CapturaNatoDigitalMultiplasAssinaturasServidor", "CapturaNatoDigitalMultiplasAssinaturasCidadao", "CapturaNatoDigitalAssinaturaEletronicaServidor", "CapturaNatoDigitalAssinaturaEletronicaCidadao", "CapturaDigitalizadoServidor", "CapturaDigitalizadoCidadao", "EncaminhamentoInicial", "EncaminhamentoPosterior", "AutuacaoProcesso", "DespachoProcesso", "DesentranhamentoProcesso", "EntranhamentoProcesso", "AvocamentoProcesso", "EncerramentoProcesso", "ReaberturaProcesso", "AjusteCustodiaProcesso", "SobrestamentoProcesso", "ProsseguimentoProcesso", "EdicaoProcesso", "CopiaProcesso" ], "type": "string", "description": "Tipos de Evento (CapturaNatoDigitalICPBrasil = 101, CapturaNatoDigitalCopia = 102, CapturaNatoDigitalMultiplasAssinaturasServidor = 103, CapturaNatoDigitalMultiplasAssinaturasCidadao = 104, CapturaNatoDigitalAssinaturaEletronicaServidor = 105, CapturaNatoDigitalAssinaturaEletronicaCidadao = 106, CapturaDigitalizadoServidor = 107, CapturaDigitalizadoCidadao = 108, EncaminhamentoInicial = 201, EncaminhamentoPosterior = 202, AutuacaoProcesso = 301, DespachoProcesso = 302, DesentranhamentoProcesso = 303, EntranhamentoProcesso = 304, AvocamentoProcesso = 305, EncerramentoProcesso = 306, ReaberturaProcesso = 307, AjusteCustodiaProcesso = 308, SobrestamentoProcesso = 309, ProsseguimentoProcesso = 310, EdicaoProcesso = 311, CopiaProcesso = 312)" }, "FundamentoLegal": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do fundamento legal", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "descricao": { "type": "string", "description": "Descrição", "nullable": true }, "ordenacao": { "type": "integer", "description": "A ordenação do fundamento em uma listagem", "format": "int32", "nullable": true }, "nivelAcesso": { "type": "string", "description": "Nível de acesso relacionado ao fundamento", "nullable": true }, "idPatriarca": { "type": "string", "description": "Id do Patriarca desse fundamento, ou nenhum se for um fundamento público", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "GeneroDocumentoApi": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "Gênero do Documento (Textual = 1, Audio = 2, Video = 3)", "format": "int32" }, "GestaoInformacaoClassificada": { "type": "object", "properties": { "idsFundamentosLegais": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "tornarPublico": { "type": "boolean" }, "vigenciaAnos": { "type": "integer", "format": "int32" }, "vigenciaMeses": { "type": "integer", "format": "int32" }, "vigenciaDias": { "type": "integer", "format": "int32" }, "justificativaTci": { "type": "string", "nullable": true }, "idAprovadorTci": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "GrupoTrabalho": { "type": "object", "properties": { "localizacao": { "$ref": "#/components/schemas/Localizacao" }, "id": { "type": "string", "description": "Identificador do papel", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipoAgente": { "type": "integer", "description": "Tipo do agente (código numérico)", "format": "int32" }, "descricaoTipoAgente": { "$ref": "#/components/schemas/AgenteTipoApi" }, "sistema": { "$ref": "#/components/schemas/Sistema" } }, "additionalProperties": false }, "Interessados": { "type": "object", "properties": { "agentesInteressados": { "type": "array", "items": { "$ref": "#/components/schemas/AgenteInteressado" }, "nullable": true }, "pessoasJuridicasInteressadas": { "type": "array", "items": { "$ref": "#/components/schemas/PessoaJuridicaInteressada" }, "nullable": true }, "interessadosSemIdentificacao": { "type": "array", "items": { "$ref": "#/components/schemas/InteressadoSemIdentificacao" }, "nullable": true } }, "additionalProperties": false }, "InteressadoSemIdentificacao": { "type": "object", "properties": { "descricao": { "type": "string", "description": "Descrição", "nullable": true } }, "additionalProperties": false }, "InteressadoSemIdentificacaoApiEntry": { "type": "object", "properties": { "descricao": { "type": "string", "description": "Descrição do interessado", "nullable": true } }, "additionalProperties": false, "description": "Dados para interessado em processo sem identificação" }, "Localizacao": { "type": "object", "properties": { "sigla": { "type": "string", "description": "Sigla", "nullable": true, "readOnly": true }, "id": { "type": "string", "description": "Identificador do papel", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipoAgente": { "type": "integer", "description": "Tipo do agente (código numérico)", "format": "int32" }, "descricaoTipoAgente": { "$ref": "#/components/schemas/AgenteTipoApi" }, "sistema": { "$ref": "#/components/schemas/Sistema" } }, "additionalProperties": false, "description": "Dados de localização" }, "ManifestacaoTipoApi": { "enum": [ "Assinado", "Recusado" ], "type": "string", "description": "Tipo de Manifestação em Documentos (Assinado = 1, Recusado = 2)" }, "NivelAcessoTipo": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "NivelAcessoTipoApi": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "description": "Níveis de Acesso ao Documento (Publico = 1, Organizacional = 2, Restrito = 3, Sigiloso = 4, Reservado = 5, Secreto = 6, Ultrassecreto = 7, SigilosoSemFundamentoLegal = 8)", "format": "int32" }, "Organizacao": { "type": "object", "properties": { "patriarca": { "$ref": "#/components/schemas/Patriarca" }, "sigla": { "type": "string", "description": "Sigla", "nullable": true, "readOnly": true }, "id": { "type": "string", "description": "Identificador do papel", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipoAgente": { "type": "integer", "description": "Tipo do agente (código numérico)", "format": "int32" }, "descricaoTipoAgente": { "$ref": "#/components/schemas/AgenteTipoApi" }, "sistema": { "$ref": "#/components/schemas/Sistema" } }, "additionalProperties": false, "description": "Dados da organização" }, "Papel": { "type": "object", "properties": { "cargo": { "type": "string", "description": "Nome", "nullable": true, "readOnly": true }, "setor": { "$ref": "#/components/schemas/Setor" }, "id": { "type": "string", "description": "Identificador do papel", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipoAgente": { "type": "integer", "description": "Tipo do agente (código numérico)", "format": "int32" }, "descricaoTipoAgente": { "$ref": "#/components/schemas/AgenteTipoApi" }, "sistema": { "$ref": "#/components/schemas/Sistema" } }, "additionalProperties": false, "description": "Dados do papel do servidor" }, "Patriarca": { "type": "object", "properties": { "sigla": { "type": "string", "description": "Sigla", "nullable": true, "readOnly": true }, "id": { "type": "string", "description": "Identificador do papel", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipoAgente": { "type": "integer", "description": "Tipo do agente (código numérico)", "format": "int32" }, "descricaoTipoAgente": { "$ref": "#/components/schemas/AgenteTipoApi" }, "sistema": { "$ref": "#/components/schemas/Sistema" } }, "additionalProperties": false }, "PessoaFisica": { "type": "object", "properties": { "nome": { "type": "string", "description": "Nome", "nullable": true }, "dataNascimento": { "type": "string", "description": "Data de nascimento", "format": "date-time" }, "cpf": { "type": "string", "description": "CPF", "nullable": true }, "nis": { "type": "string", "description": "NIS", "nullable": true }, "rg": { "type": "string", "description": "RG", "nullable": true }, "orgaoExpedidor": { "type": "string", "description": "Órgão Expedidor", "nullable": true }, "inss": { "type": "string", "description": "INSS", "nullable": true }, "tituloEleitor": { "type": "string", "description": "Título de Eleitor", "nullable": true }, "zonaEleitoral": { "type": "string", "description": "Zona Eleitoral", "nullable": true }, "secao": { "type": "string", "description": "Seção Eleitoral", "nullable": true }, "municipio": { "type": "string", "description": "Município", "nullable": true } }, "additionalProperties": false }, "PessoaJuridica": { "type": "object", "properties": { "cnpj": { "type": "string", "description": "CNPJ", "nullable": true }, "razaoSocial": { "type": "string", "description": "Razão Social", "nullable": true }, "inss": { "type": "string", "description": "INSS", "nullable": true }, "responsavel": { "$ref": "#/components/schemas/PessoaFisica" } }, "additionalProperties": false }, "PessoaJuridicaInteressada": { "type": "object", "properties": { "razaoSocial": { "type": "string", "description": "Razão social", "nullable": true }, "cnpj": { "type": "string", "description": "CNPJ", "nullable": true }, "email": { "type": "string", "description": "E-mail", "nullable": true } }, "additionalProperties": false }, "PessoaJuridicaInteressadaApiEntry": { "type": "object", "properties": { "razaoSocial": { "type": "string", "description": "Razão social do interessado", "nullable": true }, "cnpj": { "type": "string", "description": "CNPJ do interessado", "nullable": true }, "email": { "type": "string", "description": "E-mail do interessado", "nullable": true } }, "additionalProperties": false, "description": "Dados para pessoa jurídica interessada em processo" }, "PlanoClassificacao": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do plano", "format": "uuid" }, "codigo": { "type": "string", "description": "Código do plano", "nullable": true }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "classes": { "type": "array", "items": { "$ref": "#/components/schemas/Classe" }, "description": "Lista de classes associadas a esse plano", "nullable": true } }, "additionalProperties": false }, "Processo": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do processo", "format": "uuid", "readOnly": true }, "ano": { "type": "string", "description": "Ano", "nullable": true, "readOnly": true }, "protocolo": { "type": "string", "description": "Protocolo", "nullable": true, "readOnly": true }, "resumo": { "type": "string", "description": "Resumo ou título do processo", "nullable": true, "readOnly": true }, "situacao": { "$ref": "#/components/schemas/ProcessoSituacaoApi" } }, "additionalProperties": false }, "ProcessoApiFilter": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de processos", "nullable": true }, "protocolos": { "type": "array", "items": { "type": "string" }, "description": "Lista de protocolos de processos", "nullable": true }, "idsLocaisAtuais": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de locais de custódia atual do processo", "nullable": true }, "idsOrganizacoesAtuais": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de organizações que se encontram na custódia do processo", "nullable": true }, "idsLocaisAutuacao": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de locais que autuaram o processo", "nullable": true }, "idsOrganizacoesAutuacao": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de organizações onde foi autuado o processo", "nullable": true }, "idSistemaAutuacao": { "type": "string", "description": "Id do sistema onde foi autuado o processo", "format": "uuid", "nullable": true }, "idsLocaisTramitacao": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de locais por onde o processo foi tramitado", "nullable": true }, "idsAutuadoPor": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de papéis de servidores que autuaram o processo", "nullable": true }, "idsTramitadoPor": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de responsáveis pela tramitação do processo", "nullable": true }, "idsInteressados": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids de interessados pelo processo", "nullable": true }, "idClasse": { "type": "string", "description": "Lista de ids de classe do processo", "format": "uuid", "nullable": true }, "autuacaoDataInicio": { "type": "string", "description": "Menor data de autuação do processo", "format": "date-time", "nullable": true }, "autuacaoDataFim": { "type": "string", "description": "Maior data de autuação do processo", "format": "date-time", "nullable": true }, "tramiteDataInicio": { "type": "string", "description": "Menor data de tramitação do processo", "format": "date-time", "nullable": true }, "tramiteDataFim": { "type": "string", "description": "Maior data de tramitação do processo", "format": "date-time", "nullable": true }, "ultimoAto": { "type": "array", "items": { "$ref": "#/components/schemas/AtoTipoApi" }, "description": "Lista de tipos de último ato do processo", "nullable": true }, "somenteEmAndamento": { "type": "boolean", "description": "Pesquisar somente processos em andamento" }, "somenteEncerrados": { "type": "boolean", "description": "Pesquisar somente processos encerrados" }, "pagina": { "type": "integer", "description": "Página atual da paginação", "format": "int32" }, "tamanhoPagina": { "type": "integer", "description": "Quantos registros por página", "format": "int32" } }, "additionalProperties": false, "description": "Filtros de busca de processos" }, "ProcessoResultSearch": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/Processo" }, "description": "Resultado de busca", "nullable": true }, "count": { "type": "integer", "description": "Quantidade de resultados", "format": "int32" } }, "additionalProperties": false, "description": "Retorno de busca com paginação" }, "ProcessoSituacaoApi": { "enum": [ "EmAndamento", "Encerrado", "Sobrestado" ], "type": "string", "description": "Situação de Processo (EmAndamento = 1, Encerrado = 2, Sobrestado = 3)" }, "ReaberturaApiEntry": { "type": "object", "properties": { "justificativa": { "type": "string", "description": "Justificativa para o ato", "nullable": true }, "restricaoAcesso": { "$ref": "#/components/schemas/RestricaoAcessoApiEntry" }, "idProcesso": { "type": "string", "description": "Id do processo para o ato", "format": "uuid" }, "idPapelResponsavel": { "type": "string", "description": "Id do papel de servidor que irá realizar o ato - o papel deve ter permissão de executar o ato", "format": "uuid" } }, "additionalProperties": false, "description": "Dados para reabertura de processo encerrado" }, "RelatorioDocumentosClassificados": { "type": "object", "properties": { "idClasseDocumento": { "type": "string", "description": "Id da Classificação Documental", "format": "uuid", "nullable": true }, "codigoClasseDocumento": { "type": "string", "description": "Código da Classificação Documental", "nullable": true }, "nomeClasseDocumento": { "type": "string", "description": "Nome da Classificação Documental", "nullable": true }, "dataClassificacao": { "type": "string", "description": "Data da classificação", "format": "date-time" }, "dataPrazoClassificacao": { "type": "string", "description": "Prazo da classificação (atualizada por reclassificação)", "format": "date-time" }, "fundamentoLegal": { "type": "string", "nullable": true }, "idDocumento": { "type": "string", "description": "Identificador do documento capturado", "format": "uuid" }, "registroDocumento": { "type": "string", "description": "Registro do documento capturado", "nullable": true }, "nomeDocumento": { "type": "string", "description": "Nome", "nullable": true }, "generoDocumento": { "$ref": "#/components/schemas/GeneroDocumentoApi" }, "idOrgao": { "type": "string", "description": "Id do Órgão do executor da classificação", "format": "uuid", "nullable": true }, "nomeOrgao": { "type": "string", "description": "Id do Órgão do executor da classificação", "nullable": true }, "siglaOrgao": { "type": "string", "description": "Id do Órgão do executor da classificação", "nullable": true }, "dataCapturaDocumento": { "type": "string", "description": "Data da captura do documento", "format": "date-time" }, "nivelAcessoClassificacao": { "$ref": "#/components/schemas/NivelAcessoTipoApi" }, "tipoEventoClassificacao": { "$ref": "#/components/schemas/TipoEventoClassificacaoApi" } }, "additionalProperties": false, "description": "Relatório com todos os documentos classificados e reclassificados que não foram desclassificados da base do E-Docs" }, "RelatorioDocumentosDesclassificados": { "type": "object", "properties": { "nivelAcessoDesclassificacao": { "$ref": "#/components/schemas/NivelAcessoTipoApi" }, "dataDesclassificacao": { "type": "string", "description": "Data da desclassificação", "format": "date-time" }, "dataClassificacao": { "type": "string", "description": "Data da Classificação", "format": "date-time" }, "idDocumento": { "type": "string", "description": "Identificador do documento capturado", "format": "uuid" }, "registroDocumento": { "type": "string", "description": "Registro do documento capturado", "nullable": true }, "nomeDocumento": { "type": "string", "description": "Nome", "nullable": true }, "generoDocumento": { "$ref": "#/components/schemas/GeneroDocumentoApi" }, "idOrgao": { "type": "string", "description": "Id do Órgão do executor da classificação", "format": "uuid", "nullable": true }, "nomeOrgao": { "type": "string", "description": "Id do Órgão do executor da classificação", "nullable": true }, "siglaOrgao": { "type": "string", "description": "Id do Órgão do executor da classificação", "nullable": true }, "dataCapturaDocumento": { "type": "string", "description": "Data da captura do documento", "format": "date-time" }, "nivelAcessoClassificacao": { "$ref": "#/components/schemas/NivelAcessoTipoApi" }, "tipoEventoClassificacao": { "$ref": "#/components/schemas/TipoEventoClassificacaoApi" } }, "additionalProperties": false, "description": "Relatório com todos os documentos classificados que sofreram desclassificação da base do E-Docs" }, "RelatorioQuantitativosDocumento": { "type": "object", "properties": { "idPatriarca": { "type": "string", "format": "uuid" }, "nomePatriarca": { "type": "string", "nullable": true }, "totalDocumentos": { "type": "integer", "format": "int32" }, "totalPaginas": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RelatorioQuantitativosDocumentoPorOrgao": { "type": "object", "properties": { "idPatriarca": { "type": "string", "format": "uuid" }, "idOrganizacao": { "type": "string", "format": "uuid" }, "nomeOrganizacao": { "type": "string", "nullable": true }, "totalDocumentos": { "type": "integer", "format": "int32" }, "totalPaginas": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RelatorioQuantitativosProcesso": { "type": "object", "properties": { "idPatriarca": { "type": "string", "format": "uuid" }, "nomePatriarca": { "type": "string", "nullable": true }, "totalProcessos": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RelatorioQuantitativosProcessoPorOrgao": { "type": "object", "properties": { "idPatriarca": { "type": "string", "format": "uuid" }, "idOrganizacao": { "type": "string", "format": "uuid" }, "nomeOrganizacao": { "type": "string", "nullable": true }, "totalProcessos": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RestricaoAcessoApiEntry": { "type": "object", "properties": { "transparenciaAtiva": { "type": "boolean", "description": "Transparência Ativa - se positivo será público, se negativo sem fundamentos legais e classificação da informação será organizacional" }, "idsFundamentosLegais": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Lista de ids dos fundamentos legais aplicáveis", "nullable": true }, "classificacaoInformacao": { "$ref": "#/components/schemas/ClassificacaoInformacaoApiEntry" } }, "additionalProperties": false, "description": "Dados para restrição de acesso de documento" }, "RestringirAcessoEmLoteApiEntry": { "type": "object", "properties": { "idResponsavel": { "type": "string", "format": "uuid" }, "idDocumento": { "type": "string", "format": "uuid" }, "gic": { "$ref": "#/components/schemas/GestaoInformacaoClassificada" } }, "additionalProperties": false }, "Setor": { "type": "object", "properties": { "organizacao": { "$ref": "#/components/schemas/Organizacao" }, "sigla": { "type": "string", "description": "Sigla", "nullable": true, "readOnly": true }, "id": { "type": "string", "description": "Identificador do papel", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipoAgente": { "type": "integer", "description": "Tipo do agente (código numérico)", "format": "int32" }, "descricaoTipoAgente": { "$ref": "#/components/schemas/AgenteTipoApi" }, "sistema": { "$ref": "#/components/schemas/Sistema" } }, "additionalProperties": false, "description": "Dados do setor" }, "Sinalizacao": { "type": "object", "properties": { "identificadorExterno": { "type": "string", "description": "Identificador da sinalização", "format": "uuid" }, "nome": { "type": "string", "description": "Nome da sinalização", "nullable": true }, "descricao": { "type": "string", "description": "Descrição da sinalização", "nullable": true }, "corTexto": { "type": "integer", "description": "Cor do texto da sinalização", "format": "int32" }, "corFundo": { "type": "integer", "description": "Cor do fundo da sinalização", "format": "int32" }, "prioridade": { "type": "integer", "description": "Prioridade da sinalização", "format": "int32" } }, "additionalProperties": false, "description": "Sinalização de processos" }, "Sistema": { "type": "object", "properties": { "id": { "type": "string", "description": "Identificador do papel", "format": "uuid" }, "nome": { "type": "string", "description": "Nome", "nullable": true }, "tipoAgente": { "type": "integer", "description": "Tipo do agente (código numérico)", "format": "int32" }, "descricaoTipoAgente": { "$ref": "#/components/schemas/AgenteTipoApi" }, "sistema": { "$ref": "#/components/schemas/Sistema" } }, "additionalProperties": false, "description": "Dados de sistema" }, "TipoEventoClassificacaoApi": { "enum": [ 4, 5, 6 ], "type": "integer", "description": "Tipo do evento de classificação (Classificacao = 4, Reclassificacao = 5, Desclassificacao = 6)", "format": "int32" }, "WebApiResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Copie 'Bearer ' + JWT válido no campo", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }