API User's Guide

Referring to object fields

Updated in 2022.1

When retrieving objects via the API, always use field names as they are defined in the database. Display labels are not supported in these requests because they may be localized and can change depending on language settings, while field names remain constant.

When creating or updating objects through workflow actions, the rule is different: for physical fields, continue to use database field names, but for virtual fields (fields that exist only on workflow forms), use the field labels exactly as they appear on the form. These virtual fields do not have underlying database names, so their form labels must be used as-is.

How to refer to object fields when retrieving objects

The following HTTP requests retrieve object data:

In these requests, the supported parameter value is the physical name of a field. You can find physical field names in the Settings App and in the Web-based Admin Center, as described below. Alternatively, you can see the Database Reference Guide. This document describes the structure of Alloy Navigator Express database tables and fields. The Alloy Navigator Express Database Reference Guide is available at the Alloy Support Portal.

To check a physical field name in the Settings App:

  1. Open the Settings App and go to the Customization > General > Fields.

  2. Navigate to an object class, such as Change Requests, Computers, or Tickets.

  3. In the workspace pane on the right, view the list of fields and double-click the required field. The Field Properties window appears.

  4. The physical name of the field is on the General tab under the Field Name. Copy and save the physical name for later use.

How to refer to object fields when creating and updating objects

The following HTTP requests create and change objects via workflow actions:

To refer to action fields in these requests, use field labels exactly as they appear on action forms. For actions that utilize object detail forms (also known as "full forms") instead of action forms, use field labels as well. However, when working with full forms, you also have the option to use physical field names if preferred.