Pesquisando documentos
URN
/documento/procurar/index
Método:
POST
Headers
{
"Content-Type": "application/json",
"Authorization": "Token XXXXXXXXXXXXXXXX"
}
Body:
{
"modelo": {
"nome": "CONTRATOS CLIENTES"
},
"projeto": {
"nome": "PROJETO TAL"
},
"filtros": [
{
"Tipo Do Documento": "CONTRATO"
},
{
"Número Do Documento": "1232"
}
]
}
Body (Vários modelos):
{
"modelo": [
{
"nome": "CONTRATOS CLIENTES"
},
{
"nome": "CONTRATOS"
}
],
"projeto": {
"nome": "PROJETO TAL"
},
"filtros": [
{
"Tipo Do Documento": "CONTRATO"
},
{
"Número Do Documento": "1232"
}
]
}
Retorno:
Obs: Se um documento possui checklist, a chave arquivos virá dentro da chave checklist.
{
"msg": "Sucesso",
"status": "success",
"erroNum": null,
"data": {
"msg": "Documentos encontrados",
"status": "success",
"erroNum": null,
"data": [
{
"it_documento": 21428082,
"it_protocolo": 47729,
"vc_nome": "CONTRATOS CLIENTES",
"ts_cadastro": "2019-06-17 15:36:45.923399",
"pastas": [
{
"sr_id": 21662935,
"vc_descricao": "Documentos",
"ts_cadastro": "2019-06-17 15:38:22.466969",
"checklist": [],
"arquivos": [
{
"it_arquivo": 54610683,
"vc_nome": "angular.png",
"vc_mime": "image/png",
"it_size": 5156,
"it_documento": 21428082,
"ts_cadastro": "2019-06-17 15:38:22.620874"
},
{
"it_arquivo": 54610691,
"vc_nome": "angular.png",
"vc_mime": "image/png",
"it_size": 5156,
"it_documento": 21428082,
"ts_cadastro": "2019-06-17 17:20:54.97357"
},
{
"it_arquivo": 54610692,
"vc_nome": "angular.png",
"vc_mime": "image/png",
"it_size": 5156,
"it_documento": 21428082,
"ts_cadastro": "2019-06-17 17:21:20.263098"
},
{
"it_arquivo": 54610693,
"vc_nome": "angular.png",
"vc_mime": "image/png",
"it_size": 5156,
"it_documento": 21428082,
"ts_cadastro": "2019-06-17 17:21:29.431113"
},
{
"it_arquivo": 54610694,
"vc_nome": "angular.png",
"vc_mime": "image/png",
"it_size": 5156,
"it_documento": 21428082,
"ts_cadastro": "2019-06-17 17:22:36.976268"
}
]
}
]
}
]
}
}
Retorno para vários modelos:
{
"msg": "Sucesso",
"status": "success",
"erroNum": null,
"data": [
{
"modelo": "MODELO A",
"msg": "Documentos encontrados",
"status": "success",
"erroNum": null,
"data": [
{
"it_documento": 35334374,
"it_projeto": 18,
"it_protocolo": 1772981,
"vc_nome": "MODELO A",
"ts_cadastro": "2021-04-27 14:43:08.000214",
"pastas": []
},
{
"it_documento": 35334375,
"it_projeto": 18,
"it_protocolo": 1772982,
"vc_nome": "MODELO A",
"ts_cadastro": "2021-04-27 14:48:22.905079",
"pastas": []
}
]
},
{
"modelo": "MODELO B",
"msg": "Documentos encontrados",
"status": "success",
"erroNum": null,
"data": [
{
"it_documento": 35334376,
"it_projeto": 18,
"it_protocolo": 1772983,
"vc_nome": "MODELO B",
"ts_cadastro": "2021-04-27 15:18:19.527985",
"pastas": [
{
"sr_id": 33693275,
"vc_descricao": "Pasta",
"ts_cadastro": "2021-04-27 15:27:13.85383",
"checklist": [],
"arquivos": [
{
"it_arquivo": 74652080,
"vc_nome": "FOTO.png",
"vc_mime": "image/jpeg",
"it_size": 57955,
"it_documento": 35334376,
"ts_cadastro": "2021-04-27 15:27:13.886574"
}
]
}
]
}
]
}
]
}
Chave "modelo" (Obrigatório)
Pode conter as informações de apenas um modelo, bem como uma lista de vários modelos.
Único modelo:
{
"modelo": {
"nome": "CONTRATOS CLIENTES"
}
}
Vários modelos:
{
"modelo": [
{
"nome": "CONTRATOS CLIENTES"
},
{
"nome": "CONTRATOS"
}
]
}
O objeto do modelo poderá conter as subchaves "id" ou "nome". Caso as duas subchaves existam no objeto, será utilizada somente a subchave "id".
Exemplo 1:
{
"modelo": {
"nome": "CONTRATOS"
}
}
Exemplo 2:
{
"modelo": {
"id": "999999"
}
}
Chave "filtros" (Opcional)
Esta chave aceita dois padrões diferentes:
- Pode ser um array de objetos, contendo o nome do campo do documento e o valor.
{
"filtros": [
{
"Nome": "João da Silva"
},
{
"Contrato": "123456"
},
{
"Cpf": "123.456.789-12"
}
]
}
- Como também pode ser um único objeto com todos os campos desejados.
{
"filtros": {
"Nome": "João da Silva",
"Contrato": "123456",
"Cpf": "123.456.789-12"
}
}
A busca é realizada com a comparação por igualdade.
Chave "projeto" (Opcional)
Pode conter as subchaves "id" ou "nome". Caso as duas subchaves existam no objeto JSON, será utilizada somente a subchave "id".
Exemplo 1:
{
"projeto": {
"nome": "Contratos"
}
}
Exemplo 2:
{
"projeto": {
"id": "123"
}
}
Chave "retornar_campos" (Opcional)
Para retornar os campos do documento deverá receber "true".
Exemplo:
{
"modelo": {
"nome": "CONTRATO CLIENTES"
},
"projeto":{
"nome": "PROJETO TAL"
},
"retornar_campos": true
}
Retorno:
"campos": [
{
"it_modelo_campo": 123,
"vc_campo_nome": "Nome",
"vc_valor": "José Ricardo"
},
{
"it_modelo_campo": 1234,
"vc_campo_nome": "Intervalo de Datas",
"vc_valor": [
"2023-09-11 00:00:00",
"2023-09-19 00:00:00"
]
},
{
"it_modelo_campo": 12345,
"vc_campo_nome": "Intervalo de Números",
"vc_valor": [
1,
5
]
}
]
Se não tiver valor, o "vc_valor" virá como null.