Get consumer documentation for a published software service template

Use this operation to retrieve the consumer documentation for a published software service template from the catalog.

HTTP method and URI path

GET /zosmf/provisioning/rest/<version>/psc/<existing-entry-name>/documentation/
consumer

In this request:

<version>: Is the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
<existing-entry-name>: Identifies the software services template to be retrieved.
documentation/consumer: Causes the consumer documentation file to be retrieved.

Query parameters

None.

Description

This operation retrieves the consumer documentation for a published software service template from the catalog.

On successful completion, HTTP status code 200 (OK) is returned, indicating that the request resulted in the consumer documentation for a software services template being retrieved.

Request content

None.

Authorization requirements

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

HTTP status codes

On successful completion, HTTP status code 200 (OK) is returned.

Response content

None.

Example HTTP interaction

In Figure 1, a request is submitted to retrieve consumer documentation for a software services template.

Figure 1. Sample request to get consumer documentation for a software services template

GET https://localhost:4444/zosmf/provisioning/rest/1.0/psc/bringUpDB2/documentation/consumer