Parameter: Lookup Fields

Applies to

Applies to: history

Value

Comma-separated field values

Applies to: dot_lookup

Lookup fields on related entities can be used with a dot syntax. For example, ${referenceField}.${dottedLookup} looks up ${reference0} by the ${dottedLookup} value of the related ${reference1}. Both fields in the dotted lookup must be defined as lookup fields.

Note: Specifically for *.id dotted lookups (such as ${referenceField}.id), the lookup can be abbreviated to ${referenceField} for example (dropping the ".id" part).

Tip: Where more then one lookup field is used in a request, the result is the logical AND of the two lookup fields. For example if the arguments ...lookupField1=X&lookupField2=Y... are used, the REST API will only return instances which match both lookup fields.

Back to help overview