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.

Classes

The BMC Cloud Lifecycle Management object model is a collection of classes that represents a cloud system and the activities that take place in the cloud. Each class has a unique name and is composed of attributes, relationships, and operations, as illustrated in the following diagram.

Attributes

Attributes provide state and descriptive information about a cloud object. Each attribute is strongly typed; that is, it has a name and a type. Attributes carry primitive types such as string, integer, Boolean, or are composed of simple data structures, such as enumerations.

Relationships

Relationships provide information about connections between cloud objects and enable you to navigate among the objects within your cloud. A relationship can represent:

  • Ownership of another class object
  • Dependence on another class object
  • A reference to another class object

Relationships are strongly typed; the type always is the name of another class in the API.

Operations

Operations provide actions that you can perform on cloud objects. Each operation has a name and return type. The return type specifies the type of object that will be returned in the HTTP response message JSON document.

Some operations are static operations, which apply to a class rather than a specific object.

The following table describes some typical operations offered by classes in the API. Each class has its own set of available operations and does not provide all the operations listed in the table. Some classes offer unique operations that are not included in this table. The API reference lists the specific operations offered by each class.

Typical operations

Operation
name

Description

create

Create a new instance of an object

delete

Remove an object

get

Retrieve the attributes and relationships of an object

onboard

Make a resource available

offboard

Make a resource unavailable

search

Find objects that meet specified criteria

update

Modify the attributes and relationships of an object

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

Comments