Using the Universal CMDB API

The Universal CMDB API is used to integrate applications with the Universal CMDB (CMDB). The API provides methods to:

• Add, remove, and update CIs and relations in the CMDB

• Retrieve information about the class model

• Retrieve information from the UCMDB history

• Run what-if scenarios

• Retrieve information about configuration items and relationships

Methods for retrieving information about configuration items and relationships generally use the Topology Query Language (TQL). For details, see Topology Query Language.

Users of the Universal CMDB API should be familiar with:

• The Java programming language

• Universal CMDB

Uses of the API

The API is used to fulfill a number of business requirements. For example, a third-party system can query the class model for information about available configuration items (CIs). For more use cases, see UCMDB API Use Cases.

Permissions

The administrator provides login credentials for connecting with the API. The API client needs the user name and password of an integration user defined in the CMDB. These users do not represent human users of the CMDB, but rather applications that connect to the CMDB.

In addition, the user must have the Access to SDK general action permission in order to log in.

For details, see Create an Integration User.