Get Group Profile Properties
The Get Group Profile Properties operation retrieves the properties of a single Group Profile designated by {group-profile-name}. This operation is supported using the BCPii interface.
HTTP method and URI
GET /api/cpcs/{cpc-id}/group-profiles/{group-profile-name}
URI variables
Variable | Description |
---|---|
{cpc-id} | Object ID of the target CPC object. |
{group-profile-name} | Group Profile name. |
Query parameters:
Name | Type | Rqd/Opt | Description |
---|---|---|---|
properties | List of String Enum | Optional | Filter string to limit returned properties to those that are identified here. This is a list of comma-separated strings where each string is a property name defined in the object's data model. |
Response body contents
On successful completion, the response body provides the current values of the properties for the Group Profile as defined in the Data model.
Description
The URI path must designate an existing Group Profile and the API user must have object-access permission to the associated CPC object. If either of these conditions is not met, HTTP status code 404 (Not Found) is returned.
If the properties query parameter is specified, the response body contains only the requested properties. The presence and value of each requested property is the same as it is when the properties query parameter is not specified. That is, it may be omitted or contain a special value, such as null, -1, or an empty string, if a prerequisite condition is not met. If the properties parameter is omitted, no such filtering is performed.
On successful execution, HTTP status code 200 (OK) is returned and the response body contains all of the current properties as defined by the data model for the Group Profile.
Authorization requirements
This operation has the following authorization requirements:
- Object-access permission to the CPC object designated by {cpc-id}.
- If any of the effective-* properties is to be updated, action/task permission for the Change LPAR Group Controls task.
- For all other properties, action/task permission for the Customize/Delete Activation Profiles task.
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. |
260 | The group profile name in the URI ({group-profile-name}) does not designate an existing group profile. | |
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) | 281 | 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.