Delete Group Profile

The Delete Group Profile operation deletes a Group profile, by profile name designated by {group-profile-name} from the Support Element. This operation is supported using the BCPii interface. [Added by feature create-delete-activation-profiles]

HTTP method and URI

DELETE /api/cpcs/{cpc-id}/group-profiles/{group-profile-name}
URI variables:
Table 1.
Variable Description
{cpc-id} Object ID of the target CPC object.
{group-profile-name} Group Profile name.

Description

The Delete Group Profile operation deletes a Group profile from the SE. This profile will be deleted based on the {group-profile-name}.

The URI path must designate an existing Group Profile and the API user must have object-access permission to the CPC. If either of these conditions is not met, status code 404 (Not Found) is returned.

On success, HTTP status code 204 (No Content) is returned.

Authorization requirements

This operation has the following authorization requirements:

For the web services interface:
  • 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 204 (No Content) is returned and no response body is provided.

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.

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.
1 The user under which the API request was authenticated does not have the required authority to perform the requested action.
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 activation profile name in the URI ({group-profile-name}) does not designate an existing Group Profile.
409 (Conflict) 2 The operation was rejected by the Support Element (SE), because the SE is currently performing processing that requires exclusive control of the SE. Retry the operation at a later time.
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.

Example HTTP interaction

Figure 1. Delete Group Profile: Request
DELETE /api/cpcs/92525d83-50e8-34a2-8f83-73f375ea85ae/group-profiles/TESTGRP1
x-api-session: 5hirq4lowb9dweimnmoedk5u1qk2ltlfo9f56xrs9kux6w6gzv
Figure 2. Delete Group Profile: Response
204 No Content
server: zSeries management console API web server / 2.0
cache-control: no-cache
date: Tue, 16 May 2023 00:33:27 GMT

<No response body>