APIs - Tutoriais

StartProcess

289 views 13/07/2020 21/06/2021 sergio-souza 0

StartProcess

Inicia um processo.

Payload de entrada:

{
    "processInstanceID": 0,                         // quando o usuário quer definir o número da instância do processo.
    "generateRecord": true,                         // caso seja passado o processInstanceId, indica que a geração do record deve ser feita pelo BPM e não foi gerenciada externamente.
    "processId": 0,                                 // número do processo
    "processVersion": 0,                            // versão do Processo
    "businessData": "string",                       // variáveis de Negócio do Processo. Ex: businessData: "{ campo1: valor1, campo2: 2 }"
    "flowExecutionData": {
        "actionToExecute": "string",                // nome da ação a ser tomada dentro do fluxo
        "nextSubject": "string"                     // usuário que pode receber a próxima ação
    },
    "authorization": "string",                      // string de autorização executados da tarefas do workflow
    "title": "string",                              // título opcional da solicitação
    "requester": "string",                          // usuário solicitante
    "externalServiceOverrideBusinessData": true     // se existir um serviço externo antes da primeira etapa, o mesmo deve sobrescrever as variáveis enviadas no businessData
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/actions/startProcess" --header "Content-Type: application/json" --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
    {
        "processInstanceID": 0        // instância de processo criada
    }
  • 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"
    }

Este artigo foi útil para você?