Create an API Task allocation (admin)
- Updated: 2024/07/10
Create an API Task allocation (admin)
After an API Task is checked-in, you can add the API Task to cloud. This API endpoint adds the API Task to cloud and creates a resource allocation for your API Task to run.
Note: You need admin rights to create an API Task
allocation.
The corresponding section that details the API Task allocation within the Control Room is Add API Task to Cloud. The API Task allocation is done after an API Task is created. For more information creating an API Task, see Create an API Task.
PUT https://{{ControlRoomURL}}/orchestrator/v1/hotbot/config/create
Request
body:
{
"fileId": "5",
"runAsUserOrNone": 3,
"concurrencyLimit": 2
}
Response:
Request/Response parameters{
"fileId": "5",
"runAsUserOrNone": 3,
"concurrencyLimit": 2
}
Parameter | Type | Required | Description |
---|---|---|---|
fileId | Integer | Yes |
ID of the automation to be deployed. |
runAsUserOrNone | Integer | No | The apitaskrunner to establish the RunAsUser context for
API Tasks. For more information on
apitaskrunner, see Run as user for API Task (apitaskrunner).
Note: This RunAsUser does not require a
Bot Runner license. |
concurrencyLimit | Integer | No | Maximum number of concurrency to run for a given real-time (hotbot) request. |