API Task Execution API

To execute an API Task in public workspace, you need to go through a number of steps.

Create an API Task Allocation
Get access details for the allocation created. Access details include execute URL to run the Api Task as well as all the required headers. - Use the url and the headers returned with Access details to execute the API Task.
example url: http://localhost:63342/knative-33.hotbot-0dd41155-2bc8-df13-700d-b8a1a0b02d75.svc.cluster.local/execute
example headers:
1. X-Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
2. API-Task-Name: Reverse String
Returns API Task result.

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 1.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

APITask

post /knative-33.hotbot-0dd41155-2bc8-df13-700d-b8a1a0b02d75.svc.cluster.local/execute
post /orchestrator/v1/hotbot/config/accessdetails
put /orchestrator/v1/hotbot/config/create
post /orchestrator/v1/hotbot/config

APITask

Up

post /knative-33.hotbot-0dd41155-2bc8-df13-700d-b8a1a0b02d75.svc.cluster.local/execute

Execute API Task (knative33Hotbot0dd411552bc8Df13700dB8a1a0b02d75SvcClusterLocalExecutePost)

<ul> <li>A user with access to API Task Access Details can get API Task Execution url as well as the necessary headers to execute the api task.</li> <li>All headers specified in the Access Details response must be sent as headers in the execute request.</li> <li>The headers may contain, for eg. X-Authorization, API-Task-Name, etc. which will be validated when execute endpoint is called.</li> <li>Above url is just an example of execute endpoint, actual url will be dynamic and should be obtained from the response to accessDetails request.</li> </ul>

Consumes

This API call consumes the following media types via the request header:

*/*

Request body

body HotBotInput (required)

Body Parameter —

Return type

HotBotOutput

Example data

Content-Type: application/json

{
  "HotBotResult" : {
    "BotOutput" : {
      "Output" : {
        "string" : "54321",
        "triggerName" : "",
        "formInstanceId" : "",
        "securelyRecorded" : false,
        "type" : "STRING",
        "repository" : "",
        "number" : "",
        "conditionalId" : "",
        "formElementType" : "",
        "packageName" : "",
        "exceptionName" : "",
        "thumbnailMetadataPath" : "",
        "expression" : "",
        "variableName" : "",
        "packageId" : "",
        "taskbotSelf" : false,
        "list" : [ "list", "list" ],
        "variableMapNames" : [ "variableMapNames", "variableMapNames" ],
        "variableMapFilter" : [ "variableMapFilter", "variableMapFilter" ],
        "iteratorId" : "",
        "iteratorName" : "",
        "formElementId" : "",
        "boolean" : "",
        "dictionary" : [ {
          "key" : "key"
        }, {
          "key" : "key"
        } ],
        "queueName" : "",
        "sessionTarget" : "",
        "screenshotMetadataPath" : "",
        "conditionalName" : "",
        "properties" : [ {
          "enabled" : true
        }, {
          "enabled" : true
        } ]
      }
    }
  }
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

API Task execution result returned. HotBotOutput

400

Bad Request. Error

401

Authentication required. Error

404

This means the hotbot service is not configured and will be accompanied by a CORS error. Was the allocation created correctly? Check for “API Task Warmup completed” event in audit log. ErrorMessage

500

Server error. Error

Up

post /orchestrator/v1/hotbot/config/accessdetails

API Task Access Details (orchestratorV1HotbotConfigAccessdetailsPost)

A user with access to API Task Access Details can get API Task Execution url and execute the task

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body HotBotAccessDetailsRequest (required)

Body Parameter —

Return type

HotBotAccessDetailsResponse

Example data

Content-Type: application/json

{
  "accessDetails" : {
    "headers" : {
      "X-Authorization" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
      "API-Task-Name" : "Reverse String"
    },
    "url" : "http://localhost:63342/knative-33.hotbot-0dd41155-2bc8-df13-700d-b8a1a0b02d75.svc.cluster.local/execute"
  },
  "errors" : {
    "code" : "code",
    "message" : "message"
  }
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

API Task Access Details url with headers is returned, that can be used to execute the task. HotBotAccessDetailsResponse

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Up

put /orchestrator/v1/hotbot/config/create

Create API Task Allocation (orchestratorV1HotbotConfigCreatePut)

Create an API Task Allocation.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body HotBotCreateRequest (required)

Body Parameter —

Return type

HotBotCreateResponse

Example data

Content-Type: application/json

{
  "runAsUserOrNone" : 3,
  "concurrencyLimit" : 2,
  "fileId" : "5"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Newly created API Task Allocation. HotBotCreateResponse

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Up

post /orchestrator/v1/hotbot/config

API Task Access Details (orchestratorV1HotbotConfigPost)

Get all the existing API Task allocations.

Consumes

This API call consumes the following media types via the request header:

*/*

Request body

body FilterRequest (required)

Body Parameter —

Return type

HotBotConfigList

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 1,
    "offset" : 0,
    "list" : [ {
      "runAsUser" : 3,
      "fileName" : "fileName",
      "filePath" : "Automation Anywhere\\\\Bots\\\\Reverse String Task",
      "concurrencyLimit" : 2,
      "fileId" : "5"
    }, {
      "runAsUser" : 3,
      "fileName" : "fileName",
      "filePath" : "Automation Anywhere\\\\Bots\\\\Reverse String Task",
      "concurrencyLimit" : 2,
      "fileId" : "5"
    } ]
  }
}