APIs - Tutoriais

GetRankingProcesses

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

GetRankingProcesses

Lista os processos mais utilizados pelo usuário no período especificado ou nos últimos seis meses se não especificado.

Payload de entrada:

{
    "start": "2021-06-01T00:00:00.000Z",    // data inicial para processar o ranking, se não informada usa data hoje menos 6 meses (opcional)
    "end": "2021-06-30T00:00:00.000Z",      // data final para processar o ranking, se não informado usa data hoje (opcional)
    "limit": 3                              // especifica o número de processos para retornar. O valor padrão é 3 (opcional)
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/queries/getRankingProcesses" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'start': '2021-06-01T00:00:00.000Z', 'end': '2021-06-30T00:00:00.000Z', 'limit': 3 }"

Responses:

  • 200 OK
    {
        "processes": [
            {
                "processId": 0,             // identificador do processo
                "currentVersion": 0,        // versão atual do processo
                "processName": "string",    // nome do processo
                "tag": "string",            // tag agrupador de processos
                "icon": "string",           // ícone do processo
                "description": "string",    // descrição do processo
                "requests": 0               // número de solicitações
            }
        ]
    }
  • 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ê?