• seg, 09/20/2021 - 08:30
  • /diego.lopes@sen...

Obtém as informações de uma instância específica de um processo (um processo já iniciado).

Payload de entrada
{ // identificador numérico do processo "processInstance": 1 }
Request
curl --location --request POST "https://api.senior.com.br/platform/workflow/getProcessInstance" --header "Authorization: Bearer {access_token}" --header "client_id: {client_id}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'processInstance': 1 }"
Response

  • 200 Ok

{ "processInstance": { // identificador da instância do processo "id": 0, "process": { // identificador do processo "processId": 0, // versão atual do processo "currentVersion": 0, // versão publicada do processo "publishedVersion": 0, // nome do processo "processName": "string", // nome do processo assim como se encontra no banco de dados "processRawName": "string", // se o processo está modificado "changed": true, // nome do arquivo do processo "fileName": "string", // se o processo esta publicado ou apenas salvo. Pode ser Saved ou Published "status": "Saved", // descrição do processo "description": "string", // data de criação do processo "creationDate": "2021-06-19T18:13:16.297Z", // se o processo está ativo "active": true, // se o processo é embarcado "embedded": true, // se o processo é simples "simple": true, // tag agrupador de processos "tag": "string", // indica o nível de acesso do usuário ao processo. Pode ser EDIT_AND_START, START, EDIT ou NONE "accessLevel": "EDIT_AND_START", // ícone do processo "icon": "string", // listagem dos tipos e quantidade de eventos de serviço externo "serviceEventQtyByType": [ { // tipo do evento "type": "IN_PROGRESS", // quantidade de eventos "quantity": 0 } ] }, // responsável que iniciou o processo "startedSubject": { // código do responsável "userCode": 0, // nome do responsável "name": "string", // tipo do responsável. Pode ser User, Group, Role ou UserApp "subjectKind": "User" }, // responsável que cancelou o processo "cancelSubject": { // código do responsável "userCode": 0, // nome do responsável "name": "string", // tipo do responsável. Pode ser User, Group, Role ou UserApp "subjectKind": "User" }, "startDate": "2021-06-19T18:13:16.297Z", "lastUptadeDate": "2021-06-19T18:13:16.297Z", "endDate": "2021-06-19T18:13:16.297Z", "flowExecutionStatus": "string", "endMessage": "string", "description": "string", "flowToken": [ { "processInstanceID": 0, "step": 0, "activityId": 0 } ], "taskExpiration": "2021-06-19T18:13:16.297Z" } }

Ou, se não encontrar uma instância de processo com o identificador informado:

{}

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