Data Collection Object


A data collection determines the structure of data to be stored in a database.

Properties
capabilitiesCollectionCapabilitiesRead-only

Capabilities the collection supports.


collectionTypestringRead-only

Collection type. Indicates how the collection was created and how it is stored.


createdDatestringRead-onlyformat date-time

Date the collection was created.


defaultDisplayOrderSortRead-only

Default item sorting order when a query doesn't specify one.


displayFieldstringmaxLength 1000

Field whose value the CMS displays to represent the collection item when referenced in a different collection.


displayNamestringmaxLength 1000

Collection's display name as shown in the CMS. For example, My First Collection.


displayNamespacestringRead-onlymaxLength 1000

UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings. Empty for all data collections not owned by Wix apps.


fieldsArray <Field>maxItems 1000

Collection's field structure.


idstringimmutablemaxLength 256

Collection ID. For example, my-first-collection. May include a namespace.


maxPageSizeintegerRead-onlyformat int32

Maximum number of items returned in a single query, based on the underlying storage. Native collections have a maximum page size of 1000 for offset-based queries or 100 for cursor-based queries. External collections' maximum page size defaults to 50, but an external provider can set any maximum value up to 1000.


ownerAppIdstringRead-onlyformat GUID

ID of the app that defined this collection. For collections defined by Wix users, this value is null.


pagingModesArray <string>Read-onlymaxItems 2

Paging modes the collection supports. In native collections, offset-based paging is supported by default.


permissionsPermissions

Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action.


pluginsArray <Plugin>maxItems 100

Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality.


revisionstringRead-onlyformat int64

Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.


updatedDatestringRead-onlyformat date-time

Date the collection was last updated.

Did this help?