Software service instance name services
The software service instance name (SSIN) services are application programming interfaces (APIs), which are implemented through industry standard Representational State Transfer (REST) services. These services allow the caller to create and manage software service instance names.
For information about cloud provisioning, including a description of the roles, see Cloud provisioning services.
Operation name | HTTP method and URI path |
---|---|
Create software service instance names |
|
List the software service instance names |
|
Create a variable name |
|
Create unique variable names |
|
Authorization requirements
Use of the SSIN services API requires the client to be authenticated. For information about client authentication in z/OSMF, see Authenticating to z/OSMF.
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.
Error response content
For the 4nn HTTP error status codes, additional diagnostic information beyond the HTTP status code is provided in the response body for the request. This information is provided in the form of a JSON object containing the following fields:
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. |
Error logging
Errors from the software services instance services are logged in the z/OSMF log. You can use this information to diagnose the problem or provide it to IBM Support, if required. For information about working with z/OSMF log files, see IBM z/OS Management Facility Configuration Guide.
HTTP status codes
- HTTP 200 Normal
- The request succeeded. A response body is provided, which contains the results of the request.
- HTTP 201 Created
- The request succeeded and resulted in the creation of an object.
- HTTP 400 Bad request
- The request contained incorrect parameters.
- HTTP 401 Unauthorized
- The request cannot be processed because the client is not authorized. This status is returned if the request contained an incorrect user ID or password, or both. Or, the client did not authenticate to z/OSMF by using a valid WWW-Authenticate header.