APIs - Tutoriais

SearchTasks

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

SearchTasks

Lista as tarefas que atendam aos filtros informados.

Payload de entrada:

{
    "filter": {
        "requesters": [     // filtrar pelo solicitante (opcional)
            "nome solicitante"
        ],
        "requests": [       // filtrar pelo identificador da solicitação (opcional)
            "string"
        ],
        "processes": [      // filtrar pelo identificador do processo (opcional)
            "1", "2"
        ],
        "statuses": [       // filtrar pelo status da tarefa. Pode ser UNREADED, READED, PENDING e TREATED (opcional)
            "PENDING"
        ]
    },
    "pagination": {         // paginação dos resultados (opcional)
        "start": 0,
        "limit": 5
    },
    "orders": [             // ordenação dos resultados por campo (opcional)
        {
            "field": "REQUESTER",   // pode ser END_DATE, EXPIRATION_DATE, PROCESS_NAME, REQUESTER, RESPONSIBLE, START_DATE ou STATUS
            "direction": "ASC"
        }
    ]
}

Exemplo de request:

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

Responses:

  • 200 OK
    {
        "tasks": [
            {
                "processId": 0,                                 // id do processo
                "processName": "string",                        // nome do processo
                "processInstanceId": 0,                         // id da instância do processo
                "activity": "string",                           // atividade
                "detail": "string",                             // detalhes do processo
                "startDate": "2021-06-19T17:38:50.507Z",        // data de início da tarefa/processo
                "endDate": "2021-06-19T17:38:50.507Z",          // data de fim da tarefa/processo
                "expirationDate": "2021-06-19T17:38:50.507Z",   // data de expiração da tarefa/processo
                "responsableName": "string",                    // nome do responsável pela tarefa
                "responsableFullName": "string",                // nome e sobrenome do responsável pela tarefa
                "requesterName": "string",                      // nome do solicitante
                "taskStatus": "UNREADED",                       // status da tarefa. Pode ser UNREADED, READED, PENDING ou TREATED
                "requestStatus": "InProgress",                  // status da solicitação. Pode ser InProgress, Completed ou Canceled
                "title": "string",                              // título da Solicitação
                "activityId": 0,                                // id da atividade
                "step": 0,                                      // passo
                "pendencyCount": 0,                             // número de pendências de uma solicitação
                "responseStatus": "WAITING"                     // estado da pendência em lote. Pode ser WAITING, EXECUTING ou ERROR
            }
        ],
        "total": 0                                              // total de registros
    }
  • 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ê?