Create software service instance names

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

HTTP method and URI path

POST  /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

None.

Description

This operation creates SSINs. It uses the name-prefix in the resource definition profile as a basis for creating the names. An initial SSIN is created when a software instance is provisioned. A maximum of 8 generated SSINs may exist in the resource definition profile that the software instance is using. Allocation of SSINs for a provisioned software instance are released when the software instance is deprovisioned. The name-prefix in the resource definition profile must end with the special wildcard character, *.

For the properties that you can specify in the request body, a JSON object, see Request content.

On successful completion, HTTP status code 201 (Created) is returned, indicating that the request resulted in the creation of a SSINs.

Request content

The request content is expected to contain a JSON object. Table 1 lists the fields in the JSON object.

Table 1. Request content for the create SSIN request
Field name	Type	Required or optional	Description
template-id	String	Required	The ID of the template.
domain-id	String	Required	The ID of the domain.
tenant-id	String	Required	The ID of the tenant.
registry-id	String	Required	The ID of the software instance registry.
quantity	String	Required	The number of names to be generated. The value must be 1-7.

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.

For more information, see Authorization requirements.

HTTP status codes

On successful completion, HTTP status code 201 (Created) 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 2. HTTP error response codes for a create 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 3.

Table 3. Response from a create SSIN request
Field	Type	Description
ssin-list	Array	Software service instance names. See Table 4.

Table 4. 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 5. 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 create 2 SSINs.

Figure 1. Sample request to create SSINs

POST /zosmf/resource-mgmt/rest/1.0/ssin
{
     "domain-id": "izu$0",
     "registry-id": "046c3cb2-7ef2-40a0-8b10-a34d8a23e5fc",
     "template-id": "9eb7df8a-284c-4550-a92e-8150bc6fe68f",
     "tenant-id": "izu$000",
     "quantity": "2"     
 }

The response body is as follows.

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