Skip to main content

GET – Job properties

Use the GET method to retrieve properties in Job resource for Redfish service

Request URL​

GET https://<BMC_IPADDR>/v1/JobService/Jobs/{PowerOff, PowerOn, Restart}

Request body​

None

Response body​

Field

Type

Description

Description

String

The resource is used to represent the settings of scheduled {Power Off|Power On|Restart} actions for a Redfish implementation.

HidePayload

Boolean

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`.

Id

String

PowerOff, PowerOn, Restart

JobState

String

This property shall indicate the state of the job.

JobStatus

String

This property shall indicate the health status of the job.

MaxExecutionTime

String

Null

The maximum amount of time the job is allowed to execute.

Messages

Array

Items: object Item count: 0~1

 

Messages[N]

Object

An array of messages associated with the job.

Name

String

PowerOff, PowerOn, Restart

PercentComplete

Integer

Null

The completion percentage of this job.

Schedule

Object

The schedule settings for this job.

 

EnabledDaysOfWeek

Array

Expand.

  

EnabledDaysOfWeek[N]

String

Days of the week when scheduled occurrences are enabled, for enabled days of the month and months of the year. If not present, all days of the week are enabled.

 

EnabledDaysOfWeek@Redfish.AllowableValues

Array

Items: string Item count: 8

  

EnabledDaysOfWeek@Redfish.AllowableValues[N]

String

“Monday”,“Tuesday”,“Wednesday”,“Thursday”,“Friday”,“Saturday”,“Sunday”,“Every”

 

InitialStartTime

Date-Time

The date and time when the initial occurrence is scheduled to occur.

 

RecurrenceInterval

String

The amount of time until the next occurrence occurs.

 

Name

String

The name of the schedule. Value: “Lenovo:{Power Off|Power On|Restart}”

StepOrder

Array

The serialized execution order of the job Steps.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "MaxExecutionTime": null,
    "JobStatus": "OK",
    "Id": "Restart",
    "@odata.id": "/redfish/v1/JobService/Jobs/Restart",
    "HidePayload": true,
    "Messages": [],
    "PercentComplete": null,
    "StepOrder": [],
    "@odata.type": "#Job.v1_0_3.Job",
    "JobState": "Suspended",
    "Name": "Restart",
    "@odata.etag": "\"41754a37fca8f52fe536e42dbcf4c544\"",
    "Schedule": {
        "RecurrenceInterval": null,
        "InitialStartTime": null,
        "EnabledDaysOfWeek@Redfish.AllowableValues": [
            "Monday",
            "Tuesday",
            "Wednesday",
            "Thursday",
            "Friday",
            "Saturday",
            "Sunday",
            "Every"
        ],
        "Name": "Lenovo:Restart",
        "EnabledDaysOfWeek": []
    },
    "Description": "The resource is used to represent the settings of scheduled Restart actions for a Redfish implementation."
}