1 de 7

Processos

Aqui estão documentadas todas as nossas APIs públicas relacionadas aos processos

Iniciar processo BPM

O objetivo dessa API é automatizar o início dos processos no sistema a partir de uma requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/process/create

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "id": 58089890,
    "stageDocumentTypes": [
        {
            "documentTypeId": 70033766,
            "documentTypeName": "DOCUMENTO CAPTURADO VIA INTEGRAÇÃO",
            "icon": null,
            "required": false,
            "sequence": null,
            "slaTime": null,
            "indexers": [],
            "desired": false,
            "attachments": [],
            "devices": null,
            "hasForm": false,
            "exists": false,
            "flagDisabled": false,
            "flagRestrainCapture": false,
            "formPrintTemplate": [],
            "form": false
        }
    ],
    "flagSelfCapture": false
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

// Erro no parâmetro "workflowId"
Tipo de Processo não encontrado para essa conta

// Erro no parâmetro "establishmentCNPJ"
Estabelecimento não encontrado

// Erro no parâmetro "initialTransition"
Esse estagio nao e uma situacao

// Erro no parâmetro "indexers"
Indexador obrigatorio não recebido ou indexador recebido [null] não encontrado na configuração deste tipo de processo []

Exemplo de Requisição:

{
	"workflowId": 5002995,
	"establishmentCNPJ": "73386365000",
	"observation":"",
	"isIntegration":"true",
    	"initialTransition": ["PRIMEIRA TRANSIÇÃO"],
	"indexers":
		[
			{
				"sequence":1,
				"indexerLabel":"INTEIRO",
				"indexerValue":"666",
				"indexerType":"I"
			},
			{
				"sequence":2,
				"indexerLabel":"TEXTO",
				"indexerValue":"NOME DO FULANO",
				"indexerType":"S"
			},
			{
				"sequence":3,
				"indexerLabel":"DATA",
				"indexerValue":"07/12/2021",
				"indexerType":"D"
			},
			{
				"sequence":4,
				"indexerLabel":"VALOR",
				"indexerValue":"1.000,00",
				"indexerType":"V"
			}
		]
}

Importante: Os parâmetros que são passados na requisição podem ser adquiridos através da abertura de um chamado com o nosso suporte: suporte@vianuvem.com.br.

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

Name

Type

Description

Request Body

Name

Type

Description

{
    "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
            }
        }
    ]
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
	"documentId": [],
	"establishmentIds": [],
	"processTypeIds": [],
	"documentTypeIds": [],
	"initialDate": "03/11/2021 10:37:28",
	"finalDate": "",
	"searchFor": "NOME DO FULANO",
	"like": false
}

Inserir documentos em processo

O objetivo dessa API é rinserir documentos em um processo no sistema a partir de um requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/process/document

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "data": [
        58089852
    ],
    "errors": []
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
     "establishment": "73386365000170",
     "indexers": ["666", "NOME DO FULANO"],
     "documentTypeId": "70033766",
     "originalFileName": "jpeg.jpeg",
     "documentAsBase64": "/9j/4AAQSkZJRgABAQAA...
     }

Importante: Os parâmetros que são passados na requisição podem ser adquiridos através do nosso suporte: suporte@vianuvem.com.br.

Mudar situação de processo

O objetivo dessa API é mudar a situação de um processo no sistema a partir de uma requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/process/changeSituation

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "data": [
        58089852
    ],
    "errors": []
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

// Erro na propriedade "indexers"
 Processo nao encontrado, com base nas informacoes de busca enviadas: Indexadores=[666, NOME DO FULAN]

// Erro na propriedade "situationName"
Situacao nao encontrada

Exemplo de Requisição:

{
     "establishment": "73386365000170",
     "indexers": ["666", "NOME DO FULANO"],
     "situationName": "SEGUNDA SITUAÇÃO"
}

Importante: Os parâmetros que são passados na requisição podem ser adquiridos através do nosso suporte: suporte@vianuvem.com.br.

Inserir comentários em processo

O objetivo dessa API é inserir comentários em um processo no sistema a partir de uma requisição do tipo REST

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/process/comments

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "data": [
        58089852
    ],
    "errors": []
}

// Erro na propriedade "indexers"
Processo nao encontrado, com base nas informacoes de busca enviadas: Indexadores=[666, NOME DO FULAN]

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
     "establishment": "73386365000170",
     "indexers": ["666", "NOME DO FULANO", "07/12/2021"],
     "comments": "TESTE DE COMENTÁRIOS"
}

Alterar indexadores de um processo

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/v1/processes/indexers?values=666

PS: No próprio endpoint, após os "values=", você deverá passar os indexadores do processo que deseja alterar os indexadores, separados por vírgula (ex: 666,NOME%DO%FULANO) - percebe-se que se substitui o "espaço" pelo sinal de porcentagem "%"

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "data": {
        "id": 58089890
    },
    "errors": []
}

{
    "data": [],
    "errors": [
        {
            "message": "\"Nenhum processo encontrado\""
        }
    ]
}

{
    "data": [],
    "errors": [
        {
            "message": "\"Mais de um processo encontrado\""
        }
    ]
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
     "indexers": [
     {
          "label": "DATA",
          "value": "10/10/2010"
     },
     {
          "label": "VALOR",
          "value": "2.000,00"
     }
     ]
}

Iniciar processo BPM

O objetivo dessa API é automatizar o início dos processos no sistema a partir de uma requisição do tipo REST.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/process/create

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "id": 58089890,
    "stageDocumentTypes": [
        {
            "documentTypeId": 70033766,
            "documentTypeName": "DOCUMENTO CAPTURADO VIA INTEGRAÇÃO",
            "icon": null,
            "required": false,
            "sequence": null,
            "slaTime": null,
            "indexers": [],
            "desired": false,
            "attachments": [],
            "devices": null,
            "hasForm": false,
            "exists": false,
            "flagDisabled": false,
            "flagRestrainCapture": false,
            "formPrintTemplate": [],
            "form": false
        }
    ],
    "flagSelfCapture": false
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

// Erro no parâmetro "workflowId"
Tipo de Processo não encontrado para essa conta

// Erro no parâmetro "establishmentCNPJ"
Estabelecimento não encontrado

// Erro no parâmetro "initialTransition"
Esse estagio nao e uma situacao

// Erro no parâmetro "indexers"
Indexador obrigatorio não recebido ou indexador recebido [null] não encontrado na configuração deste tipo de processo []

Exemplo de Requisição:

{
	"workflowId": 5002995,
	"establishmentCNPJ": "73386365000",
	"observation":"",
	"isIntegration":"true",
    	"initialTransition": ["PRIMEIRA TRANSIÇÃO"],
	"indexers":
		[
			{
				"sequence":1,
				"indexerLabel":"INTEIRO",
				"indexerValue":"666",
				"indexerType":"I"
			},
			{
				"sequence":2,
				"indexerLabel":"TEXTO",
				"indexerValue":"NOME DO FULANO",
				"indexerType":"S"
			},
			{
				"sequence":3,
				"indexerLabel":"DATA",
				"indexerValue":"07/12/2021",
				"indexerType":"D"
			},
			{
				"sequence":4,
				"indexerLabel":"VALOR",
				"indexerValue":"1.000,00",
				"indexerType":"V"
			}
		]
}

Importante: Os parâmetros que são passados na requisição podem ser adquiridos através da abertura de um chamado com o nosso suporte: suporte@vianuvem.com.br.

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

Name

Type

Description

Request Body

Name

Type

Description

{
    "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
            }
        }
    ]
}

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Internal Server Error</body>
</html>

Exemplo de Requisição:

{
	"documentId": [],
	"establishmentIds": [],
	"processTypeIds": [],
	"documentTypeIds": [],
	"initialDate": "03/11/2021 10:37:28",
	"finalDate": "",
	"searchFor": "NOME DO FULANO",
	"like": false
}