Start of change

Publish a software services template

You can use this operation to publish a software services template. The publish operation locks the template, preventing any further modification, and creates a public copy of it.

HTTP method and URI path

POST /zosmf/provisioning/rest/<version>/scc/<object-id>/actions/publish
In this request
<object-id>
Identifies the software services template to be published.
<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.

Query parameters

None.

Description

This operation publishes a software services template.

On successful completion, HTTP status code 204 (Normal) is returned, indicating that the request resulted in a software services template being published.

The software services template must be in the draft, draft approved, or archived state.

To work with a published software services template, use the REST APIs that are described in Published software service template services.

Request content

The request body is optional. It contains a JSON object that describes the publish operation. See Table 1.

Table 1. Request content for the software services template request
Parameter Type Required or Optional Description
archive-existing boolean Optional If set to true, indicates that if a published entry with this name already exists, that entry should be moved into the archived state, and publish this one instead.

If set to false, indicates that if a published entry with this name already exists, the request should fail. False is the default if this parameter is not specified.

If no published entry with this name already exists, then this flag is ignored.

ignore-test boolean Optional If set to true, indicates a publish of the template does not require a test run to be performed.

If this parameter is not specified, then the value defaults to false.

ignore-source-change boolean Optional If set to true, indicates that the publish of the entry is not restricted by the change in the original source that was used on the create or modify of the entry.

If this parameter is not specified, then the value defaults to false.

Authorization requirements

The user's z/OS user ID must be defined as a landlord and a domain administrator.

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.

For more information, see Authorization requirements.

HTTP status codes

On successful completion, HTTP status code 204 (Normal) is returned.

Response content

None.

Example HTTP interaction

Figure 1 shows a request to publish a software services template.
Figure 1. Sample request to publish a software services template
POST https://localhost:4444/zosmf/provisioning/rest/1.0/scc/d0166782-4e18-4b07-a075-c8946c88e068/actions/publish

End of change