UiPath · JSON Structure

Orchestrator Start Info Structure

Parameters controlling how jobs are started

Type: object Properties: 7 Required: 2
AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

StartInfo is a JSON Structure definition published by UiPath, describing 7 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ReleaseKey Strategy RobotIds NoOfRobots Source InputArguments JobPriority

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-structure/orchestrator-start-info-structure.json",
  "name": "StartInfo",
  "description": "Parameters controlling how jobs are started",
  "type": "object",
  "required": [
    "ReleaseKey",
    "Strategy"
  ],
  "properties": {
    "ReleaseKey": {
      "type": "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": "int64"
      },
      "description": "List of robot IDs to use when Strategy is RobotIds or Specific",
      "example": []
    },
    "NoOfRobots": {
      "type": "int32",
      "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"
    }
  }
}