Português
English
SearchTasks
Lista as tarefas que atendam aos filtros informados.
Payload de entrada
{
"filter": {
// filtrar pelo solicitante (opcional)
"requesters": [
"nome solicitante"
],
// filtrar pelo identificador da solicitação (opcional)
"requests": [
"string"
],
// filtrar pelo identificador do processo (opcional)
"processes": [
"1", "2"
],
// filtrar pelo status da tarefa. Pode ser UNREADED, READED, PENDING e TREATED (opcional)
"statuses": [
"PENDING"
]
},
// paginação dos resultados (opcional)
"pagination": {
"start": 0,
"limit": 5
},
// ordenação dos resultados por campo (opcional)
"orders": [
{
// pode ser END_DATE, EXPIRATION_DATE, PROCESS_NAME, REQUESTER, RESPONSIBLE, START_DATE ou STATUS
"field": "REQUESTER",
"direction": "ASC"
}
]
}
Request
curl --location --request POST "https://api.senior.com.br/platform/workflow/searchTasks" --header "Authorization: Bearer {access_token}" --header "client_id: {client_id}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'filter': { 'requesters': [ 'admin' ], 'requests': [ ], 'processes': [ '1', '2' ], 'statuses': [ 'PENDING' ]}, 'pagination': { 'start': 0, 'limit': 5 }, 'orders': [{ 'field': 'REQUESTER', 'direction': 'ASC' }]}"
Response
200 Ok
{
"tasks": [
{
// id do processo
"processId": 0,
// nome do processo
"processName": "string",
// id da instância do processo
"processInstanceId": 0,
// atividade
"activity": "string",
// detalhes do processo
"detail": "string",
// data de início da tarefa/processo
"startDate": "2021-06-19T17:38:50.507Z",
// data de fim da tarefa/processo
"endDate": "2021-06-19T17:38:50.507Z",
// data de expiração da tarefa/processo
"expirationDate": "2021-06-19T17:38:50.507Z",
// nome do responsável pela tarefa
"responsableName": "string",
// nome e sobrenome do responsável pela tarefa
"responsableFullName": "string",
// nome do solicitante
"requesterName": "string",
// status da tarefa. Pode ser UNREADED, READED, PENDING ou TREATED
"taskStatus": "UNREADED",
// status da solicitação. Pode ser InProgress, Completed ou Canceled
"requestStatus": "InProgress",
// título da Solicitação
"title": "string",
// id da atividade
"activityId": 0,
// passo
"step": 0,
// número de pendências de uma solicitação
"pendencyCount": 0,
// estado da pendência em lote. Pode ser WAITING, EXECUTING ou ERROR
"responseStatus": "WAITING"
}
],
// total de registros
"total": 0
}
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"
}
