Start of change

List the portable software instances defined to z/OSMF

You can use this operation to obtain a list of the portable software instances that are defined to a z/OSMF instance.

HTTP method and URI path

GET /zosmf/swmgmt/pswi
where:
zosmf/swmgmt
Identifies the software management services.
pswi
Informs the service that the request is for a portable software instance object.

Standard headers

Use the following standard HTTP header with this request:
Accept-Language
Identifies the preferred language for any messages that are returned to the caller. The following values are acceptable:
  • Accept-Language: en (English)
  • Accept-Language: ja (Japanese)
If any other language value is specified or if the header is omitted, then English is used.

Custom headers

None.

Request content

None.

Usage considerations

See Usage considerations for the z/OSMF REST services.

Required authorizations

Certain authorizations are required to submit a request through the software management services to list portable software instances. The user ID that initiates the request requires the same authorizations as the ones needed to perform a list operation with the z/OSMF Software Management task. The user ID needs READ access to the Software Management task. For more information about access controls for the Software Management task, see Creating access controls for the Software Management task in IBM z/OS Management Facility Configuration Guide.

Expected response

On completion, the service returns an HTTP response with a status code that indicates whether your request completed. Status code 200 indicates success. A status code of 4nn or 5nn indicates that an error occurred. For more information about errors, see Error handling.

If the request is successful, the response also includes the following JSON object: 
{
   "pswilist": [
   {
      "name":"pswi-name",
      "system":"system-nickname",
      "description":"pswi-description",
      "directory":"UNIX-directory", 
      "categories":"["categories"],
      "lastmodified":"last-modified",
      "modifiedby":"modified-user-ID",
      "created":"date-created",
      "createdby":"created-user-ID",
      "locked":"date-locked",
      "lockedby":"locked-user-ID"
   }
]}
where:
pswilist
Array that contains each portable software instance that is defined to z/OSMF.
pswi-name
Name of the portable software instance.
system-nickname
Nickname of the z/OSMF host system that has access to the volumes and data sets where the portable software instance is located.

To obtain information about the specified system, you can use the z/OSMF topology services. For more information, see Topology services.

pswi-description
Description of the portable software instance.
UNIX-directory
UNIX directory that contains the portable software instance files.
categories
Comma-separated list of the categories to which the portable software instance is assigned.
last-modified
Date and time, in ISO 8601 format, that the portable software instance was last modified.
modified-user-ID
User ID of the user who last modified the portable software instance.
date-created
Date and time, in ISO 8601 format, that the portable software instance was created.
created-user-ID
User ID of the user who created the portable software instance.
date-locked
Date and time, in ISO 8601 format, that the portable software instance was locked. This attribute is null if the portable software instance is not currently locked.
locked-user-ID
User ID of the user who locked the portable software instance. This attribute is null if the portable software instance is not currently locked.

Example

In the following example, the GET method is used to retrieve a list of the portable software instances that are defined on the z/OSMF host system zosmf1.yourco.com.
Figure 1. Sample request to retrieve a list of portable software instances
GET /zosmf/swmgmt/pswi HTTP/1.1
Host: zosmf1.yourco.com
A sample response is shown in Figure 2.
Figure 2. Sample response from a request to retrieve a list of portable software Required authorizations
HTTP/1.1 200 OK
Date: Tues, 05 June 2020 18:53:27 +00004GMT
Content-Type: application/json
Content-Language: en
Connection: close


{"pswilist":[{"name":"DB2V9", "system":"PEV174", "description":null,
"directory":"/u/zosmfuser/DB2V9","categories":null,
"lastmodified":"2020-06-01T19:23:25+00:00", "modifiedby":"FRED",
"created":"2020-01-03T12:00:10+00:00", "createdby":"BARNEY", "locked":null,
"lockedby":null}]}
End of change