SOAP API reference

The SOAP API consists of a set of commands that a client can request a server to perform. Each command has a request format and a response format.

The description of each command includes the following information:

Request format and Response format
Describes the format of the SOAP message body that the client sends to the server (the request) and that the server returns to the client (the response).

Unless otherwise specified, all of the XML elements in the request format are required.

Many commands use a common subset of XML elements. Rather than repeating the descriptions for each command, the contents of the elements are described in API parameters.

Where the format refers to "Criteria for this object type" or "Data for this object type", the elements allowed depends on the object type. For details, see API object types.

Security key
Describes the format of the System Authorization Facility (SAF) resource key that the CICS® Configuration Manager server sends to the external security manager (such as RACF®), to verify that the user is authorized to perform the command. For some commands, the server also sends a key to verify that the user is authorized to manipulate the resource definitions that the command will affect. For more information on these keys, see Restricting access to API commands and resource definitions.

The server performs these security checks only if the system option for security checking is activated. For details, see SysOpts (system options).