Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Using the API reference sections

The BMC Cloud Lifecycle Management API consists of multiple APIs that are described in separate reference sections within this space (Callout API, Cloud API, and Provider API). This topic describes the organization and content of the reference sections.

Reference section organization

The reference section for each API begins with an overview that lists the classes in the API. Each class in the API has a class topicthat describes the class and is followed by zero or more API topicsthat describe the operations offered by the class. Abstract classes and classes that are used only as data structures do not have API topics. The following figure illustrates the hierarchical organization of the reference sections:

api-organization-reference.png

API overview

The API overview contains a list of classes in the API along with brief descriptions. Each class in the list links to the corresponding class topic. Click here to view an example of an API overview.

Class topics

Each class topic lists the APIs available in the class and the relationships and attributes of the class. Click here to view an example of a class topic. The following table describes the content of each class topic:

Class topic content

 

API topics

Each API topic describes an operation, its input parameters and the corresponding HTTP request and response messages. Click here to view an example of an API topic. The following table describes the content of each API topic:

API topic content

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*