Responses common to all CLI commands

CLI commands return responses consisting of parts that are common to all CLI commands and parts that differ depending on the command.

The parts common to all CLI commands are as follows.

If the CLI command finishes within the time limit or if an error occurs after the request is received but before the response is sent:

The parts of the response body that are common to all CLI commands (outlined in red) are as follows. For information about other items, see the description of the response of the relevant command.

Note that the following commands return responses that consist of only the parts common to all CLI commands and do not differ depending on the command: YKBLDCMD, YKBLDRMT, YKBTSCAN, YKDEFGRP, YKDEFRMT, YKDELCMD, YKDELCNF, YKDELRMT, YKDEXCTG, YKDROP, YKEXPORT, YKIMPORT, YKQHPATH, and YKRMTCDV.

Key	Format	Description
`servletKey`	string	Value of the `servletKey` key in the TSO/E address space
`ver`	string	Version of the REST API for TSO/E address space services for z/OSMF
`appData`	object or undefined	Object output by the BCM Web API
`bcmVer`	string	Value output in `vvrrnn` format `vv`: Version number of Business Continuity Manager `rr`: Revision number of Business Continuity Manager `mm`: Release modification number of Business Continuity Manager
`vendor`	string	Vendor name
`rc`	number	Return code of the CLI command or the BCM Web API server For information about the return codes of a CLI command, see the description of return codes for that CLI command in Format of BCM Web API requests that run CLI commands. For information about the return codes of the BCM Web API server, see Return codes set by the BCM Web API server.
`bcmMsg`	object array	Message structure output by the CLI command or the BCM Web API server
`msgID`	string	Message ID This is output if there is a message.
`msgSev`	number	Severity level of the message This is output if there is a message.
`msgText`	string	Message ID and message text This is output if there is a message.
`msgValue`	string or undefined	Additional message information This is output as a part of the message structure if there is additional message information.
`action`^#	string or undefined	Value of the `action` key(`submit`) specified at the time of the request
`cliname`^#	string or undefined	Value of the `cliname` key specified at the time of the request
`operands`^#	string or undefined	Value of the `operands` key specified at the time of the request
`reused`	boolean or undefined	For details, see the IBM manual z/OS Management Facility Programming Guide.
`timeout`	boolean	`false`: If the CLI command finishes within the time limit. `true`: If the CLI command does not finish within the time limit or if another CLI command is running.

#: If the request contains a mistake, the key might not be output.

Tip:

The format "undefined" indicates that this key is not output in situations such as when information cannot be obtained. If the key format is "object or undefined" or "object array or undefined", and the key is not output, no key under that key is output.

If the CLI command does not finish within the time limit or if another CLI command is running

Keys are output in the following format:

{"servletKey":"USERID-71-aabcaaaf",
 "ver":"0100",
 "reused":false, "timeout":true
}

The output keys are as described in If the CLI command finishes within the time limit or if an error occurs after the request is received but before the response is sent:.

If an error occurs during the sending the request or receiving of the response or during initialization

Keys are output in the following format:

{"servletKey":"USERID-71-aabcaaaf",
 "ver":"0100",
 "tsoData":[
   {"TSO MESSAGE":
     {"VERSION":"0100",
      "DATA":"YK7407E Request message is too long."
   ...],
 "reused":false, "timeout":false
}

Key	Format	Description
`servletKey`	string	Value of the `servletKey` key in the TSO/E address space
`ver`	string	structure-version For details, see the IBM manual z/OS Management Facility Programming Guide.
`tsoData`	object or undefined	TSO/E message object
`TSO MESSAGE`	object or undefined	TSO/E message information
`VERSION`	string	JSON-version (A four-digit number indicating the JSON version of the message format) For details, see the IBM manual z/OS Management Facility Programming Guide.
`DATA`	string or undefined	TSO/E message
`reused`	boolean or undefined	For details, see the IBM manual z/OS Management Facility Programming Guide.
`timeout`	boolean	`false`: If the CLI command finishes within the time limit. `true`: If the CLI command does not finish within the time limit.

If an error occurs before the request is received (if the `servletKey` key specified in the request is invalid, the session times out, or there is a mistake in the header or URI of the request)

Keys are output in the following format:

{"servletKey":"USERID-71-aabcaaaf",
 "ver":"0100",
 "msgData":[
   {"messageText":"IZUG1121E: The TSO/E address space could not be created because an error occurred with the logon procedure or the user settings.",
    "messageId":"IZUG1121E"}
   ...],
 "reused":false, "timeout":false
}

Key	Format	Description
`servletKey`	string	Value of the `servletKey` key in the TSO/E address space
`ver`	string	structure-version For details, see the IBM manual z/OS Management Facility Programming Guide.
`msgData`	array or undefined	JSON object of the z/OSMF message This key is output if a z/OSMF message is output.
`messageText`	string	ID and text of the z/OSMF message
`messageId`	string	z/OSMF message ID
`reused`	boolean or undefined	For details, see the IBM manual z/OS Management Facility Programming Guide.
`timeout`	boolean	`false`: If the CLI command finishes within the time limit. `true`: If the CLI command does not finish within the time limit.

If the CLI command finishes within the time limit or if an error occurs after the request is received but before the response is sent:

If the CLI command does not finish within the time limit or if another CLI command is running

If an error occurs during the sending the request or receiving of the response or during initialization

If an error occurs before the request is received (if the servletKey key specified in the request is invalid, the session times out, or there is a mistake in the header or URI of the request)

If an error occurs before the request is received (if the `servletKey` key specified in the request is invalid, the session times out, or there is a mistake in the header or URI of the request)