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
Content-Type*	String	application/json
Authorization*	String	Token de acesso adquirido através da API "Get JWT" (bearer)

Request Body

Name	Type	Description
workflowId*	Integer	Código do tipo de processo que será iniciado
establishmentCNPJ*	String	CNPJ do estabelecimento onde o processo será iniciado
observation*	String	Comentários do processo. Pode ser vazio
isIntegration*	Boolean	Booleano que indica se o processo será iniciado a partir de uma integração. Neste caso, sempre será "true"
initialTransition*	Array de strings	Array de string que indica as opções no início do fluxo (perguntas iniciais dos decisores). Dependendo do fluxo, pode ser vazio
indexers*	Array de objetos	Array de objetos que indica quais são os indexadores do processo que será iniciado
sequence*	Integer	Sequência do indexador no processo (pertence a propriedade "indexers")
indexerLabel*	String	Nome do campo ou label que o indexador possui (pertence a propriedade "indexers")
indexerValue*	String	Valor que o indexador da label acima irá possuir (pertence a propriedade "indexers")
indexerType*	String	Tipo do indexador (pertence a propriedade "indexers"): I - Inteiro S - String V - Valor L - Lista D - Data M - Data múltipla

200: OK Requisição de sucesso

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

500: Internal Server Error Erro de autenticação

412: Precondition Failed Erro nos parâmetros enviados

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: [email protected].