Skip to main content

GET /nodes/{uuid}/jobs/{job-id}

Use this method to return the return active job information on a specific ThinkSystem or ThinkAgile server.

Note
This REST API requires Lenovo XClarity Administrator v4.2.0 or later.

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/nodes/{uuid}/jobs/{job-id}
where

  • {uuid iis the UUID of the server

  • {job-id} is the ID of the job to be returned

Query parameters​

ParameterRequired / OptionalDescription
IncludeDetail={Boolean}OptionalIndicates whether to return job details. This can be one of the following values.
  • true. Returns information about the job, steps, and members.
  • false. (default) Returns information only about the job.
The following example returns information only about the job.
GET https://192.0.2.0/nodes/b7d353d9a8019a434aa8948a6d16f3/tasks/7
The following example returns information about the job, steps, and members.
GET https://192.0.2.0/nodes/b7d353d9a8019a434aa8948a6d16f3/tasks/7?IncludeDetail=true

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
IdStringJob ID
DescriptionStringJob description
EndTimeStringTimestamp, in ISO-8601 format, when the job completed
JobStateStringJob state
JobStatusStringJob status
MessagesArray of objectsInformation about each message for the overall job
 MessageStringMessage text
 MessageArgsStringList of message arguments
 MessageIdStringMessage ID
 MessageSeverityStringMessage severity
 ResolutionStringMessage resolution
 @odata.typeString 
NameStringJob name
PercentCompleteStringPercentage complete of the job. This can be an integer from 0 - 100.
StartTimeStringTimestamp, in ISO-8601 format, when the job started
StepOrderArray of strings 
StepsArray of objectsInformation about each task in the job
 DescriptionStringTask description
 MembersArray of objects 
  IdStringTask ID
  JobStateStringTask state
  JobStatusStringTask status
  MessagesArray of objectsInformation about each message for the substep
   MessageStringMessage text
   MessageArgsArray of stringsList of message arguments
   MessageIdStringMessage ID
   MessageSeverityStringMessage severity
   ResolutionStringMessage resolution
   @odata.typeString 
  NameStringTask name
  PercentCompleteStringPercentage complete of the task. This can be an integer from 0 - 100.
  StartTimeStringTimestamp, in ISO-8601 format, when the task completed
  @odata.idString 
 NameStringTask name
 @odata.idString 
@odata.idString 
The following example is returned if the request is successful and includeDetails is false.
{
    "Id": "FW_Update_6",
    "Description": "This resource is used to represent a job for a Redfish implementation.",
    "EndTime": "2025-01-20T08:45:36+00:00",
    "JobState": "Exception",
    "JobStatus": "Critical",
    "Messages": [{
        "Message": "The target device '/redfish/v1/UpdateService/FirmwareInventory/SCM-FPGA' will be updated with image 'ef3a7e0b-aa14-441c-8af1-3276dd724f2c'.",
        "MessageArgs": [
            "/redfish/v1/UpdateService/FirmwareInventory/SCM-FPGA",
            "ef3a7e0b-aa14-441c-8af1-3276dd724f2c"
        ],
        "MessageId": "Update.1.0.1.TargetDetermined",
        "MessageSeverity": "OK",
        "Resolution": "None.",
        "@odata.type": "#Message.v1_1_1.Message"
    }],
    "Name": "FW_Update_6",
    "PercentComplete": 0,
    "StartTime": "2025-01-20T08:43:54+00:00",
    "StepOrder": [ "lnvgy_fw_dcscm_ihfs01n-2.44_anyos_comp.uxz" ],
    "Steps": {
        "Description": null,
        "Members": [],
        "Name": null,
        "@odata.id": "/redfish/v1/JobService/Jobs/FW_Update_33/Steps"
    },
    "@odata.id": "/redfish/v1/JobService/Jobs/FW_Update_6"
}
The following example is returned if the request is successful and includeDetails is true.
{
    "Id": "FW_Update_6",
    "Description": "This resource is used to represent a job for a Redfish implementation.",
    "EndTime": "2025-01-20T08:45:36+00:00",
    "JobState": "Exception",
    "JobStatus": "Critical",
    "Messages": [{
        "Message": "The target device '/redfish/v1/UpdateService/FirmwareInventory/SCM-FPGA' will be updated with image 'ef3a7e0b-aa14-441c-8af1-3276dd724f2c'.",
        "MessageArgs": [
            "/redfish/v1/UpdateService/FirmwareInventory/SCM-FPGA",
            "ef3a7e0b-aa14-441c-8af1-3276dd724f2c"
        ],
        "MessageId": "Update.1.0.1.TargetDetermined",
        "MessageSeverity": "OK",
        "Resolution": "None.",
        "@odata.type": "#Message.v1_1_1.Message"
    }],
    "Name": "FW_Update_6",
    "PercentComplete": 0,
    "StartTime": "2025-01-20T08:43:54+00:00",
    "StepOrder": [ "lnvgy_fw_dcscm_ihfs01n-2.44_anyos_comp.uxz" ],
    "Steps": {
        "Description": "A collection of Job resource instances.",
        "Members": [{
            "Id": "lnvgy_fw_dcscm_ihfs01n-2.44_anyos_comp.uxz",
            "JobState": "Exception",
            "JobStatus": "OK",
            "Messages": [{
                "Message": "Awaiting for an action to proceed with installing image 'ef3a7e0b-aa14-441c-8af1-3276dd724f2c' on '/redfish/v1/UpdateService/FirmwareInventory/SCM-FPGA'.",
                "MessageArgs": [
                    "ef3a7e0b-aa14-441c-8af1-3276dd724f2c",
                    "/redfish/v1/UpdateService/FirmwareInventory/SCM-FPGA"
                ],
                "MessageId": "Update.1.0.1.AwaitToUpdate",
                "MessageSeverity": "OK",
                "Resolution": "Perform the requested action to advance the update operation.",
                "@odata.type": "#Message.v1_1_1.Message"
            }],
            "Name": "lnvgy_fw_dcscm_ihfs01n-2.44_anyos_comp.uxz",
            "PercentComplete": 0,
            "StartTime": "2025-01-20T08:43:54+00:00",
            "@odata.id": "/redfish/v1/JobService/Jobs/FW_Update_6/Steps/lnvgy_fw_dcscm_ihfs01n-2.44_anyos_comp.uxz"
        }],
        "Name": "FW_Update_6 Job Steps",
        "@odata.id": "/redfish/v1/JobService/Jobs/FW_Update_6/Steps"
    },
    "@odata.id": "/redfish/v1/JobService/Jobs/FW_Update_6"
}