Common specifications of the BCM Web API

Business Continuity Manager Web API Reference Guide

Version
9.9.1
Audience
anonymous
Part Number
MK-96HC137-03

Common specifications of the BCM Web API are as follows.

Request header

Specify the header specified by the REST API of the z/OSMF TSO/E address space service. For the Content-Type header, specify application/json. For details, see the IBM manual z/OS Management Facility Programming Guide.

Request body

  • Specify requests by using the ISO 8859-1 character encoding.
  • Specify requests in JSON format.

HTTP status codes

If the BCM Web API request succeeded, 200 is set for the HTTP status code of the response header. If the request was not received by z/OSMF due to a communication failure or other reason, a value other than 200 is returned to the HTTP status code. In such cases, see the status codes described in "Error handling" in the IBM manual z/OS Management Facility Programming Guide and check the cause of the error.

Response header

Content-Type and other header information is set by z/OSMF (not by the BCM Web API server). For details about the values set for response headers, see the IBM manual z/OS Management Facility Programming Guide.

Response body

The response is returned with the character encoding specified as the value of the charset key (default = ISO8859-1) in the Content-Type header.

Handling of copy groups

In the same session, you cannot load copy groups of configuration files having different prefixes. If the prefixes are the same, you can perform operations on multiple copy groups in the same session.