{"id":"9672d43a-189c-4b3a-9609-98240a8e553e","createdDate":"2024-05-30T09:33:57.477Z","updatedDate":"2024-05-30T09:33:57.477Z","resourceId":"4162e174-63b3-4bdb-8b8b-6e468bc522dd","sdk":{"schema":{"name":"velo-deps_wix-data.v2_collections","fqn":"","slug":"velo-deps-wix-data-v2-collections","typesMap":{"BulkGetDataCollectionsResponse":{"name":"BulkGetDataCollectionsResponse","fqn":"BulkGetDataCollectionsResponse","slug":"bulk-get-data-collections-response","actions":[],"properties":[{"name":"activeCollections","slug":"active-collections","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"}},"description":"List of requested collections.\nWhen `include_referenced_collections` is `true` in the request, referenced collections are included here."},{"name":"deletedCollections","slug":"deleted-collections","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"}},"description":"List of requested deleted collections. Only populated when `showDeletedCollections` is true in the request."}]},"DataCollection":{"name":"DataCollection","fqn":"DataCollection","slug":"data-collection","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"DATE"},"description":"Date the collection was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Collection ID. For example, `my-first-collection`. May include a namespace."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"DATE"},"description":"Date the collection was last updated."},{"name":"capabilities","slug":"capabilities","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"CollectionCapabilities","referenceFqn":"CollectionCapabilities"},"description":"Capabilities the collection supports."},{"name":"collectionType","slug":"collection-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"CollectionType","referenceFqn":"CollectionType"},"description":"Collection type. Indicates how the collection was created and is stored.\n\n* `NATIVE`: User-created collection.\n* `WIX_APP`: [Collection](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-collections) created by a Wix app, including [starter collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-starter-collections) created when a Wix app is installed.\n* `BLOCKS_APP`: Collection created by a Wix Blocks app.\n* `EXTERNAL`: Collection located in externally connected storage."},{"name":"defaultDisplayOrder","slug":"default-display-order","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Sort","referenceFqn":"Sort"},"description":"Indicates how the collection's items are sorted by default when a query doesn't specify an order."},{"name":"displayField","slug":"display-field","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"The field whose value the CMS displays to represent the collection item when referenced in a different collection."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Collection's display name as shown in the CMS. For example, `My First Collection`."},{"name":"displayNamespace","slug":"display-namespace","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.\nEmpty for all data collections not owned by internal Wix apps."},{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Field","referenceFqn":"Field"}},"description":"Collection's field structure."},{"name":"maxPageSize","slug":"max-page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of items returned in a single query, based on the underlying storage.\nNative collections have a maximum page size of 1000 for offset-based queries or 100 for cursor-based queries.\nExternal collections' maximum page size defaults to 50, but an external provider can set any maximum value up to 1000."},{"name":"ownerAppId","slug":"owner-app-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app that defined this collection. For user-defined collections, this value is null."},{"name":"pagingModes","slug":"paging-modes","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"PagingMode","referenceFqn":"PagingMode"}},"description":"All paging modes the collection supports. In native collections, offset-based paging is supported by default."},{"name":"permissions","slug":"permissions","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Permissions","referenceFqn":"Permissions"},"description":"Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action."},{"name":"plugins","slug":"plugins","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Plugin","referenceFqn":"Plugin"}},"description":"All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must pass the latest revision number."}]},"CollectionCapabilities":{"name":"CollectionCapabilities","fqn":"CollectionCapabilities","slug":"collection-capabilities","actions":[],"properties":[{"name":"collectionOperations","slug":"collection-operations","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CollectionOperation","referenceFqn":"CollectionOperation"}},"description":"Collection operations supported. The listed operations can be performed on the collection itself.\n+ `UPDATE`: Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed.\n+ `REMOVE`: Allows deleting the entire collection. If not included, the collection can't be deleted."},{"name":"dataOperations","slug":"data-operations","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DataOperation","referenceFqn":"DataOperation"}},"description":"Data operations the collection supports. The listed operations can be performed on data the collection contains.\n\nSupported values: `AGGREGATE`, `BULK_INSERT`, `BULK_REMOVE`, `BULK_SAVE`, `BULK_UPDATE`, `COUNT`, `DISTINCT`, `FIND`, `GET`, `INSERT`, `INSERT_REFERENCE`, `IS_REFERENCED`, `QUERY_REFERENCED`, `REMOVE`, `REMOVE_REFERENCE`, `REPLACE_REFERENCES`, `SAVE`, `TRUNCATE`, `UPDATE`."},{"name":"indexLimits","slug":"index-limits","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"IndexLimits","referenceFqn":"IndexLimits"},"description":"Maximum number of indexes for the collection."}]},"CollectionOperation":{"name":"CollectionOperation","fqn":"CollectionOperation","slug":"collection-operation","actions":[],"enumValues":["REMOVE","UPDATE"],"properties":[]},"DataOperation":{"name":"DataOperation","fqn":"DataOperation","slug":"data-operation","actions":[],"enumValues":["AGGREGATE","BULK_INSERT","BULK_REMOVE","BULK_SAVE","BULK_UPDATE","COUNT","DISTINCT","FIND","GET","INSERT","INSERT_REFERENCE","IS_REFERENCED","QUERY_REFERENCED","REMOVE","REMOVE_REFERENCE","REPLACE_REFERENCES","SAVE","TRUNCATE","UPDATE"],"properties":[]},"IndexLimits":{"name":"IndexLimits","fqn":"IndexLimits","slug":"index-limits","actions":[],"properties":[{"name":"regular","slug":"regular","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of regular (non-unique) indexes allowed for this collection."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of regular and unique indexes allowed for this collection."},{"name":"unique","slug":"unique","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of unique indexes allowed for this collection."}]},"CollectionType":{"name":"CollectionType","fqn":"CollectionType","slug":"collection-type","actions":[],"enumValues":["BLOCKS_APP","EXTERNAL","NATIVE","WIX_APP"],"properties":[]},"Sort":{"name":"Sort","fqn":"Sort","slug":"sort","actions":[],"properties":[{"name":"direction","slug":"direction","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Direction","referenceFqn":"Direction"},"description":"Sort order. Use `ASC` for ascending order or `DESC` for descending order.\n\nDefault: `ASC`"},{"name":"fieldKey","slug":"field-key","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Field to sort by."}]},"Direction":{"name":"Direction","fqn":"Direction","slug":"direction","actions":[],"enumValues":["ASC","DESC"],"properties":[]},"Field":{"name":"Field","fqn":"Field","slug":"field","actions":[],"oneofProperties":{"rangeValidations":[{"name":"arraySizeRange","slug":"array-size-range","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"ArraySizeRange","referenceFqn":"ArraySizeRange"},"description":"Array size range permitted. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`."},{"name":"numberRange","slug":"number-range","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"NumberRange","referenceFqn":"NumberRange"},"description":"Range of possible values for a numerical field."},{"name":"stringLengthRange","slug":"string-length-range","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"StringLengthRange","referenceFqn":"StringLengthRange"},"description":"Length range permitted for a text field. Relevant for fields that hold strings, such as those of type `TEXT` or `RICH_TEXT`."}]},"properties":[{"name":"capabilities","slug":"capabilities","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"FieldCapabilities","referenceFqn":"FieldCapabilities"},"description":"Capabilities the field supports."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Description of the field."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Field's display name when shown in the CMS. For example, `First Name`."},{"name":"encrypted","slug":"encrypted","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates if field is encrypted."},{"name":"immutable","slug":"immutable","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the field is immutable. An immutable field can be set once, but then cannot be updated.\n\nDefault: `false`"},{"name":"key","slug":"key","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique identifier for the field. For example, `firstName`."},{"name":"plugin","slug":"plugin","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"}},{"name":"plugins","slug":"plugins","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FieldPlugin","referenceFqn":"FieldPlugin"}},"description":"Additional optional plugins for the field."},{"name":"readOnly","slug":"read-only","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the field is read-only. A read-only field can't be changed.\n\nDefault: `false`"},{"name":"required","slug":"required","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the field is required.\n\nDefault: `false`"},{"name":"systemField","slug":"system-field","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the field is a system field (created automatically)."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Type","referenceFqn":"Type"},"description":"Field's data type."},{"name":"typeMetadata","slug":"type-metadata","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"TypeMetadata","referenceFqn":"TypeMetadata"},"description":"Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays."}]},"ArraySizeRange":{"name":"ArraySizeRange","fqn":"ArraySizeRange","slug":"array-size-range","actions":[],"properties":[{"name":"maxSize","slug":"max-size","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum permitted number of items in an array field. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`.\n\nDefault: No validation"},{"name":"minSize","slug":"min-size","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Minimum permitted number of items in an array field. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`.\n\nDefault: No validation"}]},"FieldCapabilities":{"name":"FieldCapabilities","fqn":"FieldCapabilities","slug":"field-capabilities","actions":[],"properties":[{"name":"queryOperators","slug":"query-operators","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"QueryOperator","referenceFqn":"QueryOperator"}},"description":"Query operators that can be used for this field.\n\nSupported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`."},{"name":"sortable","slug":"sortable","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the collection can be sorted by this field.\n\nDefault: `false`"}]},"QueryOperator":{"name":"QueryOperator","fqn":"QueryOperator","slug":"query-operator","actions":[],"enumValues":["CONTAINS","ENDS_WITH","EQ","EXISTS","GT","GTE","HAS_ALL","HAS_SOME","LT","LTE","NE","STARTS_WITH","URLIZED"],"properties":[]},"NumberRange":{"name":"NumberRange","fqn":"NumberRange","slug":"number-range","actions":[],"properties":[{"name":"max","slug":"max","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum permitted value for a numerical field.\n\nDefault: No validation"},{"name":"min","slug":"min","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Minimum permitted value for a numerical field.\n\nDefault: No validation"}]},"FieldPlugin":{"name":"FieldPlugin","fqn":"FieldPlugin","slug":"field-plugin","actions":[],"oneofProperties":{"options":[{"name":"cmsOptions","slug":"cms-options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"CmsOptions","referenceFqn":"CmsOptions"},"description":"Options for the CMS plugin."}]},"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"FieldPluginType","referenceFqn":"FieldPluginType"}}]},"CmsOptions":{"name":"CmsOptions","fqn":"CmsOptions","slug":"cms-options","actions":[],"properties":[{"name":"internal","slug":"internal","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates an internal CMS field. The CMS does not display internal fields.\n\nDefault: `false`"}]},"FieldPluginType":{"name":"FieldPluginType","fqn":"FieldPluginType","slug":"field-plugin-type","actions":[],"enumValues":["CMS","UNKNOWN"],"properties":[]},"StringLengthRange":{"name":"StringLengthRange","fqn":"StringLengthRange","slug":"string-length-range","actions":[],"properties":[{"name":"maxLength","slug":"max-length","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum permitted length for a text field.\n\nDefault: No validation"},{"name":"minLength","slug":"min-length","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Minimum permitted length for a text field.\n\nDefault: No validation"}]},"Type":{"name":"Type","fqn":"Type","slug":"type","actions":[],"enumValues":["ADDRESS","ANY","ARRAY","ARRAY_DOCUMENT","ARRAY_STRING","AUDIO","BOOLEAN","DATE","DATETIME","DOCUMENT","IMAGE","LANGUAGE","LEGACY_BOOK","LEGACY_BROKEN_REFERENCE","LEGACY_COLOR","LEGACY_EXTERNAL_URL","LEGACY_EXTERNAL_VIDEO","LEGACY_IMAGE","LEGACY_TIME","MEDIA_GALLERY","MULTI_REFERENCE","NUMBER","OBJECT","PAGE_LINK","REFERENCE","RICH_CONTENT","RICH_TEXT","TEXT","TIME","UNKNOWN_FIELD_TYPE","URL","VIDEO"],"properties":[]},"TypeMetadata":{"name":"TypeMetadata","fqn":"TypeMetadata","slug":"type-metadata","actions":[],"oneofProperties":{"metadata":[{"name":"array","slug":"array","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"_Array","referenceFqn":"_Array"},"description":"Metadata for an array field."},{"name":"multiReference","slug":"multi-reference","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"MultiReference","referenceFqn":"MultiReference"},"description":"Metadata for a multi-reference field."},{"name":"object","slug":"object","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"_Object","referenceFqn":"_Object"},"description":"Metadata for an object field."},{"name":"pageLink","slug":"page-link","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PageLink","referenceFqn":"PageLink"},"description":"Metadata for a page link field."},{"name":"reference","slug":"reference","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Reference","referenceFqn":"Reference"},"description":"Metadata for a reference field."}]},"properties":[]},"_Array":{"name":"_Array","fqn":"_Array","slug":"array","actions":[],"properties":[{"name":"elementType","slug":"element-type","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Type","referenceFqn":"Type"},"description":"Element's data type."},{"name":"typeMetadata","slug":"type-metadata","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"TypeMetadata","referenceFqn":"TypeMetadata"},"description":"Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays."}]},"MultiReference":{"name":"MultiReference","fqn":"MultiReference","slug":"multi-reference","actions":[],"properties":[{"name":"referencedCollectionId","slug":"referenced-collection-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Referenced collection ID."},{"name":"referencingDisplayName","slug":"referencing-display-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Display name in the CMS for the referenced data."},{"name":"referencingFieldKey","slug":"referencing-field-key","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Referencing field key."}]},"_Object":{"name":"_Object","fqn":"_Object","slug":"object","actions":[],"properties":[{"name":"fields","slug":"fields","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ObjectField","referenceFqn":"ObjectField"}},"description":"Fields within the object."}]},"ObjectField":{"name":"ObjectField","fqn":"ObjectField","slug":"object-field","actions":[],"properties":[{"name":"capabilities","slug":"capabilities","isReadOnly":true,"isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"FieldCapabilities","referenceFqn":"FieldCapabilities"},"description":"Capabilities the object field supports."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Display name for the field."},{"name":"key","slug":"key","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Field key."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Type","referenceFqn":"Type"},"description":"Field type."},{"name":"typeMetadata","slug":"type-metadata","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"TypeMetadata","referenceFqn":"TypeMetadata"},"description":"Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays."}]},"PageLink":{"name":"PageLink","fqn":"PageLink","slug":"page-link","actions":[],"properties":[{"name":"calculator","slug":"calculator","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Calculator","referenceFqn":"Calculator"}},{"name":"linkedRouterPage","slug":"linked-router-page","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Defines reference to router pattern in the site document."}]},"Calculator":{"name":"Calculator","fqn":"Calculator","slug":"calculator","actions":[],"oneofProperties":{"pattern":[{"name":"fieldsPattern","slug":"fields-pattern","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"FieldsPattern","referenceFqn":"FieldsPattern"},"description":"Value is calculated according to pattern, whitespaces are replaced with dash [-]."},{"name":"urlizedOnlyPattern","slug":"urlized-only-pattern","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"UrlizedOnlyPattern","referenceFqn":"UrlizedOnlyPattern"},"description":"Value is only URL encoded."}]},"properties":[]},"FieldsPattern":{"name":"FieldsPattern","fqn":"FieldsPattern","slug":"fields-pattern","actions":[],"properties":[{"name":"lowercase","slug":"lowercase","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"}},{"name":"pattern","slug":"pattern","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"}}]},"UrlizedOnlyPattern":{"name":"UrlizedOnlyPattern","fqn":"UrlizedOnlyPattern","slug":"urlized-only-pattern","actions":[],"properties":[{"name":"pattern","slug":"pattern","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"}}]},"Reference":{"name":"Reference","fqn":"Reference","slug":"reference","actions":[],"properties":[{"name":"referencedCollectionId","slug":"referenced-collection-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Referenced collection ID."}]},"PagingMode":{"name":"PagingMode","fqn":"PagingMode","slug":"paging-mode","actions":[],"enumValues":["CURSOR","OFFSET"],"properties":[]},"Permissions":{"name":"Permissions","fqn":"Permissions","slug":"permissions","actions":[],"properties":[{"name":"insert","slug":"insert","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Role","referenceFqn":"Role"},"description":"Lowest role needed to add a collection."},{"name":"read","slug":"read","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Role","referenceFqn":"Role"},"description":"Lowest role needed to read a collection."},{"name":"remove","slug":"remove","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Role","referenceFqn":"Role"},"description":"Lowest role needed to remove a collection."},{"name":"update","slug":"update","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Role","referenceFqn":"Role"},"description":"Lowest role needed to update a collection."}]},"Role":{"name":"Role","fqn":"Role","slug":"role","actions":[],"enumValues":["ADMIN","ANYONE","SITE_MEMBER","SITE_MEMBER_AUTHOR","UNKNOWN_ROLE"],"properties":[]},"Plugin":{"name":"Plugin","fqn":"Plugin","slug":"plugin","actions":[],"oneofProperties":{"options":[{"name":"cmsOptions","slug":"cms-options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PluginCmsOptions","referenceFqn":"PluginCmsOptions"},"description":"Options for the CMS plugin."},{"name":"editablePageLinkOptions","slug":"editable-page-link-options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PageLinkPluginOptions","referenceFqn":"PageLinkPluginOptions"},"description":"Options for the PageLink plugin."},{"name":"multilingualOptions","slug":"multilingual-options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"MultilingualOptions","referenceFqn":"MultilingualOptions"},"description":"Options for the Multilingual plugin."},{"name":"publishOptions","slug":"publish-options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PublishPluginOptions","referenceFqn":"PublishPluginOptions"},"description":"Options for the Publish plugin."},{"name":"singleItemOptions","slug":"single-item-options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"SingleItemPluginOptions","referenceFqn":"SingleItemPluginOptions"},"description":"Options for the Single Item plugin."},{"name":"urlizedOptions","slug":"urlized-options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"UrlizedPluginOptions","referenceFqn":"UrlizedPluginOptions"},"description":"Options for the Urlized plugin."}]},"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PluginType","referenceFqn":"PluginType"},"description":"Plugin types. The following plugins are supported:\n\n* `PUBLISH`: Allows items to be marked as either draft or published. For each item you can set a publishing time when the item will become visible to site visitors.\n* `SINGLE_ITEM`: Ensures the collection can have one item at most. Can only be applied to a new collection.\n* `URLIZED`: Generates item URLs for collections used by dynamic pages.\n* `MULTILINGUAL`: Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).\n* `CMS`: Contains CMS-related collection attributes"}]},"PluginCmsOptions":{"name":"PluginCmsOptions","fqn":"PluginCmsOptions","slug":"plugin-cms-options","actions":[],"properties":[{"name":"siteSort","slug":"site-sort","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"SiteSort","referenceFqn":"SiteSort"},"description":"CMS sort, applied when a collection is displayed on a site."}]},"SiteSort":{"name":"SiteSort","fqn":"SiteSort","slug":"site-sort","actions":[],"properties":[{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Sort","referenceFqn":"Sort"}},"description":"Field and order for the site sort."}]},"PageLinkPluginOptions":{"name":"PageLinkPluginOptions","fqn":"PageLinkPluginOptions","slug":"page-link-plugin-options","actions":[],"properties":[{"name":"isMutable","slug":"is-mutable","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"}},{"name":"isPersisted","slug":"is-persisted","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"}}]},"MultilingualOptions":{"name":"MultilingualOptions","fqn":"MultilingualOptions","slug":"multilingual-options","actions":[],"properties":[{"name":"translatableFieldKeys","slug":"translatable-field-keys","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of fields to allow translation."}]},"PublishPluginOptions":{"name":"PublishPluginOptions","fqn":"PublishPluginOptions","slug":"publish-plugin-options","actions":[],"properties":[{"name":"defaultStatus","slug":"default-status","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Status","referenceFqn":"Status"},"description":"Default status."}]},"Status":{"name":"Status","fqn":"Status","slug":"status","actions":[],"enumValues":["DRAFT","PUBLISHED","UNKNOWN_PUBLISH_PLUGIN_STATUS"],"properties":[]},"SingleItemPluginOptions":{"name":"SingleItemPluginOptions","fqn":"SingleItemPluginOptions","slug":"single-item-plugin-options","actions":[],"properties":[{"name":"singleItemId","slug":"single-item-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the single item in this collection. If you insert or update an item, its ID value is always changed to this."}]},"PluginType":{"name":"PluginType","fqn":"PluginType","slug":"plugin-type","actions":[],"enumValues":["CMS","EDITABLE_PAGE_LINK","GRIDAPPLESS","MULTILINGUAL","PUBLISH","SHARED","SINGLE_ITEM","UNKNOWN_PLUGIN_TYPE","URLIZED"],"properties":[]},"UrlizedPluginOptions":{"name":"UrlizedPluginOptions","fqn":"UrlizedPluginOptions","slug":"urlized-plugin-options","actions":[],"properties":[{"name":"format","slug":"format","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Format","referenceFqn":"Format"},"description":"Encoding method for generating a URL in ASCII characters.\n\n* `ORIGINAL`: Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL.\n* `PLAIN`: No changes are made before generating the encoded URL."}]},"Format":{"name":"Format","fqn":"Format","slug":"format","actions":[],"enumValues":["ORIGINAL","PLAIN","UNKNOWN_URLIZED_PLUGIN_FORMAT"],"properties":[]},"BulkGetDataCollectionsOptions":{"name":"BulkGetDataCollectionsOptions","fqn":"BulkGetDataCollectionsOptions","slug":"bulk-get-data-collections-options","actions":[],"properties":[{"name":"consistentRead","slug":"consistent-read","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`"},{"name":"dataCollectionIds","slug":"data-collection-ids","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the collections to retrieve."},{"name":"includeReferencedCollections","slug":"include-referenced-collections","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the returned collection list should include referenced collections.\n\nDefault: `false`"},{"name":"showDeletedCollections","slug":"show-deleted-collections","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to include deleted collections.\n\nDefault: `false`"},{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Sorting","referenceFqn":"Sorting"},"description":"Sorting preferences."}]},"Sorting":{"name":"Sorting","fqn":"Sorting","slug":"sorting","actions":[],"properties":[{"name":"fieldName","slug":"field-name","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the field to sort by."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"SortOrder","referenceFqn":"SortOrder"},"description":"Sort order."}]},"SortOrder":{"name":"SortOrder","fqn":"SortOrder","slug":"sort-order","actions":[],"enumValues":["ASC","DESC"],"properties":[]},"CreateDataCollectionFieldResponse":{"name":"CreateDataCollectionFieldResponse","fqn":"CreateDataCollectionFieldResponse","slug":"create-data-collection-field-response","actions":[],"properties":[{"name":"dataCollection","slug":"data-collection","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"},"description":"updated data collection"}]},"CreateDataCollectionFieldOptions":{"name":"CreateDataCollectionFieldOptions","fqn":"CreateDataCollectionFieldOptions","slug":"create-data-collection-field-options","actions":[],"properties":[{"name":"field","slug":"field","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Field","referenceFqn":"Field"},"description":"field to create"}]},"DeleteDataCollectionFieldResponse":{"name":"DeleteDataCollectionFieldResponse","fqn":"DeleteDataCollectionFieldResponse","slug":"delete-data-collection-field-response","actions":[],"properties":[{"name":"dataCollection","slug":"data-collection","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"},"description":"updated data collection"}]},"DeleteDataCollectionFieldOptions":{"name":"DeleteDataCollectionFieldOptions","fqn":"DeleteDataCollectionFieldOptions","slug":"delete-data-collection-field-options","actions":[],"properties":[{"name":"fieldKey","slug":"field-key","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"Field key to delete"}]},"GetDataCollectionOptions":{"name":"GetDataCollectionOptions","fqn":"GetDataCollectionOptions","slug":"get-data-collection-options","actions":[],"properties":[{"name":"consistentRead","slug":"consistent-read","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`"}]},"ListDataCollectionsResponse":{"name":"ListDataCollectionsResponse","fqn":"ListDataCollectionsResponse","slug":"list-data-collections-response","actions":[],"properties":[{"name":"collections","slug":"collections","isDeprecated":false,"isInternal":false,"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"}},"description":"List of collections."},{"name":"pagingMetadata","slug":"paging-metadata","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"PagingMetadataV2","referenceFqn":"PagingMetadataV2"},"description":"Paging information."}]},"PagingMetadataV2":{"name":"PagingMetadataV2","fqn":"PagingMetadataV2","slug":"paging-metadata-v2","actions":[],"properties":[{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned in the response."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Offset that was requested."},{"name":"tooManyToCount","slug":"too-many-to-count","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Flag that indicates the server failed to calculate the `total` field."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set."}]},"ListDataCollectionsOptions":{"name":"ListDataCollectionsOptions","fqn":"ListDataCollectionsOptions","slug":"list-data-collections-options","actions":[],"properties":[{"name":"consistentRead","slug":"consistent-read","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to retrieve data from the primary database instance.\nThis decreases performance but ensures data retrieved is up to date even immediately after an update.\nLearn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).\n\nDefault: `false`"},{"name":"paging","slug":"paging","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Paging","referenceFqn":"Paging"},"description":"Pagination information."},{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Sorting","referenceFqn":"Sorting"},"description":"Defines how collections in the response are sorted.\n\nDefault: Ordered by ID in ascending order."}]},"Paging":{"name":"Paging","fqn":"Paging","slug":"paging","actions":[],"properties":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to load."},{"name":"offset","slug":"offset","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to skip in the current sort order."}]},"UpdateDataCollectionFieldResponse":{"name":"UpdateDataCollectionFieldResponse","fqn":"UpdateDataCollectionFieldResponse","slug":"update-data-collection-field-response","actions":[],"properties":[{"name":"dataCollection","slug":"data-collection","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"},"description":"updated data collection"}]},"UpdateDataCollectionFieldOptions":{"name":"UpdateDataCollectionFieldOptions","fqn":"UpdateDataCollectionFieldOptions","slug":"update-data-collection-field-options","actions":[],"properties":[{"name":"field","slug":"field","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"Field","referenceFqn":"Field"},"description":"Field to update"}]}},"actions":[{"name":"createDataCollection","fqn":"createDataCollection","slug":"create-data-collection","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["collection","collection._id","collection.fields.key","collection.fields.type","collection.permissions.insert","collection.permissions.read","collection.permissions.remove","collection.permissions.update"],"permissions":["Manage Data Collections"],"permissionsScopesIds":["SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"},"description":"Details of collection created."},"examples":[{"title":"Create a data collection that only authorized users can edit (dashboard page code)","content":"import { collections } from \"wix-data.v2\";\n\n/* Sample collection object: \n *\n * const newCollection = {\n * _id: \"myMusicCollection\",\n * permissions: {\n * read: \"ANYONE\",\n * insert: \"SITE_MEMBER_AUTHOR\",\n * update: \"SITE_MEMBER_AUTHOR\",\n * remove: \"SITE_MEMBER_AUTHOR\"\n * },\n * fields: [\n * {\n * key: \"artist\",\n * displayName: \"Artist Name\",\n * description: \"The artist's name\",\n * type: \"TEXT\"\n * },\n * {\n * key: \"songTitle\",\n * displayName: \"Song Title\",\n * description: \"The song's full title\",\n * type: \"TEXT\" \n * },\n * {\n * key: \"uploadedBy\",\n * displayName: \"Uploaded By\",\n * description: \"The person who uploaded the song\",\n * type: \"TEXT\",\n * plugins: [\n * {\n * type: \"CMS\",\n * cmsOptions: {\n * internal: true\n * }\n * }\n * ]\n * }\n * ]\n * }; \n */\n\nexport async function myCreateDataCollectionFunction(newCollection) {\n try {\n const createDataCollectionResponse = await collections.createDataCollection(newCollection);\n return createDataCollectionResponse;\n } catch (error) {\n console.error(error);\n // Handle the error\n } \n}\n\n/* Returns a promise that resolves to the created collection:\n * \n * {\n * \"_createdDate\": \"2024-01-04T08:57:43.872Z\",\n * \"_id\": \"myThirdMusicCollection\",\n * \"_updatedDate\": \"2024-01-04T08:57:43.872Z\",\n * \"capabilities\": {\n * \"collectionOperations\": [\n * \"REMOVE\",\n * \"UPDATE\"\n * ],\n * \"dataOperations\": [\n * \"AGGREGATE\",\n * \"BULK_INSERT\",\n * \"BULK_REMOVE\",\n * \"BULK_SAVE\",\n * \"BULK_UPDATE\",\n * \"COUNT\",\n * \"DISTINCT\",\n * \"FIND\",\n * \"GET\",\n * \"INSERT\",\n * \"INSERT_REFERENCE\",\n * \"IS_REFERENCED\",\n * \"QUERY_REFERENCED\",\n * \"REPLACE_REFERENCES\",\n * \"REMOVE\",\n * \"REMOVE_REFERENCE\",\n * \"SAVE\",\n * \"UPDATE\"\n * ],\n * \"indexLimits\": {\n * \"regular\": 3,\n * \"total\": 4,\n * \"unique\": 1\n * }\n * },\n * \"collectionType\": \"NATIVE\",\n * \"displayField\": \"artist\",\n * \"displayName\": \"myMusicCollection\",\n * \"fields\": [\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"description\": \"The artist's name\",\n * \"displayName\": \"Artist Name\",\n * \"encrypted\": false,\n * \"key\": \"artist\",\n * \"plugins\": [],\n * \"systemField\": false,\n * \"type\": \"TEXT\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"description\": \"The song's full title\",\n * \"displayName\": \"Song Title\",\n * \"encrypted\": false,\n * \"key\": \"songTitle\",\n * \"plugins\": [],\n * \"systemField\": false,\n * \"type\": \"TEXT\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"description\": \"The person who uploaded the song\",\n * \"displayName\": \"Uploaded By\",\n * \"encrypted\": false,\n * \"key\": \"uploadedBy\",\n * \"plugins\": [\n * {\n * \"cmsOptions\": {\n * \"internal\": true\n * },\n * \"type\": \"CMS\"\n * }\n * ],\n * \"systemField\": false,\n * \"type\": \"TEXT\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"displayName\": \"ID\",\n * \"encrypted\": false,\n * \"key\": \"_id\",\n * \"plugins\": [],\n * \"systemField\": true,\n * \"type\": \"TEXT\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"displayName\": \"Created Date\",\n * \"encrypted\": false,\n * \"key\": \"_createdDate\",\n * \"plugins\": [],\n * \"systemField\": true,\n * \"type\": \"DATETIME\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"displayName\": \"Updated Date\",\n * \"encrypted\": false,\n * \"key\": \"_updatedDate\",\n * \"plugins\": [],\n * \"systemField\": true,\n * \"type\": \"DATETIME\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"displayName\": \"Owner\",\n * \"encrypted\": false,\n * \"key\": \"_owner\",\n * \"plugins\": [],\n * \"systemField\": true,\n * \"type\": \"TEXT\"\n * }\n * ],\n * \"pagingModes\": [\n * \"OFFSET\"\n * ],\n * \"permissions\": {\n * \"insert\": \"SITE_MEMBER_AUTHOR\",\n * \"read\": \"ANYONE\",\n * \"remove\": \"SITE_MEMBER_AUTHOR\",\n * \"update\": \"SITE_MEMBER_AUTHOR\"\n * },\n * \"plugins\": [],\n * \"revision\": \"1\"\n * }\n */\n"},{"title":"Create a data collection that only authorized users can edit (export from backend code)","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { collections } from \"wix-data.v2\";\n\n/* Sample collection object: \n *\n * const newCollection = {\n * _id: \"myMusicCollection\",\n * permissions: {\n * read: \"ANYONE\",\n * insert: \"SITE_MEMBER_AUTHOR\",\n * update: \"SITE_MEMBER_AUTHOR\",\n * remove: \"SITE_MEMBER_AUTHOR\"\n * },\n * fields: [\n * {\n * key: \"artist\",\n * displayName: \"Artist Name\",\n * description: \"The artist's name\",\n * type: \"TEXT\"\n * },\n * {\n * key: \"songTitle\",\n * displayName: \"Song Title\",\n * description: \"The song's full title\",\n * type: \"TEXT\" \n * },\n * {\n * key: \"uploadedBy\",\n * displayName: \"Uploaded By\",\n * description: \"The person who uploaded the song\",\n * type: \"TEXT\",\n * plugins: [\n * {\n * type: \"CMS\",\n * cmsOptions: {\n * internal: true\n * }\n * }\n * ]\n * }\n * ]\n * }; \n */\n\nexport const myCreateDataCollectionFunction = webMethod(Permissions.Anyone, async (newCollection) => {\n try {\n const createDataCollectionResponse = await collections.createDataCollection(newCollection);\n return createDataCollectionResponse;\n } catch (error) {\n console.error(error);\n // Handle the error\n } \n});\n\n\n/* Returns a promise that resolves to the created collection:\n * \n * {\n * \"_createdDate\": \"2024-01-04T08:57:43.872Z\",\n * \"_id\": \"myThirdMusicCollection\",\n * \"_updatedDate\": \"2024-01-04T08:57:43.872Z\",\n * \"capabilities\": {\n * \"collectionOperations\": [\n * \"REMOVE\",\n * \"UPDATE\"\n * ],\n * \"dataOperations\": [\n * \"AGGREGATE\",\n * \"BULK_INSERT\",\n * \"BULK_REMOVE\",\n * \"BULK_SAVE\",\n * \"BULK_UPDATE\",\n * \"COUNT\",\n * \"DISTINCT\",\n * \"FIND\",\n * \"GET\",\n * \"INSERT\",\n * \"INSERT_REFERENCE\",\n * \"IS_REFERENCED\",\n * \"QUERY_REFERENCED\",\n * \"REPLACE_REFERENCES\",\n * \"REMOVE\",\n * \"REMOVE_REFERENCE\",\n * \"SAVE\",\n * \"UPDATE\"\n * ],\n * \"indexLimits\": {\n * \"regular\": 3,\n * \"total\": 4,\n * \"unique\": 1\n * }\n * },\n * \"collectionType\": \"NATIVE\",\n * \"displayField\": \"artist\",\n * \"displayName\": \"myMusicCollection\",\n * \"fields\": [\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"description\": \"The artist's name\",\n * \"displayName\": \"Artist Name\",\n * \"encrypted\": false,\n * \"key\": \"artist\",\n * \"plugins\": [],\n * \"systemField\": false,\n * \"type\": \"TEXT\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"description\": \"The song's full title\",\n * \"displayName\": \"Song Title\",\n * \"encrypted\": false,\n * \"key\": \"songTitle\",\n * \"plugins\": [],\n * \"systemField\": false,\n * \"type\": \"TEXT\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"description\": \"The person who uploaded the song\",\n * \"displayName\": \"Uploaded By\",\n * \"encrypted\": false,\n * \"key\": \"uploadedBy\",\n * \"plugins\": [\n * {\n * \"cmsOptions\": {\n * \"internal\": true\n * },\n * \"type\": \"CMS\"\n * }\n * ],\n * \"systemField\": false,\n * \"type\": \"TEXT\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"displayName\": \"ID\",\n * \"encrypted\": false,\n * \"key\": \"_id\",\n * \"plugins\": [],\n * \"systemField\": true,\n * \"type\": \"TEXT\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"displayName\": \"Created Date\",\n * \"encrypted\": false,\n * \"key\": \"_createdDate\",\n * \"plugins\": [],\n * \"systemField\": true,\n * \"type\": \"DATETIME\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"displayName\": \"Updated Date\",\n * \"encrypted\": false,\n * \"key\": \"_updatedDate\",\n * \"plugins\": [],\n * \"systemField\": true,\n * \"type\": \"DATETIME\"\n * },\n * {\n * \"capabilities\": {\n * \"queryOperators\": [\n * \"CONTAINS\",\n * \"ENDS_WITH\",\n * \"EQ\",\n * \"EXISTS\",\n * \"GTE\",\n * \"GT\",\n * \"HAS_ALL\",\n * \"HAS_SOME\",\n * \"LT\",\n * \"LTE\",\n * \"NE\",\n * \"STARTS_WITH\",\n * \"URLIZED\"\n * ],\n * \"sortable\": true\n * },\n * \"displayName\": \"Owner\",\n * \"encrypted\": false,\n * \"key\": \"_owner\",\n * \"plugins\": [],\n * \"systemField\": true,\n * \"type\": \"TEXT\"\n * }\n * ],\n * \"pagingModes\": [\n * \"OFFSET\"\n * ],\n * \"permissions\": {\n * \"insert\": \"SITE_MEMBER_AUTHOR\",\n * \"read\": \"ANYONE\",\n * \"remove\": \"SITE_MEMBER_AUTHOR\",\n * \"update\": \"SITE_MEMBER_AUTHOR\"\n * },\n * \"plugins\": [],\n * \"revision\": \"1\"\n * }\n */\n"},{"title":"Create a permissions-protected collection with dynamic URLs ","description":"This function creates a collection whose items anyone can view but only site members with author permissions can edit. A dynamic URL is generated for each item in the collection.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { collections } from 'wix-data.v2';\n\n/* Sample collection object:\n * Includes a plugin that generates dynamic pages for each item in the collection.\n *\n * const newCollection = {\n * _id: \"shirts\",\n * displayName: \"Shirts\",\n * displayField: \"shirts\",\n * permissions: {\n * read: \"ANYONE\",\n * insert: \"SITE_MEMBER_AUTHOR\",\n * update: \"SITE_MEMBER_AUTHOR\",\n * remove: \"SITE_MEMBER_AUTHOR\"\n * },\n * fields: \n * [\n * {\n * key: \"name\",\n * displayName: \"Item Name\",\n * description: \"Name of item, required\",\n * required: true\n * },\n * {\n * key: \"price\",\n * displayName: \"Item Price\",\n * description: \"Price of item, required\",\n * required: true\n * },\n * {\n * key: \"description\",\n * displayName: \"Item Description\",\n * description: \"Item description, not required\",\n * required: false\n * },\n * ],\n * plugins: \n * [\n * {\n * type: \"URLIZED\",\n * urlizedOptions: {\n * format: \"ORIGINAL\"\n * }\n * }\n * ]\n * }; \n */ \n\nexport const myCreateDataCollectionFunctionAdvanced = webMethod(Permissions.Anyone, async (newCollection) => {\n try {\n const createDataCollectionResponse = await collections.createDataCollection(newCollection);\n return createDataCollectionResponse;\n } catch (error) {\n console.error(error);\n // Handle the error\n } \n});\n\n/* Returns a promise that resolves to the created collection:\n * {\n * \"_id\": \"shirts\",\n * \"collectionType\": \"NATIVE\",\n * \"displayName\": \"Shirts\",\n * \"displayField\": \"shirts\",\n * \"capabilities\": {\n * \"dataOperations\": [\n * \"IS_REFERENCED\",\n * \"INSERT\",\n * \"SAVE\",\n * \"BULK_INSERT\",\n * \"BULK_UPDATE\",\n * \"UPDATE\",\n * \"TRUNCATE\",\n * \"REMOVE\",\n * \"REMOVE_REFERENCE\",\n * \"COUNT\",\n * \"FIND\",\n * \"REPLACE_REFERENCES\",\n * \"BULK_REMOVE\",\n * \"INSERT_REFERENCE\",\n * \"GET\",\n * \"BULK_SAVE\",\n * \"QUERY_REFERENCED\",\n * \"DISTINCT\",\n * \"AGGREGATE\"\n * ],\n * \"collectionOperations\": [\n * \"UPDATE\",\n * \"REMOVE\"\n * ],\n * \"indexLimits\": {\n * \"regular\": 3,\n * \"unique\": 1,\n * \"total\": 4\n * }\n * },\n * \"fields\": [\n * {\n * \"key\": \"name\",\n * \"displayName\": \"Item Name\",\n * \"type\": \"TEXT\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false,\n * \"description\": \"Name of item, required\",\n * \"required\": true\n * },\n * // Additional system fields ... \n * ],\n * \"permissions\": {\n * \"insert\": \"SITE_MEMBER_AUTHOR\",\n * \"update\": \"SITE_MEMBER_AUTHOR\",\n * \"remove\": \"SITE_MEMBER_AUTHOR\",\n * \"read\": \"ANYONE\"\n * },\n * \"revision\": \"1\",\n * \"plugins\": \n * [\n * {\n * \"type\": \"URLIZED\",\n * \"urlizedOptions\": {\n * \"format\": \"ORIGINAL\"\n * }\n * }\n * ],\n * \"pagingModes\": \n * [\n * \"OFFSET\"\n * ],\n * \"_createdDate\": \"2023-07-23T11:38:41.518Z\",\n * \"_updatedDate\": \"2023-07-23T11:38:41.518Z\"\n * };\n */ \n"}],"actionParams":[{"name":"collection","slug":"collection","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"},"description":"Collection details."}],"description":"Creates a new data collection.\n\nThe 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."},{"name":"deleteDataCollection","fqn":"deleteDataCollection","slug":"delete-data-collection","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["dataCollectionId"],"permissions":["Manage Data Collections"],"permissionsScopesIds":["SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Delete an existing collection (dashboard page code)","content":"import { collections } from \"wix-data.v2\";\n\n// Deleting the collection whose _id is \"myMusicCollection\": \n// const dataCollectionId = \"myMusicCollection\" \n\nexport async function myDeleteDataCollectionFunction(dataCollectionId) { \n try {\n await collections.deleteDataCollection(dataCollectionId); \n return; \n } catch (error) {\n console.error(error);\n // Handle the error\n } \n} \n\n/* Promise resolves to void */"},{"title":"Delete an existing collection (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { collections } from 'wix-data.v2';\n\n// Deleting the collection whose _id is \"myMusicCollection\": \n// const dataCollectionId = \"myMusicCollection\" \n\nexport const myDeleteDataCollectionFunction = webMethod(Permissions.Anyone, async (dataCollectionId) => {\n try {\n await collections.deleteDataCollection(dataCollectionId);\n return;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Promise resolves to void */\n"}],"actionParams":[{"name":"dataCollectionId","slug":"data-collection-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the collection to delete."}],"description":"Deletes a data collection.\n\n> **Note:**\n> Once a collection is deleted, it can't be restored."},{"name":"getDataCollection","fqn":"getDataCollection","slug":"get-data-collection","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["dataCollectionId"],"permissions":["Manage Data Collections"],"permissionsScopesIds":["SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"},"description":"Details of the collection requested."},"examples":[{"title":"Get a collection","content":"import { collections } from \"wix-data.v2\";\n\n/* Retrieving a collection with an _id of \"myMusicCollection\"\n * \n * Sample dataCollectionId value:\n * const dataCollectionId = \"myMusicCollection\" \n */\n\nexport async function myGetDataCollectionFunction(dataCollectionId) {\n try {\n const retrievedCollection = await collections.getDataCollection(dataCollectionId)\n return retrievedCollection; \n } catch (error) {\n console.error(error);\n // Handle the error\n } \n} \n\n/* Returns a promise that resolves to the retrieved collection:\n* {\n* \"_id\": \"myMusicCollection\",\n* \"collectionType\": \"NATIVE\",\n* \"displayName\": \"My Music Collection\",\n* \"displayField\": \"myMusicCollection\",\n* \"capabilities\": {\n* \"dataOperations\": [\n* \"IS_REFERENCED\",\n* \"INSERT\",\n* \"SAVE\",\n* \"BULK_INSERT\",\n* \"BULK_UPDATE\",\n* \"UPDATE\",\n* \"TRUNCATE\",\n* \"REMOVE\",\n* \"REMOVE_REFERENCE\",\n* \"COUNT\",\n* \"FIND\",\n* \"REPLACE_REFERENCES\",\n* \"BULK_REMOVE\",\n* \"INSERT_REFERENCE\",\n* \"GET\",\n* \"BULK_SAVE\",\n* \"QUERY_REFERENCED\",\n* \"DISTINCT\",\n* \"AGGREGATE\"\n* ],\n* \"collectionOperations\": [\n* \"UPDATE\",\n* \"REMOVE\"\n* ],\n* \"indexLimits\": {\n* \"regular\": 3,\n* \"unique\": 1,\n* \"total\": 4\n* }\n* },\n* \"fields\": \n* [\n* {\n* \"key\": \"artist\",\n* \"displayName\": \"Artist Name\",\n* \"type\": \"TEXT\",\n* \"systemField\": false,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false,\n* \"description\": \"The artist's name\"\n* },\n* {\n* \"key\": \"_id\",\n* \"displayName\": \"ID\",\n* \"type\": \"TEXT\",\n* \"systemField\": true,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false\n* },\n* {\n* \"key\": \"_createdDate\",\n* \"displayName\": \"Created Date\",\n* \"type\": \"DATETIME\",\n* \"systemField\": true,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false\n* },\n* {\n* \"key\": \"_updatedDate\",\n* \"displayName\": \"Updated Date\",\n* \"type\": \"DATETIME\",\n* \"systemField\": true,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false\n* },\n* {\n* \"key\": \"_owner\",\n* \"displayName\": \"Owner\",\n* \"type\": \"TEXT\",\n* \"systemField\": true,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false\n* }\n* ],\n* \"permissions\": {\n* \"insert\": \"SITE_MEMBER_AUTHOR\",\n* \"update\": \"SITE_MEMBER_AUTHOR\",\n* \"remove\": \"SITE_MEMBER_AUTHOR\",\n* \"read\": \"ANYONE\"\n* },\n* \"revision\": \"1\",\n* \"plugins\": [],\n* \"pagingModes\": [\n* \"OFFSET\"\n* ],\n* \"_createdDate\": \"2023-07-19T12:40:02.372Z\",\n* \"_updatedDate\": \"2023-07-19T12:40:02.372Z\"\n* };\n*/ \n"},{"title":"Get a collection (export from backend code)","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { collections } from \"wix-data.v2\";\n\n/* Retrieving a collection with an _id of \"myMusicCollection\"\n * \n * Sample dataCollectionId value:\n * const dataCollectionId = \"myMusicCollection\" \n */\n\nexport const myGetDataCollectionFunction = webMethod(Permissions.Anyone, async (dataCollectionId) => {\n try {\n const retrievedCollection = await collections.getDataCollection(dataCollectionId);\n return retrievedCollection;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Returns a promise that resolves to the retrieved collection:\n* {\n* \"_id\": \"myMusicCollection\",\n* \"collectionType\": \"NATIVE\",\n* \"displayName\": \"My Music Collection\",\n* \"displayField\": \"myMusicCollection\",\n* \"capabilities\": {\n* \"dataOperations\": [\n* \"IS_REFERENCED\",\n* \"INSERT\",\n* \"SAVE\",\n* \"BULK_INSERT\",\n* \"BULK_UPDATE\",\n* \"UPDATE\",\n* \"TRUNCATE\",\n* \"REMOVE\",\n* \"REMOVE_REFERENCE\",\n* \"COUNT\",\n* \"FIND\",\n* \"REPLACE_REFERENCES\",\n* \"BULK_REMOVE\",\n* \"INSERT_REFERENCE\",\n* \"GET\",\n* \"BULK_SAVE\",\n* \"QUERY_REFERENCED\",\n* \"DISTINCT\",\n* \"AGGREGATE\"\n* ],\n* \"collectionOperations\": [\n* \"UPDATE\",\n* \"REMOVE\"\n* ],\n* \"indexLimits\": {\n* \"regular\": 3,\n* \"unique\": 1,\n* \"total\": 4\n* }\n* },\n* \"fields\": \n* [\n* {\n* \"key\": \"artist\",\n* \"displayName\": \"Artist Name\",\n* \"type\": \"TEXT\",\n* \"systemField\": false,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false,\n* \"description\": \"The artist's name\"\n* },\n* {\n* \"key\": \"_id\",\n* \"displayName\": \"ID\",\n* \"type\": \"TEXT\",\n* \"systemField\": true,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false\n* },\n* {\n* \"key\": \"_createdDate\",\n* \"displayName\": \"Created Date\",\n* \"type\": \"DATETIME\",\n* \"systemField\": true,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false\n* },\n* {\n* \"key\": \"_updatedDate\",\n* \"displayName\": \"Updated Date\",\n* \"type\": \"DATETIME\",\n* \"systemField\": true,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false\n* },\n* {\n* \"key\": \"_owner\",\n* \"displayName\": \"Owner\",\n* \"type\": \"TEXT\",\n* \"systemField\": true,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false\n* }\n* ],\n* \"permissions\": {\n* \"insert\": \"SITE_MEMBER_AUTHOR\",\n* \"update\": \"SITE_MEMBER_AUTHOR\",\n* \"remove\": \"SITE_MEMBER_AUTHOR\",\n* \"read\": \"ANYONE\"\n* },\n* \"revision\": \"1\",\n* \"plugins\": [],\n* \"pagingModes\": [\n* \"OFFSET\"\n* ],\n* \"_createdDate\": \"2023-07-19T12:40:02.372Z\",\n* \"_updatedDate\": \"2023-07-19T12:40:02.372Z\"\n* };\n*/\n"}],"actionParams":[{"name":"dataCollectionId","slug":"data-collection-id","isDeprecated":false,"isInternal":false,"type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the collection to retrieve."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"GetDataCollectionOptions","referenceFqn":"GetDataCollectionOptions"},"description":"Options for retrieving a data collection."}],"description":"Retrieves a data collection by ID."},{"name":"listDataCollections","fqn":"listDataCollections","slug":"list-data-collections","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"permissions":["Manage Data Collections"],"permissionsScopesIds":["SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListDataCollectionsResponse","referenceFqn":"ListDataCollectionsResponse"}},"examples":[{"title":"Lists existing collections (dashboard page code)","description":"","content":"import { collections } from \"wix-data.v2\";\n\nexport async function myListDataCollectionsFunction(options) { \n try {\n const myDataCollections = await collections.listDataCollections();\n return myDataCollections;\n } catch (error) {\n console.error(error);\n // Handle the error \n } \n}\n\n/* Returns a promise that resolves to a list of existing data collections: \n* {\n* \"collections\": [\n* // ...\n* {\n* \"_id\": \"myMusicCollection\",\n* \"collectionType\": \"NATIVE\",\n* \"displayName\": \"My Music Collection\",\n* \"displayField\": \"myMusicCollection\",\n* \"capabilities\": {\n* \"dataOperations\": [\n* \"IS_REFERENCED\",\n* \"INSERT\",\n* \"SAVE\",\n* \"BULK_INSERT\",\n* \"BULK_UPDATE\",\n* \"UPDATE\",\n* \"TRUNCATE\",\n* \"REMOVE\",\n* \"REMOVE_REFERENCE\",\n* \"COUNT\",\n* \"FIND\",\n* \"REPLACE_REFERENCES\",\n* \"BULK_REMOVE\",\n* \"INSERT_REFERENCE\",\n* \"GET\",\n* \"BULK_SAVE\",\n* \"QUERY_REFERENCED\",\n* \"DISTINCT\",\n* \"AGGREGATE\"\n* ],\n* \"collectionOperations\": [\n* \"UPDATE\",\n* \"REMOVE\"\n* ],\n* \"indexLimits\": {\n* \"regular\": 3,\n* \"unique\": 1,\n* \"total\": 4\n* }\n* },\n* \"fields\": \n* [\n* {\n* \"key\": \"artist\",\n* \"displayName\": \"Artist Name\",\n* \"type\": \"TEXT\",\n* \"systemField\": false,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false,\n* \"description\": \"The artist's name\"\n* },\n* {\n* \"key\": \"_id\",\n* \"displayName\": \"ID\",\n* \"type\": \"TEXT\",\n* \"systemField\": true,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false\n* },\n* // Additional system fields ...\n* ],\n* \"permissions\": {\n* \"insert\": \"SITE_MEMBER_AUTHOR\",\n* \"update\": \"SITE_MEMBER_AUTHOR\",\n* \"remove\": \"SITE_MEMBER_AUTHOR\",\n* \"read\": \"ANYONE\"\n* },\n* \"revision\": \"1\",\n* \"plugins\": [],\n* \"pagingModes\": [\n* \"OFFSET\"\n* ],\n* \"_createdDate\": \"2023-07-19T12:40:02.372Z\",\n* \"_updatedDate\": \"2023-07-19T12:40:02.372Z\"\n* }\n* ],\n* \"pagingMetadata\": {\n* \"count\": 18,\n* \"offset\": 0,\n* \"total\": 18,\n* \"tooManyToCount\": false\n* }\n* }; \n* */\n"},{"title":"Lists existing collections (export from backend code)","description":"","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { collections } from 'wix-data.v2';\n\nexport const myListDataCollectionsFunction = webMethod(Permissions.Anyone, async (options) => {\n try {\n const myDataCollections = await collections.listDataCollections();\n return myDataCollections;\n } catch (error) {\n console.error(error);\n // Handle the error \n } \n});\n\n/* Returns a promise that resolves to a list of existing data collections: \n* {\n* \"collections\": [\n* // ...\n* {\n* \"_id\": \"myMusicCollection\",\n* \"collectionType\": \"NATIVE\",\n* \"displayName\": \"My Music Collection\",\n* \"displayField\": \"myMusicCollection\",\n* \"capabilities\": {\n* \"dataOperations\": [\n* \"IS_REFERENCED\",\n* \"INSERT\",\n* \"SAVE\",\n* \"BULK_INSERT\",\n* \"BULK_UPDATE\",\n* \"UPDATE\",\n* \"TRUNCATE\",\n* \"REMOVE\",\n* \"REMOVE_REFERENCE\",\n* \"COUNT\",\n* \"FIND\",\n* \"REPLACE_REFERENCES\",\n* \"BULK_REMOVE\",\n* \"INSERT_REFERENCE\",\n* \"GET\",\n* \"BULK_SAVE\",\n* \"QUERY_REFERENCED\",\n* \"DISTINCT\",\n* \"AGGREGATE\"\n* ],\n* \"collectionOperations\": [\n* \"UPDATE\",\n* \"REMOVE\"\n* ],\n* \"indexLimits\": {\n* \"regular\": 3,\n* \"unique\": 1,\n* \"total\": 4\n* }\n* },\n* \"fields\": \n* [\n* {\n* \"key\": \"artist\",\n* \"displayName\": \"Artist Name\",\n* \"type\": \"TEXT\",\n* \"systemField\": false,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false,\n* \"description\": \"The artist's name\"\n* },\n* {\n* \"key\": \"_id\",\n* \"displayName\": \"ID\",\n* \"type\": \"TEXT\",\n* \"systemField\": true,\n* \"capabilities\": {\n* \"sortable\": true,\n* \"queryOperators\": [\n* \"EQ\",\n* \"LT\",\n* \"GT\",\n* \"NE\",\n* \"LTE\",\n* \"GTE\",\n* \"STARTS_WITH\",\n* \"ENDS_WITH\",\n* \"CONTAINS\",\n* \"HAS_SOME\",\n* \"HAS_ALL\",\n* \"EXISTS\",\n* \"URLIZED\"\n* ]\n* },\n* \"encrypted\": false\n* },\n* // Additional system fields ...\n* ],\n* \"permissions\": {\n* \"insert\": \"SITE_MEMBER_AUTHOR\",\n* \"update\": \"SITE_MEMBER_AUTHOR\",\n* \"remove\": \"SITE_MEMBER_AUTHOR\",\n* \"read\": \"ANYONE\"\n* },\n* \"revision\": \"1\",\n* \"plugins\": [],\n* \"pagingModes\": [\n* \"OFFSET\"\n* ],\n* \"_createdDate\": \"2023-07-19T12:40:02.372Z\",\n* \"_updatedDate\": \"2023-07-19T12:40:02.372Z\"\n* }\n* ],\n* \"pagingMetadata\": {\n* \"count\": 18,\n* \"offset\": 0,\n* \"total\": 18,\n* \"tooManyToCount\": false\n* }\n* }; \n* */\n"},{"title":"List up to 10 existing data collections with a given offest ","description":"","content":"import { Permissions, webMethod } from \"wix-web-module\";\nimport { collections } from \"wix-data.v2\";\n\n/* Sample options parameter:\n *\n * const options = {\n * paging: {\n * limit: 10, \n * offset: 1\n * }\n * };\n */ \n\nexport const myListDataCollectionsFunctionAdv = webMethod(Permissions.Anyone, async (options) => {\n try {\n const ListDataCollectionsResponse = await collections.listDataCollections(options);\n return ListDataCollectionsResponse;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Returns a promise that resolves to a list of existing data collections:\n * {\n * \"collections\": [\n * ...\n * // List of collections, starting with the second collection\n * ...\n * { \n * \"_id\": \"Members/FullData\",\n * \"collectionType\": \"WIX_APP\",\n * \"ownerAppId\": \"14cc59bc-f0b7-15b8-e1c7-89ce41d0e0c9\",\n * \"displayName\": \"FullData\",\n * \"defaultDisplayOrder\": {\n * \"fieldKey\": \"_createdDate\",\n * \"direction\": \"ASC\"\n * },\n * \"displayNamespace\": \"Members\",\n * \"displayField\": \"loginEmail\",\n * \"capabilities\": {\n * \"dataOperations\": [\n * \"UPDATE\",\n * \"REMOVE\",\n * \"COUNT\",\n * \"FIND\",\n * \"GET\"\n * ],\n * \"collectionOperations\": []\n * },\n * \"fields\": \n * [\n * {\n * \"key\": \"_id\",\n * \"displayName\": \"ID\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": [\n * \"EQ\",\n * \"HAS_SOME\",\n * \"CONTAINS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"loginEmail\",\n * \"displayName\": \"Login Email\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": [\n * \"EQ\",\n * \"HAS_SOME\",\n * \"CONTAINS\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"firstName\",\n * \"displayName\": \"First Name\",\n * \"type\": \"TEXT\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"HAS_SOME\",\n * \"CONTAINS\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"lastName\",\n * \"displayName\": \"Last Name\",\n * \"type\": \"TEXT\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"HAS_SOME\",\n * \"CONTAINS\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"phone\",\n * \"displayName\": \"Phone\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": []\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"email\",\n * \"displayName\": \"Email\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": []\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"nickname\",\n * \"displayName\": \"Nickname\",\n * \"type\": \"TEXT\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"HAS_SOME\",\n * \"CONTAINS\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"slug\",\n * \"displayName\": \"Slug\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": [\n * \"EQ\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"profilePhoto\",\n * \"displayName\": \"Profile Photo\",\n * \"type\": \"IMAGE\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": []\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"coverPhoto\",\n * \"displayName\": \"Cover Photo\",\n * \"type\": \"IMAGE\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": []\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"status\",\n * \"displayName\": \"Status\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": []\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"privacyStatus\",\n * \"displayName\": \"Privacy Status\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": []\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"activityStatus\",\n * \"displayName\": \"Activity Status\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": []\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"lastLoginDate\",\n * \"displayName\": \"Last Login Date\",\n * \"type\": \"DATETIME\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": []\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_createdDate\",\n * \"displayName\": \"Creation Date\",\n * \"type\": \"DATETIME\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": []\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_updatedDate\",\n * \"displayName\": \"Last Updated\",\n * \"type\": \"DATETIME\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": false,\n * \"queryOperators\": []\n * },\n * \"encrypted\": false\n * }\n * ],\n * \"permissions\": {\n * \"insert\": \"ADMIN\",\n * \"update\": \"ADMIN\",\n * \"remove\": \"ADMIN\",\n * \"read\": \"ANYONE\"\n * },\n * \"revision\": \"0\",\n * \"plugins\": [],\n * \"pagingModes\": [\n * \"OFFSET\"\n * ]\n * }\n * ],\n * \"pagingMetadata\": {\n * \"count\": 10,\n * \"offset\": 1,\n * \"total\": 18,\n * \"tooManyToCount\": false\n * }\n * };\n */ \n"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"ListDataCollectionsOptions","referenceFqn":"ListDataCollectionsOptions"},"description":"Options for retrieving a list of data collections."}],"description":"Retrieves a list of all data collections associated with the site or project.\n\nBy default, the list is ordered by ID in ascending order."},{"name":"updateDataCollection","fqn":"updateDataCollection","slug":"update-data-collection","isDeprecated":false,"isInternal":false,"isDeveloperPreview":false,"requiredProperties":["collection","collection._id","collection.fields.key","collection.fields.type","collection.permissions.insert","collection.permissions.read","collection.permissions.remove","collection.permissions.update","collection.revision"],"permissions":["Manage Data Collections"],"permissionsScopesIds":["SCOPE.DC-DATA.DATA-COLLECTIONS-MANAGE"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"},"description":"Updated collection details."},"examples":[{"title":"Updates an existing collection (dashboard page code)","content":"\nimport { collections } from \"wix-data.v2\";\n\n/* Example collection parameter: \n * Elevate read permissions to SITE_MEMBER, and add a field\n * \n * const updatedDataCollection = {\n * _id: \"myMusicCollection\",\n * fields: \n * [\n * {\n * key: \"artist\",\n * displayName: \"Artist Name\",\n * description: \"The artist's name\",\n * },\n * {\n * key: \"song\",\n * displayName: \"Song Title\",\n * description: \"The song's title\",\n * \"required\": true\n * },\n * ]\n * revision: \"1\",\n * permissions: {\n * read: \"SITE_MEMBER\", \n * insert: \"SITE_MEMBER_AUTHOR\",\n * update: \"SITE_MEMBER_AUTHOR\",\n * remove: \"SITE_MEMBER_AUTHOR\"\n * },\n * };\n */\n\n\nexport async function myUpdateDataCollectionFunction(updatedDataCollection) {\n try {\n const updateDataCollectionResponse = await collections.updateDataCollection(updatedDataCollection);\n return updateDataCollectionResponse; \n } catch (error) {\n console.error(error);\n // Handle the error\n } \n} \n\n/* Returns a promise that resolves to the updated collection:\n * {\n * \"_id\": \"myMusicCollection\",\n * \"collectionType\": \"NATIVE\",\n * \"displayName\": \"My Music Collection\",\n * \"displayField\": \"myMusicCollection\",\n * \"capabilities\": {\n * \"dataOperations\": [\n * \"IS_REFERENCED\",\n * \"INSERT\",\n * \"SAVE\",\n * \"BULK_INSERT\",\n * \"BULK_UPDATE\",\n * \"UPDATE\",\n * \"TRUNCATE\",\n * \"REMOVE\",\n * \"REMOVE_REFERENCE\",\n * \"COUNT\",\n * \"FIND\",\n * \"REPLACE_REFERENCES\",\n * \"BULK_REMOVE\",\n * \"INSERT_REFERENCE\",\n * \"GET\",\n * \"BULK_SAVE\",\n * \"QUERY_REFERENCED\",\n * \"DISTINCT\",\n * \"AGGREGATE\"\n * ],\n * \"collectionOperations\": [\n * \"UPDATE\",\n * \"REMOVE\"\n * ],\n * \"indexLimits\": {\n * \"regular\": 3,\n * \"unique\": 1,\n * \"total\": 4\n * }\n * },\n * \"fields\": [\n * {\n * \"key\": \"artist\",\n * \"displayName\": \"Artist Name\",\n * \"type\": \"TEXT\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false,\n * \"description\": \"The artist's name\",\n * \"required\": true\n * },\n * {\n * \"key\": \"song\",\n * \"displayName\": \"Song Title\",\n * \"type\": \"TEXT\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false,\n * \"description\": \"The song's title\",\n * \"required\": true\n * },\n * {\n * \"key\": \"_id\",\n * \"displayName\": \"ID\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_createdDate\",\n * \"displayName\": \"Created Date\",\n * \"type\": \"DATETIME\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_updatedDate\",\n * \"displayName\": \"Updated Date\",\n * \"type\": \"DATETIME\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_owner\",\n * \"displayName\": \"Owner\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * }\n * ],\n * \"permissions\": {\n * \"insert\": \"SITE_MEMBER\",\n * \"update\": \"SITE_MEMBER_AUTHOR\",\n * \"remove\": \"SITE_MEMBER_AUTHOR\",\n * \"read\": \"SITE_MEMBER_AUTHOR\"\n * },\n * \"revision\": \"2\",\n * \"plugins\": [],\n * \"pagingModes\": [\n * \"OFFSET\"\n * ],\n * \"_createdDate\": \"2023-07-19T12:40:02.372Z\",\n * \"_updatedDate\": \"2023-07-19T14:00:28.836Z\"\n * }\n */ \n"},{"title":"Updates an existing collection (export from backend code)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { collections } from 'wix-data.v2';\n\n/* Example collection parameter: \n * Elevate read permissions to SITE_MEMBER, and add a field\n * \n * const updatedDataCollection = {\n * _id: \"myMusicCollection\",\n * fields: \n * [\n * {\n * key: \"artist\",\n * displayName: \"Artist Name\",\n * description: \"The artist's name\",\n * },\n * {\n * key: \"song\",\n * displayName: \"Song Title\",\n * description: \"The song's title\",\n * \"required\": true\n * },\n * ]\n * revision: \"1\",\n * permissions: {\n * read: \"SITE_MEMBER\", \n * insert: \"SITE_MEMBER_AUTHOR\",\n * update: \"SITE_MEMBER_AUTHOR\",\n * remove: \"SITE_MEMBER_AUTHOR\"\n * },\n * };\n */\n\nexport const myUpdateDataCollectionFunction = webMethod(Permissions.Anyone, async (updatedDataCollection) => {\n try {\n const updateDataCollectionResponse = await collections.updateDataCollection(updatedDataCollection);\n return updateDataCollectionResponse;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Returns a promise that resolves to the updated collection:\n * {\n * \"_id\": \"myMusicCollection\",\n * \"collectionType\": \"NATIVE\",\n * \"displayName\": \"My Music Collection\",\n * \"displayField\": \"myMusicCollection\",\n * \"capabilities\": {\n * \"dataOperations\": [\n * \"IS_REFERENCED\",\n * \"INSERT\",\n * \"SAVE\",\n * \"BULK_INSERT\",\n * \"BULK_UPDATE\",\n * \"UPDATE\",\n * \"TRUNCATE\",\n * \"REMOVE\",\n * \"REMOVE_REFERENCE\",\n * \"COUNT\",\n * \"FIND\",\n * \"REPLACE_REFERENCES\",\n * \"BULK_REMOVE\",\n * \"INSERT_REFERENCE\",\n * \"GET\",\n * \"BULK_SAVE\",\n * \"QUERY_REFERENCED\",\n * \"DISTINCT\",\n * \"AGGREGATE\"\n * ],\n * \"collectionOperations\": [\n * \"UPDATE\",\n * \"REMOVE\"\n * ],\n * \"indexLimits\": {\n * \"regular\": 3,\n * \"unique\": 1,\n * \"total\": 4\n * }\n * },\n * \"fields\": [\n * {\n * \"key\": \"artist\",\n * \"displayName\": \"Artist Name\",\n * \"type\": \"TEXT\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false,\n * \"description\": \"The artist's name\",\n * \"required\": true\n * },\n * {\n * \"key\": \"song\",\n * \"displayName\": \"Song Title\",\n * \"type\": \"TEXT\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false,\n * \"description\": \"The song's title\",\n * \"required\": true\n * },\n * {\n * \"key\": \"_id\",\n * \"displayName\": \"ID\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_createdDate\",\n * \"displayName\": \"Created Date\",\n * \"type\": \"DATETIME\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_updatedDate\",\n * \"displayName\": \"Updated Date\",\n * \"type\": \"DATETIME\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_owner\",\n * \"displayName\": \"Owner\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * }\n * ],\n * \"permissions\": {\n * \"insert\": \"SITE_MEMBER\",\n * \"update\": \"SITE_MEMBER_AUTHOR\",\n * \"remove\": \"SITE_MEMBER_AUTHOR\",\n * \"read\": \"SITE_MEMBER_AUTHOR\"\n * },\n * \"revision\": \"2\",\n * \"plugins\": [],\n * \"pagingModes\": [\n * \"OFFSET\"\n * ],\n * \"_createdDate\": \"2023-07-19T12:40:02.372Z\",\n * \"_updatedDate\": \"2023-07-19T14:00:28.836Z\"\n * }\n */\n"},{"title":"Updates an existing collection ","description":"This function effectively replaces the existing collection with the collection passed as a parameter.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { collections } from 'wix-data.v2';\n\n/* Example collection object: \n *\n * Existing fields are added a \"type\" property. In addition, a plugin has been added that defines each new * item in the collection draft by default. You can publish them at a later date. \n * \n * const updatedCollection = {\n * _id: \"shirts\",\n * revision: \"1\",\n * displayName: \"Shirts\",\n * displayField: \"shirts\",\n * permissions: {\n * read: \"ANYONE\",\n * insert: \"SITE_MEMBER_AUTHOR\",\n * update: \"SITE_MEMBER_AUTHOR\",\n * remove: \"SITE_MEMBER_AUTHOR\"\n * },\n * fields: \n * [\n * {\n * key: \"name\",\n * displayName: \"Item Name\",\n * description: \"Name of item, required\",\n * required: true,\n * type: \"TEXT\"\n * },\n * {\n * key: \"price\",\n * displayName: \"Price of Item\",\n * description: \"Price of item, required\",\n * required: true,\n * type: \"NUMBER\" \n * },\n * {\n * key: \"desc\",\n * displayName: \"Item Description\",\n * description: \"Item description, not required\",\n * type: \"TEXT\" \n * },\n * ],\n * plugins: \n * [\n * {\n * type: \"URLIZED\",\n * urlizedOptions: {\n * format: \"ORIGINAL\"\n * }\n * },\n * {\n * type: \"PUBLISH\", \n * publishOptions: {\n * defaultStatus: \"DRAFT\" \n * }\n * }\n * ]\n * }; \n */\n\nexport const myUpdateDataCollectionFunction = webMethod(Permissions.Anyone, async (updatedCollection) => {\n try {\n const updateDataCollectionResponse = await collections.updateDataCollection(updatedCollection);\n return updateDataCollectionResponse;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Returns a promise that resolves to the updated collection:\n * {\n * \"_id\": \"shirts\",\n * \"collectionType\": \"NATIVE\",\n * \"displayName\": \"Shirts\",\n * \"displayField\": \"shirts\",\n * \"capabilities\": {\n * \"dataOperations\": [\n * \"IS_REFERENCED\",\n * \"INSERT\",\n * \"SAVE\",\n * \"BULK_INSERT\",\n * \"BULK_UPDATE\",\n * \"UPDATE\",\n * \"TRUNCATE\",\n * \"REMOVE\",\n * \"REMOVE_REFERENCE\",\n * \"COUNT\",\n * \"FIND\",\n * \"REPLACE_REFERENCES\",\n * \"BULK_REMOVE\",\n * \"INSERT_REFERENCE\",\n * \"GET\",\n * \"BULK_SAVE\",\n * \"QUERY_REFERENCED\",\n * \"DISTINCT\",\n * \"AGGREGATE\"\n * ],\n * \"collectionOperations\": [\n * \"UPDATE\",\n * \"REMOVE\"\n * ],\n * \"indexLimits\": {\n * \"regular\": 3,\n * \"unique\": 1,\n * \"total\": 4\n * }\n * },\n * \"fields\": [\n * {\n * \"key\": \"name\",\n * \"displayName\": \"Item Name\",\n * \"type\": \"TEXT\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false,\n * \"description\": \"Name of item, required\",\n * \"required\": true\n * },\n * {\n * \"key\": \"price\",\n * \"displayName\": \"Price of Item\",\n * \"type\": \"NUMBER\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false,\n * \"description\": \"Price of item, required\",\n * \"required\": true\n * },\n * {\n * \"key\": \"desc\",\n * \"displayName\": \"Item Description\",\n * \"type\": \"TEXT\",\n * \"systemField\": false,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false,\n * \"description\": \"Item description, not required\"\n * },\n * {\n * \"key\": \"_id\",\n * \"displayName\": \"ID\",\n * \"type\": \"TEXT\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_createdDate\",\n * \"displayName\": \"Created Date\",\n * \"type\": \"DATETIME\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_updatedDate\",\n * \"displayName\": \"Updated Date\",\n * \"type\": \"DATETIME\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * },\n * {\n * \"key\": \"_draftDate\",\n * \"displayName\": \"Unpublish Date\",\n * \"type\": \"DATETIME\",\n * \"systemField\": true,\n * \"capabilities\": {\n * \"sortable\": true,\n * \"queryOperators\": [\n * \"EQ\",\n * \"LT\",\n * \"GT\",\n * \"NE\",\n * \"LTE\",\n * \"GTE\",\n * \"STARTS_WITH\",\n * \"ENDS_WITH\",\n * \"CONTAINS\",\n * \"HAS_SOME\",\n * \"HAS_ALL\",\n * \"EXISTS\",\n * \"URLIZED\"\n * ]\n * },\n * \"encrypted\": false\n * }\n * ],\n * \"permissions\": {\n * \"insert\": \"SITE_MEMBER_AUTHOR\",\n * \"update\": \"SITE_MEMBER_AUTHOR\",\n * \"remove\": \"SITE_MEMBER_AUTHOR\",\n * \"read\": \"ANYONE\"\n * },\n * \"revision\": \"2\",\n * \"plugins\": [\n * {\n * \"type\": \"URLIZED\",\n * \"urlizedOptions\": {\n * \"format\": \"ORIGINAL\"\n * }\n * },\n * {\n * \"type\": \"PUBLISH\",\n * \"publishOptions\": {\n * \"defaultStatus\": \"DRAFT\"\n * }\n * }\n * ],\n * \"pagingModes\": [\n * \"OFFSET\"\n * ],\n * \"_createdDate\": \"2023-07-23T11:38:41.518Z\",\n * \"_updatedDate\": \"2023-07-23T13:13:49.154Z\"\n * };\n */\n"}],"actionParams":[{"name":"collection","slug":"collection","isDeprecated":false,"isInternal":false,"type":{"kind":"REFERENCE","name":"DataCollection","referenceFqn":"DataCollection"},"description":"Updated collection details. The existing collection is replaced with this version."}],"description":"Updates a data collection.\n\nA collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.\nIf a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.\nOtherwise, the request fails.\n\nWhen a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.\n\n> **Note:**\n> After a collection is updated, it only contains the properties included in the `updateDataCollection()` call. If the existing collection has properties with values and those properties\n> aren't included in the updated collection details, their values are lost."}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n\n# About the Data Collections API\n\n\n\nThe Data Collections API enables you to create, delete, and modify the structure of data collections in a Wix site.\n\n## Data collections and their structure\nWix sites store data in collections.\nA collection determines the structure of the data to be stored, defining the fields each item should contain and the data type of each field.\nYou can [create and modify collections](https://support.wix.com/en/article/content-manager-creating-a-collection) for a site using the Content Management System(CMS).\nWith the Data Collections API, you can also use code to create, modify, and delete collections in a Wix site.\nYou can then store and retrieve data in these collections using [`wix-data`](https://www.wix.com/velo/reference/wix-data).\n\n**Note:**\nThe 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.\n\n## Setting Collection Edit Permissions \n\nAccess 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.\n\nWix Data recognizes 4 roles: \n* `ADMIN`: The site owner.\n* `SITE_MEMBER_AUTHOR`: A signed-in user who has added content to the collection.\n* `SITE MEMBER`: Any signed-in user.\n* `ANYONE`: Any site visitor.\n\nFor 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:\n* `insert`: `ADMIN`\n* `update`: `ADMIN`\n* `remove`: `ADMIN`\n* `read`: `SITE_MEMBER`\n\n## Function permissions information\n\nFunctions in the Wix Data v2 API are restricted and only run if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n\n

\n
Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.
\n

","displayName":"Introduction","slugifyName":"introduction","fqn":"Introduction60"}],"builderTypes":[],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.77"}}

getDataCollection( )