UiPath · JSON Structure

Orchestrator Robot Ref Structure

A lightweight reference to a robot associated with a job

Type: object Properties: 6
AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

RobotRef is a JSON Structure definition published by UiPath, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Id Name MachineName MachineId Version Type

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-robot-ref-structure.json",
  "name": "RobotRef",
  "description": "A lightweight reference to a robot associated with a job",
  "type": "object",
  "properties": {
    "Id": {
      "type": "int64",
      "description": "Unique integer identifier of the robot",
      "example": 12345
    },
    "Name": {
      "type": "string",
      "description": "Display name of the robot",
      "example": "Example Name"
    },
    "MachineName": {
      "type": "string",
      "description": "Hostname of the machine the robot runs on",
      "example": "Example Name"
    },
    "MachineId": {
      "type": "int64",
      "description": "Unique integer identifier of the machine",
      "example": 12345
    },
    "Version": {
      "type": "string",
      "description": "Version of the UiPath Robot software",
      "example": "1.0.0"
    },
    "Type": {
      "type": "string",
      "enum": [
        "Unattended",
        "Attended",
        "NonProduction",
        "TestAutomation",
        "RpaDeveloper",
        "StudioX",
        "HeadlessUnattended"
      ],
      "description": "Licensing type of the robot",
      "example": "Unattended"
    }
  }
}