Published software service template services

The published software service template services are an application programming interface (API), which is implemented through industry standard Representational State Transfer (REST) services. These services allow the caller to create and manage software services templates that are in the published state.

For information about cloud provisioning, including a description of the roles, see Cloud provisioning services.

The published software services catalog contains a list of the software services templates that are in the published state.

Table 1 lists the operations that the published software service template services provide.

Table 1. z/OSMF published software service template services: operations summary
Operation name	HTTP method and URI path
Run a published software service template	`POST /zosmf/provisioning/rest/<version>/psc/<name>/actions/run`
Get a published software service template	`GET /zosmf/provisioning/rest/<version>/psc/<existing-entry-name>`
Get consumer documentation for a published software service template	`GET /zosmf/provisioning/rest/<version>/psc/<existing-entry-name>/documentation/ consumer`
Get prompt variables for a published software service template	`GET /zosmf/provisioning/rest/<version>/psc/<existing-entry-name>/ prompt-variables`
List the published software service templates	`GET /zosmf/provisioning/rest/<version>/psc/`

Authorization requirements

Use of the published software service template services API requires the client to be authenticated. For information about client authentication in z/OSMF, see Authenticating to z/OSMF.

The specific requirements for each published software service template service are described in the topic for that service. For an overview of the security requirements for cloud provisioning roles, see Authorization requirements. For details, see IBM z/OS Management Facility Configuration Guide.

Error response content

For the 4nn HTTP error status codes, additional diagnostic information beyond the HTTP status code is provided in the response body for the request. This information is provided in the form of a JSON object containing the following fields:

Table 2. Response from a software services template request failure
Field	Type	Description
`http-status`	String	HTTP status code.
`request-method`	String	HTTP request method.
`request-uri`	String	HTTP request URI.
`reason`	String	HTTP status reason code.
`message`	String	Message describing the error.
`detailed-message`	String	Message describing the error in more detail.
`debug`	String	Debug information about for the error.

Error logging

Errors from the software services template services are logged in the z/OSMF log. You can use this information to diagnose the problem or provide it to IBM Support, if required. For information about working with z/OSMF log files, see IBM z/OS Management Facility Configuration Guide.

HTTP status codes

The following HTTP status codes are valid:

HTTP 200 OK: The request succeeded. A response body is provided, which contains the results of the request.
HTTP 201 Created: The request succeeded and resulted in the creation of an object.
HTTP 202 Accepted: The request was successfully validated and is performed asynchronously.
HTTP 204 No content: The request succeeded, but no content is available to be returned.
HTTP 400 Bad request: The request contained incorrect parameters.
HTTP 401 Unauthorized: The request cannot be processed because the client is not authorized. This status is returned if the request contained an incorrect user ID or password, or both. Or, the client did not authenticate to z/OSMF by using a valid WWW-Authenticate header.
HTTP 404 Not found: The requested resource does not exist.
HTTP 409 Request conflict: The request cannot be processed because of conflict in the request, such as an edit conflict between multiple updates.

Related information

The run operation for a published template creates a workflow, starts the workflow, and creates a corresponding software services instance in the software services registry. To work with a software services instance, use the REST APIs described in Software services instance services.