Diploma
Classe que controla os Diplomas
| API | Descrição |
|---|---|
| GET neutronapi/diploma/diplomaGetAsync/{idDiploma} |
Método para recuperar os Dados do Diplomado |
| POST neutronapi/diploma/diplomaPostAsync |
Método para recuperar os Dados do Diplomado |
Autenticado
Métodos relacionados ao usuário logado na API. Os códigos de erro desta categoria vão do 0001 ao 0099.
| API | Descrição |
|---|---|
| GET neutronapi/usuario/getnome |
Recupera o nome do usuário logado. |
| GET neutronapi/usuario/getdetalhesusuario |
Recupera informações detalhadas do usuário logado. |
| GET neutronapi/usuario/getassinaturabase64 |
Recupera a assinatura do usuário codificada em Base64. |
| GET neutronapi/usuario/getassinatura |
Recupera o arquivo de assinatura. |
| GET neutronapi/usuario/getcertificado |
Recupera o arquivo do certificado. |
| POST neutronapi/usuario/postcertificado |
Salva o certificado do usuário logado na API. |
| POST neutronapi/usuario/postassinatura |
Salva a assinatura do usuário logado na API. |
| GET neutronapi/usuario/getlogout |
Encerra a sessão do usuário logado. |
| POST neutronapi/usuario/postalterardados |
Alterar os dados do usuário logado. |
| GET neutronapi/usuario/listaPerfilFuncionalidadeGetAsync/{aplicacao} |
Recupera lista de Perfil de Funcionalidades |
Organizacao
Métodos relacionados a organização. Os códigos de erro desta categoria vão do 0500 ao 0599.
| API | Descrição |
|---|---|
| POST neutronapi/organizacao/postconfiguracao |
Insere uma nova configuração. |
| PUT neutronapi/organizacao/putconfiguracao |
Altera uma configuração. |
| GET neutronapi/organizacao/getconfiguracoes |
Recupera as configurações do usuário logado. |
| DELETE neutronapi/organizacao/deleteconfiguracao/{idconf} |
Exclui uma configuração. |
Dossie
| API | Descrição |
|---|---|
| GET neutronapi/dossie/{idDossie}/getcamposagrupador |
Recupera a lista de Campos Agrupador do Dossie |
| GET neutronapi/dossie/GetDossiePorUsuario |
Recupera os dossies por Usuario que está logado no sistema |
| GET neutronapi/dossie/GetItemDossieID/{idDossie} |
Recupera os dossies por Usuario que está logado no sistema |
| GET neutronapi/dossie/GetDossieDocs/{idDossie} |
Recupera os documentos do dossie |
| POST neutronapi/dossie/{idDossie}/postDossie | |
| POST neutronapi/dossie/postarquivos/{idItemDossie} |
Salva o(s) arquivo(s) como um novo documento no repositório. Utilize a codificação "multipart/form-data" para enviar os dados. Envie um conjunto de pares chave/valor com content type corretamente identificado. Use keys do tipo "Text" para os dados de indexação. Use keys do tipo "File" para enviar os arquivos. |
| PUT neutronapi/dossie/PutItemDossie/{idItemDossie} |
Atualizar item de Dossie |
| PUT neutronapi/dossie/PutItemDossieDoc/{IdItemDoc} |
Atualizar o Id do Documento na tabela de Dossie Item Doc |
| PUT neutronapi/dossie/PutDossieItemDocDelete |
Atualizar o Id do Documento na tabela de Dossie Item Doc |
| PUT neutronapi/dossie/FinalizaItemDossie |
Finaliza o Dossie |
| DELETE neutronapi/dossie/DeleteItemDossie |
Deleta Item de Dossie por id do item |
Assinatura
Classe referente aos metodos de Assinatura
| API | Descrição |
|---|---|
| GET neutronapi/assinatura/listaassinaturasGetAsync |
Recupera lista de Assinaturas |
| GET neutronapi/assinatura/assinaturaCampoGetAsync/{idassinatura} |
Recupera os Campos que a Assinatura vai utilizar |
| POST neutronapi/assinatura/postwebhookbry |
End point para receber os dados do WeebHook da Bry |
| POST neutronapi/Assinatura?idDocPortal={idDocPortal}&idPortalSync={idPortalSync} |
Baixa o arquivo assinado e o protocolo |
Repositorio
Métodos relacionados aos repositórios. Os codigos de erro desta categoria estão entre 0300 e 0399.
| API | Descrição |
|---|---|
| GET neutronapi/getrepositorios |
Recupera a lista de repositórios que o usuário tem permissão. |
| GET neutronapi/repositorio/{idrepositorio}/getjanelaspesquisa |
Retorna uma lista com as janelas de pesquisa pelo id do repositório. |
| GET neutronapi/repositorios/getjanelaspesquisa |
Retorna uma lista com as janelas de pesquisa pelo id do repositório. |
| GET neutronapi/repositorio/{idrepositorio}/getlistasselecao |
Busca as listas de seleção do Repositório. |
| GET neutronapi/repositorio/{idrepositorio}/getjanelasarmazenamento |
Retorna uma lista com as janelas de armazenagem pelo id do repositório. |
| GET neutronapi/repositorio/getjanelasarmazenamento |
Retorna uma lista com as janelas de armazenagem pelo id do repositório. |
| GET neutronapi/repositorios/getlotes |
Lista os lotes da web que o usuário possui permissão. |
| GET neutronapi/repositorios/{idrepositorio}/getlotesRepositorio |
Lista os lotes da web que o usuário possui permissão. /// ID do repositório. |
| GET neutronapi/repositorios/{idRepositorioOrigem}/getrelacaodocumentos |
Lista a relaçaõ de documentos que o usuário possui permissão no repositório. |
| POST neutronapi/repositorio/postarquivosV2 |
V2 Salva o(s) arquivo(s) como um novo documento no repositório. Utilize a codificação "multipart/form-data" para enviar os dados. Envie um conjunto de pares chave/valor com content type corretamente identificado. Use keys do tipo "Text" para os dados de indexação. Use keys do tipo "File" para enviar os arquivos. |
| POST neutronapi/repositorio/postarquivos |
Salva o(s) arquivo(s) como um novo documento no repositório. Utilize a codificação "multipart/form-data" para enviar os dados. Envie um conjunto de pares chave/valor com content type corretamente identificado. Use keys do tipo "Text" para os dados de indexação. Use keys do tipo "File" para enviar os arquivos. |
| POST neutronapi/repositorio/postarquivoslote |
Salva o(s) arquivo(s) como um novo documento no lote. Utilize a codificação "multipart/form-data" para enviar os dados. Envie um conjunto de pares chave/valor com content type corretamente identificado. Use keys do tipo "Text" para os dados de indexação. Use keys do tipo "File" para enviar os arquivos. |
| POST neutronapi/repositorio/postnovaversao |
Método para criar o Versionamento do documento |
Dashboard
Classe que controla os Dashboards Os códigos de erro desta categoria estão entre 0700 e 0799
| API | Descrição |
|---|---|
| GET neutronapi/dashboard/dashboardGetAsync |
Método para recuperar |
| POST neutronapi/dashboard/dashboardPostAsync/{idDashboard} |
Nenhuma documentação disponível. |
Documento
Métodos relacionados aos documentos. Os códigos de erro desta categoria estão entre 0100 e 0199.
| API | Descrição |
|---|---|
| POST neutronapi/postdocumentosComPaginacao?pageNumber={pageNumber}&pageSize={pageSize} |
Recebe uma janela com os campos preenchidos. Preencha no mínimo o ID da janela. Para os campos preencha no mínimo: Nome, ValorInicial e TipoCampo. |
| POST neutronapi/postdocumentos |
Recebe uma janela com os campos preenchidos. Preencha no mínimo o ID da janela. Para os campos preencha no mínimo: Nome, ValorInicial e TipoCampo. Para janela do tipo Tarefa preencha o Filtro. |
| GET neutronapi/getdocumentosversionados/{idJanela}/{idOriginal} |
Recebe uma janela com os campos preenchidos. Preencha no mínimo o ID da janela. Para os campos preencha no mínimo: Nome, ValorInicial e TipoCampo. Para janela do tipo Tarefa preencha o Filtro. |
| POST neutronapi/postdocumentosrelacao/{iddoc}/{idrelacao} |
Cria um link de para o URL intergation com o código da relação. |
| POST neutronapi/postdocumentosrelacaourl/{iddoc}/{idrelacao} | |
| PUT neutronapi/documento/{iddocumento}/{idpagina}/putarquivo?idrepositorio={idrepositorio} |
Altera o arquivo de uma página armazenada. Envie o arquivo no corpo da requisição. |
| PUT neutronapi/documento/{idrepositorio}/putgrampear |
A função Grampear junta vários documentos em um. |
| PUT neutronapi/documento/{idrepositorio}/{iddoc}/putanexar |
Anexa arquivos ao documento armazenado. Utilize a codificação "multipart/form-data" para enviar os dados. Envie um conjunto de pares chave/valor com content type corretamente identificado. Use keys do tipo "File" para enviar os arquivos. |
| GET neutronapi/documento/{iddoc}/{idjanela}/getinfodocumento |
Recupera as informações de indexação do documento pelo seu ID. |
| GET neutronapi/documento/{iddoc}/{idjanela}/getinfodocumentoAcao |
Recupera as informações de indexação do documento pelo seu ID. |
| GET neutronapi/documento/{iddoc}/{idrepositorio}/getdocumentohistorico |
Recupera o histórico de operações do documento. |
| GET neutronapi/documento/{doclink}/getdoclink |
Recupera os dados do documento compartilhado. |
| POST neutronapi/documentos/postdocumentospdflink |
Cria uma tarefa para criar o arquivo PDF. Após a criação do PDF será gerado o |
| GET neutronapi/documento/{iddoc}/{pagina}/getoriginal?idrepositorio={idrepositorio} |
Recupera o arquivo original pelo código do documento. |
| GET neutronapi/documento/{iddoc}/{pagina}/{extensao}/getcheckpagina?idrepositorio={idrepositorio} |
Verifica se o arquivo original existe no servidor pelo código do documento. |
| POST neutronapi/documentos/postdocumentospdf |
Cria um PDF com todos os documentos. |
| POST neutronapi/documentos/postdocumentospdfs |
Cria um PDF para cada documento. Varios documentos serão adicionados a um arquivo ZIP, caso contrário retorna o PDF direto. |
| POST neutronapi/documentos/postdocumentosoriginais |
Cria um ZIP com todos os documentos. |
| GET neutronapi/documento/{iddoc}/{pagina}/pdf?idrepositorio={idrepositorio} |
Recupera o arquivo convertido para PDF. Se o arquivo original for PDF ele será enviado diretamente sem conversão. |
| GET neutronapi/documento/{iddoc}/{pagina}/getweb?idrepositorio={idrepositorio} |
Recupera o arquivo convertido para visualização na WEB. Os formatos compatíveis são: PDF; DOCX, XLSX, PPTX; JPG, PNG Todos os outros formatos serão automaticamente convertidos para PDF. |
| GET neutronapi/documento/{iddoc}/getdocumentopdf?idrepositorio={idrepositorio} |
Recupera um arquivo PDF com todas as páginas do Documento. |
| GET neutronapi/documento/{iddoc}/getdocumentooriginal?idrepositorio={idrepositorio} |
Recupera um arquivo ZIP com todas as páginas do Documento. |
| PUT neutronapi/documentos/puteditarcampos |
Altera os dados de indexação do documento. |
| PUT neutronapi/documentos/puteditaindicesdocumento |
Altera os dados de indexação de um ou mais documentos. |
| PUT neutronapi/documentos/restauradocumentos |
Exclui um ou mais documentos pelo IDDOC. |
| DELETE neutronapi/documentos/deletedocumentos |
Exclui um ou mais documentos pelo IDDOC. |
| GET neutronapi/documento/{iddoc}/{pagina}/getanotacao?idrepositorio={idrepositorio} |
Recupera as anotações da página. |
| POST neutronapi/documento/postanotacao |
Salva os dados de anotação da página. |
| GET neutronapi/documento/{iddoc}/getminiatura?idrepositorio={idrepositorio} |
Recupera uma miniatura no formado PDF com as dimensões 40x40. |
| PUT neutronapi/documento/{idLote}/putdesgrampear |
A função Grampear junta vários documentos em um. |
| PUT neutronapi/documentos/{idRepositorio}/{idDocumento}/puttornacorrente | |
| POST neutronapi/Documento?diretorioDel={diretorioDel} |
Exclui um diretório junto com todos os seus arquivos. |
| POST neutronapi/Documento?idJanelaArmazenagem={idJanelaArmazenagem}&pagina={pagina}&idLote={idLote} |
Salva o(s) arquivo(s) como um novo documento no lote. Utilize a codificação "multipart/form-data" para enviar os dados. Envie um conjunto de pares chave/valor com content type corretamente identificado. Use keys do tipo "Text" para os dados de indexação. Use keys do tipo "File" para enviar os arquivos. |
Formularios
Métodos relacionados aos processos. Os códigos de erro desta categoria estão entre 0600 e 0699.
| API | Descrição |
|---|---|
| GET neutronapi/formulario/formularioGetAsync/{idFormulario} |
Recuperar formulario por id |
| GET neutronapi/formulario/listaformulariosGetAsync |
Recupera lista de Formularios |
| GET neutronapi/formulario/listaformulariosProcessoGetAsync/{idProcesso} |
Recupera lista de Formularios Processo |
| POST neutronapi/formulario/formularioPostAsync/{idFormulario} |
Salva o(s) formulário(s) como um novo documento no repositório. |
| POST neutronapi/formulario/formularioExternoPost |
Salva o(s) formulário(s) como um novo documento no repositório. Utilize a codificação "multipart/form-data" para enviar os dados. Envie um conjunto de pares chave/valor com content type corretamente identificado. Use keys do tipo "Text" para os dados de indexação. Use keys do tipo "File" para enviar os arquivos. As chaves a seguir são de preenchimento obrigatório USUARIO, SENHA, ORGANIZACAO, IDJANELA e IDFORMULARIO |
Processo
Métodos relacionados aos processos. Os códigos de erro desta categoria estão entre 0200 e 0299.
| API | Descrição |
|---|---|
| GET neutronapi/processos/getprocessos |
Retorna uma lista de processos. |
| GET neutronapi/processos/{idprocesso}/gettarefas |
Retorna uma lista de tarefas de um processo pelo seu ID. |
| POST neutronapi/processos/postdocumentos |
Retorna uma lista de documentos de uma janela de tarefa. |
| GET neutronapi/processos/{idjanelatarefa}/getacoes |
Recupera uma lista de ações da janela pelo id. |
| PUT neutronapi/processos/{iddoc}/{idacao}/putexecutaacao |
Executa a ação no documento. |
| GET neutronapi/processos/{idprocesso}/getjanelaarmazenagem |
Recupera a janela de armazenagem vinculada ao processo. |
| GET neutronapi/processo/{idjanela}/getlistasignatarios |
Retorna uma lista com os possiveis signatarios. |
| GET neutronapi/processos/{idjanela}/getstatusassinatura |
Verifica o status do documento enviado para o portal Certificador. |
| GET neutronapi/processos/{iddoc}/{idjanela}/getcancelaassinatura |
Cancela o documento enviado para o Portal Certificador |
Janela
Métodos relacionados as janelas. Os códigos de erro desta categoria estão entre 0400 e 0499.
| API | Descrição |
|---|---|
| GET neutronapi/janela/{idjanela}/getcampos |
Recupera os campos da janela. |
| POST neutronapi/janela/posturlintegracao |
Recupera uma URI de acesso a lista de documentos. Ex. https://subdominio.softwareneutron.com.br/urlintegration/link?url=MkFBUTErO... |
| GET neutronapi/janela/{idjanela}/getdetalhesjanela |
Recupera as informações detalhadas da janela. |
| GET neutronapi/janela/{idjanela}/{idcampo}/getproximovalorsequencia |
Recupera o próximo valor de uma sequência e soma um no próximo valor. |