GET – Task properties
Use the GET method to retrieve properties in Task resource for Redfish service.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/TaskService/Tasks/{Id}
Request body
None
Response body
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| Id | String | The Id property uniquely identifies this task resource. | ||||||
| Name | String | Task {Id}. | ||||||
| Description | String | "This resource represents a task for a Redfish implementation." | ||||||
| StartTime | String | The date-time stamp that the task was last started. | ||||||
| EndTime | String | The date-time stamp that the task was last completed. | ||||||
| HidePayload | Boolean | This property shall indicate whether the contents of the payload should be hidden from view after the task has been created. | ||||||
| PercentComplete | Integer | This property shall indicate the completion progress of the task, reported in percent of completion. | ||||||
| TaskMonitor | Link | The URI of the Task Monitor for this task. It is a URI for deleting the task when the TaskState is Completed, Exception or Killed. | ||||||
| TaskState | String | The state of the task. | ||||||
| TaskStatus | String | The completion status of the task. The mapping between TaskState and TaskStatus:
| ||||||
| Messages | Object | Expand. | ||||||
| Messages[N] | String | A message associated with the task.. | ||||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"StartTime": "2019-11-12T15:05:12+00:00",
"@odata.id": "/redfish/v1/TaskService/Tasks/e809efa4-0e8f-48fc-86d9-6d4c5b0d2da0",
"Messages": [
{
"@odata.type": "#Message.v1_0_7.Message",
"MessageArgs": [
"e809efa4-0e8f-48fc-86d9-6d4c5b0d2da0"
],
"Message": "The task with id e809efa4-0e8f-48fc-86d9-6d4c5b0d2da0 has completed.",
"Severity": "OK",
"Resolution": "None.",
"MessageId": "TaskEvent.1.0.TaskCompletedOK"
},
{
"@odata.type": "#Message.v1_0_7.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [
null
],
"Severity": "OK",
"Resolution": "None",
"MessageId": "Base.1.5.Success"
},
{
"@odata.type": "#Message.v1_0_7.Message",
"MessageArgs": [
"1",
"/redfish/v1/UpdateService/FirmwareInventory/BMC-Primary",
"BMC-TEI3-10",
"57B-1.20",
"57B-1.20"
],
"Message": "Assignment 1: Resource /redfish/v1/UpdateService/FirmwareInventory/BMC-Primary SoftwareID BMC-TEI3-10 Version 57B-1.20 to Version 57B-1.20.",
"Severity": "OK",
"Resolution": "None",
"MessageId": "LenovoFirmwareUpdateRegistry.1.0.UpdateAssignment"
},
{
"@odata.type": "#Message.v1_0_7.Message",
"Message": "Assignment 1: Apply complete",
"MessageArgs": [
"1"
],
"Severity": "OK",
"Resolution": "None",
"MessageId": "LenovoFirmwareUpdateRegistry.1.0.PayloadApplyCompleted"
}
],
"Id": "e809efa4-0e8f-48fc-86d9-6d4c5b0d2da0",
"HidePayload": true,
"Name": "Task e809efa4-0e8f-48fc-86d9-6d4c5b0d2da0",
"PercentComplete": 100,
"TaskStatus": "OK",
"TaskMonitor": "/redfish/v1/TaskService/fdcf8893-817e-4a6a-b990-264123ba4004",
"TaskState": "Completed",
"EndTime": "2019-11-12T15:06:33+00:00",
"@odata.etag": "\"1573571193473\"",
"@odata.type": "#Task.v1_4_1.Task",
"Description": "This resource represents a task for a Redfish implementation."
}