Todas as coleções
API's - Integrações
API - Métodos de documentos
API - Métodos de documentos
Atualizado há mais de uma semana

Para inserir ou editar um arquivo binário é necessário codificá-lo em Base64.

Limitações:

  1. O campo nomeArquivo é limitado em 120 caracteres.

  2. O campo nomeArquivoOrigem é limitado em 99 caracteres.

  3. Caracteres especiais ou espaços não são aceitos.

  4. Os campos de id devem enviar obrigatoriamente números inteiros.


Inserir documento

Path: /api/documentos/novo/json
Método: POST

Inserir documento base64. JSON enviado (exemplo):

{ 
"nomeArquivo":"teste",
"descricao":"descricao teste",
"numero":"612",
"tipo":{
"id":4
},
"dominio":{
"id":1
},
"nomeArquivoOrigem":"teste.txt",
"formato":0,
"despesa":{
"id":140
},
"processo":{
"id":26
},
"desdobramento":{
"id":158
},
"arquivo":"ARQUIVO EM BYTES BASE64*"
}


Editar documento

Path: /api/documentos/edita/json
Método: POST

Editar documento. JSON enviado (exemplo):

{ 
"id":"8",
"nomeArquivo":"teste",
"descricao":"descricao teste",
"numero":"612",
"tipo":{
"id":4
},
"dominio":{
"id":1
},
"nomeArquivoOrigem":"teste.txt",
"formato":0,
"desdobramento":{
"id":158
},
"arquivo":"ARQUIVO EM BYTES BASE64*"
}


Listar documentos de um processo

Path: /api/documentos/processo/{idProcesso}/json
Método: GET

Lista todos os documentos de um processo específico. JSON retornado (exemplo):

[
{
"id": 511,
"nomeArquivo": "sdfsdf",
"nomeArquivoOrigem": "438-xtgjp.gif",
"descricao": "sdfsdfsfd",
"numero": "123",
"tamanho": "0,03MB",
"dataCadastro": "30/06/2017",
"data": "08/06/2017",
"tipo": {
"id": 13,
"nome": "pbcylxghbmmcdljtuhgfwrggqqoaatlmrrsrtwcvwbpfydtvkp"
},
"resumoProcesso": "01 - Ambiental - Abilio Soares - A Verificar3 x Andréia Mezenga - 1234.5678.987.91983",
"idDesdobramento": 15693,
"idAdvogado": 2,
"nomeAdvogado": "Anita Coimbra do Nascimento"
},
{
"id": 512,
"nomeArquivo": "fdfdhgddf",
"nomeArquivoOrigem": "450-jyedb.gif",
"descricao": "dgfjghkjhjhkjhgk",
"numero": "123456789",
"tamanho": "0,03MB",
"dataCadastro": "30/06/2017",
"data": "28/06/2017",
"tipo": {
"id": 15,
"nome": "jrdoqlwvkvmibuyavvuzakuewyvprqxiwduejbcywydpkorjjz"
},
"resumoProcesso": "01 - Ambiental - Abilio Soares - A Verificar3 x Andréia Mezenga - 1234.5678.987.91983",
"idDesdobramento": 15693,
"idAdvogado": 3,
"nomeAdvogado": "Gilberto da Silveira"
}
]


Retorna documento específico

Path: /api/documentos/{idDocumento}/json
Método: GET

Retorna as informações de um documento específico. JSON retornado (exemplo):

{
"id": 514,
"nomeArquivo": "sdfgsdf",
"nomeArquivoOrigem": "443-uicjc.gif",
"descricao": "dfgdfg dfgdfg",
"numero": "123456789",
"tamanho": "0,03MB",
"dataCadastro": "30/06/2017",
"data": "07/06/2017",
"tipo": {
"id": 15,
"nome": "jrdoqlwvkvmibuyavvuzakuewyvprqxiwduejbcywydpkorjjz"
},
"resumoProcesso": "01 - Ambiental - Abilio Soares - A Verificar3 x Andréia Mezenga - 1234.5678.987.91983",
"idDesdobramento": 15693,
"idAdvogado": 3,
"nomeAdvogado": "Gilberto da Silveira",
"arquivo": "ARQUVIO BASE64*"
}
Respondeu à sua pergunta?