ApiTaskAllocation

A single API Task allocation record indicating an allocated real-time API Task

Properties

Name	Type	Description
fileId	integer	Numeric file ID of the API Task bot in the repository
filePath	string	Repository path of the allocated API Task (e.g., /Automation/MyApiTask)
fileName	string	Display name of the API Task file
runAsUserOrNone	integer	User ID under which the API Task executes, or null if using the caller's credentials
concurrencyLimit	integer	Maximum number of concurrent instances allowed for this API Task in real-time execution mode

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiTaskAllocation",
  "title": "ApiTaskAllocation",
  "type": "object",
  "description": "A single API Task allocation record indicating an allocated real-time API Task",
  "properties": {
    "fileId": {
      "type": "integer",
      "description": "Numeric file ID of the API Task bot in the repository"
    },
    "filePath": {
      "type": "string",
      "description": "Repository path of the allocated API Task (e.g., /Automation/MyApiTask)"
    },
    "fileName": {
      "type": "string",
      "description": "Display name of the API Task file"
    },
    "runAsUserOrNone": {
      "type": "integer",
      "description": "User ID under which the API Task executes, or null if using the caller's credentials"
    },
    "concurrencyLimit": {
      "type": "integer",
      "description": "Maximum number of concurrent instances allowed for this API Task in real-time execution mode"
    }
  }
}