Executar Robôs e Runtimes

Lista de APIs disponíveis para execução de robôs e manipulação de filas de execução.

Executar robô (com parâmetros)

POST https://app.rpaidea.com/api/integration/v1/run/{ID_COMPUTER}/{ID_BOT}

Start de execução de forma assíncrona do robô no runtime indicado, retornando o id da execução para futura requisição do resultado.

Headers

Name	Type	Description
Authorization*	string	Bearer {RESULT-OF-LOGIN}
Content-Type*	string	application/json
x-api-key*	String	{token}

Request Body

Name	Type	Description
	object	{ "variables": [ { "name":"CNPJ", "type": "text", "value":"{VALUE}" }, { "name":"IE", "type": "text", "value":"{IE}" } ] }

200 Robô executado com sucesso

{ID_EXECUTION}

401 Usuário não autorizado.

{
  "timestamp": 1574970103297,
  "status": 401,
  "error": "Unauthorized",
  "message": "Unauthorized",
  "path": "/api/user/auth"
}S

Executar robô (com parâmetros) v2

POST https://app.rpaidea.com/api/integration/v2/run/{ID_COMPUTER}/{ID_BOT}

Start de execução de forma assíncrona do robô no runtime indicado, retornando o id da execução para futura requisição do resultado.

Headers

Name	Type	Description
Authorization*	string	Bearer {RESULT-OF-LOGIN}
Content-Type*	string	application/json
x-api-key*	String	token

Request Body

Name	Type	Description
	object	{ "variables": [ "name": "CNPJ", "type": "text", "value": "{VALUE}" ] }

200

{
  "id": "execution_id",
}

Executar robô (sem parâmetros)

GET https://app.rpaidea.com/api/integration/v1/run/{ID_COMPUTER}/{ID_BOT}

Start de execução de forma assíncrona do robô no runtime indicado, retornando o id da execução para futura requisição do resultado. Neste caso sem o envio de parâmetros iniciais via body, mantendo somente os parâmetros default.

Headers

Name	Type	Description
Authorization*	string	Bearer {RESULT-OF-LOGIN}
Content-Type*	string	application/json
x-api-key*	String	Token

200 Robô executado com sucesso

{ID_EXECUTION}

401 Usuário não autorizado.

{
  "timestamp": 1574970103297,
  "status": 401,
  "error": "Unauthorized",
  "message": "Unauthorized",
  "path": "/api/user/auth"
}

Buscar resultado da execução

GET https://app.rpaidea.com/api/integration/v1/result/{ID_COMPUTER}/{ID_EXECUTION}

Buscar o resultado de forma parcial ou total da execução de um robô.

Headers

Name	Type	Description
Authorization*	string	Bearer {RESULT-OF-LOGIN}
Content-Type*	string	Application/json
x-api-key*	String	token

200 Requisição realizada com sucesso

{
    "idTask": "",
    "clientId": "",
    "tokenIntegration": "",
    "token": "",
    "dtAdd": "",
    "dtSentRuntime": "",
    "dtIni": "",
    "dtEnd": "",
    "returnValue": "",
    "parameters": "{\"variables\":[]}",
    "nameBot": "Nome do Robô no Orquestrador",
    "idBot": "",
    "versionBot": 0.01,
    "status": "FINISHED",
    "positive": true,
    "lastNotification": null,
    "progress": 1.0,
    "executionOrder": null,
    "localBot": "",
    "user": {},
    "taskOcr": [],
    "taskSteps": [],
    "scheduling": false
}

Deletar execução da fila

DELETE https://app.rpaidea.com/api/integration/v1/delete/{ID_COMPUTER}/{ID_EXECUTION}

Excluir execuções de uma fila de execução.

Headers

Name	Type	Description
Authorization*	string	Bearer {RESULT-OF-LOGIN}
Content-Type*	string	Application/json
x-api-key*	String	token

200

Obtendo ID do Robô e do Computador

Para utilização das requisições descritas acima será necessário capturar o código identificador do computador (runtime) em que se deseja executar a ação e do robô que deseja executar.

Para obter essas informações, acesse o Orquestrador e localize o robô que deseja executar no menu "Robôs. No menu ao lado direito do robô, utilize a opção "Usar via API". Uma tela será aberta contendo os dados para utilização na API.

Veja no exemplo a seguir: