Add a new software instance

HTTP method and URI path

POST /zosmf/swmgmt/swi

Standard headers

Use the following standard HTTP header with this request:

Content-Type

Identifies the type of input content provided by the caller. The JSON content type ("Content-Type: application/json") is used for the JSON document included as input with this request.

Accept-Language

Identifies the preferred language for messages that may be returned to the caller. Acceptable values are "Accept-Language: en" (English) and "Accept-Language: ja" (Japanese). Any other language value is ignored and English is used instead. In addition, if the header is not specified, English is used.

Custom headers

None.

Request content

{
  "name":"swi-name",
  "system":"system-nickname", 
  "description":"swi-description",
  "globalzone":"global-zone", 
  "targetzones":["target-zones"], 
  "categories":["categories"],
  "datasets":[
  {
    "dsname":"data-set-name",
    "volume":"volume-serial"
  }],
  "products":[{
    "prodname":"product-name",
    "prodid":"product-id", 
    "release":"product-level",
    "vendor":"vendor-name",
    "url":"product-url",
    "features":["feature-name"],    
    "generalavailability":"general-availability-date",
    "endofservice":"end-of-service-date"
    }],
  "workflows":[{
    "name":"workflow-name",
    "description":"workflow-description",
    "location": {
      "smptype":"smp-type",
      "smpname":"smp-name",
      "dsname":"workflow-dsname",
      "path":"workflow-path"},
    "performonhostsystem":true | false
    }],
  "datasetproperties":[{
    "dddefname":"dddef-name",
    "zone":"zone-name",
    "dsname":"data-set-name",
    "volume":"volume-serial",
    "dstype":"DLIB",
    "properties":[{"key":"value"}] 
    }],
 "datasetpropertylabels":[{
    "propertyname":"property-name",
    "label":"property-label"
    }],
  "productproperties":[{
    "prodid"":"product-id",
    "release":"product-level",
    "prodname":"product-name",
    "properties":[{"key":"value"}] 
    }]
}

Usage considerations

See Usage considerations for the z/OSMF REST services.

Required authorizations

To submit requests through the software management services, the user ID initiating the request requires the same authorizations as when performing an analogous operation using the z/OSMF Software Management task. That is, the user ID must have READ access to the Software Management task, and CONTROL access to the SAF resources corresponding to the software instance to be added. If the specified categories are implicitly added during this software instance add operation, the user ID must also have CONTROL access to the SAF resources corresponding to the specified categories. For 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, which includes a status code indicating whether your request completed. Status code 200 indicates success. A status code of 4nn or 5nn indicates that an error has occurred. For more details, see Error handling.

Example

POST /zosmf/swmgmt/swi HTTP/1.1
Host: pev174.yourco.com Content-Type: application/json Accept-Language: en { "name":"Hooli", "system":"PEV174", "description":"Fictitious software product from Hooli", "globalzone":"IBMUSER.HOOLI.CSI", "targetzones":["TGTZ"], "datasets":[    {"dsname":"IBMUSER.HOOLI.PROCLIB","volume": "LV1234"},    {"dsname":"IBMUSER.HOOLI.PARMLIB","volume":"LV1234"}    ], "products":[    {"prodname":"Hooli Express","release":"2.1","vendor":"Hooli Software"}    ], "workflows":[    {"name":"Setup Hooli",      "description":"Setup and configure fictitious software product Hooli",      "location": {"dsname":"IBMUSER.HOOLI.WORKFLOW(SETUP)"}}    ],   "datasetproperties":[     {"dddefname":"HOOLMOD","properties":[{"hooli-LnkLst":"yes"},{"hooli-ispfType":"LMOD"}]},     {"dddefname":"HOOLMSG","properties":[{"hooli-ispfType":"MESSAGE"}]},     {"dddefname":"HOOLPNL","properties":[{"hooli-ispfType":"PANEL"}]},     {"dddefname":"HOOLSKL","properties":[{"hooli-ispfType":"SKELETON"}]},     {"dddefname":"HOOLTBL","properties":[{"hooli-ispfType":"TABLE"}]},     {"dddefname":"HOOLREXX","properties":[{"hooli-ispfType":"EXEC"}]}     ], "datasetpropertylabels":[     {"propertyname":"hooli-LnkLst","label":"LNKLST Eligible"},     {"propertyname":"hooli-ispfType","label":"ISPF Element Type"}     ] }