Update Storage Site Properties

The Update Storage Site Properties operation updates one or more of the writable properties of a storage site.

HTTP method and URI

POST /api/storage-sites/{storage-site-id}

In this request, the URI variable {storage-site-id} is the object ID of the Storage Site object.

Request body contents

The request body is expected to contain a JSON object that provides the new value of any writable property that is to be updated by this operation. Field names and data types in this JSON object are expected to match the corresponding property names and data types defined in the Data model. The JSON object can and should omit fields for properties whose values are not to be changed by this operation.

Description

This operation updates a storage site's properties with the values specified.

If the API user does not have action/task permission to the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks, a 403 (Forbidden) status code is returned. A 404 (Not Found) status code is returned if the object ID {storage-site-id} does not identify a Storage Site object on the HMC. If the FICON® configuration associated with the CPC identified by the URI in the storage site’s cpc-uris property already contains a storage site with the specified name, a 400 (Bad Request) status code is returned.

If the request body fails to validate, a 400 (Bad Request) status code is returned.

If the request body contents are valid, the storage site's properties are updated to their corresponding request body content's field's values. All fields are optional and may be excluded from the request body; if a field is not found in the request body, its property's value will not be modified.

If the update changes the value of any property for which property-change notifications are due, those notifications are emitted asynchronously to this operation.

Authorization requirements

This operation has the following authorization requirement:
  • Action/task permission to the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks.

HTTP status and reason codes

On success, HTTP status code 204 (No Content) is returned and no response body is provided.

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

Table 1. Update Storage Site 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.
8 A storage site with the name specified in the request body already exists within the FICON configuration associated with the CPC identified by the URI in the cpc-uris property of the storage site with the object-id {storage-site-id}.
403 (Forbidden) 1 The API user does not have action/task permission to the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks.
404 (Not Found) 1 The storage site with the object-id {storage-site-id} does not exist on the HMC.
409 (Conflict) 2 The storage site object with the object-id {storage-site-id} was busy and the request timed out.
503 (Service Unavailable 1 The request could not be processed because the HMC is not currently communicating with the SE needed to perform the requested operation.

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

Example HTTP interaction

Figure 1. Update Storage Site Properties: Request
POST /api/storage-sites/13ff101c-941f-11e8-a0c0-fa163e27d492 HTTP/1.1
x-api-session: 1uhgm42bm5vbmtbwrvvpqqic5u3ffc4aqz40cjwtsjlcpm042
content-type: application/json
content-length: 51
{
   "description":"Primary site",
   "name":"New York"
}
Figure 2. Update Storage Site Properties: Response
204 No Content
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Mon, 30 Jul 2018 20:08:16 GMT

<No response body>