Delete Partition Link

The Delete Partition Link operation deletes the identified partition link asynchronously.

POST /api/partition-links/{partition-link-id}/operations/delete

In this request, the URI variable {partition-link-id} is the object ID of the Partition Link object to be deleted.

Once the operation has completed, a job-completion notification is sent and results are available for the asynchronous portion of this operation. These results are retrieved using the Query Job Status operation directed at the job URI provided in the response body.

The result document returned by the Query Job Status operation is specified in the description for Query Job Status. When the status of the job is "complete", the results include a job completion status code and reason code (fields job-status-code and job-reason-code) which are set as indicated in Job status and reason code. The job-results field contains null when this operation is successful. When it is not successful, the job-results field contains an object with the following fields:

This operation asynchronously deletes the designated partition link. Once the delete request is accepted, a 202 (Accepted) status code is returned and the response body contains a URI that may be queried to retrieve the status of the operation. See Query Job Status for information on how to query job status. When the operation has completed, an asynchronous result message is sent, with Job Status and Reason Codes described in Job status and reason code.

The deletion first detaches all partitions currently associated with the partition link. The partition link stays in "updating" state until all partitions have been detached successfully. Only after detaching all partitions, the partition link itself is deleted. If the detach operation for a any partition fails due to an error, the deletion of the partition link is aborted and a job status and reason code is returned describing the failure. If the API user does not have action/task permission to the Delete Partition Link task, a 403 (Forbidden) status code is returned. A 404 (Not Found) status code is returned if the object-id {partition-link-id} does not identify a Partition Link object for which the API user has object-access permission. If the status of the partition link, the parent CPC, or any associated partition is not in a valid state, a 409 (Conflict) status code is returned. A 409 (Conflict) status code is also returned if the API user does not have object-access permission to all partitions currently associated with the partition link.

This operation has the following authorization requirement:

  • Object-access permission to the partition link whose object-id is {partition-link-id}.
  • Object-access permissions to all Partition objects currently connected to the partition link whose object-id is {partition-link-id}.
  • Action/task permission to the Delete Partition Link task.

On success, HTTP status code 204 (No Content) 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 and associated error message.

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