xref: /openbmc/bmcweb/redfish-core/schema/dmtf/json-schema/Job.v1_2_4.json (revision f2a8e57e)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/Job.v1_2_4.json",
    "$ref": "#/definitions/Job",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
                }
            },
            "type": "object"
        },
        "Job": {
            "additionalProperties": false,
            "description": "The `Job` schema contains information about a job that a Redfish job service schedules or executes.  Clients create jobs to describe a series of operations that occur at periodic intervals.",
            "longDescription": "This resource shall contain a job in a Redfish implementation.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource."
                },
                "CreatedBy": {
                    "description": "The person or program that created this job entry.",
                    "longDescription": "This property shall contain the username, software program name, or other identifier indicating the creator of this job.",
                    "readonly": true,
                    "type": "string"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "EndTime": {
                    "description": "The date and time when the job was completed.",
                    "format": "date-time",
                    "longDescription": "This property shall indicate the date and time when the job was completed.  This property shall not appear if the job is running or was not completed.  This property shall appear only if the `JobState` is `Completed`, `Cancelled`, or `Exception`.",
                    "readonly": true,
                    "type": "string"
                },
                "EstimatedDuration": {
                    "description": "The estimated total time required to complete the job.",
                    "longDescription": "This property shall indicate the estimated total time needed to complete the job.  The value is not expected to change while the job is in progress, but the service may update the value if it obtains new information that significantly changes the expected duration.  Services should be conservative in the reported estimate and clients should treat this value as an estimate.",
                    "pattern": "^P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?$",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_1_0"
                },
                "HidePayload": {
                    "description": "An indication of whether the contents of the payload should be hidden from view after the job has been created.  If `true`, responses do not return the payload.  If `false`, responses return the payload.  If this property is not present when the job is created, the default is `false`.",
                    "longDescription": "This property shall indicate whether the contents of the payload should be hidden from view after the job has been created.  If `true`, responses shall not return the `Payload` property.  If `false`, responses shall return the `Payload` property.  If this property is not present when the job is created, the default is `false`.",
                    "readonly": true,
                    "type": "boolean"
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "JobState": {
                    "$ref": "#/definitions/JobState",
                    "description": "The state of the job.",
                    "longDescription": "This property shall indicate the state of the job.",
                    "readonly": false
                },
                "JobStatus": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Health",
                    "description": "The status of the job.",
                    "longDescription": "This property shall indicate the health status of the job.  This property should contain `Critical` if one or more messages in the `Messages` array contains the severity `Critical`.  This property should contain `Warning` if one or more messages in the `Messages` array contains the severity `Warning` and if no messages contain the severity `Critical`.  This property should contain `OK` if all messages in the `Messages` array contain the severity `OK` or if the array is empty.",
                    "readonly": true
                },
                "Links": {
                    "$ref": "#/definitions/Links",
                    "description": "The links to other resources that are related to this resource.",
                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
                    "versionAdded": "v1_2_0"
                },
                "MaxExecutionTime": {
                    "description": "The maximum amount of time the job is allowed to execute.",
                    "longDescription": "The value shall be an ISO 8601 conformant duration describing the maximum duration the job is allowed to execute before being stopped by the service.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Messages": {
                    "description": "An array of messages associated with the job.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Message.json#/definitions/Message"
                    },
                    "longDescription": "This property shall contain an array of messages associated with the job.",
                    "type": "array"
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
                },
                "Payload": {
                    "$ref": "#/definitions/Payload",
                    "description": "The HTTP and JSON request payload details for this job.",
                    "longDescription": "This property shall contain the HTTP and JSON request payload information for executing this job.  This property shall not be included in the response if the `HidePayload` property is `true`."
                },
                "PercentComplete": {
                    "description": "The completion percentage of this job.",
                    "longDescription": "This property shall indicate the completion progress of the job, reported in percent of completion, `0` to `100`.  If the job has not been started, the value shall be zero.",
                    "maximum": 100,
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "%"
                },
                "Schedule": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Schedule.json#/definitions/Schedule",
                    "description": "The schedule settings for this job.",
                    "longDescription": "This object shall contain the scheduling details for this job and the recurrence frequency for future instances of this job."
                },
                "StartTime": {
                    "description": "The date and time when the job was started or is scheduled to start.",
                    "format": "date-time",
                    "longDescription": "This property shall indicate the date and time when the job was last started or is scheduled to start.",
                    "readonly": true,
                    "type": "string"
                },
                "StepOrder": {
                    "description": "The serialized execution order of the job steps.",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This property shall contain an array of `Id` property values for the job steps in the order that they shall be executed.  Each step shall be completed prior to the execution of the next step in array order.  An incomplete list of steps shall be considered an invalid configuration.  If this property is not present or contains an empty array it shall indicate that the step execution order is omitted and may occur in parallel or in series as determined by the service.",
                    "readonly": true,
                    "type": "array"
                },
                "Steps": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/JobCollection.json#/definitions/JobCollection",
                    "description": "The link to a collection of steps for this job.",
                    "longDescription": "This property shall contain the link to a resource collection of type `JobCollection`.  This property shall not be present if this resource represents a step for a job.",
                    "readonly": true
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "JobState": {
            "enum": [
                "New",
                "Starting",
                "Running",
                "Suspended",
                "Interrupted",
                "Pending",
                "Stopping",
                "Completed",
                "Cancelled",
                "Exception",
                "Service",
                "UserIntervention",
                "Continue"
            ],
            "enumDescriptions": {
                "Cancelled": "Job was cancelled.",
                "Completed": "Job was completed.",
                "Continue": "Job is to resume operation.",
                "Exception": "Job has stopped due to an exception condition.",
                "Interrupted": "Job has been interrupted.",
                "New": "A new job.",
                "Pending": "Job is pending and has not started.",
                "Running": "Job is running normally.",
                "Service": "Job is running as a service.",
                "Starting": "Job is starting.",
                "Stopping": "Job is in the process of stopping.",
                "Suspended": "Job has been suspended.",
                "UserIntervention": "Job is waiting for user intervention."
            },
            "enumLongDescriptions": {
                "Cancelled": "This value shall represent that the operation completed because the job was cancelled by an operator.",
                "Completed": "This value shall represent that the operation completed successfully or with warnings.",
                "Continue": "This value shall represent that the operation has been resumed from a paused condition and should return to a Running state.",
                "Exception": "This value shall represent that the operation completed with errors.",
                "Interrupted": "This value shall represent that the operation has been interrupted but is expected to restart and is therefore not complete.",
                "New": "This value shall represent that this job is newly created but the operation has not yet started.",
                "Pending": "This value shall represent that the operation is pending some condition and has not yet begun to execute.",
                "Running": "This value shall represent that the operation is executing.",
                "Service": "This value shall represent that the operation is now running as a service and expected to continue operation until stopped or killed.",
                "Starting": "This value shall represent that the operation is starting.",
                "Stopping": "This value shall represent that the operation is stopping but is not yet complete.",
                "Suspended": "This value shall represent that the operation has been suspended but is expected to restart and is therefore not complete.",
                "UserIntervention": "This value shall represent that the operation is waiting for a user to intervene and needs to be manually continued, stopped, or cancelled."
            },
            "type": "string"
        },
        "Links": {
            "additionalProperties": false,
            "description": "The links to other resources that are related to this resource.",
            "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "CreatedResources": {
                    "description": "An array of URIs referencing the resources created as the result of this job.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
                    },
                    "longDescription": "This property shall contain an array of links to resources indicating the resources created as the result of this job.  Services shall set this property prior to the job entering its final state.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_2_0"
                },
                "CreatedResources@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "Payload": {
            "additionalProperties": false,
            "description": "The HTTP and JSON payload details for this job.",
            "longDescription": "This object shall contain information detailing the HTTP and JSON payload information for executing this job.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "HttpHeaders": {
                    "description": "An array of HTTP headers in this job.",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This property shall contain an array of HTTP headers in this job.",
                    "readonly": true,
                    "type": "array"
                },
                "HttpOperation": {
                    "description": "The HTTP operation that executes this job.",
                    "longDescription": "This property shall contain the HTTP operation that executes this job.",
                    "readonly": true,
                    "type": "string"
                },
                "JsonBody": {
                    "description": "The JSON payload to use in the execution of this job.",
                    "longDescription": "This property shall contain JSON-formatted payload for this job.",
                    "readonly": true,
                    "type": "string"
                },
                "TargetUri": {
                    "description": "The link to the target for this job.",
                    "format": "uri-reference",
                    "longDescription": "This property shall contain link to a target location for an HTTP operation.",
                    "readonly": true,
                    "type": "string"
                }
            },
            "type": "object"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2022.3",
    "title": "#Job.v1_2_4.Job"
}