This documentation supports the 21.3 version of BMC Helix ITSM.To view an earlier version, select the version from the Product version menu.

Using custom fields in simplified REST APIs


Simplified REST APIs return data for out-of-the-box fields. But if you want to include a custom field in the data to be returned by the simplified REST APIs, you must add the custom field and the field ID in the REST API schema from BMC Helix Innovation Studio.

For example, you want the Jira Issue ID field to be retrieved for incidents in the data fetched by the simplified REST API. In that case, you must include the field and the field ID in the Incident API schema in BMC Helix Innovation Studio:

{"jiraissueid":"536870913"}

To use multiple custom fields, add the fields in a comma-separated list:

{"jiraissueid":"536870913", "Custom_Status":"536870914", "Custom_Priority":"536870915"}

To modify the API schema to include custom fields

  1. As an administrator, log into BMC Helix Innovation Studio.
  2. In Workspace, click BMC Helix ITSM APIs
  3. On the Documents tab, open a mapping.
    For example, select Incident Mapping as shown in the following image.
    Select Documents to add a custom field to the REST API mapping
  4. Add the field name and field ID in the Document schema field.
    ExampleAddingCustomFieldToRESTAPI_5Dec2024.png
  5. Click Save and Close.

Results

When the REST API is run to retrieve data, the custom field included in the document schema is also retrieved and displayed in the results.

 

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