Obter dados de execução do bot

Recuperar informações sobre um bot como as informações do servidor e se ele funcionou com sucesso ou encontrou um erro.

Solicitação

GET http://{{ControlRoomURL}}/v2/botinsight/data/api/getbotrundata?pageno={pageno}&limit={limit}&fromDate={fromDate}&toDate={toDate}

Header: X-Authorization <<authentication token>>

Todas as chamadas API devem conter ou um código de autenticação de API de autenticação (gera um código JSON Web) ou um código portador dos serviços OAuth. Não é possível utilizar os dois em conjunto num API.
Para visualizar os dados de execução do bot, você deve ter um dos seguintes:
- Função AAE_BOT_INSIGHT_ADMIN
- Licença ANALYTICSCLIENT_VALUE junto com a função AAE_ADMIN

Parâmetros da solicitação


Parâmetro	Tipo	Obrigatório	Descrição
paginanumero	Inteiro	Não	O número de página dos dados do Bot Run Data que você deseja recuperar.
limite	Inteiro	Não	Limita o número de resultados devolvidos. O padrão é de 1000. Por exemplo, se você especificar o limite como `2500` para recuperar um total de 10.000 registros, então as informações recuperadas serão as seguintes: 0 página retorna 1 - 2.500 1.ª página retorna 2.501 - 5.000 2.ª página retorna 5.001 - 7.500 3.ª página retorna 7.501 - 10.000
dataInicial	String	Não	O carimbo de data de início para o intervalo de datas. Se você não fornecer esse parâmetro, a API retornará todos os dados disponíveis. Formato: `yyyy-mm-ddThh:mm:ss`
dataFinal	String	Não	O carimbo de data final para o intervalo de datas. Formato: `yyyy-mm-ddThh:mm:ss` Padrão: data atual

GET http://{{ControlRoomURL}}/v2/botinsight/data/api/getbotrundata?pageno=1&limit=2&fromDate=2022-01-27T00%3A30%3A00Z&toDate=2022-02-27T06%3A30%3A00Z

Resposta

{
   "totalRecords":2,
   "botRunDataList":[
      {
         "id":60,
         "userName":"runner",
         "hostName":"WIN-MT6N77BI0C2",
         "fileName":"newtestbot27",
         "fileType":"RUN_NOW",
         "startDate":"2022-01-27T06:36:36Z",
         "endDate":"2022-01-27T06:36:36Z",
         "status":"FAILED",
         "totalLines":3,
         "currentLine":3,
         "timeTaken":1852,
         "progress":100
      },
      {
         "id":30,
         "userName":"runner",
         "hostName":"WIN-MT6N77BI0C2",
         "fileName":"Blm_test_bot",
         "fileType":"RUN_NOW",
         "startDate":"2022-01-28T11:33:25Z",
         "endDate":"2022-01-28T11:33:26Z",
         "status":"COMPLETED",
         "totalLines":3,
         "currentLine":3,
         "timeTaken":1820,
         "progress":100
      }
   ]
}

Parâmetros de resposta


Parâmetro	Tipo	Descrição
registrosTotais	Inteiro	Total de Registros que foram recuperados como parte do pedido.
listaDeDadosDeExecuçãoDoBot	Matriz	O conjunto de objetos Bot Run Data.
Objeto listaDeDadosDeExecuçãoDoBot
id	Inteiro	O bot executa uma identificação única para a corrida em particular.
userName	String	O nome do usuário que está executando o bot.
nomeDoHost	String	O nome do host.
fileName	String	O nome do arquivo do bot.
tipoDeArquivo	String	O tipo de arquivo associado a este bot. A seguir estão os valores possíveis para o Tipo de arquivo: `RUN_NOW` : Uma execução regular como bot de usuários. `WLM_TASK`: Um bot de gerenciamento de carga de trabalho que é executado em uma fila. `SCHEDULED`: Um bot que está agendado. `API`: Um bot que é executado a partir da API. `AARI`: Um bot de processo.
startDate	String	A data e hora do início da operação do bot.
endDate	String	A data e hora do fim da operação do bot.
status	String	O status do bot. Os valores possíveis incluem: `COMPLETED`: a execução do bot foi concluída com êxito. `DEPLOYED`: o login automático foi concluído com êxito e o bot foi implantado a um dispositivo. `DEPLOY_FAILED`: falha na implantação do bot ao dispositivo. Por exemplo, se o login automático não funcionou. `QUEUED`: o usuário ou dispositivo solicitado está processando outra execução. `PENDING_EXECUTION`: o dispositivo foi selecionado, mas o bot ainda não foi implantado nesse dispositivo. `RUNNING` ou `UPDATE`: o bot está em execução em um dispositivo. `RUN_FAILED`: o bot falhou após ser implantado a um dispositivo. `RUN_PAUSED`: o usuário pausou o bot. `RUN_TIMED_OUT`: o bot não concluiu as tarefas dentro do período de tempo específico. `UNKNOWN`: a conexão entre o serviço e o dispositivo foi perdida.
totalLines	Inteiro	O número total de linhas de comando que o bot contém.
currentLine	Inteiro	A linha atual que o bot está processando.
timeTaken	Inteiro	O tempo em milissegundos que o bot leva para concluir a operação.
progress	Inteiro	O andamento do bot, mostrado em porcentagem.

Nota: Você pode exibir o Control Room APIs no Community Edition, mas a funcionalidade da API é limitada. Você precisa de uma edição licenciada do Automation 360 para acessar a funcionalidade completa das APIs.

A API REST responde a cada solicitação com um código de resposta HTTP. Para códigos de resposta, consulte Códigos de resposta da API.