xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/JobService.v1_1_0.json (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/JobService.v1_1_0.json",
    "$ref": "#/definitions/JobService",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2025 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": {
                "#JobService.CancelAllJobs": {
                    "$ref": "#/definitions/CancelAllJobs"
                },
                "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"
        },
        "CancelAllJobs": {
            "additionalProperties": false,
            "description": "Cancels all jobs.",
            "longDescription": "This action shall cancel all jobs.  The service shall transition all jobs to the `Cancelled` state.",
            "parameters": {},
            "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": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object",
            "versionAdded": "v1_1_0"
        },
        "JobService": {
            "additionalProperties": false,
            "description": "The `JobService` schema contains properties for scheduling and execution of operations, represents the properties for the job service itself, and has links to jobs managed by the job service.",
            "longDescription": "This resource shall represent a job service for 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."
                },
                "DateTime": {
                    "description": "The current date and time setting for the job service.",
                    "format": "date-time",
                    "longDescription": "This property shall contain the current date and time setting for the job service.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "JobDocuments": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/JobDocumentCollection.json#/definitions/JobDocumentCollection",
                    "description": "The links to the job document collection.",
                    "longDescription": "This property shall contain a link to a resource collection of type `JobDocumentCollection`.  This property shall only be present if the service supports document-based jobs.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "JobExecutors": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/JobExecutorCollection.json#/definitions/JobExecutorCollection",
                    "description": "The links to the job executor collection.",
                    "longDescription": "This property shall contain a link to a resource collection of type `JobExecutorCollection`.  This property shall only be present if the service supports document-based jobs.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "Jobs": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/JobCollection.json#/definitions/JobCollection",
                    "description": "The links to the jobs collection.",
                    "longDescription": "This property shall contain a link to a resource collection of type `JobCollection`.",
                    "readonly": true
                },
                "Log": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/LogService.json#/definitions/LogService",
                    "description": "The link to a log service that the job service uses.  This service can be a dedicated log service or a pointer to a log service under another resource, such as a manager.",
                    "longDescription": "This property shall contain a link to a resource of type `LogService` that this job service uses.",
                    "readonly": true
                },
                "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."
                },
                "ServiceCapabilities": {
                    "$ref": "#/definitions/JobServiceCapabilities",
                    "description": "The supported capabilities of this job service implementation.",
                    "longDescription": "This property shall contain properties that describe the capabilities or supported features of this implementation of a job service."
                },
                "ServiceEnabled": {
                    "description": "An indication of whether this service is enabled.",
                    "longDescription": "This property shall indicate whether this service is enabled.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "Status": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
                    "description": "The status and health of the resource and its subordinate or dependent resources.",
                    "longDescription": "This property shall contain any status or health properties of the resource."
                },
                "ValidationPolicy": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/ValidationPolicy"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The policy for how document-based jobs are validated.",
                    "longDescription": "This property shall contain policy for how document-based jobs are validated.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "JobServiceCapabilities": {
            "additionalProperties": false,
            "description": "The supported capabilities of this job service implementation.",
            "longDescription": "This type shall contain properties that describe the capabilities or supported features of this implementation of a job service.",
            "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": {
                "DocumentBasedJobs": {
                    "description": "An indication of whether document-based jobs are supported.",
                    "longDescription": "This property shall indicate whether document-based jobs are supported.  Document-based jobs are jobs that are created by performing the `SubmitJob` action on a `JobDocument` resource in the `JobDocumentCollection` resource referenced by the `JobDocuments` property.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_1_0"
                },
                "MaxJobs": {
                    "description": "The maximum number of jobs supported.",
                    "longDescription": "This property shall contain the maximum number of jobs supported by the implementation.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "MaxSteps": {
                    "description": "The maximum number of job steps supported.",
                    "longDescription": "This property shall contain the maximum number of steps supported by a single job instance.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "Scheduling": {
                    "description": "An indication of whether scheduling of jobs is supported.",
                    "longDescription": "This property shall indicate whether the `Schedule` property within the job supports scheduling of jobs.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "UserSpecifiedJobs": {
                    "description": "An indication of whether user-specified jobs are supported.",
                    "longDescription": "This property shall indicate whether user-specified jobs are supported.  User-specified jobs are jobs that are created by performing an HTTP `POST` operation on the `JobCollection` resource referenced by the `Jobs` property.",
                    "readonly": true,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_1_0"
                }
            },
            "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"
        },
        "ValidationPolicy": {
            "enum": [
                "Automatic",
                "Manual",
                "Bypass"
            ],
            "enumDescriptions": {
                "Automatic": "Jobs are validated automatically.",
                "Bypass": "Jobs are not validated.",
                "Manual": "Jobs are validated manually."
            },
            "enumLongDescriptions": {
                "Automatic": "This value shall indicate that jobs are validated automatically.  The `JobState` property of a new job shall contain `Validating` when created with the `SubmitJob` action from the `JobDocument` resource.",
                "Bypass": "This value shall indicate jobs are not validated.  The `JobState` property of a new job shall contain `Pending` when created with the `SubmitJob` action from the `JobDocument` resource.",
                "Manual": "This value shall indicate jobs are validated manually.  The `JobState` property of a new job shall contain `New` when created with the `SubmitJob` action from the `JobDocument` resource and wait for a user to perform the `Validate` action in the `Job` resource."
            },
            "type": "string"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2025.2",
    "title": "#JobService.v1_1_0.JobService"
}