Get Console Remote Firmware Update Properties

The Get Console Remote Firmware Update Properties operation retrieves the properties of a single Remote Firmware Update element object.

HTTP method and URI

GET /api/console/remote-firmware-updates/{remote-firmware-update-id}

In this request, the URI variable {remote-firmware-update-id} is the element ID of the Remote Firmware Update object.

Response body contents

On successful completion, the response body is a JSON object that provides the current values of the properties for the Remote Firmware Update Console element object as defined in the Remote Firmware Update Console element object. Field names and data types in the JSON object are the same as the property names and data types defined in the Data model.

Description

Returns the current values for the properties of the remote firmware update element object as defined in Remote Firmware Update Console element object.

See Authorize Remote Firmware Updates for a description of the complete remote firmware update process.

If the API user does not have action/task permission to the Manage Remote Firmware Updates task, a 403 (Forbidden) status code is returned. A 404 (Not Found) status code is returned if {remote-firmware-update-id} does not identify a Remote Firmware Update element object on the Console.

Authorization requirements

This operation has the following authorization requirement:
  • Action/task permission to the Manage Remote Firmware Updates task.

HTTP status and reason codes

On success, HTTP status code 200 (OK) is returned and the response body is provided as described in Response body contents.

The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and associated error message.

Table 1. Get Console Remote Firmware Update Properties: HTTP status and reason codes
HTTP error status code Reason code Description
400 (Bad Request) Various Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.
403 (Forbidden) 1 The API user does not have action/task permission to the Manage Remote Firmware Updates task.
404 (Not Found) 5 A remote firmware update operation with element-id {remote-firmware-update-id} does not exist in the Console.

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. Get Console Remote Firmware Update Properties: Request
GET /api/console/remote-firmware-updates/de52dc87-adb4-4cba-a8c7-cb1c4516f495 HTTP/1.1
x-api-session: 1mxapd2skpb1pzv6ow9oan6zpus4veno8w81v23s74louuaut3
Figure 2. Get Console Remote Firmware Update Properties: Response
200 OK
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Fri, 19 Feb 2021 17:52:00 GMT
content-type: application/json;charset=UTF-8
content-length: 496
{
   "backup-location":"usb",
   "class":"remote-firmware-update",
   "creation-time":1613757008319,
   "element-id":"de52dc87-adb4-4cba-a8c7-cb1c4516f495",
   "element-uri":"/api/console/remote-firmware-updates/de52dc87-adb4-4cba-a8c7-cb1c4516f495",
   "execution-window":60,
   "parent":"/api/console",
   "scheduled-execution-time":1614924900000,
   "service-contact-email-address":"ssrEmail@example.com",
   "service-contact-name":"ssrName",
   "service-contact-telephone-number":"01233456789",
   "state":"scheduled",
   "target-bundle":"H33"
}