Delete a software services instance

The delete operation removes a software services instance from the software services registry.

HTTP method and URI path

DELETE /zosmf/provisioning/rest/<version>/scr/<object-id>

In this request, the URI path variables are described, as follows:

<version> identifies the version of the provisioning service. The following value is valid: 1.0.
<object-id> identifies the software services instance to be deleted.

Query parameters

None.

Description

This operation removes a z/OSMF software services instance. The state of a software services instance must be one of the following:

deprovisioned
deprovisioning-failed
provisioning-failed.

Authorization requirements

The user’s z/OS user ID must have READ access to the following resource profile in the ZMFAPLA class: <SAF-prefix>.ZOSMF.PROVISIONING.SOFTWARE_SERVICES.

The user issuing the request must be the owner of the software services instance.

For more information, see Authorization requirements.

HTTP status codes

On successful completion, HTTP status code 204 Normal is returned.

Otherwise, the following HTTP status codes are returned for the indicated errors.

Table 1. HTTP error response codes for a delete software services instance request
HTTP error status code	Description
`HTTP 401 Unauthorized`	The requester user ID is not authorized for this request.
`HTTP 404 Not found`	The specified software services instance was not found because it does not exist.
`HTTP 409 Request conflict`	The software services instance could not be removed because its state was not either deprovisioned, deprovisioning-failed, or provisioning-failed.

Response content

On successful completion, the response body contains nothing.

If a failure occurs, the response body contains a JSON object with a description of the error.

Table 2. Response from a request failure
Field	Type	Description
httpStatus	Integer	HTTP status code.
requestMethod	String	HTTP request method.
requestUri	String	HTTP request URI.
messageID	String	Message identifier for the error.
messageText	String	Message text describing the error.
additionalInfo	String	Additional information describing the error.
debug	String	Debug information about for the error.

Example HTTP interaction

In the following example, the DELTE method is used to delete a software services instance. The software services instance is uniquely identified by a key, which is the string value 76963ea5-81a4-42d6-99d6-f3e19747cf61.

Figure 1. Sample request to delete a software services instance

DELETE /zosmf/provisioning/rest/ 1.0/scr/76963ea5-81a4-42d6-99d6-f3e19747cf61