APIs - Tutoriais

GetRequestsResume

50 views 18/06/2021 21/06/2021 alex-serodio 0

GetRequestsResume

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

Payload de entrada:

{
    "start": 0,                 // a partir de qual solicitação a busca começa (opcional)
    "limit": 0,                 // quantidade de solicitações retornadas (opcional)
    "filterProcess": [ 1, 2 ],  // identificadores dos processos dos quais deseja buscar as solicitações (opcional)
    "filterValue": "string",    // filtro por nome ou variáveis igual ao informado (opcional)
    "filter": [                 // filtro por status da solicitação. Pode ser InProgress, Completed e Canceled (opcional)
        "InProgress"
    ],
    "orders": [                 // para ordenação do resultado por campo (opcional)
        {
            "key": "processInstanceId",
            "value": "desc"
        }  
    ],
    "situation": "InProgress"   // filtro por status. Pode ser InProgress, WillExpire ou Expired (opcional)
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/queries/getRequestsResume" --header "Authorization: Bearer {access_token}" --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' }"

Responses:

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