Get source information for a software services template

Use this operation to retrieve source information for a software services template .

HTTP method and URI path

GET /zosmf/provisioning/rest/<version>/scc/<object-id>/sources

In this request

<object-id>: Identifies the software services template for which information is to be retrieved.

<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 retrieves source information for a template, which includes details of the original source paths that were provided, and whether the files have been changed since the last time the template was updated with the source paths.

On successful completion, HTTP status code 200 (Normal) is returned, indicating that the request resulted in a software services template being retrieved. A response body is provided, as described in Response content.

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

On successful completion, the service returns a response body, which contains a JSON object. See Table 1.

Table 1. Response from a get source request
Field	Type	Description
action-definition-file	Source-Info-Object	Details for the action definition file. See Table 2.
workflow-definition-file	Source-Info-Object	Details for the workflow definition file. See Table 2.
workflow-variable-input-file	Source-Info-Object	Details for the workflow variable input file. See Table 2.

Table 2. Response from a get request: Source-Info-Object
Field	Type	Description
original-source-path	String	The original source path provided for the file.
out-of-sync	boolean	Indicates if the file that is associated with the template matches the original source file. The value is false if the current file that is associated with the template matches the original source file, and true if the current file that is associated with the template differs from the original source file, or if the original source file is not found.

Example HTTP interaction

Figure 1 shows a request to retrieve the source information.

Figure 1. Sample request to retrieve source information

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

The following is the response body for the request.

Figure 2. Response body for the get source request

{
  "action-definition-file": {
    "original-source-path": "/users/gg/zosmf/user-workflows/factory/mq/qmgr/qmgrActions.xml",
    "out-of-sync": false
  },
  "workflow-definition-file": {
    "original-source-path": "/users/gg/zosmf/user-workflows/factory/mq/qmgr/provision.xml",
    "out-of-sync": false
  },
  "workflow-variable-input-file": null
}