CollectionReferenceKeyDefinition

A reference key that points to a DataItem in a
Collection. This is the most common type of
reference key to create.

For more information, see the Developer Guide.


Properties

collectionId

collectionId: string;

The ID of the collection referenced


fieldWhitelist?

optional fieldWhitelist: string[];

If specified, only expose this list of fields through this reference key. This can be used to limit
namespace pollution in shape data from lots of unnecessary fields, or just to hide information you'd
prefer not to be visible in the UI or through formulas.


primaryKey

primaryKey: string;

The primary key of the data item referenced


readonly?

optional readonly: boolean;

If true, prevent the user from editing the field values of this reference key through the normal UI