Web Services API data structures

This section provides reference information for the CMDB Web Services API data structures. The CMDB Web Services data structures are used as parameters for CMDB Web Services operations. The data structures are categorized by the type of functions they perform, as listed in the following table.

List of data structures categorized by type

Data structure type

Data structure list

Common structures

The common data structures are XML elements used by one or more web service operations.

Business object structures

Business Objects are an abstraction of a business entity (such as a service offering, contract, or organization) that models service-model information in a familiar way. A business object corresponds to BMC CMDB Common Data Model (CDM) classes. The following structures were designed specifically for work with business objects.

Atrium Audit structures

The audit structures enable you to retrieve information about changes to relationship and CI classes in BMC Helix CMDB.

Class structures

The class structures enable you to work with relationship and CI classes in BMC Helix CMDB.

Classic federation structures

Classic federation structures see the data structures as defined in the atrium_classicfederation_200901.xsd file. The following data structures support the classic federation operations.

Classic reconciliation

Classic reconciliation structures see the data structures as defined in the atrium_classicreconcilliation_200901.xsd file. The following data structures support the classic reconciliation operations.

Federated CMDB configuration structures

These structures allow you to set up a federated CMDB for queries.

Dataset structures

The dataset structures enable you to work with the datasets in BMC Helix CMDB.

Graph query structures

The graph query structures allow you to build a list of graph query objects with qualifications.

Graph walk structures

The graph walk structures enable you to work with the graph walk queries.

Instance structures

The instance structures enable you to work with the CI or relationship class instances.

Normalization structures

Use normalization structures to help with the normalization of your data to minimize duplication of information and to help reduce data anomalies.

Query structures

The query structures allow you to build a list of query objects with qualifications.

Reconciliation structures

Service configuration structures

Service impact structures


Service utility structures


Version structures



 

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