Skip to main content

GET – Firmware update job properties

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

Request URL​

GET https://<BMC_IPADDR>/v1/JobService/Jobs/FW_Update_{N}

Request body​

None

Response body​

Field

Type

Description

Id

String

FW_Update_{N}

Name

String

Same as Id.

Description

String

This resource is used to represent a job for a Redfish implementation.

JobStatus

String

This property shall indicate the health status of the job.

JobState

String

This property shall indicate the state of the job.

Messages

Array

Indicates current update messages.

StartTime

String

The start time of this job.

EndTime

String

The end time of this job.

PercentComplete

Integer

The completion percentage of this job.

Steps

Link

A link to JobCollection.

StepOrder

Array

Items: string

Item count: number of step jobs.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "@odata.context": "/redfish/v1/$metadata#Job.Job",
    "@odata.etag": "\"776850C7\"",
    "@odata.id": "/redfish/v1/JobService/Jobs/FW_Update_1",
    "@odata.type": "#Job.v1_1_1.Job",
    "Description": "This resource is used to represent a job for a Redfish implementation.",
    "EndTime": "2024-12-03T20:35:55+00:00",
    "Id": "FW_Update_1",
    "JobState": "Completed",
    "JobStatus": "OK",
    "Messages": [
        {
            "@odata.type": "#Message.v1_1_1.Message",
            "Message": "The target device '/redfish/v1/UpdateService/                        FirmwareInventory/BMC-Backup' will be updated with                         image 'lnvgy_fw_xcc-dur_ihx407y-0.80_anyos_comp.uxz'.",
            "MessageArgs": [
                "/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup",
                "lnvgy_fw_xcc-dur_ihx407y-0.80_anyos_comp.uxz"
            ],
            "MessageId": "Update.1.0.1.TargetDetermined",
            "MessageSeverity": "OK",
            "Resolution": "None."
        },
        {
            "@odata.type": "#Message.v1_1_1.Message",
            "Message": "Device '/redfish/v1/UpdateService/FirmwareInventory/                        BMC-Backup' successfully updated with image                         'lnvgy_fw_xcc-dur_ihx407y-0.80_anyos_comp.uxz'.",
            "MessageArgs": [
                "/redfish/v1/UpdateService/FirmwareInventory/BMC-Backup",
                "lnvgy_fw_xcc-dur_ihx407y-0.80_anyos_comp.uxz"
            ],
            "MessageId": "Update.1.0.1.UpdateSuccessful",
            "MessageSeverity": "OK",
            "Resolution": "None."
        }
    ],
    "Name": "FW_Update_1",
    "PercentComplete": 100,
    "StartTime": "2024-12-03T20:35:39+00:00",
    "StepOrder": [
        "BMC-Backup"
    ],
    "Steps": {
        "@odata.id": "/redfish/v1/JobService/Jobs/FW_Update_1/Steps"
    }
}