UiPath · JSON Structure

Orchestrator Stop Job Request Structure

Request payload for stopping a running job

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

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

Properties

jobId strategy

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-stop-job-request-structure.json",
  "name": "StopJobRequest",
  "description": "Request payload for stopping a running job",
  "type": "object",
  "required": [
    "jobId",
    "strategy"
  ],
  "properties": {
    "jobId": {
      "type": "int64",
      "description": "Unique integer identifier of the job to stop",
      "example": 12345
    },
    "strategy": {
      "type": "string",
      "enum": [
        "SoftStop",
        "Kill"
      ],
      "description": "Stop strategy. SoftStop waits for the current activity to complete before stopping; Kill immediately terminates the robot process.",
      "example": "SoftStop"
    }
  }
}