List Capacity Records

The List Capacity Records operation lists the capacity record for a given CPC that are managed by this HMC. This operation is supported using the BCPii interface.

HTTP method and URI

GET /api/cpcs/{cpc-id}/capacity-records

In this request, the URI variable {cpc-id} is the object ID of the target CPC object.

Response body contents

On successful completion, the response body contains a JSON object with the following fields:

Field name Type Description
capacity-record Array of objects Array of nested objects (described in the next table).

Each nested object contains the following fields:

Field name Type Description
element-uri String/ URI Canonical URI path of the Capacity Record object.
record-identifier String The record identifier of the Capacity Record
target-name String (1-17) The value that must be used on the X-API-Target-Name request header when performing and operation on this object.
Note: This property is only returned when the BCPii interface was used for the request.

Description

This operation lists the capacity record for a given CPC.

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

Authorization requirements

This operation has the following authorization requirement:
  • For the web services interface, object-access permission to the CPC object designated by {cpc-id}
  • For the BCPii interface, the source partition must have receive BCPii security controls permissions for the CPC object designated by {cpc-id}.

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.

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) 0 The request used the BCPii interface and the source partition does not have receive BCPii security controls permission for the CPC object.
404 (Not Found) 1 The object ID in the URI ({cpc-id}) does not designate an existing CPC object, or the API user does not have object-access permission to the object.
409 (Conflict) 329 The operation cannot be performed because the CPC designated by the request URI is an unmanaged CPC, which is not supported by this operation.
500 (Server Error) 275 An unexpected error occurred during the operation.
503 (Service Unavailable) 1 The request could not be processed because the HMC is not 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.