Using the API reference topics

The BMC Cloud Lifecycle Management API consists of the Callout API, the Cloud API, and the Provider-API. This topic describes the organization and content of the reference section for each of those APIs.

The reference section for each API begins with a summary of the classes that compose the API. Each class in the API has a topic that describes the class and topics that describe individual APIs in the class.

Class summary topic

The class summary topic contains a list of classes in the API along with brief descriptions. Click on a class name to go to the corresponding class topic.

Class topics

Each class topic lists the APIs available in the class and the relationships and attributes of the class. The following table describes the sections that appear on each class topic.

Class topic sections

API topics

Each API topic describes an operation, its input parameters and the corresponding HTTP request and response messages. The following table describes the sections on an API topic.