Consultar processos
O objetivo dessa API é realizar a consulta de processos no sistema a partir de um requisição do tipo REST.
POST: https://webservices.vianuvem.com.br/AdminVianuvem/api/process/search
Headers
| Nome | Tipo | Descrição |
| Content-Type* | String | application/json |
| Authorization* | String | Token de acesso adquirido através da API "Get JWT" (bearer) |
Request Body
| Nome | Tipo | Descrição |
| documentId | Array de integer | Este parâmetro está em desuso no Holmes Auto e pode ser enviado vazio |
| establishmentIds | Array de integer | IDs dos estabelecimentos para filtrar a consulta |
| processTypeIds | Array de integer | Códigos dos tipos de processos que deseja consultar |
| initialDate | String | Filtro de data inicial. Formato esperado: "DD/MM/AAAA HH:MM:SS" (Ex: "03/11/2021 10:37:28") |
| finalDate | String | Filtro de data final. Formato esperado: "DD/MM/AAAA HH:MM:SS" |
| searchFor | String | Termo para busca geral, equivalente à pesquisa global do sistema Holmes Auto |
| like | Boolean | Define se a busca no "searchFor" deve utilizar o operador LIKE (parcial) ou não |
Respostas de Sucesso
200: OK
Requisição realizada com sucesso.
JSON
{
"hits": 1,
"time": 18,
"processes": [
{
"processId": 58089890,
"createDate": "03/11/2021 10:37:28",
"idEstablishment": 50102182,
"flagReserved": "N",
"reservedUserId": null,
"reservedInitDate": null,
"nameProcessType": "PROCESSO BPM ABERTO VIA INTEGRAÇÃO",
"idProcessStage": 1960390,
"idProcessType": 50029957,
"idSituation": 51202584,
"nameSituation": "TAREFA DA PRIMEIRA TRANSIÇÃO",
"listSituation": [],
"typeSituation": null,
"idCustomer": 6921,
"flagDocumentsRequired": "S",
"missingDocuments": [],
"nameEstablishment": "INTEGRAÇÕES",
"flagUseNotification": null,
"slaTime": 0,
"slaType": null,
"indexerVO": [
{
"indexerNumber": 1,
"indexerType": "I",
"indexerLabel": "INTEIRO",
"indexerValue": "666",
"indexerDetails": [],
"indexerFieldName": "INTEIRO",
"alert": null,
"id": 82073974,
"parentId": null,
"form": false,
"stageId": null,
"uniqueId": null
},
{
"indexerNumber": 2,
"indexerType": "S",
"indexerLabel": "TEXTO",
"indexerValue": "NOME DO FULANO",
"indexerDetails": [],
"indexerFieldName": "TEXTO",
"alert": null,
"id": 82073975,
"parentId": null,
"form": false,
"stageId": null,
"uniqueId": null
},
{
"indexerNumber": 3,
"indexerType": "D",
"indexerLabel": "DATA",
"indexerValue": "07/12/2021",
"indexerDetails": [],
"indexerFieldName": "DATA",
"alert": null,
"id": 82073976,
"parentId": null,
"form": false,
"stageId": null,
"uniqueId": null
},
{
"indexerNumber": 4,
"indexerType": "V",
"indexerLabel": "VALOR",
"indexerValue": "1.000,00",
"indexerDetails": [],
"indexerFieldName": "VALOR",
"alert": null,
"id": 82073977,
"parentId": null,
"form": false,
"stageId": null,
"uniqueId": null
}
],
"documentVO": [],
"reservedUserName": null,
"indSelfCapture": 0,
"indNotifySelfCapture": 0,
"checklist": [],
"ownerName": "INTEGRACAO",
"lastSituationProgressDate": "03/11/2021 10:37:28",
"workflow": true,
"transitionsTree": [
{
"text": "ALTERAÇÃO DE SITUAÇÃO",
"stageId": 1960384,
"stageType": "connector",
"transition": null,
"roles": [
{
"roleId": 50029246,
"name": "PERFIL DE USUÁRIO DE INTEGRAÇÃO"
}
],
"next": [
{
"text": "PRIMEIRA SITUAÇÃO",
"stageId": 1960388,
"stageType": "task",
"transition": "TRANSIÇÃO PRIMEIRA SITUAÇÃO",
"roles": [
{
"roleId": 50029246,
"name": "PERFIL DE USUÁRIO DE INTEGRAÇÃO"
}
],
"next": [],
"transtionId": 2406283,
"actionName": []
},
{
"text": "SEGUNDA SITUAÇÃO",
"stageId": 1960389,
"stageType": "task",
"transition": "TRANSIÇÃO SEGUNDA SITUAÇÃO",
"roles": [
{
"roleId": 50029246,
"name": "PERFIL DE USUÁRIO DE INTEGRAÇÃO"
}
],
"next": [],
"transtionId": 2406284,
"actionName": []
}
],
"transtionId": 2406290,
"actionName": []
}
],
"swimlaneRoleName": "PERFIL DE USUÁRIO DE INTEGRAÇÃO",
"breadCrumbs": [],
"finalSituation": false,
"reservedToMe": false,
"processEventNameInCurrentTransition": [],
"processEstablishmentBreadCrumb": [
"INTEGRAÇÕES"
],
"processOwnerBreadCrumb": [
"INTEGRACAO"
],
"relatedDocuments": [],
"processDelay": null,
"childProcessIds": [],
"waitingChildProcessIds": [],
"parentProcessId": null
}
],
"filters": [
{
"name": "process_progress_checklist_concat",
"values": {}
},
{
"name": "process_situation",
"values": {
"TAREFA DA PRIMEIRA TRANSIÇÃO": 1
}
},
{
"name": "indexers_labels",
"values": {
"INTEIRO": 1,
"TEXTO": 1,
"DATA": 1,
"VALOR": 1
}
},
{
"name": "user_name",
"values": {
"INTEGRACAO": 1
}
},
{
"name": "check_label_prev_text",
"values": {}
},
{
"name": "check_label_prev",
"values": {}
},
{
"name": "check_label_next_text",
"values": {}
},
{
"name": "indexers_labels_types_names",
"values": {
"VALOR|V|null": 1,
"INTEIRO|I|null": 1,
"TEXTO|S|null": 1,
"DATA|D|null": 1
}
},
{
"name": "establishment",
"values": {
"INTEGRAÇÕES": 1
}
},
{
"name": "process_type",
"values": {
"PROCESSO BPM ABERTO VIA INTEGRAÇÃO": 1
}
},
{
"name": "situation",
"values": {}
},
{
"name": "establishment_group",
"values": {
"INTEGRAÇÕES": 1
}
},
{
"name": "document_type",
"values": {
"": 1
}
}
]
}
500: Internal Server Error
Erro de autenticação ou erro interno do servidor.
HTML
<html>
<head>
<title>Error</title>
</head>
<body>Internal Server Error</body>
</html>Exemplo de Requisição
JSON
{
"documentId": [],
"establishmentIds": [],
"processTypeIds": [],
"documentTypeIds": [],
"initialDate": "03/11/2021 10:37:28",
"finalDate": "",
"searchFor": "NOME DO FULANO",
"like": false
}