Data layout

For each component, there is a section describing the following: the component name, API names used to make and find the component, object type returned by the APIs, parameters to the API, dependency of the API on other objects and finally the relationships of the component with all other components.

Under each component name, the following information is provided:

The object name to be created or found is a heading in the left column.

API Usage

Under the heading are the commands showing the usage syntax including the order of parameter.

Mandatory Parameters

These parameters are required. Parameters are described in three columns:

Parameter name, Data type, Description

Optional Parameters

These parameters are not required. Parameters are described in three columns:

Parameter name, Data type, Description

Return Values

Lists the object types returned by the APIs. Return values are listed in two columns:

Type of object reference returned, Description

Dependency

List of dependencies of the API on other objects.

Relationships

Lists of the relationships of the object with all other objects.