Perform an action against a software services instance

HTTP method and URI path

POST /zosmf/provisioning/rest/<version>/scr/<object-id>/actions/<action>

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.
<action> identifies the action to be performed.

Query parameters

None.

Description

This operation performs an action against a software services instance.

On successful completion, HTTP status code 200 (Normal) is returned and the response body is provided, as described in Response content.

Request content

The request content is expected to contain a JSON object. See Table 1 for the fields.

Table 1. Request content for the perform action software services instance request
Field name	Type	Required or optional	Description
input-variables	input Variable[]	Optional	The input variables to be used by workflow-type actions. See Table 2.

Table 2. Input variable structure
Field	Type
name	String
value	String

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, or, for catalog registry type objects, a domain administrator of the software services instance, or, for general registry type objects, the landlord.

For more information, see Authorization requirements.

HTTP status codes

On successful completion, HTTP status code 200 (Normal) is returned and the response body is provided, as described in Response content.

Otherwise, the following HTTP status codes are returned for the indicated errors. The response body is a standard error response body providing the reason code that is indicated and associated error message.

Table 3. HTTP error response codes for a do action request
HTTP error status code	Description
HTTP 400 Eror	Bad request.
HTTP 401 Unauthorized	The requestor 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.

Response content

On successful completion, the response body contains a JSON object consisting of the response from the action.

Table 4. Resonse body for the do action request
Field name	Type	Description
action-id	String	The ID of the action object that was created by running the action. The action ID is used on further requests to the action object.
action-uri	String	The URI of the new action object.

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

Table 5. 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 POST method is used to perform an action for a software services instance.

Figure 1. Sample request to perform an action against a software services instance variables

POST /zosmf/provisioning/rest/1.0/scr/81963ea5-81a4-42d6-99d6-f3e19747cf61/actions/start

An example of the response is shown in the figures that follow.

Figure 2. Sample response from a get software services instance variables request

{
"action-id":"65963ea5-81a4-42d6-99d6-f3e19748cf61",
"action-uri":
"/zosmf/provisioning/rest/1.0/scr/76963ea5-81a4-42d6-99d6-f3e19747cf61/actions/65963ea5-81a4-42d6-99d6-f3e19748cf61"
}