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
     

Best practice
You can still use the BMC Helix ITSM platform REST API and webs services to integrate custom applications. However, we recommend that you use the simplified REST API for all supported use cases. If you need to perform operations on a custom form, use the BMC Helix ITSM platform REST API.

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 API

Access and authentication for the simplified REST API

Using the simplified REST API

Enabling the simplified REST API

Endpoints in the simplified REST API

Troubleshooting the simplified REST API

 

Examples of using the simplified REST API

Example of using the simplified REST API to search for a ticket

Example of using the simplified REST API to search and update an incident

Example of using the simplified REST API to search and update a change request

Example of using the simplified REST API to search and update a problem investigation

Example of using the simplified REST API to download an attachment

Example of using the simplified REST API to get person details

Example of using the simplified REST API to retrieve and update work notes

Example of using the simplified REST API to retrieve recommended knowledge articles and tickets

Example of using the simplified REST API to retrieve metadata

Example of using the simplified REST API to create a ticket

 

 

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