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 topic that describes the class and is followed by zero or more API topics that 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 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

Heading

Description

Basic APIs

Lists APIs that perform basic CRUD operations (that is, create, retrieve, update, and delete). Each URI in the list links to the corresponding API topic.

Operation APIs

Lists APIs that perform specialized actions, such as onboard, offboard, start, stop, and so on. Each URI in the list links to the corresponding API topic.

Relationship APIs

Lists APIs that retrieve related objects. Each URI in the list links to the corresponding API topic.

Relationships

Lists all relationships of the class in a table that contains the name, type, multiplicity, and description of each relationship. The type for each relationship is always another class. Each type name in the list links to the corresponding class topic.

Attributes

Lists all attributes of the class. It contains the name, type, multiplicity, and description of each attribute. Most attributes are primitive types such as String, Integer, Boolean, or Float. In most cases, non-primitive types that are assigned to attributes are enumerations, but sometimes might be a class type. Each non-primitive type in the list links to the corresponding class topic or data type topic.

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

Heading

Description

Description

Describes the operation.

API stability classification

Lists the stability classification of the operation.

API overview

Lists the HTTP method, URI, and return type of the operation.

HTTP request message

Describes the request message query string parameters, message headers, and message body.

HTTP response message

Describes the response message headers and message body.

Example

Contains a sample HTTP request for the operation.

Was this page helpful? Yes No Submitting... Thank you

Comments