StartProcess

  • Mon, 09/20/2021 - 08:29
  • /diego.lopes@sen...

Inicia um processo.

Payload de entrada
{ // quando o usuário quer definir o número da instância do processo. "processInstanceID": 0, // caso seja passado o processInstanceId, indica que a geração do record deve ser feita pelo BPM e não foi gerenciada externamente. "generateRecord": true, // número do processo "processId": 0, // versão do Processo "processVersion": 0, // variáveis de Negócio do Processo. Ex: businessData: "{ campo1: valor1, campo2: 2 }" "businessData": "string", "flowExecutionData": { // nome da ação a ser tomada dentro do fluxo "actionToExecute": "string", // usuário que pode receber a próxima ação "nextSubject": "string" }, // string de autorização executados da tarefas do workflow "authorization": "string", // título opcional da solicitação "title": "string", // usuário solicitante "requester": "string", . // se existir um serviço externo antes da primeira etapa, o mesmo deve sobrescrever as variáveis enviadas no businessData "externalServiceOverrideBusinessData": true }
Request
curl --location --request POST "https://api.senior.com.br/platform/workflow/startProcess" --header "Content-Type: application/json" --header "client_id: {client_id}" --header "Accept: application/json" --header "Authorization: Bearer {token}" --data-raw "{ 'processId': '{number}', 'businessData': '{string}', 'flowExecutionData': { 'actionToExecute': '{string}', 'nextSubject': '{string}' }, 'processInstanceID': '{number}', 'processVersion': '{number}', 'authorization': '{string}', 'title': '{string}', 'requester': '{string}' }"
Response

  • 200 Ok

{ // instância de processo criada "processInstanceID": 0 }

  • 400 Bad Request: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente

{ "message": "Descrição do erro", "errorCode": "codigoDoErro", "reason": "BAD_REQUEST", "domain": "platform", "service": "workflow" }

  • 401 Unauthorized: Usuário ou senha inválido

{ "error_description": "Descrição do erro", "error": "codigo_do_erro" }

  • 403 Forbidden: Permissão negada

  • 404 Not Found: Processo com id {idDoProcesso} não encontrado

{ "message": "Descrição do erro", "errorCode": "codigoDoErro", "reason": "OBJECT_NOT_FOUND", "domain": "platform", "service": "workflow" }

  • 404 Not Found: Processo com id {idDoProcesso} e versão {versaoDoProcesso} não encontrado

{ "message": "Descrição do erro", "errorCode": "codigoDoErro", "reason": "OBJECT_NOT_FOUND", "domain": "platform", "service": "workflow" }