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

Obtém o resumo das solicitações que atendam aos filtros informados.

Payload de entrada
{ // a partir de qual solicitação a busca começa (opcional) "start": 0, // quantidade de solicitações retornadas (opcional) "limit": 0, // identificadores dos processos dos quais deseja buscar as solicitações (opcional) "filterProcess": [ 1, 2 ], // filtro por nome ou variáveis igual ao informado (opcional) "filterValue": "string", // filtro por status da solicitação. Pode ser InProgress, Completed e Canceled (opcional) "filter": [ "InProgress" ], // para ordenação do resultado por campo (opcional) "orders": [ { "key": "processInstanceId", "value": "desc" } ], // filtro por status. Pode ser InProgress, WillExpire ou Expired (opcional) "situation": "InProgress" }
Request
curl --location --request POST "https://api.senior.com.br/platform/workflow/getRequestsResume" --header "Authorization: Bearer {access_token}" --header "client_id: {client_id}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'start': 0, 'limit': 5, 'filterProcess': [ 1, 2 ], 'filterValue': 'Cotação', 'filter': [ 'InProgress' ], 'orders': [{ 'key': 'processInstanceId', 'value': 'desc' }], 'situation': 'InProgress' }"
Response

  • 200 Ok

{ "requestsResume": [ { // identificador da instância de processo "processInstanceId": 3, // nome do processo "processName": "string", // criação da solicitação "startDate": "2021-06-16T20:35:00Z", // enceramento da solicitação "endDate": "2021-06-17T20:35:01Z", // status "status": "string", // nome da atividade atual "activityName": "string", // usuário atual da tarefa "taskUser": "string", // data de Expiração "expirationDate": "2021-06-18T14:52:35.323Z", // identificador do processo "processId": 2, // versão do processo "processVersion": 2, // indica se o processo desta solicitação é embarcado "embedded": false, // detalhes da solicitação "detail": "string", // identificador de uma pendência "flowToken": [ { // identificador da instância do processo "processInstanceID": 3, // identificador da etapa do processo "step": 2, // identificador da atividade "activityId": 2 } ] } ], // número total de instância de processos "total": 1 }

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