Run a published software service template

Use this operation to run a software services template that is in the published state.

HTTP method and URI path

POST /zosmf/provisioning/rest/<version>/psc/<name>/actions/run

In this request:

<version>: Is the URI path variable <version> that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
<name>: Identifies the software services template to be run.

Query parameters

None.

Description

This operation creates a workflow, starts the workflow, and creates a corresponding software services instance in the software services registry, with a state of being-provisioned.

To work with a software services instance, use the REST APIs described in Software services instance services.

Request content

The request content is expected to contain a JSON object as described in Table 1 and Table 2.

Table 1. Request content for the run software services template request
Field name	Type	Required or optional	Description
input-properties	Array of Objects	Optional	An array of required runtime property objects
domain-name	String	Optional	Required if the user has consumer authorization to more than one domain with this template name.
tenant-name	String	Optional	Required if the user has consumer authorization to more than one tenant in the same domain that contains this template name.
user-data-id	String	Optional	ID for the user data specified with user-data. Passed into the software services registry.
account-info	String	Optional	Account information to use in the JCL JOB statement. The default is the account information that is associated with the resource pool for the tenant.
user-data	String	Optional	User data that is passed into the software services registry. Can be specified only if user-data-id is provided.

Table 2. Run-Time Property
Field	Type	Description
name	String	Name of the required runtime property.
value	String	Value of the required runtime property.

Authorization requirements

The user ID must be in a tenant that the template is associated with, or be an approver.

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.

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.

Response content

On successful completion, the service returns a response body, which contains a JSON object, as described in Table 3.

Table 3. Response from a run software services template version request
Field	Type	Description
`registry-info`	Object	Object mapping that matches the response body returned from a registry create action.
`workflow-info`	Object	Object mapping that matches the response body returned from a workflow create action.

Example HTTP interaction

In Figure 1, a request is submitted to run the software services template named bringUpDB2.

Figure 1. Sample request to run a software services template

POST https://localhost:4444/zosmf/provisioning/rest/1.0/psc/bringUpDB2/actions/run


{
     "input-properties":[{"name":"CSQ_MQ_SSID","value":"ZCT1"},
     {"name":"CSQ_CMD_PFX","value":"!ZCT1"},{"name":"CSQ_ENVIRONMENT","value":"TEST"}],
     "domain-name":"default",
     "tenant-name":"tenant1"
 }

The following is the response body for the request.

Figure 2. Sample response body

{
   "registry-info": {
     "object-name": "QMgr_7",
     "object-id": "c5a8ecdd-db35-466b-aad9-cba0f33bb84b",
     "object-uri": "/zosmf/provisioning/rest/1.0/scr/c5a8ecdd-db35-466b-aad9-cba0f33bb84b"
   },
   "workflow-info": {
     "workflowKey": "ff96459f-27fa-490a-a3e4-4086649c12f3",
     "workflowDescription": "Procedure to provision a MQ for zOS Queue Manager",
     "workflowID": "ProvisionQueueManager",
     "workflowVersion": "1.0.1",
     "vendor": "IBM"
   }
 }