List the software service instance names

You can use this operation to list the software service instance names (SSINs).

HTTP method and URI path

GET  /zosmf/resource-mgmt/rest/<version>/ssin

In this request, the URI path variable <version> identifies the version of the z/OSMF software service instance name 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: Name of the object for which SSINs should be obtained.
registry-id: Identifier of the registry for which SSINs should be obtained.

If you specify no query parameters, then all SSINs are returned.

Description

The list operation returns software service instance names based on the input query.

On successful completion, HTTP status code 200 (Normal) is returned, along with a response body.

Request content

None.

Authorization requirements

The user’s z/OS user ID must have READ access to the following resource profile in the ZMFAPLA class: <SAF-prefix>.ZOSMF.PROVISIONING.RESOURCE_MANAGEMENT.

See Authorization requirements.

HTTP status codes

On successful completion, HTTP status code 200 (Normal) is returned and the response body is provided, as described in Response content.

Otherwise, the following HTTP status codes are returned for the indicated errors. The response body is a standard error response body that provides the reason code that is indicated and associated error message.

Table 1. HTTP error response codes for a list SSIN request
HTTP error status code	Description
`HTTP 400 Bad request`	The request contained incorrect parameters.
`HTTP 401 Unauthorized`	The requester user ID is not authorized for this request.

Response content

On successful completion, the service returns a JSON object named ssin-list consisting of the names that were created. See Table 2.

Table 2. Response from a list SSINs request
Field	Type	Description
ssin-list	Array	Software service instance names. See Table 3.

Table 3. Fields in the ssin-list array
Field	Type	Description
ssin	String	Software service instance name.

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

Table 4. Response from a request failure
Field	Type	Description
httpStatus	Integer	HTTP status code.
requestMethod	String	HTTP request method.
requestUri	String	HTTP request URI.
messageID	String	Message identifier for the error.
messageText	String	Message text describing the error.
additionalInfo	String	Additional information describing the error.
debug	String	Debug information about for the error.

Example HTTP interaction

In Figure 1, a request is submitted to list the SSINs for name=INAME.*.

Figure 1. Sample request to list SSINs

GET /zosmf/resource-mgmt/rest/1.0/ssin?name=INAME.*

The response body is as follows.

{
   "ssin-list": [
     {
       "ssin": "INAME101"
     },
     {
       "ssin": "INAME201"
     }
   ]
 }