The responses of BCM Web API requests that run CLI commands have the following format.
Response body
- 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 appData key is output.
-
{"servletKey":"servletKey", "ver":"structure-version", "appData":{ "bcmVer":"BCM-version", "vendor":"Hitachi Vantara, Ltd.", "rc":0, "bcmMsg":[message-output-by-the-BCM-Web-API-server] "action":"submit", "cliname":"CLI-command-name", "operands":"parameter-string-for-the-CLI-command" CLI-specific-response-data }, "reused":false, "timeout":false }
- If an error occurs after a request is received but before a response is sent, see message-output-by-the-BCM-Web-API-server and resolve the error.
- If the CLI command does not finish within the time limit or if another CLI command is running:
- true is output for the timeout key value.
-
{"servletKey":"servletKey", "ver":"structure-version", "reused":false, "timeout":true }
- You cannot get the CLI execution results in this case, so get them by using the method described in Getting the results if the CLI command does not finish within the time limit or another CLI command is running.
- If an error occurs at a timing other than after a request is received but before the response is sent (for example, during response reception, response sending, or initialization processing):
- The tsoData key is output.
-
{"servletKey":"servletKey", "ver":"structure-version", "tsoData": [ {"TSO MESSAGE": {"VERSION":"JSON-version", "DATA":"msgText"} }...], "reused":false, "timeout":false }
- See the TSO/E message (msgText) and resolve the error.
- 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):
- The msgData key is output.
-
{"servletKey":"servletKey", "ver":"structure-version", "msgData":[ {"messageText":"z/OSMF-message", "messageId":"z/OSMF-message-ID"} ...], "reused":false, "timeout":false }
- See the z/OSMF message and resolve the error.