APIs - Tutoriais

StartRequest

52 views 21/06/2021 21/06/2021 alex-serodio 0

StartRequest

Inicia uma solicitação no BPM.

Payload de entrada:

{
   "processId": 0,                             // identificador do processo
   "businessData": "string",                   // objeto com as variáveis de negócio do processo, ex: businessData: "{ campo1: valor1, campo2: 2 }"
   "actionToExecute": "string",                // nome da ação a ser tomada dentro do fluxo. Obrigatório caso possua mais de uma ação possível (opcional)
   "nextSubject": "string",                    // responsável que vai receber a próxima ação. Obrigatório caso o mecanismo de atribuição retorne mais de um responsável (opcional)
   "externalServiceAuthorization": "string",   // token de autorização para integração com Serviços Externos, caso necessário (opcional)
   "title": "string",                          // título da solicitação (opcional)
   "requester": "string"                       // usuário solicitante, caso a solicitação esteja sendo feita em nome de outro usuário (opcional)
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/actions/startRequest" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'processId': 1, 'businessData': '{ nome: 'Nome do Solicitante', idade: 25 }', 'actionToExecute': 'string', 'nextSubject': 'string', 'externalServiceAuthorization': 'string', 'title': 'string', 'requester': 'string' }"

Responses:

  • 200 OK
    {
       "processInstanceID": 0       // identificador da instância do 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"
    }

Este artigo foi útil para você?