Integrating third-party applications with BMC Helix ITSM by using the simplified REST API
The simplified API is an enhanced, redesigned API that offers more capabilities and better consumption of the API. The simplified API offers advantages such as:
- First-class objects
- User friendly and industry standard naming conventions for endpoints and attributes
- Industry standard searching, filtering, and sorting of results
- Better error handling and status codes
The following topics include helpful examples of using the BMC Helix ITSM simplified REST APIs:
Getting started with the simplified REST API
-
Overview of the simplified REST APIAccess and authentication for the simplified REST APIOverview of the simplified REST APIAccess and authentication for the simplified REST APIOverview of the simplified REST APIAccess and authentication for the simplified REST APIOverview of the simplified REST APIAccess and authentication for the simplified REST API
Using the simplified REST API
-
Enabling the simplified REST APIEnabling the simplified REST APIEnabling the simplified REST APIEnabling the simplified REST APIEnabling the simplified REST APIEndpoints in the simplified REST APIEndpoints in the simplified REST APIEndpoints in the simplified REST APIEndpoints in the simplified REST APIEndpoints in the simplified REST APITroubleshooting the simplified REST APITroubleshooting the simplified REST API
Examples of using the simplified REST API
-
Example of using the simplified REST API to search and update an incidentExample of using the simplified REST API to search and update a change requestExample of using the simplified REST API to search and update a problem investigationExample of using the simplified REST API to download an attachmentExample of using the simplified REST API to retrieve and update work notesExample of using the simplified REST API to get person detailsExample of using the simplified REST API to retrieve metadataExample of using the simplified REST API to retrieve recommended knowledge articles and ticketsExample of using the simplified REST API to create a ticketExample of using the simplified REST API to search and update an incidentExample of using the simplified REST API to search and update a change requestExample of using the simplified REST API to search and update a problem investigationExample of using the simplified REST API to download an attachmentExample of using the simplified REST API to retrieve and update work notesExample of using the simplified REST API to get person detailsExample of using the simplified REST API to retrieve recommended knowledge articles and ticketsExample of using the simplified REST API to retrieve metadataExample of using the simplified REST API to create a ticketExample of using the simplified REST API to search and update an incidentExample of using the simplified REST API to search and update a problem investigationExample of using the simplified REST API to search and update a change requestExample of using the simplified REST API to get person detailsExample of using the simplified REST API to download an attachmentExample of using the simplified REST API to retrieve and update work notesExample of using the simplified REST API to retrieve recommended knowledge articles and ticketsExample of using the simplified REST API to retrieve metadataExample of using the simplified REST API to create a ticketExample of using the simplified REST API to download an attachmentExample of using the simplified REST API to get person detailsTip: For faster searching, add an asterisk to the end of your partial query. Example: cert*