Delete CPC Hardware Message

The Delete CPC Hardware Message operation deletes a single CPC hardware message. This operation is supported using the BCPii interface.

HTTP method and URI

DELETE /api/cpcs/{cpc-id}/hardware-messages/{hardware-message-id}

URI Variables:

Variable Description
{cpc-id} Object ID of the CPC object.
{hardware-message-id} Element ID of the hardware message to delete.

Description

This operation deletes a specific CPC hardware message. The hardware message to be deleted is identified by the {hardware-message-id} variable in the URI.

The URI path must designate an existing CPC and the API user must have object-access permission to it; otherwise status code 404 (Not Found) is returned.

The URI path must designate an existing hardware message; otherwise, status code 404 (Not Found) is returned. In addition, the API user must have Action/Task permission to the Hardware Messages task; otherwise, status code 403 (Forbidden) is returned.

Authorization requirements

This operation has the following authorization requirements:
  • For the web services interface:
    • Object-access permission to the CPC object designated by {cpc-id}
    • Action/Task permission to the Hardware Messages task.
  • For the BCPii interface the source partition must have receive BCPii security controls permissions for the CPC object.

HTTP status and reason codes

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

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. Delete CPC Hardware Message: 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) 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 API user does not have Action/Task permission for the Hardware Messages task.
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.
4 The CPC designated by the request URI does not support this operation.
322 The element ID in the URI {hardware-message-id} does not designate an existing CPC hardware message.
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.

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

Example HTTP interaction

Figure 1. Delete CPC Hardware Message: Request
DELETE /api/cpcs/0fdde999-5957-3129-99aa-b6f4bfbbc071/hardware-messages/
   d5591a80-43f8-11e4-ac52-42f2e910664b HTTP/1.1
x-api-session: c8un3odpy8yyp150o3poz1ud4gwyfodlwyq495327bpyn2p0z
Figure 2. Delete CPC Hardware Message: Response
204 No Content
date: Mon, 09 Feb 2015 20:07:31 GMT
server: zSeries management console API web server / 2.0

<No response body>