UiPath · Schema

StartInfo

Parameters controlling how jobs are started

AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

Properties

Name Type Description
ReleaseKey string GUID key of the process (release) to start
Strategy string Strategy for allocating robots to the job
RobotIds array List of robot IDs to use when Strategy is RobotIds or Specific
NoOfRobots integer Number of robots to use when Strategy is JobsCount
Source string Source attribution for the started jobs
InputArguments string JSON-serialized input arguments to pass to the process
JobPriority string Priority level for the job queue
View JSON Schema on GitHub

JSON Schema

orchestrator-start-info-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-schema/orchestrator-start-info-schema.json",
  "title": "StartInfo",
  "description": "Parameters controlling how jobs are started",
  "type": "object",
  "required": [
    "ReleaseKey",
    "Strategy"
  ],
  "properties": {
    "ReleaseKey": {
      "type": "string",
      "format": "uuid",
      "description": "GUID key of the process (release) to start",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "Strategy": {
      "type": "string",
      "enum": [
        "All",
        "Specific",
        "JobsCount",
        "RobotIds"
      ],
      "description": "Strategy for allocating robots to the job",
      "example": "All"
    },
    "RobotIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "description": "List of robot IDs to use when Strategy is RobotIds or Specific",
      "example": []
    },
    "NoOfRobots": {
      "type": "integer",
      "description": "Number of robots to use when Strategy is JobsCount",
      "example": 1
    },
    "Source": {
      "type": "string",
      "enum": [
        "Manual",
        "Schedule",
        "Queue"
      ],
      "description": "Source attribution for the started jobs",
      "example": "Manual"
    },
    "InputArguments": {
      "type": "string",
      "description": "JSON-serialized input arguments to pass to the process",
      "example": "example-value"
    },
    "JobPriority": {
      "type": "string",
      "enum": [
        "Low",
        "Normal",
        "High"
      ],
      "description": "Priority level for the job queue",
      "example": "Low"
    }
  }
}