The Data Collections API enables your app to create, delete, and modify the structure of data collections in a Wix site.
Wix sites store data in collections. A collection determines the structure of the data to be stored, defining the fields each item should contain and the data type of each field. Site owners can create and modify collections for their site using the Content Management System(CMS). With the Data Collections API, you can use code to create, modify, and delete collections in a Wix site. You can then store and retrieve data in these collections using the Data Items API.
Note: The structure you define for a data collection isn't enforced. This means that if you add or update an item containing a field or data type that doesn't match the collection's structure, your data is stored anyway.
Access to a data collection is controlled by its permissions. These permissions are defined in the collection object and they specify which types of user can perform actions on the data contained in the collection.
Wix Data recognizes 4 roles:
ADMIN: The site owner.SITE_MEMBER_AUTHOR: A signed-in user who has added content to the collection.SITE MEMBER: Any signed-in user.ANYONE: Any site visitor.
For each of the 4 basic actions (inserting, updating, removing, and reading content) the minimal role required must be set. For example, if you want to allow only site members to view data, and only the site owner to insert, update, and remove data, declare your permissions as follows:
insert:ADMINupdate:ADMINremove:ADMINread:SITE_MEMBER
- NATIVE: User-created collection.
- WIX_APP: Collection created by a Wix app, including starter collections created when a Wix app is installed.
- BLOCKS_APP: Collection created by a Wix Blocks app.
- EXTERNAL: Collection located in externally connected storage.
Updates a data collection.
A collection ID, revision number, permissions, and at least 1 field must be provided within the collection body parameter.
If a collection with that ID exists, and if its current revision number matches the one provided, it is updated.
Otherwise, the request fails.
When a collection is updated, its updatedDate property is changed to the current date and its revision property is incremented.
Note: After a collection is updated, it only contains the properties included in the Update Data Collection request. If the existing collection has properties with values and those properties aren't included in the updated collection details, their values are lost.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Retrieves a list of all data collections associated with the site or project.
By default, the list is ordered by ID in ascending order.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Creates a new data collection.
The request body must include an ID, details for at least 1 field, and a permissions object. If any of these are missing, the collection isn't created.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Retrieves a data collection by ID.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Deletes a data collection.
Note: Once a collection is deleted, it can't be restored.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Event triggered when collection is cloned from other instance CREATED event will be also triggered along with this action
Event Body
Event triggered when collection is changed, describing some of changes UPDATED event will be also triggered along with this action