Skip to main content

Hi everyone,

I recently deployed a bot using the AA360 API with the following payload:

{  "fileId": //BotId,   "runAsUserIds": "    //UserID  ],  "poolIds": l],  "overrideDefaultDevice": false,  "callbackInfo": {    "url": "https://callbackserver.com/storeBotExecutionStatus",     "headers": {      "X-Authorization": "//token"    }  }}

Everything works fine, and in the response I receive both a deploymentId and an automationName.
However, I'm struggling to understand how I can actually use the deploymentId. What is its specific purpose within the API?

Additionally, I'm wondering if there is an API that allows me to view in-progress activities or access a historical table of executions, similar to what can be viewed in Control Room. So far, I’ve only found the API for the AUDIT log, but nothing akin to an Activity table or In-progress executions.
Has anyone dealt with this issue or have any suggestions on how to proceed?

Thanks in advance!

As far as the API, the Bot Execution Orchestration API looks to be about it. You can pass it an Execution ID and then review its execution history. It does not look like Execution ID and Deployment ID are synonymous, so you’d have to use the activity/list first to get the Execution ID, then pass that to activity/execution/{id} to get more info about the run.

If you use either Bot Insight or CoE Manager, it is obviously able to pull much more data on the executions, but I think very little is exposed to end users through the API.

https://<yourcontrolroom>/swagger/ui/?url=/swagger/api/v3/bot-execution-orchestrator-api-supported.yaml

As far as the API, the Bot Execution Orchestration API looks to be about it. You can pass it an Execution ID and then review its execution history. It does not look like Execution ID and Deployment ID are synonymous, so you’d have to use the activity/list first to get the Execution ID, then pass that to activity/execution/{id} to get more info about the run.

If you use either Bot Insight or CoE Manager, it is obviously able to pull much more data on the executions, but I think very little is exposed to end users through the API.

https://<yourcontrolroom>/swagger/ui/?url=/swagger/api/v3/bot-execution-orchestrator-api-supported.yaml

Sorry @JLogan3o13 

I did not understand

That’s an interesting question, Andrea.C1 !

I think the following community members may be able to help 

@ChanduMohammad 

@Zaid Chougle 

@Tamil Arasu10 

@Paul Hawkins 

@Padmakumar 

Hi ​@Andrea.C1 ,

 

The deploymentId you receive after starting a bot run via the AA360 API is a unique identifier for that specific bot execution instance. It is primarily used to track, correlate, and manage the execution lifecycle of that particular run.

Purpose of deploymentId:

  • Track Execution Status:
    You can use the deploymentId to monitor the status of that specific bot run if your callback URL or polling mechanism supports it.

  • Correlate Callbacks:
    The deploymentId is sent back in callback notifications (if configured), allowing you to associate execution results or errors with the originating run request.

  • Query or Manage Execution (if supported):
    Some APIs may allow querying execution details by deploymentId, though this depends on the available endpoints.

Regarding Viewing In-Progress or Historical Executions:

  • Currently, Automation Anywhere's API surface for Community or Enterprise Cloud editions primarily exposes:

    • Audit Logs API: For audit trail and logs.
    • Bot Run API: To start bots and receive execution status callbacks.

  • Activity Table or In-progress Executions API:
    There is no public or documented API that directly exposes the Control Room’s Activity or In-progress executions table.

Reply


Terms & ConditionsCookie settings