Call the BCM Web API by using the REST API provided by the z/OSMF TSO/E address space services.
When a Business Continuity Manager CLI command is issued as a request from an API client, the BCM Web API server in the TSO/E address space receives the request. The BCM Web API server parses the JSON message in the received request body, extracts the Business Continuity Manager CLI command name and parameters in the message, and runs the CLI command. After running the CLI command, the BCM Web API server converts the results of the CLI command issued to the storage system and the TSO/E message into JSON format, and then returns that information to the client as the REST API response.
The following table describes the procedure for running a BCM Web API request.
|
No. |
Step |
Description |
|---|---|---|
|
1 |
Perform user authentication for z/OSMF. |
|
|
2 |
Start a TSO/E address space on z/OS by running the API request for starting a TSO/E address space. |
|
|
3 |
Start the BCM Web API server in the TSO/E address space by running the API request for starting the BCM Web API server. |
|
|
4 |
Running Business Continuity Manager CLI commands by using the BCM Web API |
Run a BCM Web API request to run the BCM CLI command. |
|
5 |
Run a BCM Web API request to get the results that could not be obtained because the CLI command timed out. |
|
|
6 |
Stop the BCM Web API by running the API request for stopping the BCM Web API server. |
|
|
7 |
Stop the TSO/E address space by running the API request for stopping TSO/E address spaces. |
The period from the start of the TSO/E address space to its end is called a session.
The following figure shows the flow of control when the preceding procedure is performed.