List the published software service templates

Use this operation to list the software services templates in the catalog that are in the published state.

HTTP method and URI path

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

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 to limit the software services templates that are returned. To be returned, a software services template must all query parameters.

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.

Description

This operation retrieves software services templates that are in the published state from the catalog.

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

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

On successful completion, the service returns a response body, which contains a JSON object with details about the software services templates. See Table 1 and Table 2.

Table 1. Array of objects
Field	Type	Description
psc-list	Array of objects	Array of software services template objects. The array is filtered 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 ID that identifies the software services template.
base-object-id	String	The object ID that is associated with all the versions of the template. software services template.
name	String	Descriptive name for the software services template. The name must be unique. It can be up to 100 characters. The name cannot contain the symbols for less than (<), greater than (>), or ampersand (&).
version	String	Version of the software services template.
owner	String	User ID of the software services template owner.
state	String	Indicates the current status of the software services template: published The entry is locked and visible in the marketplace.
description	String	Description of the software services template.
domain-name	String	Name of the domain this template resides in.
action-definition-file	String	Location of the action definition file.
software-id	String	A short, arbitrary, value that identifies the software being provisioned.
software-name	String	Name of the software being provisioned.
software-type	String	Identifies the type of software being provisioned.
software-version	String	Version of the software being provisioned.
workflow-definition-file	String	Location of the workflow definition file for the software services template. This file is the primary XML file for the workflow definition.
workflow-id	String	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	Optional properties file that specifies values for one or more of the variables that are defined in the workflow definition file.
create-time	String	The time that this software services template was created, in ISO 8601 format.
create-by-user	String	The user that created this software services template.
last-modified-time	String	The last time this software services template was updated, in ISO 8601 format.
last-modified-by-user	String	The user that last updated this software services template.

If a failure occurs, the response body contains a JSON object with a description of the error.

Table 3. Response from a software services template request failure
Field	Type	Description
`http-status`	String	HTTP status code.
`request-method`	String	HTTP request method.
`request-uri`	String	HTTP request URI.
`reason`	String	HTTP status reason code.
`message`	String	Message describing the error.
`detailed-message`	String	Message describing the error in more detail.
`debug`	String	Debug information about for the error.

Example HTTP interaction

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

Figure 1. Sample request to list all published software service templates

GET https://localhost:4444/zosmf/provisioning/rest/1.0/psc HTTP/1.1

The following is the response body for the request.

Figure 2. Response body for the GET request

{
  "psc-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"
    }
  ]
}