List the software services templates

You can use this operation to list the software services templates that are defined in the catalog.

HTTP method and URI path

GET /zosmf/provisioning/rest/<version>/scc

In this request, the URI path variable <version> identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.

Query parameters

You can specify the following query parameter on this request. Objects matching all query parameters are returned.

name: Optional, regular expression, specifies the external name of the software services template.
owner: Optional, specifies the user ID or group ID that identifies the owner of the software services template.
software-type: Optional, specifies the type of software being provisioned.
domain-name: Optional, specifies the domain name.
state: Optional, regular expression, specifies the state.

If you specify no query parameters, then all software services templates are returned.

Description

This operation list the software services templates in the catalog.

On successful completion, HTTP status code 200 (OK) is returned, indicating that the request resulted in a list of software services templates 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 with details about the software services templates. See Table 1, Table 2.

Table 1. Array of objects
Field	Type	Description
scc-list	Array of objects	Array of software services template objects. The array is filter based on any query parameters that were provided.

Table 2. Fields for each software services template
Field	Type	Description
generated-name	String	The generated name for the software services template.
object-id	String	The unique ID that identifies the software services template.
base-object-id	String	The object ID that is associated with all of the versions of the software services template.
name	String	Descriptive name for the software services template.
version	String	Version of the software services template.
owner	String	User ID of the software services template owner.
state	String	Indicates the status of the software services template: archived The entry is hidden from consumers. You can make it available again with the Publish action. corrupted The contents of the software services template are missing or incorrect. Delete the template. draft The entry is in the edit state and visible only to the owner and the administrator. No approvals are required for this template. The entry can be tested with the Test a software services template API. draft_approved The software services template is in edit state and all the approvals that are associated with the template and the respective runAs user IDs have been received. The entry can be tested with the Test a software services template API. draft_pending_approvals The software services template is in edit state and one or more associated approvals has not been approved. The entry cannot be tested (with the Test a software services template API) in this state. draft_missing_required_approver One or more of the definition files contains a runAsUser element without a corresponding approver element. Either an approver element must be added for the runAsUser element, or a domain or general approver must be added for the software services template. The entry cannot be tested (with the Test a software services template API) in this state. pending_security_update Permission to access the software services template is being processed. No API requests are allowed for the software services template until the security processing is complete. published The entry is locked and visible to consumers. security_update_failed Security access setup related to the software services template failed. Only the view and delete API requests a available.
description	String	Description of the software services template.
action-definition-file	String	Location of the action definition file, a file in XML format that defines the actions for the software services instance provisioned from the template.
software-id	String	A short, arbitrary value that identifies the software that is being provisioned.
software-name	String	Name of the software that is being provisioned.
software-type	String	Identifies the type of software that is being provisioned.
software-version	String	Version of the software that is being provisioned.
workflow-definition-file	String	Location of the workflow definition file, the primary XML file that defines the workflow.
workflow-id	String	Workflow ID. A short, arbitrary value that identifies the workflow.
workflow-vendor	String	Name of the vendor that provided the workflow definition file.
workflow-version	String	Version of the workflow definition file.
workflow-variable-input-file	String	Location of the workflow variable input file, an optional properties file used to specify in advance the values for one or more of the variables that are defined in the workflow definition file.
domain-name	String	The name of the domain that the template resides in.
create-time	String	The time that this object was created, in ISO 8601 format.
created-by-user	String	The user that created this object.
last-modified-time	String	The last time this object was updated, in ISO 8601 format.
last-modified-by-user	String	The user that last updated this object.

Example HTTP interaction

Figure 1 shows a request to retrieve a software services template.

Figure 1. Sample request to retrieve a software services template

GET https://localhost:4444/zosmf/provisioning/rest/1.0/scc/

The following is the response body for the request.

{
  "scc-list": [
    {
      "name": "mqCBA",
      "version": "1",
      "owner": "domadmin",
      "state": "published",
      "description": "This workflow provisions an MQ for z/OS Queue Manager",
      "generated-name": "mqCBA.1.default",
      "object-id": "5b0c3367-b856-4727-99ac-f9a79c9abf28",
      "base-object-id": "c0e4d08f-f046-4a79-8a15-6981743d07ed",
      "domain-name": "default",
      "action-definition-file": "definition/qmgrActions.xml",
      "software-id": "5655-W97",
      "software-name": "IBM MQ for z/OS",
      "software-type": "QMgr",
      "software-version": "V8.0.0",
      "workflow-definition-file": "definition/provision.xml",
      "workflow-id": "ProvisionQueueManager",
      "workflow-vendor": "IBM",
      "workflow-version": "1.0.1",
      "workflow-variable-input-file": "definition/workflow_variables.properties",
      "create-time": "2016-11-18T20:00:43.504Z",
      "created-by-user": "domadmin",
      "last-modified-by-user": "domadmin",
      "last-modified-time": "2016-11-18T20:28:43.951Z"
    }
  ]
}