Overview of the REST API
Starting from version 9.1.04.002, BMC CMDB supports REST interface for the following tasks:
- Create configuration items (CIs), search for CIs, update CIs, retrieve CIs, and so on.
- Create metadata
- Create, retrieve, update, and delete a class
- Create, retrieve, update, and delete an attribute
- Create, retrieve, update, and delete an instance
- Query BMC CMDB by using Find Objects, Graph Walk, and Query by Path APIs
- Find Objects—Used to search for CIs with a simple qualification.
For example, find computer names starting with "clm-pun". - Graph walk— Used to search for CIs in a service model.
For example, find all computer systems that are related to a financial service. - Query by path— Used to search for CIs with a complex qualification.
For example, search for computer systems located in Austin, hosted with Red Hat Linux operating system.
- Find Objects—Used to search for CIs with a simple qualification.
- Create and run AI jobs
- Subscribe for notification
Allows to subscribe for a notification regarding the changes in CIs, based on the query provided. - Request for changed CIs
Enables the Notification Engine to identify the changed CIs and store them to a query result form. Provides transaction ID for the processed result. - Retrieve the changed CIs
Retrieves the changed CIs for a given transaction ID.
For more information about using the REST APIs, see, Endpoints-in-the-REST-API.
Using REST API has the following benefits:
- Improved integration process
- Easier hybrid deployment
- Platform independence
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*