JobCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-site-recovery/json-schema/microsoft-azure-site-recovery-job-collection-schema.json",
  "title": "JobCollection",
  "description": "Collection of jobs.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-site-recovery-replicationjobs-api-openapi.yml#/components/schemas/JobCollection",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The Job items on this page",
      "items": {
        "$ref": "#/$defs/Job"
      }
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "ASRTask": {
      "type": "object",
      "description": "Task of the Job.",
      "properties": {
        "taskId": {
          "type": "string",
          "description": "The Id."
        },
        "name": {
          "type": "string",
          "description": "The unique Task name."
        },
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "The start time."
        },
        "endTime": {
          "type": "string",
          "format": "date-time",
          "description": "The end time."
        },
        "allowedActions": {
          "type": "array",
          "description": "The state/actions applicable on this task.",
          "items": {
            "type": "string"
          }
        },
        "friendlyName": {
          "type": "string",
          "description": "The name."
        },
        "state": {
          "type": "string",
          "description": "The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other."
        },
        "stateDescription": {
          "type": "string",
          "description": "The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped."
        },
        "taskType": {
          "type": "string",
          "description": "The type of task. Details in CustomDetails property depend on this type."
        },
        "customDetails": {
          "$ref": "#/$defs/TaskTypeDetails",
          "description": "The custom task details based on the task type."
        },
        "groupTaskCustomDetails": {
          "$ref": "#/$defs/GroupTaskDetails",
          "description": "The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it."
        },
        "errors": {
          "type": "array",
          "description": "The task error details.",
          "items": {
            "$ref": "#/$defs/JobErrorDetails"
          }
        }
      }
    },
    "GroupTaskDetails": {
      "type": "object",
      "description": "This class represents the group task details when parent child relationship exists in the drill down.",
      "properties": {
        "instanceType": {
          "type": "string",
          "description": "The type of task details."
        },
        "childTasks": {
          "type": "array",
          "description": "The child tasks.",
          "items": {
            "$ref": "#/$defs/ASRTask"
          }
        }
      },
      "required": [
        "instanceType"
      ]
    },
    "Job": {
      "type": "object",
      "description": "Job details.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/JobProperties",
          "description": "The custom data."
        },
        "location": {
          "type": "string",
          "description": "Resource Location"
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/ProxyResource"
        }
      ]
    },
    "JobDetails": {
      "type": "object",
      "description": "Job details based on specific job type.",
      "properties": {
        "instanceType": {
          "type": "string",
          "description": "Gets the type of job details (see JobDetailsTypes enum for possible values)."
        },
        "affectedObjectDetails": {
          "type": "object",
          "description": "The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "required": [
        "instanceType"
      ]
    },
    "JobErrorDetails": {
      "type": "object",
      "description": "This class contains the error details per object.",
      "properties": {
        "serviceErrorDetails": {
          "$ref": "#/$defs/ServiceError",
          "description": "The Service error details."
        },
        "providerErrorDetails": {
          "$ref": "#/$defs/ProviderError",
          "description": "The Provider error details."
        },
        "errorLevel": {
          "type": "string",
          "description": "Error level of error."
        },
        "creationTime": {
          "type": "string",
          "format": "date-time",
          "description": "The creation time of job error."
        },
        "taskId": {
          "type": "string",
          "description": "The Id of the task."
        }
      }
    },
    "JobProperties": {
      "type": "object",
      "description": "Job custom data details.",
      "properties": {
        "activityId": {
          "type": "string",
          "description": "The activity id."
        },
        "scenarioName": {
          "type": "string",
          "description": "The ScenarioName."
        },
        "friendlyName": {
          "type": "string",
          "description": "The DisplayName."
        },
        "state": {
          "type": "string",
          "description": "The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other."
        },
        "stateDescription": {
          "type": "string",
          "description": "The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped."
        },
        "tasks": {
          "type": "array",
          "description": "The tasks.",
          "items": {
            "$ref": "#/$defs/ASRTask"
          }
        },
        "errors": {
          "type": "array",
          "description": "The errors.",
          "items": {
            "$ref": "#/$defs/JobErrorDetails"
          }
        },
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "The start time."
        },
        "endTime": {
          "type": "string",
          "format": "date-time",
          "description": "The end time."
        },
        "allowedActions": {
          "type": "array",
          "description": "The Allowed action the job.",
          "items": {
            "type": "string"
          }
        },
        "targetObjectId": {
          "type": "string",
          "description": "The affected Object Id."
        },
        "targetObjectName": {
          "type": "string",
          "description": "The name of the affected object."
        },
        "targetInstanceType": {
          "type": "string",
          "description": "The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class."
        },
        "customDetails": {
          "$ref": "#/$defs/JobDetails",
          "description": "The custom job details like test failover job details."
        }
      }
    },
    "ProviderError": {
      "type": "object",
      "description": "This class contains the error details per object.",
      "properties": {
        "errorCode": {
          "type": "integer",
          "format": "int32",
          "description": "The Error code."
        },
        "errorMessage": {
          "type": "string",
          "description": "The Error message."
        },
        "errorId": {
          "type": "string",
          "description": "The Provider error Id."
        },
        "possibleCauses": {
          "type": "string",
          "description": "The possible causes for the error."
        },
        "recommendedAction": {
          "type": "string",
          "description": "The recommended action to resolve the error."
        }
      }
    },
    "ProxyResource": {
      "type": "object",
      "title": "Proxy Resource",
      "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location",
      "allOf": [
        {
          "$ref": "#/$defs/Resource"
        }
      ]
    },
    "Resource": {
      "type": "object",
      "title": "Resource",
      "description": "Common fields that are returned in the response for all Azure Resource Manager resources",
      "properties": {
        "id": {
          "type": "string",
          "format": "arm-id",
          "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "The name of the resource",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"",
          "readOnly": true
        },
        "systemData": {
          "$ref": "#/$defs/systemData",
          "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
          "readOnly": true
        }
      },
      "x-ms-azure-resource": true
    },
    "ServiceError": {
      "type": "object",
      "description": "ASR error model.",
      "properties": {
        "code": {
          "type": "string",
          "description": "Error code."
        },
        "message": {
          "type": "string",
          "description": "Error message."
        },
        "possibleCauses": {
          "type": "string",
          "description": "Possible causes of error."
        },
        "recommendedAction": {
          "type": "string",
          "description": "Recommended action to resolve error."
        },
        "activityId": {
          "type": "string",
          "description": "Activity Id."
        }
      }
    },
    "TaskTypeDetails": {
      "type": "object",
      "description": "Task details based on specific task type.",
      "properties": {
        "instanceType": {
          "type": "string",
          "description": "The type of task details."
        }
      },
      "required": [
        "instanceType"
      ]
    }
  }
}