Get software services template documentation

Use this operation to retrieve software services template documentation from the catalog.

HTTP method and URI path

GET /zosmf/provisioning/rest/<version>/scc/<object-id>/documentation/admin
GET /zosmf/provisioning/rest/<version>/scc/<object-id>/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.
<object-id>: Identifies the software services template to retrieve.
documentation/admin: Causes the administrator documentation file to be retrieved.
documentation/consumer: Causes the consumer documentation file to be retrieved.

Query parameters

None.

Description

This operation retrieves software services template documentation from the catalog.

On successful completion, the operation returns HTTP status code 200 (OK), indicating that the request resulted in software services template documentation being retrieved.

Request content

None.

Authorization requirements

The user's z/OS user ID must be defined as a landlord, domain administrator, domain approver, or template 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 (OK) is returned.

Response content

The documentation file in the associated mime type.

Example HTTP interaction

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

Figure 1. Sample request to retrieve software services template documentation

GET https://localhost:4444/zosmf/provisioning/rest/1.0/scc/5ccbad22-94fd-4b31-bb2b-95aa8602cc48/documentation/consumer