Get the ActivityRunStatus of an ActivityRun

v1.0.0

Gets the ActivityRunStatus of an ActivityRun. When successful, the response is the requested ActivityRunStatus. If unsuccessful, an appropriate ApiError is returned.

Input

{
  "type": "object",
  "properties": {
    "activityRunID": {
      "type": "integer",
      "format": "int32"
    }
  },
  "required": [
    "activityRunID"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "A DTO for an IActivityRunStatus",
  "properties": {
    "CurrentStep": {
      "type": "integer",
      "format": "int32",
      "description": "The activity step currently executing, indicated by numeric order"
    },
    "Status": {
      "type": "string",
      "description": "The status of the ActivityRun",
      "enum": [
        "Ready",
        "InProgress",
        "Succeeded",
        "Cancelled",
        "Failed"
      ]
    },
    "StepProgress": {
      "type": "integer",
      "format": "int32",
      "description": "The percent progress from the currently executing step.  This value shall be null if progress is not available"
    },
    "StepStatus": {
      "type": "string",
      "description": "The status text from the currently executing step"
    }
  }
}