API User's Guide

Referring to object fields

Updated in 2022.1

In API requests to retrieve objects, you must specify the original field names as they appear in the database; display labels are not supported. However, in API requests to create or update objects via workflow actions, you must use display labels of fields. Read this page to see the difference.

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, as described below. Alternatively, you can see the Database Reference Guide. This document describes the structure of Alloy Navigator database tables and fields. The Alloy Navigator 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 General > Fields > Miscellaneous > All Fields > By Table Name.

  2. Select the view-table that corresponds to the object. The name of the table should be [Object]_List, e.g. Computer_List.

  3. Open the drop-down 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.