{"id":"f6bdd4ba-c35f-4486-903e-1050b376c165","createdDate":"2024-07-09T11:03:53.092Z","updatedDate":"2024-07-09T11:03:53.092Z","resourceId":"cc32e433-637d-4b53-af07-6747e142e0af","api":{"schema":{"object":{"displayName":" Object","description":"","slug":"object","$ref":"","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git","SPIService":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService"},"methods":[{"summary":"Query Data Items","description":"Retrieves a list of items based on the provided filtering, sorting, and paging preferences.\n\nSee [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information about handling data queries.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.QueryDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.QueryDataItemsResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryDataItemsRequest","description":"","properties":{"collectionId":{"description":"ID of the collection to query.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"query":{"description":"Query preferences. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for information about handling data queries.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includeReferencedItems":{"description":"Fields for which to include the full referenced items in the query's results, rather than just their IDs.\nReturned items are sorted in ascending order by the creation date of the reference.\nIf the field being querried is a multi-reference field and the array is empty, the response does not return any items.","title":"includeReferencedItems","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.QueryDataItemsRequest.ReferencedItemToInclude"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Applicable if the external database is eventually consistent.","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"When `true`, the query response must include the total number of items that match the query.","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collectionId","query","query.filter","query.pagingMethod","consistentRead","returnTotalCount"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"ITEM_ALREADY_EXISTS","name":"ItemAlreadyExists","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.ItemAlreadyExistsError"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"ITEM_NOT_FOUND","name":"ItemNotFound","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.ItemNotFoundError"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"COLLECTION_ALREADY_EXISTS","name":"CollectionAlreadyExists","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.CollectionAlreadyExistsError"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"COLLECTION_NOT_FOUND","name":"CollectionNotFound","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.CollectionNotFoundError"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"REFERENCE_ALREADY_EXISTS","name":"ReferenceAlreadyExists","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.ReferenceAlreadyExistsError"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"REFERENCE_NOT_FOUND","name":"ReferenceNotFound","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.ReferenceNotFoundError"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"VALIDATION_ERROR","name":"ValidationError","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.ValidationError"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"COLLECTION_CHANGE_NOT_SUPPORTED","name":"CollectionChangeNotSupportedError","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.CollectionChangeNotSupported"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BAD_REQUEST","name":"BadRequestError"}],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryDataItemsResponse"},"legacyExamples":[{"name":"QueryDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Query a single data item by ID","description":"Queries a single data item using a filter with an `_id` field.","request":"curl POST https://external-db.example.com/v3/items/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\"\n },\n \"sort\": [],\n \"paging\": {\n \"limit\": 1,\n \"offset\": 0\n },\n \"fields\": []\n },\n \"includeReferencedItems\": [],\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"items\": [{\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"population\": 8300000.0,\n \"country\": \"US\",\n \"isCapital\": false\n }],\n \"pagingMetadata\": {\n }\n}"}},{"name":"QueryDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":4,"content":{"title":"Complex query","description":"A query with filtering requirements, sorting preferences, and the fields and referenced items to include.","request":"curl POST https://external-db.example.com/v3/items/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n \"$or\": [{\n \"$and\": [{\n \"name\": {\n \"$startsWith\": \"New\"\n }\n }, {\n \"population\": {\n \"$gt\": 1000000.0\n }\n }]\n }, {\n \"$and\": [{\n \"isCapital\": true\n }, {\n \"_updatedDate\": {\n \"$gt\": {\n \"$date\": \"2021-01-01T00:00:00Z\"\n }\n }\n }, {\n \"$not\": {\n \"name\": {\n \"$startsWith\": \"New\"\n }\n }\n }]\n }]\n },\n \"sort\": [{\n \"fieldName\": \"country\",\n \"order\": \"ASC\"\n }, {\n \"fieldName\": \"name\",\n \"order\": \"DESC\"\n }],\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"fields\": [\"_id\", \"name\", \"population\", \"pointsOfInterest\", \"myTrips\", \"_updatedDate\"]\n },\n \"includeReferencedItems\": [{\n \"fieldKey\": \"pointsOfInterest\",\n \"limit\": 50\n }, {\n \"fieldKey\": \"myTrips\",\n \"limit\": 50,\n \"filter\": {\n \"_owner\": \"6785b759-eeb3-4709-ac3c-91013d82690c\"\n }\n }],\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"items\": [{\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"population\": 8336817.0,\n \"myTrips\": [{\n \"_id\": \"528a0b23-d6d8-464a-82af-09e0c00f56b0\",\n \"startDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n }\n }],\n \"_updatedDate\": {\n \"$date\": \"2021-02-03T04:05:06Z\"\n },\n \"pointsOfInterest\": [{\n \"_id\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"name\": \"Statue of Liberty\"\n }, {\n \"_id\": \"0348998e-48d7-463e-96c3-a571d4a568a8\",\n \"name\": \"Empire State Building\"\n }]\n }],\n \"pagingMetadata\": {\n }\n}"}},{"name":"QueryDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Query data items","request":"curl POST https://external-db.example.com/v3/items/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n },\n \"sort\": [],\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"fields\": []\n },\n \"includeReferencedItems\": [],\n \"consistentRead\": false,\n \"returnTotalCount\": true\n}'","response":"{\n \"items\": [{\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"population\": 8300000.0,\n \"country\": \"US\",\n \"isCapital\": false\n }],\n \"pagingMetadata\": {\n \"total\": 1\n }\n}"}},{"name":"QueryDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":3,"content":{"title":"Query with cursor information","description":"For collections that support cursor pagination, a cursor is provided for the second page and onwards.","request":"curl POST https://external-db.example.com/v3/items/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n },\n \"sort\": [],\n \"fields\": [],\n \"cursorPaging\": {\n \"limit\": 2,\n \"cursor\": \"ImtpZCI6ImEz\"\n }\n },\n \"includeReferencedItems\": [],\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"items\": [{\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"population\": 8300000.0,\n \"country\": \"US\",\n \"isCapital\": false\n }, {\n \"name\": \"Paris\",\n \"_id\": \"e831385d-d067-4905-a98a-456f5a526ca2\",\n \"population\": 2100000.0,\n \"country\": \"FR\",\n \"isCapital\": true\n }],\n \"pagingMetadata\": {\n \"cursors\": {\n \"next\": \"0O52kwmAcT\",\n \"prev\": \"omZq6gTpR9\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"ITEM_ALREADY_EXISTS","name":"ItemAlreadyExists","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.ItemAlreadyExistsError"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"ITEM_NOT_FOUND","name":"ItemNotFound","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.ItemNotFoundError"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"COLLECTION_ALREADY_EXISTS","name":"CollectionAlreadyExists","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.CollectionAlreadyExistsError"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"COLLECTION_NOT_FOUND","name":"CollectionNotFound","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.CollectionNotFoundError"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"REFERENCE_ALREADY_EXISTS","name":"ReferenceAlreadyExists","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.ReferenceAlreadyExistsError"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"REFERENCE_NOT_FOUND","name":"ReferenceNotFound","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.ReferenceNotFoundError"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"VALIDATION_ERROR","name":"ValidationError","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.ValidationError"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"COLLECTION_CHANGE_NOT_SUPPORTED","name":"CollectionChangeNotSupportedError","errorSchemaName":"com.wixpress.cloud.externaldatabasespi.v3.CollectionChangeNotSupported"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"BAD_REQUEST","name":"BadRequestError"}],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryDataItemsResponse"},"legacyExamples":[{"name":"QueryDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Query a single data item by ID","description":"Queries a single data item using a filter with an `_id` field.","request":"curl POST https://external-db.example.com/v3/items/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\"\n },\n \"sort\": [],\n \"paging\": {\n \"limit\": 1,\n \"offset\": 0\n },\n \"fields\": []\n },\n \"includeReferencedItems\": [],\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"items\": [{\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"population\": 8300000.0,\n \"country\": \"US\",\n \"isCapital\": false\n }],\n \"pagingMetadata\": {\n }\n}"}},{"name":"QueryDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":4,"content":{"title":"Complex query","description":"A query with filtering requirements, sorting preferences, and the fields and referenced items to include.","request":"curl POST https://external-db.example.com/v3/items/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n \"$or\": [{\n \"$and\": [{\n \"name\": {\n \"$startsWith\": \"New\"\n }\n }, {\n \"population\": {\n \"$gt\": 1000000.0\n }\n }]\n }, {\n \"$and\": [{\n \"isCapital\": true\n }, {\n \"_updatedDate\": {\n \"$gt\": {\n \"$date\": \"2021-01-01T00:00:00Z\"\n }\n }\n }, {\n \"$not\": {\n \"name\": {\n \"$startsWith\": \"New\"\n }\n }\n }]\n }]\n },\n \"sort\": [{\n \"fieldName\": \"country\",\n \"order\": \"ASC\"\n }, {\n \"fieldName\": \"name\",\n \"order\": \"DESC\"\n }],\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"fields\": [\"_id\", \"name\", \"population\", \"pointsOfInterest\", \"myTrips\", \"_updatedDate\"]\n },\n \"includeReferencedItems\": [{\n \"fieldKey\": \"pointsOfInterest\",\n \"limit\": 50\n }, {\n \"fieldKey\": \"myTrips\",\n \"limit\": 50,\n \"filter\": {\n \"_owner\": \"6785b759-eeb3-4709-ac3c-91013d82690c\"\n }\n }],\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"items\": [{\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"population\": 8336817.0,\n \"myTrips\": [{\n \"_id\": \"528a0b23-d6d8-464a-82af-09e0c00f56b0\",\n \"startDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n }\n }],\n \"_updatedDate\": {\n \"$date\": \"2021-02-03T04:05:06Z\"\n },\n \"pointsOfInterest\": [{\n \"_id\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"name\": \"Statue of Liberty\"\n }, {\n \"_id\": \"0348998e-48d7-463e-96c3-a571d4a568a8\",\n \"name\": \"Empire State Building\"\n }]\n }],\n \"pagingMetadata\": {\n }\n}"}},{"name":"QueryDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Query data items","request":"curl POST https://external-db.example.com/v3/items/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n },\n \"sort\": [],\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"fields\": []\n },\n \"includeReferencedItems\": [],\n \"consistentRead\": false,\n \"returnTotalCount\": true\n}'","response":"{\n \"items\": [{\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"population\": 8300000.0,\n \"country\": \"US\",\n \"isCapital\": false\n }],\n \"pagingMetadata\": {\n \"total\": 1\n }\n}"}},{"name":"QueryDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":3,"content":{"title":"Query with cursor information","description":"For collections that support cursor pagination, a cursor is provided for the second page and onwards.","request":"curl POST https://external-db.example.com/v3/items/query \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"query\": {\n \"filter\": {\n },\n \"sort\": [],\n \"fields\": [],\n \"cursorPaging\": {\n \"limit\": 2,\n \"cursor\": \"ImtpZCI6ImEz\"\n }\n },\n \"includeReferencedItems\": [],\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"items\": [{\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"population\": 8300000.0,\n \"country\": \"US\",\n \"isCapital\": false\n }, {\n \"name\": \"Paris\",\n \"_id\": \"e831385d-d067-4905-a98a-456f5a526ca2\",\n \"population\": 2100000.0,\n \"country\": \"FR\",\n \"isCapital\": true\n }],\n \"pagingMetadata\": {\n \"cursors\": {\n \"next\": \"0O52kwmAcT\",\n \"prev\": \"omZq6gTpR9\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Query Data Items","slugifiedName":"query-data-items"},"permissionScopes":[]},{"summary":"Count Data Items","description":"Counts the number of items in the specified data collection that match the filtering preferences.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.CountDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.CountDataItemsResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CountDataItemsRequest","description":"","properties":{"collectionId":{"description":"ID of the collection to query.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter to specify which items to count. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) for more information about handling data queries.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Applicable if the external database is eventually consistent.","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collectionId","filter","consistentRead"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.CountDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.CountDataItemsResponse"},"legacyExamples":[{"name":"CountDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Count items","request":"curl POST https://external-db.example.com/v3/items/count \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"filter\": {\n },\n \"consistentRead\": false\n}'","response":"{\n \"totalCount\": 84\n}"}},{"name":"CountDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Count items with a filter","request":"curl POST https://external-db.example.com/v3/items/count \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"filter\": {\n \"country\": \"US\"\n },\n \"consistentRead\": false\n}'","response":"{\n \"totalCount\": 42\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/count","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.CountDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.CountDataItemsResponse"},"legacyExamples":[{"name":"CountDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Count items","request":"curl POST https://external-db.example.com/v3/items/count \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"filter\": {\n },\n \"consistentRead\": false\n}'","response":"{\n \"totalCount\": 84\n}"}},{"name":"CountDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Count items with a filter","request":"curl POST https://external-db.example.com/v3/items/count \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"filter\": {\n \"country\": \"US\"\n },\n \"consistentRead\": false\n}'","response":"{\n \"totalCount\": 42\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Count Data Items","slugifiedName":"count-data-items"},"permissionScopes":[]},{"summary":"Aggregate Data Items","description":"Runs an aggregation query on the specified data collection and returns the resulting list of items.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.AggregateDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AggregateDataItemsRequest","description":"","properties":{"collectionId":{"description":"ID of the collection on which to run the aggregation.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialFilter":{"description":"Filter to apply to the collection's data before aggregation. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) for more information about handling data queries.","title":"initialFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregation":{"description":"Aggregation to apply to the data.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Aggregation","summary":"aggregation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"finalFilter":{"description":"Filter to apply to the processed data after aggregation. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) for more information about handling data queries.","title":"finalFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sorting configuration.","title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Applicable if the external database is eventually consistent.","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"When `true`, the query response must include the total number of items that match the query.","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.pagingMethod"}],"required":["collectionId","consistentRead","returnTotalCount","pagingMethod"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsResponse"},"legacyExamples":[{"name":"AggregateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Data aggregation request with no grouping fields","request":"curl POST https://external-db.example.com/v3/items/aggregate \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"initialFilter\": {\n \"country\": \"US\"\n },\n \"aggregation\": {\n \"groupingFields\": [],\n \"operations\": [{\n \"resultFieldName\": \"sumPopulation\",\n \"sum\": {\n \"itemFieldName\": \"population\"\n }\n }]\n },\n \"sort\": [],\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"items\": [{\n \"sumPopulation\": 3.0E8\n }],\n \"pagingMetadata\": {\n }\n}"}},{"name":"AggregateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":3,"content":{"title":"Data aggregation request with two grouping fields","request":"curl POST https://external-db.example.com/v3/items/aggregate \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"aggregation\": {\n \"groupingFields\": [\"country\", \"isCapital\"],\n \"operations\": [{\n \"resultFieldName\": \"sumPopulation\",\n \"sum\": {\n \"itemFieldName\": \"population\"\n }\n }]\n },\n \"sort\": [{\n \"fieldName\": \"country\",\n \"order\": \"ASC\"\n }, {\n \"fieldName\": \"isCapital\",\n \"order\": \"ASC\"\n }],\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"items\": [{\n \"country\": \"CA\",\n \"isCapital\": false,\n \"sumPopulation\": 1000000.0\n }, {\n \"country\": \"CA\",\n \"isCapital\": true,\n \"sumPopulation\": 3.8E7\n }, {\n \"country\": \"US\",\n \"isCapital\": false,\n \"sumPopulation\": 700000.0\n }, {\n \"country\": \"US\",\n \"isCapital\": true,\n \"sumPopulation\": 3.0E8\n }],\n \"pagingMetadata\": {\n }\n}"}},{"name":"AggregateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Data aggregation request","description":"Aggregation request with an initial filter, aggregation operations, and a final filter.","request":"curl POST https://external-db.example.com/v3/items/aggregate \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"initialFilter\": {\n \"isCapital\": false\n },\n \"aggregation\": {\n \"groupingFields\": [\"country\"],\n \"operations\": [{\n \"resultFieldName\": \"sumPopulation\",\n \"sum\": {\n \"itemFieldName\": \"population\"\n }\n }, {\n \"resultFieldName\": \"countOfCities\",\n \"itemCount\": {\n }\n }]\n },\n \"finalFilter\": {\n \"countOfCities\": {\n \"$gt\": 5.0\n }\n },\n \"sort\": [{\n \"fieldName\": \"sumPopulation\",\n \"order\": \"ASC\"\n }],\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"returnTotalCount\": true\n}'","response":"{\n \"items\": [{\n \"country\": \"US\",\n \"sumPopulation\": 2000000.0,\n \"countOfCities\": 25.0\n }, {\n \"country\": \"CA\",\n \"sumPopulation\": 1000000.0,\n \"countOfCities\": 10.0\n }],\n \"pagingMetadata\": {\n \"total\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/aggregate","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsResponse"},"legacyExamples":[{"name":"AggregateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Data aggregation request with no grouping fields","request":"curl POST https://external-db.example.com/v3/items/aggregate \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"initialFilter\": {\n \"country\": \"US\"\n },\n \"aggregation\": {\n \"groupingFields\": [],\n \"operations\": [{\n \"resultFieldName\": \"sumPopulation\",\n \"sum\": {\n \"itemFieldName\": \"population\"\n }\n }]\n },\n \"sort\": [],\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"items\": [{\n \"sumPopulation\": 3.0E8\n }],\n \"pagingMetadata\": {\n }\n}"}},{"name":"AggregateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":3,"content":{"title":"Data aggregation request with two grouping fields","request":"curl POST https://external-db.example.com/v3/items/aggregate \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"aggregation\": {\n \"groupingFields\": [\"country\", \"isCapital\"],\n \"operations\": [{\n \"resultFieldName\": \"sumPopulation\",\n \"sum\": {\n \"itemFieldName\": \"population\"\n }\n }]\n },\n \"sort\": [{\n \"fieldName\": \"country\",\n \"order\": \"ASC\"\n }, {\n \"fieldName\": \"isCapital\",\n \"order\": \"ASC\"\n }],\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"items\": [{\n \"country\": \"CA\",\n \"isCapital\": false,\n \"sumPopulation\": 1000000.0\n }, {\n \"country\": \"CA\",\n \"isCapital\": true,\n \"sumPopulation\": 3.8E7\n }, {\n \"country\": \"US\",\n \"isCapital\": false,\n \"sumPopulation\": 700000.0\n }, {\n \"country\": \"US\",\n \"isCapital\": true,\n \"sumPopulation\": 3.0E8\n }],\n \"pagingMetadata\": {\n }\n}"}},{"name":"AggregateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Data aggregation request","description":"Aggregation request with an initial filter, aggregation operations, and a final filter.","request":"curl POST https://external-db.example.com/v3/items/aggregate \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"initialFilter\": {\n \"isCapital\": false\n },\n \"aggregation\": {\n \"groupingFields\": [\"country\"],\n \"operations\": [{\n \"resultFieldName\": \"sumPopulation\",\n \"sum\": {\n \"itemFieldName\": \"population\"\n }\n }, {\n \"resultFieldName\": \"countOfCities\",\n \"itemCount\": {\n }\n }]\n },\n \"finalFilter\": {\n \"countOfCities\": {\n \"$gt\": 5.0\n }\n },\n \"sort\": [{\n \"fieldName\": \"sumPopulation\",\n \"order\": \"ASC\"\n }],\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"returnTotalCount\": true\n}'","response":"{\n \"items\": [{\n \"country\": \"US\",\n \"sumPopulation\": 2000000.0,\n \"countOfCities\": 25.0\n }, {\n \"country\": \"CA\",\n \"sumPopulation\": 1000000.0,\n \"countOfCities\": 10.0\n }],\n \"pagingMetadata\": {\n \"total\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Aggregate Data Items","slugifiedName":"aggregate-data-items"},"permissionScopes":[]},{"summary":"Query Distinct Values","description":"Retrieves a list of distinct values for a given field for all items that match the query, without duplicates.\n\n\nAs with the [Query Data Items](https://dev.wix.com/docs/rest/assets/data/external-database-spi/query-data-items) endpoint, this endpoint retrieves items based on the filtering, sorting, and paging preferences provided.\nHowever, the Query Distinct Values endpoint doesn't return the full items that match the query. Rather, for items that match the query, it returns all unique values in the field specified in `fieldName`. If more than one item has the same value in that field, that value appears only once.\n\nSee [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information about handling data queries.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.QueryDistinctValues","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.QueryDistinctValuesResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryDistinctValuesRequest","description":"","properties":{"collectionId":{"description":"ID of the collection to query.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter to apply to the collection's data before aggregation. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) for more information about handling data queries.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldName":{"description":"Item field name for which to return all distinct values.","title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Order to by which to sort the results. Valid values are `ASC` and `DESC`.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Applicable if the external database is eventually consistent.","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"When `true`, the query response must include the total number of items that match the query.","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.QueryDistinctValuesRequest.pagingMethod"}],"required":["collectionId","fieldName","consistentRead","returnTotalCount","pagingMethod"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryDistinctValuesRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryDistinctValuesResponse"},"legacyExamples":[{"name":"QueryDistinctValues","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Query distinct values","request":"curl POST https://external-db.example.com/v3/items/query-distinct-values \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"fieldName\": \"country\",\n \"order\": \"ASC\",\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"distinctValues\": [\"US\", \"CA\"],\n \"pagingMetadata\": {\n }\n}"}},{"name":"QueryDistinctValues","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Query distinct values with filtering","description":"Data items are filtered before retrieving distinct values.","request":"curl POST https://external-db.example.com/v3/items/query-distinct-values \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"filter\": {\n \"isCapital\": true\n },\n \"fieldName\": \"country\",\n \"order\": \"ASC\",\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"returnTotalCount\": true\n}'","response":"{\n \"distinctValues\": [\"CA\", \"US\"],\n \"pagingMetadata\": {\n \"total\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/query-distinct-values","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryDistinctValuesRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryDistinctValuesResponse"},"legacyExamples":[{"name":"QueryDistinctValues","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Query distinct values","request":"curl POST https://external-db.example.com/v3/items/query-distinct-values \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"fieldName\": \"country\",\n \"order\": \"ASC\",\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"returnTotalCount\": false\n}'","response":"{\n \"distinctValues\": [\"US\", \"CA\"],\n \"pagingMetadata\": {\n }\n}"}},{"name":"QueryDistinctValues","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Query distinct values with filtering","description":"Data items are filtered before retrieving distinct values.","request":"curl POST https://external-db.example.com/v3/items/query-distinct-values \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"filter\": {\n \"isCapital\": true\n },\n \"fieldName\": \"country\",\n \"order\": \"ASC\",\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"returnTotalCount\": true\n}'","response":"{\n \"distinctValues\": [\"CA\", \"US\"],\n \"pagingMetadata\": {\n \"total\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Query Distinct Values","slugifiedName":"query-distinct-values"},"permissionScopes":[]},{"summary":"Insert Data Items","description":"Adds one or more items to a collection.\n\nA data item object contains the `_id` and `_owner` fields. The response array must include the same items that were inserted, and each returned item must be added the `_createdDate` and `_updatedDate` fields.\n\nHowever, data items can also be inserted without an `_id` field. In that case, it is the service provider's responsibility to generate a unique ID for each item.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.InsertDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemsResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"InsertDataItemsRequest","description":"","properties":{"collectionId":{"description":"ID of the collection in which to insert the items.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"Items to insert.","minItems":1,"title":"items","type":"array","items":{"type":"object"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collectionId","items"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemsResponse"},"legacyExamples":[{"name":"InsertDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Insert items without an `_id` field","description":"Data items can be inserted without an `_id` field. In that case, it is the service provider's responsibility to generate a unique ID for each item.","request":"curl POST https://external-db.example.com/v3/items/insert \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"items\": [{\n \"name\": \"New York\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\"\n }\n }]\n}"}},{"name":"InsertDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":3,"content":{"title":"Insert multiple items","description":"Inserts two data items to a collection. One insertion fails while the other succeeds.","request":"curl POST https://external-db.example.com/v3/items/insert \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"items\": [{\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }, {\n \"_id\": \"e831385d-d067-4905-a98a-456f5a526ca2\",\n \"name\": \"Paris\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\"\n }\n }, {\n \"error\": {\n \"errorCode\": \"ITEM_ALREADY_EXISTS\",\n \"errorMessage\": \"Item already exists\",\n \"data\": {\n \"itemId\": \"e831385d-d067-4905-a98a-456f5a526ca2\"\n }\n }\n }]\n}"}},{"name":"InsertDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Insert a single item into a collection","request":"curl POST https://external-db.example.com/v3/items/insert \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"items\": [{\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\",\n \"_createdDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n }\n }\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/insert","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemsResponse"},"legacyExamples":[{"name":"InsertDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Insert items without an `_id` field","description":"Data items can be inserted without an `_id` field. In that case, it is the service provider's responsibility to generate a unique ID for each item.","request":"curl POST https://external-db.example.com/v3/items/insert \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"items\": [{\n \"name\": \"New York\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\"\n }\n }]\n}"}},{"name":"InsertDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":3,"content":{"title":"Insert multiple items","description":"Inserts two data items to a collection. One insertion fails while the other succeeds.","request":"curl POST https://external-db.example.com/v3/items/insert \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"items\": [{\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }, {\n \"_id\": \"e831385d-d067-4905-a98a-456f5a526ca2\",\n \"name\": \"Paris\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\"\n }\n }, {\n \"error\": {\n \"errorCode\": \"ITEM_ALREADY_EXISTS\",\n \"errorMessage\": \"Item already exists\",\n \"data\": {\n \"itemId\": \"e831385d-d067-4905-a98a-456f5a526ca2\"\n }\n }\n }]\n}"}},{"name":"InsertDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Insert a single item into a collection","request":"curl POST https://external-db.example.com/v3/items/insert \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"items\": [{\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\",\n \"_createdDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n }\n }\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Insert Data Items","slugifiedName":"insert-data-items"},"permissionScopes":[]},{"summary":"Update Data Items","description":"Updates one or more items in a collection. Items must be completely replaced.\n\nThe response array must include the same items that were updated, and each returned item must be added the `_createdDate` and `_updatedDate` fields.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.UpdateDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.UpdateDataItemsResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateDataItemsRequest","description":"","properties":{"collectionId":{"description":"ID of the collection in which to update the items.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"Items to update.","minItems":1,"title":"items","type":"array","items":{"type":"object"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collectionId","items"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.UpdateDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.UpdateDataItemsResponse"},"legacyExamples":[{"name":"UpdateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Update a single item in a collection","request":"curl POST https://external-db.example.com/v3/items/update \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"items\": [{\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\",\n \"_createdDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2021-04-05T06:07:08Z\"\n }\n }\n }]\n}"}},{"name":"UpdateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Update multiple data items","description":"Updates two data items in a collection. One update fails while the other succeeds.","request":"curl POST https://external-db.example.com/v3/items/update \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"items\": [{\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }, {\n \"_id\": \"e831385d-d067-4905-a98a-456f5a526ca2\",\n \"name\": \"Paris\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\",\n \"_createdDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2021-04-05T06:07:08Z\"\n }\n }\n }, {\n \"error\": {\n \"errorCode\": \"ITEM_NOT_FOUND\",\n \"errorMessage\": \"Item does not exist\",\n \"data\": {\n \"itemId\": \"e831385d-d067-4905-a98a-456f5a526ca2\"\n }\n }\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/update","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.UpdateDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.UpdateDataItemsResponse"},"legacyExamples":[{"name":"UpdateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Update a single item in a collection","request":"curl POST https://external-db.example.com/v3/items/update \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"items\": [{\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\",\n \"_createdDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2021-04-05T06:07:08Z\"\n }\n }\n }]\n}"}},{"name":"UpdateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Update multiple data items","description":"Updates two data items in a collection. One update fails while the other succeeds.","request":"curl POST https://external-db.example.com/v3/items/update \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"items\": [{\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"name\": \"New York\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }, {\n \"_id\": \"e831385d-d067-4905-a98a-456f5a526ca2\",\n \"name\": \"Paris\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\"\n }]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\",\n \"_createdDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2021-04-05T06:07:08Z\"\n }\n }\n }, {\n \"error\": {\n \"errorCode\": \"ITEM_NOT_FOUND\",\n \"errorMessage\": \"Item does not exist\",\n \"data\": {\n \"itemId\": \"e831385d-d067-4905-a98a-456f5a526ca2\"\n }\n }\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Update Data Items","slugifiedName":"update-data-items"},"permissionScopes":[]},{"summary":"Remove Data Items","description":"Removes one or more items from a collection. The response object must contain the removed item.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.RemoveDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemsResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RemoveDataItemsRequest","description":"","properties":{"collectionId":{"description":"ID of the collection from which to remove items.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemIds":{"description":"IDs of items to remove.","minItems":1,"title":"itemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collectionId","itemIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemsResponse"},"legacyExamples":[{"name":"RemoveDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Remove several items","description":"Removes two data items from a collection. One removal fails while the other succeeds.","request":"curl POST https://external-db.example.com/v3/items/remove \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"itemIds\": [\"c285e77c-a86b-4361-a55f-c6b934d70187\", \"e831385d-d067-4905-a98a-456f5a526ca2\"]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\",\n \"_createdDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2021-04-05T06:07:08Z\"\n }\n }\n }, {\n \"error\": {\n \"errorCode\": \"ITEM_NOT_FOUND\",\n \"errorMessage\": \"Item does not exist\",\n \"data\": {\n \"itemId\": \"e831385d-d067-4905-a98a-456f5a526ca2\"\n }\n }\n }]\n}"}},{"name":"RemoveDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Remove a single item from a collection","request":"curl POST https://external-db.example.com/v3/items/remove \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"itemIds\": [\"c285e77c-a86b-4361-a55f-c6b934d70187\"]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\",\n \"_createdDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2021-04-05T06:07:08Z\"\n }\n }\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/remove","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemsResponse"},"legacyExamples":[{"name":"RemoveDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Remove several items","description":"Removes two data items from a collection. One removal fails while the other succeeds.","request":"curl POST https://external-db.example.com/v3/items/remove \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"itemIds\": [\"c285e77c-a86b-4361-a55f-c6b934d70187\", \"e831385d-d067-4905-a98a-456f5a526ca2\"]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\",\n \"_createdDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2021-04-05T06:07:08Z\"\n }\n }\n }, {\n \"error\": {\n \"errorCode\": \"ITEM_NOT_FOUND\",\n \"errorMessage\": \"Item does not exist\",\n \"data\": {\n \"itemId\": \"e831385d-d067-4905-a98a-456f5a526ca2\"\n }\n }\n }]\n}"}},{"name":"RemoveDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Remove a single item from a collection","request":"curl POST https://external-db.example.com/v3/items/remove \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"itemIds\": [\"c285e77c-a86b-4361-a55f-c6b934d70187\"]\n}'","response":"{\n \"results\": [{\n \"item\": {\n \"name\": \"New York\",\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"_owner\": \"facda016-24ef-4909-a90e-70687f17f658\",\n \"_createdDate\": {\n \"$date\": \"2021-01-02T03:04:05Z\"\n },\n \"_updatedDate\": {\n \"$date\": \"2021-04-05T06:07:08Z\"\n }\n }\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Remove Data Items","slugifiedName":"remove-data-items"},"permissionScopes":[]},{"summary":"Truncate Data Items","description":"Removes all items from a collection.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.TruncateDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.TruncateDataItemsResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"TruncateDataItemsRequest","description":"","properties":{"collectionId":{"description":"ID of the collection from which to remove all items.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collectionId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.TruncateDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.TruncateDataItemsResponse"},"legacyExamples":[{"name":"TruncateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Truncate a given collection","request":"curl POST https://external-db.example.com/v3/items/truncate \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\"\n}'","response":"{\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/truncate","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.TruncateDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.TruncateDataItemsResponse"},"legacyExamples":[{"name":"TruncateDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Truncate a given collection","request":"curl POST https://external-db.example.com/v3/items/truncate \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\"\n}'","response":"{\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Truncate Data Items","slugifiedName":"truncate-data-items"},"permissionScopes":[]},{"summary":"Query Referenced Data Items","description":"Retrieves the items referenced in the specified field of a referring item. Reference fields refer to items that exist in different collections. Implement this endpoint so callers can retrieve the full details of the referenced items.\n\nThis service plugin supports item multi-references, which means that data collections can have many-to-many relationships with other collections. For example, consider a scenario where a **Movies** collection includes a multi-reference **Actors** field, which might refer to several **Actor** items in an **Actors** collection. Users can therefore query the **Movies** collection to retrieve the **Actor** items referenced in each **Movie** item.\n\n> **Notes:**\n> - This endpoint does not retrieve the full referenced items of referenced items. For example, the referenced **Actors** collection might itself contain a multi-reference field with references to **Award** items in an **Awards** collection. When calling this endpoint to retrieve the refernced items of any **Movie** item, the response contains the referenced **Actor** items, but only the IDs of the **Award** items. To retrieve the full **Award** items, the user must either call this endpoint for the **Actors** collection, or the [Query Data Items](https://dev.wix.com/docs/rest/assets/data/external-database-spi/query-data-items) endpoint for the **Awards** collection.\n> - This endpoint might also be called when a user calls the [isReferenced](https://https://dev.wix.com/docs/rest/api-reference/wix-data/data-items/is-referenced-data-item) endpoint of the Wix Data API.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.QueryReferencedDataItems","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.QueryReferencedDataItemsResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryReferencedDataItemsRequest","description":"","properties":{"collectionId":{"description":"ID of the collection to query.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemIds":{"description":"IDs of the referring items. If the array is empty, return results for all referring items.","maxItems":1000,"title":"referringItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemIds":{"description":"IDs of the referenced items. If the array is empty, return all referenced items for the referring items.","maxItems":1000,"title":"referencedItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Order to by which to sort the results. Valid values are `ASC` and `DESC`.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringFieldKey":{"description":"Field key to query in the referring collection.","title":"referringFieldKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Applicable if the external database is eventually consistent.","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsToReturn":{"description":"Fields to return in the referenced item. If the array is empty or not provided, all fields in the referenced item are returned.","title":"fieldsToReturn","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"When `true`, the response includes the total number of the items that match the query.","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includeReferencedItems":{"description":"When `true`, the response includes the full referenced items. When `false`, only the IDs of referenced items be returned.","title":"includeReferencedItems","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.QueryReferencedDataItemsRequest.pagingMethod"}],"required":["collectionId","referringFieldKey","pagingMethod","consistentRead","returnTotalCount","includeReferencedItems"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryReferencedDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryReferencedDataItemsResponse"},"legacyExamples":[{"name":"QueryReferencedDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Query for and return any referenced items","description":"For a single data item, query and return all referenced items.","request":"curl POST https://external-db.example.com/v3/items/query-referenced \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringItemIds\": [\"c285e77c-a86b-4361-a55f-c6b934d70187\"],\n \"referencedItemIds\": [],\n \"order\": \"ASC\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"fieldsToReturn\": [],\n \"returnTotalCount\": false,\n \"includeReferencedItems\": true\n}'","response":"{\n \"items\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"referencedItem\": {\n \"_id\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"name\": \"Statue of Liberty\"\n }\n }],\n \"pagingMetadata\": {\n }\n}"}},{"name":"QueryReferencedDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Query for referenced items","description":"For a single data item, query and return a specified referenced item.","request":"curl POST https://external-db.example.com/v3/items/query-referenced \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringItemIds\": [\"c285e77c-a86b-4361-a55f-c6b934d70187\"],\n \"referencedItemIds\": [\"faa17edb-2d88-488d-8e95-24b9364c3284\"],\n \"order\": \"ASC\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"paging\": {\n \"limit\": 1,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"fieldsToReturn\": [],\n \"returnTotalCount\": false,\n \"includeReferencedItems\": false\n}'","response":"{\n \"items\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }],\n \"pagingMetadata\": {\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/query-referenced","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryReferencedDataItemsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.QueryReferencedDataItemsResponse"},"legacyExamples":[{"name":"QueryReferencedDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Query for and return any referenced items","description":"For a single data item, query and return all referenced items.","request":"curl POST https://external-db.example.com/v3/items/query-referenced \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringItemIds\": [\"c285e77c-a86b-4361-a55f-c6b934d70187\"],\n \"referencedItemIds\": [],\n \"order\": \"ASC\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"paging\": {\n \"limit\": 50,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"fieldsToReturn\": [],\n \"returnTotalCount\": false,\n \"includeReferencedItems\": true\n}'","response":"{\n \"items\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"referencedItem\": {\n \"_id\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"name\": \"Statue of Liberty\"\n }\n }],\n \"pagingMetadata\": {\n }\n}"}},{"name":"QueryReferencedDataItems","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Query for referenced items","description":"For a single data item, query and return a specified referenced item.","request":"curl POST https://external-db.example.com/v3/items/query-referenced \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringItemIds\": [\"c285e77c-a86b-4361-a55f-c6b934d70187\"],\n \"referencedItemIds\": [\"faa17edb-2d88-488d-8e95-24b9364c3284\"],\n \"order\": \"ASC\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"paging\": {\n \"limit\": 1,\n \"offset\": 0\n },\n \"consistentRead\": false,\n \"fieldsToReturn\": [],\n \"returnTotalCount\": false,\n \"includeReferencedItems\": false\n}'","response":"{\n \"items\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }],\n \"pagingMetadata\": {\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Query Referenced Data Items","slugifiedName":"query-referenced-data-items"},"permissionScopes":[]},{"summary":"Insert Data Item References","description":"Inserts one or more item references into a referring field of the specified item.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.InsertDataItemReferences","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemReferencesResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"InsertDataItemReferencesRequest","description":"","properties":{"collectionId":{"description":"ID of the referring collection.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringFieldKey":{"description":"Field key of the field in the referring collection to insert references into.","title":"referringFieldKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"references":{"description":"References to insert.","minItems":1,"title":"references","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ReferenceId"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collectionId","referringFieldKey","references"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemReferencesRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemReferencesResponse"},"legacyExamples":[{"name":"InsertDataItemReferences","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Insert an item reference","description":"Creates a reference from one item to another.","request":"curl POST https://external-db.example.com/v3/items/insert-references \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"references\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }]\n}'","response":"{\n \"results\": [{\n \"reference\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n }]\n}"}},{"name":"InsertDataItemReferences","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Insert multiple item references","description":"Creates two item references, one of which succeeds while the other fails.","request":"curl POST https://external-db.example.com/v3/items/insert-references \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"references\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }, {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"0348998e-48d7-463e-96c3-a571d4a568a8\"\n }]\n}'","response":"{\n \"results\": [{\n \"reference\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n }, {\n \"error\": {\n \"errorCode\": \"REFERENCE_ALREADY_EXISTS\",\n \"errorMessage\": \"Reference already exists\",\n \"data\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"0348998e-48d7-463e-96c3-a571d4a568a8\"\n }\n }\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/insert-references","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemReferencesRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemReferencesResponse"},"legacyExamples":[{"name":"InsertDataItemReferences","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Insert an item reference","description":"Creates a reference from one item to another.","request":"curl POST https://external-db.example.com/v3/items/insert-references \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"references\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }]\n}'","response":"{\n \"results\": [{\n \"reference\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n }]\n}"}},{"name":"InsertDataItemReferences","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Insert multiple item references","description":"Creates two item references, one of which succeeds while the other fails.","request":"curl POST https://external-db.example.com/v3/items/insert-references \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"references\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }, {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"0348998e-48d7-463e-96c3-a571d4a568a8\"\n }]\n}'","response":"{\n \"results\": [{\n \"reference\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n }, {\n \"error\": {\n \"errorCode\": \"REFERENCE_ALREADY_EXISTS\",\n \"errorMessage\": \"Reference already exists\",\n \"data\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"0348998e-48d7-463e-96c3-a571d4a568a8\"\n }\n }\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Insert Data Item References","slugifiedName":"insert-data-item-references"},"permissionScopes":[]},{"summary":"Remove Data Item References","description":"Removes one or more item references from a referring field of the specified item.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.RemoveDataItemReferences","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemReferencesResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"RemoveDataItemReferencesRequest","description":"","properties":{"collectionId":{"description":"ID of the referring collection.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringFieldKey":{"description":"Field key of the field in the referring collection to remove references from.","title":"referringFieldKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"references":{"description":"References to remove.","minItems":1,"title":"references","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ReferenceId"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collectionId","referringFieldKey","references"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemReferencesRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemReferencesResponse"},"legacyExamples":[{"name":"RemoveDataItemReferences","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Remove multiple item references","description":"Removes two item references, one of which succeeds while the other fails.","request":"curl POST https://external-db.example.com/v3/items/remove-references \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"references\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }, {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"0348998e-48d7-463e-96c3-a571d4a568a8\"\n }]\n}'","response":"{\n \"results\": [{\n \"reference\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n }, {\n \"error\": {\n \"errorCode\": \"REFERENCE_NOT_FOUND\",\n \"errorMessage\": \"Reference does not exist\",\n \"data\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"0348998e-48d7-463e-96c3-a571d4a568a8\"\n }\n }\n }]\n}"}},{"name":"RemoveDataItemReferences","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Remove a single reference","request":"curl POST https://external-db.example.com/v3/items/remove-references \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"references\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }]\n}'","response":"{\n \"results\": [{\n \"reference\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/items/remove-references","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemReferencesRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemReferencesResponse"},"legacyExamples":[{"name":"RemoveDataItemReferences","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"Remove multiple item references","description":"Removes two item references, one of which succeeds while the other fails.","request":"curl POST https://external-db.example.com/v3/items/remove-references \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"references\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }, {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"0348998e-48d7-463e-96c3-a571d4a568a8\"\n }]\n}'","response":"{\n \"results\": [{\n \"reference\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n }, {\n \"error\": {\n \"errorCode\": \"REFERENCE_NOT_FOUND\",\n \"errorMessage\": \"Reference does not exist\",\n \"data\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"0348998e-48d7-463e-96c3-a571d4a568a8\"\n }\n }\n }]\n}"}},{"name":"RemoveDataItemReferences","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Remove a single reference","request":"curl POST https://external-db.example.com/v3/items/remove-references \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\",\n \"referringFieldKey\": \"pointsOfInterest\",\n \"references\": [{\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }]\n}'","response":"{\n \"results\": [{\n \"reference\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Remove Data Item References","slugifiedName":"remove-data-item-references"},"permissionScopes":[]},{"summary":"List Collections","description":"Retrieves a list of data collections and their details.\n\nWhen `collectionIds` is empty, all existing collections are returned.\nIf a specified collection does not exist, that collection can be ignored.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.ListCollections","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ListCollectionsResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ListCollectionsRequest","description":"","properties":{"collectionIds":{"description":"IDs of collections to retrieve. If empty, all available collections are retrieved.","title":"collectionIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.ListCollectionsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.ListCollectionsResponse"},"legacyExamples":[{"name":"ListCollections","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"List specified collections only","request":"curl POST https://external-db.example.com/v3/collections/get \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionIds\": [\"cities\", \"non-existing-collection\"]\n}'","response":"{\n \"collections\": [{\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"description\": \"The ID of the document\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"LT\", \"GT\", \"LTE\", \"GTE\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"STARTS_WITH\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created date\",\n \"description\": \"The date when the document was created\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated date\",\n \"description\": \"The date when the document was last updated\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }],\n \"capabilities\": {\n \"dataOperations\": [\"QUERY\", \"COUNT\"]\n },\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"OFFSET\"\n }]\n}"}},{"name":"ListCollections","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"List all collections","request":"curl POST https://external-db.example.com/v3/collections/get \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionIds\": []\n}'","response":"{\n \"collections\": [{\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"description\": \"The ID of the document\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"LT\", \"GT\", \"LTE\", \"GTE\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"STARTS_WITH\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created date\",\n \"description\": \"The date when the document was created\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated date\",\n \"description\": \"The date when the document was last updated\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }],\n \"capabilities\": {\n \"dataOperations\": [\"QUERY\", \"COUNT\"]\n },\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"OFFSET\"\n }, {\n \"id\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"fields\": [{\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"description\": \"The ID of the document\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"LT\", \"GT\", \"LTE\", \"GTE\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }],\n \"capabilities\": {\n \"dataOperations\": [\"QUERY\", \"COUNT\"]\n },\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"OFFSET\"\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/collections/get","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.ListCollectionsRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.ListCollectionsResponse"},"legacyExamples":[{"name":"ListCollections","serviceName":"ExternalDatabaseService","type":"METHOD","order":2,"content":{"title":"List specified collections only","request":"curl POST https://external-db.example.com/v3/collections/get \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionIds\": [\"cities\", \"non-existing-collection\"]\n}'","response":"{\n \"collections\": [{\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"description\": \"The ID of the document\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"LT\", \"GT\", \"LTE\", \"GTE\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"STARTS_WITH\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created date\",\n \"description\": \"The date when the document was created\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated date\",\n \"description\": \"The date when the document was last updated\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }],\n \"capabilities\": {\n \"dataOperations\": [\"QUERY\", \"COUNT\"]\n },\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"OFFSET\"\n }]\n}"}},{"name":"ListCollections","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"List all collections","request":"curl POST https://external-db.example.com/v3/collections/get \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionIds\": []\n}'","response":"{\n \"collections\": [{\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"description\": \"The ID of the document\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"LT\", \"GT\", \"LTE\", \"GTE\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"STARTS_WITH\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created date\",\n \"description\": \"The date when the document was created\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated date\",\n \"description\": \"The date when the document was last updated\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }],\n \"capabilities\": {\n \"dataOperations\": [\"QUERY\", \"COUNT\"]\n },\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"OFFSET\"\n }, {\n \"id\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"fields\": [{\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"description\": \"The ID of the document\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"LT\", \"GT\", \"LTE\", \"GTE\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }],\n \"capabilities\": {\n \"dataOperations\": [\"QUERY\", \"COUNT\"]\n },\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"OFFSET\"\n }]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"List Collections","slugifiedName":"list-collections"},"permissionScopes":[]},{"summary":"Create Collection","description":"Creates a new data collection.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.CreateCollection","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.CreateCollectionResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateCollectionRequest","description":"","properties":{"collection":{"description":"Details of the collection to create.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Collection","summary":"collection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collection.id","collection.fields","collection.fields.key","collection.fields.type","collection.fields.encrypted"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.CreateCollectionRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.CreateCollectionResponse"},"legacyExamples":[{"name":"CreateCollection","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Create a collection","request":"curl POST https://external-db.example.com/v3/collections/create \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collection\": {\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\",\n \"referencedCollectionFieldKey\": \"cities\",\n \"referencedCollectionFieldDisplayName\": \"Cities\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created Date\",\n \"type\": \"DATETIME\",\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated Date\",\n \"type\": \"DATETIME\",\n \"encrypted\": false\n }, {\n \"key\": \"_owner\",\n \"displayName\": \"Owner\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }],\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"UNKNOWN_PAGING_MODE\"\n }\n}'","response":"{\n \"collection\": {\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"description\": \"The ID of the document\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"LT\", \"GT\", \"LTE\", \"GTE\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"STARTS_WITH\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created date\",\n \"description\": \"The date when the document was created\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated date\",\n \"description\": \"The date when the document was last updated\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_owner\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }],\n \"capabilities\": {\n \"dataOperations\": [\"QUERY\", \"COUNT\"]\n },\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"OFFSET\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/collections/create","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.CreateCollectionRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.CreateCollectionResponse"},"legacyExamples":[{"name":"CreateCollection","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Create a collection","request":"curl POST https://external-db.example.com/v3/collections/create \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collection\": {\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\",\n \"referencedCollectionFieldKey\": \"cities\",\n \"referencedCollectionFieldDisplayName\": \"Cities\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created Date\",\n \"type\": \"DATETIME\",\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated Date\",\n \"type\": \"DATETIME\",\n \"encrypted\": false\n }, {\n \"key\": \"_owner\",\n \"displayName\": \"Owner\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }],\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"UNKNOWN_PAGING_MODE\"\n }\n}'","response":"{\n \"collection\": {\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"description\": \"The ID of the document\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"LT\", \"GT\", \"LTE\", \"GTE\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"STARTS_WITH\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created date\",\n \"description\": \"The date when the document was created\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated date\",\n \"description\": \"The date when the document was last updated\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_owner\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }],\n \"capabilities\": {\n \"dataOperations\": [\"QUERY\", \"COUNT\"]\n },\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"OFFSET\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Create Collection","slugifiedName":"create-collection"},"permissionScopes":[]},{"summary":"Update Collection","description":"Updates the structure of an existing data collection.\n\nSome parameters, such as `capabilities` and `pagingMode`, are determined by the service provider. If the collection passed in the request contains these parameters, their values must be ignored. However, these fields must be included in the response collection with relevant values.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.UpdateCollection","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.UpdateCollectionResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateCollectionRequest","description":"","properties":{"collection":{"description":"Updated structure details for the specified collection.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Collection","summary":"collection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collection.id","collection.fields","collection.fields.key","collection.fields.type","collection.fields.encrypted"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.UpdateCollectionRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.UpdateCollectionResponse"},"legacyExamples":[{"name":"UpdateCollection","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Update a collection","request":"curl POST https://external-db.example.com/v3/collections/update \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collection\": {\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\",\n \"referencedCollectionFieldKey\": \"cities\",\n \"referencedCollectionFieldDisplayName\": \"Cities\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created Date\",\n \"type\": \"DATETIME\",\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated Date\",\n \"type\": \"DATETIME\",\n \"encrypted\": false\n }, {\n \"key\": \"_owner\",\n \"displayName\": \"Owner\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }],\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"UNKNOWN_PAGING_MODE\"\n }\n}'","response":"{\n \"collection\": {\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"description\": \"The ID of the document\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"LT\", \"GT\", \"LTE\", \"GTE\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"STARTS_WITH\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created date\",\n \"description\": \"The date when the document was created\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated date\",\n \"description\": \"The date when the document was last updated\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_owner\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }],\n \"capabilities\": {\n \"dataOperations\": [\"QUERY\", \"COUNT\"]\n },\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"OFFSET\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/collections/update","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.UpdateCollectionRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.UpdateCollectionResponse"},"legacyExamples":[{"name":"UpdateCollection","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Update a collection","request":"curl POST https://external-db.example.com/v3/collections/update \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collection\": {\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\",\n \"referencedCollectionFieldKey\": \"cities\",\n \"referencedCollectionFieldDisplayName\": \"Cities\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created Date\",\n \"type\": \"DATETIME\",\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated Date\",\n \"type\": \"DATETIME\",\n \"encrypted\": false\n }, {\n \"key\": \"_owner\",\n \"displayName\": \"Owner\",\n \"type\": \"TEXT\",\n \"encrypted\": false\n }],\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"UNKNOWN_PAGING_MODE\"\n }\n}'","response":"{\n \"collection\": {\n \"id\": \"cities\",\n \"displayName\": \"Cities\",\n \"fields\": [{\n \"key\": \"_id\",\n \"displayName\": \"ID\",\n \"description\": \"The ID of the document\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"LT\", \"GT\", \"LTE\", \"GTE\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"name\",\n \"displayName\": \"Name\",\n \"description\": \"The name of the city\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\", \"STARTS_WITH\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"country\",\n \"displayName\": \"Country\",\n \"description\": \"Country code\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": true,\n \"queryOperators\": [\"EQ\"]\n },\n \"encrypted\": false\n }, {\n \"key\": \"pointsOfInterest\",\n \"displayName\": \"Points of interest\",\n \"type\": \"MULTI_REFERENCE\",\n \"multiReferenceOptions\": {\n \"referencedCollectionId\": \"pointsOfInterest\"\n },\n \"encrypted\": false\n }, {\n \"key\": \"_createdDate\",\n \"displayName\": \"Created date\",\n \"description\": \"The date when the document was created\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_updatedDate\",\n \"displayName\": \"Updated date\",\n \"description\": \"The date when the document was last updated\",\n \"type\": \"DATETIME\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }, {\n \"key\": \"_owner\",\n \"type\": \"TEXT\",\n \"capabilities\": {\n \"sortable\": false,\n \"queryOperators\": []\n },\n \"encrypted\": false\n }],\n \"capabilities\": {\n \"dataOperations\": [\"QUERY\", \"COUNT\"]\n },\n \"permissions\": {\n \"insert\": \"ADMIN\",\n \"update\": \"ADMIN\",\n \"remove\": \"ADMIN\",\n \"read\": \"ANYONE\"\n },\n \"pagingMode\": \"OFFSET\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Update Collection","slugifiedName":"update-collection"},"permissionScopes":[]},{"summary":"Delete Collection","description":"Deletes a data collection.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.DeleteCollection","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.DeleteCollectionResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"DeleteCollectionRequest","description":"","properties":{"collectionId":{"description":"ID of the collection to delete.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["collectionId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.DeleteCollectionRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.DeleteCollectionResponse"},"legacyExamples":[{"name":"DeleteCollection","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Delete a collection","request":"curl POST https://external-db.example.com/v3/collections/delete \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\"\n}'","response":"{\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/collections/delete","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.DeleteCollectionRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.DeleteCollectionResponse"},"legacyExamples":[{"name":"DeleteCollection","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Delete a collection","request":"curl POST https://external-db.example.com/v3/collections/delete \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n \"collectionId\": \"cities\"\n}'","response":"{\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Delete Collection","slugifiedName":"delete-collection"},"permissionScopes":[]},{"summary":"Get Capabilities","description":"Lists the global capabilities the external database supports.","operationId":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService.GetCapabilities","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.GetCapabilitiesResponse","description":""}},"deprecated":false,"servers":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"GetCapabilitiesRequest","description":"","properties":{},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.GetCapabilitiesRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.GetCapabilitiesResponse"},"legacyExamples":[{"name":"GetCapabilities","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Get the capabilities of the specified collection","request":"curl POST https://external-db.example.com/v3/capabilities/get \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n}'","response":"{\n \"supportsCollectionModifications\": true,\n \"supportedFieldTypes\": [\"TEXT\", \"DATETIME\", \"NUMBER\", \"BOOLEAN\"]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v3/capabilities/get","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":[],"applicableIdentities":[],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.cloud.externaldatabase.spi:external-database-spi","serviceArtifactId":"","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.externaldatabasespi.v3.GetCapabilitiesRequest","responseMessage":"com.wixpress.cloud.externaldatabasespi.v3.GetCapabilitiesResponse"},"legacyExamples":[{"name":"GetCapabilities","serviceName":"ExternalDatabaseService","type":"METHOD","order":1,"content":{"title":"Get the capabilities of the specified collection","request":"curl POST https://external-db.example.com/v3/capabilities/get \\\n -H 'Content-Type: application/json;charset=UTF-8' \\\n -H 'Authorization: ' \\\n --d '{\n}'","response":"{\n \"supportsCollectionModifications\": true,\n \"supportedFieldTypes\": [\"TEXT\", \"DATETIME\", \"NUMBER\", \"BOOLEAN\"]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Get Capabilities","slugifiedName":"get-capabilities"},"permissionScopes":[]}],"webhooks":[],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the External Database Service Plugin\n\nAs an external database service plugin provider (formerly SPI), you can create a service that allows Wix sites to access and manage data stored anywhere, as if it were hosted natively on Wix. By implementing this service plugin, your service can:\n\n- Make external business data available to Wix sites.\n- Make an external database available to Wix site owners to store their business data.\n\nLearn more [about service plugins](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/service-plugins/about-service-plugin-extensions).\n\n## Managing data with Wix\n\nWix offers a variety of data management solutions to accommodate common user needs at different scales. This includes support for internal databases that are hosted directly on Wix, as well as [external databases](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ae9cab4a-b40b-48f1-b1b3-e659595e3440slug::introduction#internal-vs-external-databases*fallback::https://dev.wix.com/docs/rest/assets/wix-data/external-database-connection/introduction#internal-vs-external-databases) hosted outside the Wix ecosystem.\n\nYou can store and manage data directly on Wix using the [Wix Data API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::1730dc2b-f113-416f-80ed-17087ffc68c8*fallback::https://dev.wix.com/docs/rest/api-reference/wix-data/introduction). Wix also supports managing data hosted on external databases. The [External Database Connections API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ae9cab4a-b40b-48f1-b1b3-e659595e3440slug::introduction*fallback::https://dev.wix.com/docs/rest/api-reference/wix-data/external-database-connection/introduction) allows Wix Data to communicate with an external database as if it were hosted directly on Wix. Wix offers several out-of-the-box [external database integrations](fallback::https://dev.wix.com/docs/develop-websites/articles/databases/external-databases/overview/integrating-external-databases-with-your-wix-site#supported-databases) for common platforms such as Google Cloud Platform (GCP), Amazon Web Services (AWS), or Microsoft Azure. These integrations translate Wix Data requests into the external database's protocol, and translate the response back into a format that Wix APIs can read.\n\nTo allow Wix Data to communicate with any other data source, implement the External Database service plugin.\n\n## Become an external database service provider\n\nThe External Database service plugin defines endpoints you can implement to integrate an external database with Wix. Wix Data calls these endpoints to access and manage the items and collections the external database contains. The endpoints descriptions specify what type of request Wix Data sends to each endpoint, and what type of response each endpoint is expected to return.\n\nWhen the service is implemented and ready for use, you can make it available to users by [creating a Wix app and configuring it](fallback::#configuration) with the details of your service. This tells Wix Data where your service is deployed. After installing your app on their sites, site admins can use the [Wix Data APIs](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::1730dc2b-f113-416f-80ed-17087ffc68c8*fallback::https://dev.wix.com/docs/rest/api-reference/wix-data/introduction) to access and interact with the external database as if it were hosted on Wix.\n\n### Provide basic functionality\n\nWhile you aren't required to implement all the endpoints in this service plugin, make sure to implement at least the following endpoints to provide basic functionality:\n\n* [Get Capabilities](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::cc32e433-637d-4b53-af07-6747e142e0afslug::get-capabilities*fallback::https://dev.wix.com/docs/rest/assets/data/external-database-spi/get-capabilities): This endpoint lets Wix Data determine which capabilities are supported by the external database.\n* [List Collections](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::cc32e433-637d-4b53-af07-6747e142e0afslug::list-collections*fallback::https://dev.wix.com/docs/rest/assets/data/external-database-spi/list-collections): This endpoint enables Wix Data to view the collections stored in the external database.\n* [Query Data Items](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::cc32e433-637d-4b53-af07-6747e142e0afslug::query-data-items*fallback::https://dev.wix.com/docs/rest/assets/data/external-database-spi/query-data-items): This endpoint enables Wix Data to query items in an external collection.\n\n## Use Cases\n\nYour service can accommodate many scenarios that require Wix Data to communicate with external databases. These might include:\n\n* A business that wants to make its data available for Wix site owners.\n* A Wix site owner whose data is stored in an external database and wants to [query and display that data on their site](slug::sample-flows#query-real-estate-properties-in-an-external-database*fallback::./sample-flow.md#query-real-estate-properties-in-an-external-database).\n* A Wix app developer who wants to implement ready-for-use external database integrations for specific database services.\n* A growing business that wants to store its Wix collections on an external cloud service to scale as needed.\n\n## Configuration\n\nTo enable Wix Data to communicate with your service:\n\n1. Create an app in the [Wix Developers Center](fallback::https://dev.wix.com/apps).\n2. Select your new app and click the [Extensions](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/about-extensions) tab.\n3. Click **Create Extension**.\n4. Find and select **External Database Provider** and click **Create**.\n5. If it has not been set before, set up an app namespace. This is a unique identifier for your app that, once set, can't be changed. It is added as a prefix to the user's external collection names.\n ![wix app namespace modal](https://wixmp-833713b177cebf373f611808.wixmp.com/images/intro-md_docs_assets_app-namespace-modal.png)\n \n\n6. Use the built-in JSON editor to provide your extension’s configuration details. Make sure to include all the required fields as they appear in the table below. Once you're done, click **Save**.\n\n | Name | Type | Description |\n |-------------|--------|-------------------------------------------------------|\n | `namespace` | String | **Required**. A prefix for all the collections your application retrieves. It must be identical to your app namespace. |\n | `uriConfig` | Object | The URI configuration object. |\n | `uriConfig.baseUri` | String | **Required**. Base URI where your service is deployed. Wix Data uses this URI to call your service's endpoints. |\n | `componentName` | String | A unique name for this component. This is an internal name that appears in the [Wix Developers Center](fallback::https://dev.wix.com/apps) only. |\n \n For example:\n\n ```json\n {\n \"namespace\": \"@your-account-name/your-app-name\",\n \"uriConfig\": {\n \"baseUri\": \"https://my-external-db-collections-service.com\"\n },\n \"componentName\": \"myExternalCollections\"\n }\n ```\n\n## Terminology\n\n| Term | Definition |\n| --- | --- |\n| Collection | A schema that determines the structure of data items to be stored. The schema defines the fields each item contains and the data type of each field. |\n| Item | A single data entry in a collection. |\n| External Database | A database hosted by an external service outside of Wix. |\n| External Database Service Provider | A 3rd-party service that implements an interface to allow Wix Data to interact with an external database. |\n","sourceRepo":"git@github.com:wix-private/cloud.git","path":"docs/intro.md"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Flows\n\nThis article presents some sample use cases your service might support. You are not limited to these exact flows, but they can serve as good starting points to help you plan your external database integration.\n\n## Query real-estate properties in an external database\n\n> **Note:**\n> This sample flow requires the implementation of at least [the basic functionality endpoints](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/introduction#provide-basic-functionality) of this service plugin.\n\nA real-estate agency stores information about the properties it manages in an external database. The agency has a Wix site and wants to make its properties available to its visitors. The agency implements the relevant endpoints of the External Database Service Plugin and hosts them at the `https://www..com` base URL. It then [creates a Wix app](fallback::https://dev.wix.com/docs/build-an-app/develop-your-app/dev-center-setup/about-the-wix-dev-center#integrating-your-app), configures it with the [details of the service](portalId::63e3acd8-2a9c-421d-8f92-d02930eeb59eresourceId::09ddf515-a458-4034-9995-2d6719a8150a*fallback::https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions), and installs the app on its site. The site can then interact with the external database like this:\n\n1. On a dedicated search page, a site visitor searches for relevant properties with the following search and sorting criteria:\n\n - Locality: Springfield\n - Max number of rooms: 3\n - Price range: $550-$700\n - Sort: Low-to-high\n - Page limit: 3\n\n2. Based on the visitor's criteria, Wix Data automatically sends a [Query Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/query-distinct-values) request to the service endpoint hosted at `https://www..com/v3/items/query`. The request body looks like this:\n\n ```json\n {\n \"collectionId\": \"SpringfieldProperties\",\n \"query\": {\n \"filter\": {\n \"price\": {\n \"$gte\": 550,\n \"$lte\": 700\n }\n },\n \"sort\": [\n {\n \"fieldName\": \"price\"\n }\n ],\n \"fields\": [],\n \"paging\": {\n \"limit\": 3,\n \"offset\": 0\n }\n },\n \"includeReferencedItems\": [],\n \"consistentRead\": false,\n \"returnTotalCount\": false\n }\n ```\n\n3. The endpoint responds with the relevant items, filtered and sorted as specified in the query. For example:\n\n ```json\n {\n \"items\": [\n {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"address\": \"742 Evergreen Terrace\", \n \"floor\": 4,\n \"aptNum\": 2,\n \"numBedrooms\": 2,\n \"numBaths\": 1,\n \"price\": 600,\n \"pets\": true,\n \"airConditioning\": false\n },\n {\n \"_id\": \"e831385d-d067-4905-a98a-456f5a526ca2\",\n \"address\": \"247 Foreverblue Blvd\", \n \"floor\": 2,\n \"aptNum\": 2,\n \"numBedrooms\": 1,\n \"numBaths\": 1,\n \"price\": 680,\n \"pets\": false,\n \"airConditioning\": true\n }\n ],\n \"pagingMetadata\": {\n \"cursors\": {\n \"next\": \"0O52kwmAcT\",\n \"prev\": \"omZq6gTpR9\"\n }\n }\n }\n ```\n\n The site receives the data as if it were stored in a native Wix Data collection. It then parses the response and displays the results to the visitor.\n\n## Manage local job positions with an app\n\n> **Note:**\n> This sample flow requires the implementation of the following service plugin endpoints:\n>\n> - The [basic functionality endpoints](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/introduction#provide-basic-functionality)\n> - [Query Referenced Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/query-referenced-data-items)\n> - [Update Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/update-data-items)\n\nA large employment agency maintains its job listings in an external database. The agency has several branches. Each branch operates in a different area and has its own Wix site.\n\nTo enable each branch to independently access and manage the job listings stored in the database, the agency implements the External Database service plugin and hosts it on the `https://www..com` base URL. It then [creates a private app](fallback::https://dev.wix.com/docs/build-apps/get-started/overview/exposing-apps-publicly-and-privately#private-apps) and configures it with the [details of the service](portalId::63e3acd8-2a9c-421d-8f92-d02930eeb59eresourceId::09ddf515-a458-4034-9995-2d6719a8150a*fallback::https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions). Each branch installs the app on its site to gain independent access to the database. Site visitors can then query, sort, and filter relevant listings on the site branch most relevant to them.\n\nIn this flow, a site visitor searches for open kitchen staff positions on a branch's site. After finding a relevant position, they browse for other listings by the same employer. Once filled, the branch closes the position.\n\n1. On a dedicated search page, a site visitor searches for open listings using the following search and sorting criteria:\n\n - Locality: North Utah\n - Sector: Restaurants\n - Position: Kitchen Staff\n - Show listing details: Job Title, Employer, Address, Hourly Salary\n - Sort: New-to-old\n - Page limit: 5\n\n2. Based on these preferences, Wix Data automatically sends a [Query Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/query-data-items) request to the service endpoint hosted at `https://www..com/v3/items/query`. The request body looks like this:\n\n ```json\n {\n \"collectionId\": \"northUtahJobs\",\n \"query\": {\n \"filter\": {\n \"jobTitle\": \"kitchenStaff\",\n \"status\": \"OPEN\"\n },\n \"sort\": [{\n \"fieldName\": \"_updatedDate\",\n \"order\": \"DESC\"\n }\n ],\n \"paging\": {\n \"limit\": 5,\n \"offset\": 0\n },\n \"fields\": [\"_id\", \"jobTitle\", \"employer\", \"address\", \"salaryHourly\", \"_updatedDate\"] // The details of the listing to retrieve\n\n },\n \"includeReferencedItems\": [{\n \"fieldKey\": \"employer\",\n }],\n \"consistentRead\": false,\n \"returnTotalCount\": true\n }\n ```\n\n The endpoint responds with the relevant listings, filtered and sorted as specified in the query. For example:\n\n ```json\n {\n \"items\": [\n {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"jobTitle\": \"kitchenStaff\",\n \"employer\": \"hellsKitchen\",\n \"address\": \"616 Old Nick Road, Salt Lake City, Utah\",\n \"salaryHourly\": 10,\n \"_updatedDate\": {\n \"$date\": \"2021-02-03T04:05:06Z\"\n },\n \"employer\": {\n \"_id\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"name\": \"hellsKitchen\",\n \"address\": \"616 Old Nick Road, Salt Lake City, Utah\",\n \"numEmployees\": \"14\",\n \"reputation\": 4.4\n }\n },\n {\n \"_id\": \"528a0b23-d6d8-464a-82af-09e0c00f56b0\",\n \"jobTitle\": \"kitchenStaff\",\n \"employer\": \"Joe's Magic Burgers\",\n \"address\": \"23 Hawkins Street, Arborville, Utah\",\n \"salaryHourly\": 9.5,\n \"_updatedDate\": {\n \"$date\": \"2021-02-02T12:53:01Z\"\n },\n \"employer\": {\n \"_id\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"name\": \"Joe's Magic Burgers\",\n \"address\": \"46 Horseshoe Lane, Utah\",\n \"numEmployees\": \"38\",\n \"reputation\": 4.9\n }\n },\n ],\n \"pagingMetadata\": {\n \"total\": 2\n }\n }\n ```\n\n3. The site receives the data as if it were stored in a native Wix Data collection. It then parses the response and displays the results to the visitor.\n\n4. One of the listings retrieved by Wix Data is for a position offered by Hell's Kitchen. The visitor wants to check which other positions Hell's Kitchen offers. To do that, Wix Data sends a [Query Referenced Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/query-referenced-data-items) request to the service endpoint hosted at `https://www..com/v3/items/query-referenced`. For each position listed by this employer, the visitor is interested in the job title, work address, hourly salary, and position status. The request looks like this:\n\n ```json\n {\n \"collectionId\": \"employers\",\n \"referringItemIds\": [\"faa17edb-2d88-488d-8e95-24b9364c3284\"], // Hell's Kitchen's ID\n \"referencedItemIds\": [],\n \"order\": \"ASC\",\n \"referringFieldKey\": \"positions\",\n \"consistentRead\": false,\n \"fieldsToReturn\": [\"_id\", \"jobTitle\", \"address\", \"hourlySalary\", \"status\"],\n \"returnTotalCount\": false,\n \"includeReferencedItems\": true\n }\n ```\n\n The endpoint responds with all the job positions offered by Hell's Kitchen, filtered and sorted as specified in the query. For example:\n\n ```json\n {\n \"items\": [\n {\n \"referringItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"referencedItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\", \n \"referencedItem\": {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"jobTitle\": \"kitchenStaff\",\n \"address\": \"616 Old Nick Road, Utah\",\n \"hourlySalary\": \"10\",\n \"status\": \"OPEN\"\n }\n },\n {\n \"referringItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"referencedItemId\": \"d345e77c-4f6b-5g60-4fh7-d6b9dd70kf9\",\n \"referencedItem\": {\n \"_id\": \"d345e77c-4f6b-5g60-4fh7-d6b9dd70kf9\",\n \"jobTitle\": \"shiftManager\",\n \"address\": \"616 Old Nick Road, Utah\",\n \"hourlySalary\": \"14.5\",\n \"status\": \"OPEN\"\n }\n },\n {\n \"referringItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"referencedItemId\": \"mir0958c-mfe8-kdo9-jf71-mfe0kfik4lkfp\",\n \"referencedItem\": {\n \"_id\": \"mir0958c-mfe8-kdo9-jf71-mfe0kfik4lkfp\",\n \"jobTitle\": \"hostPerson\",\n \"address\": \"616 Old Nick Road, Utah\",\n \"hourlySalary\": \"9.5\",\n \"status\": \"HIRED\"\n }\n },\n // Additional positions\n ],\n \"pagingMetadata\": {}\n }\n ```\n\n5. The site receives the data as if it were stored in a native Wix Data collection. It parses the data, filters for positions whose `status` is `OPEN`, and displays the results to the visitor.\n\n6. The Hell's Kitchen branch on Old Nick Road hires a new employee for the kitchen staff position. The employment agency's branch then closes the position. To do that, Wix Data sends an [Update Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/update-data-items) request to the service endpoint hosted at `https://www..com/v3/items/update` to update the position's status as `HIRED`. The request looks like this:\n\n ```json\n {\n \"collectionId\": \"northUtahJobs\",\n \"items\": [\n {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"jobTitle\": \"kitchenStaff\",\n \"employer\": \"hellsKitchen\",\n \"address\": \"616 Old Nick Road, Utah\",\n \"salaryHourly\": 10,\n \"status\": \"HIRED\",\n \"_updatedDate\": {\n \"$date\": \"2021-02-15T15:22:36Z\"\n }\n } \n ]\n }\n ```\n\n The endpoint responds with the updated item:\n\n ```json\n {\n \"results\": [\n {\n \"item\": {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"jobTitle\": \"kitchenStaff\",\n \"employer\": \"hellsKitchen\",\n \"address\": \"616 Old Nick Road, Utah\",\n \"salaryHourly\": 10,\n \"status\": \"HIRED\",\n \"_updatedDate\": {\n \"$date\": \"2021-02-15T15:22:36Z\"\n }\n }\n }\n ]\n }\n ```\n","sourceRepo":"git@github.com:wix-private/cloud.git","path":"docs/sample-flow.md"},{"displayName":"Error Types","slugifyName":"error-types","content":"# Error Types in the External Database Collections Service Plugin\n\nSome endpoints in the external database service plugin must respond with errors if the request is invalid or cannot be successfully fulfilled. In such cases, your service must respond with an error specific to the particular issue in the request.\n\n## Error structure\n\nEach error type conforms to a predefined structure. It includes an error code, an error message, and a data object with additional error handling information. In addition, each error type has a corresponding HTTP code.\n\nError objects have the following properties:\n\n| Field | Type | Description |\n| ----- | ---- | --------------|\n| `errorCode` | String | A code that indicates why the request failed. |\n| `errorMessage` | String | A human-readable error message. |\n| `data` | Object | Additional error data specific to the error type. |\n\nFor example, your service might receive a request to query a collection that does not exist. In this case, your service must respond with the relevant error code, a descriptive message, and a data object with the `collectionId` of the collection that was not found. This type of error looks like this:\n\n```json\nHTTP/1.1 404 Not Found\nContent-Type: application/json\n\n{\n \"errorCode\": \"COLLECTION_NOT_FOUND\",\n \"errorMessage\": \"The requested collection was not found.\",\n \"data\": {\n \"collectionId\": \"catPictures\"\n }\n}\n```\n\n## Types of errors\n\nThe following table lists the errors your service must return based on the issue in the request:\n\n| Error Code | HTTP Status Code | Description |\n|-----------------------------------|------------------|-------------|\n| `ITEM_NOT_FOUND` | `Not Found (404)` | Item was not found in the specified collection. See corresponding [data object](fallback::#item-not-found). |\n| `ITEM_ALREADY_EXISTS` | `Conflict (409)` | Item with the same `id` already exists in the specified collection. See corresponding [data object](fallback::#item-already-exists) |\n| `COLLECTION_NOT_FOUND` | `Not Found (404)` | Collection was not found. See corresponding [data object](fallback::#collection-not-found). |\n| `COLLECTION_ALREADY_EXISTS` | `Conflict (409)` | Collection with the same `id` already exists. See corresponding [data object](fallback::#collection-already-exists). |\n| `COLLECTION_CHANGE_NOT_SUPPORTED` | `Bad Request (400)` | The service does not allow modifications to the specified collection. The corresponding [data object](fallback::#collection-changes-not-supported) lists the fields that caused the error. |\n| `REFERENCE_NOT_FOUND` | `Not Found (404)` | Reference was not found for the specified item. See corresponding [data object](fallback::#reference-not-found). |\n| `REFERENCE_ALREADY_EXISTS` | `Conflict (409)` | Reference already exists for the specified item. See corresponding [data object](fallback::#reference-already-exists). |\n| `VALIDATION_ERROR` | `Bad Request (400)` | One or more fields in the request are not valid. The corresponding [data object](fallback::#validation-violations) lists the validation errors caused by the request. |\n| `BAD_REQUEST` | `Bad Request (400)` | Generic error indicating an invalid request. Use the `errorMessage` field to provide more information. |\n\n## Error data object structures\n\nEach error object type has a unique `data` property structure. This section details the `data` structure associated with each type.\n\n### Item not found\n \n| Field | Type | Description |\n| --- | --- | --- |\n| `itemId` | String | ID of the item that was not found. |\n\n```json\n{\n \"errorCode\": \"ITEM_NOT_FOUND\",\n \"errorMessage\": \"The requested item was not found.\",\n \"data\": {\n \"itemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\"\n }\n}\n```\n\n### Item already exists\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `itemId` | String | ID of the item that already exists. |\n\n```json\n{\n \"errorCode\": \"ITEM_ALREADY_EXISTS\",\n \"errorMessage\": \"The item already exists in the collection.\",\n \"data\": {\n \"itemId\": \"c2f5e77c-a86b-4361-a55f-c6b934d70187\"\n }\n}\n```\n\n### Collection not found\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `collectionId` | String | ID of the collection that was not found. |\n\n```json\n{\n \"errorCode\": \"COLLECTION_NOT_FOUND\",\n \"errorMessage\": \"The requested collection was not found.\",\n \"data\": {\n \"collectionId\": \"cities\"\n }\n}\n```\n\n### Collection already exists\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `collectionId` | String | ID of the collection that already exists. |\n\n```json\n{\n \"errorCode\": \"COLLECTION_ALREADY_EXISTS\",\n \"errorMessage\": \"The specified collection already exists.\",\n \"data\": {\n \"collectionId\": \"countries\"\n }\n}\n```\n\n### Collection changes not supported\n\nThis `data` property of this error lists all fields that the request attempted, but failed, to change. Each such attempt causes an individual [Collection Change Not Supported](fallback::#collection-change-not-supported) error.\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `errors` | Array of [collection change not supported](fallback::#collection-change-not-supported) errors | An array of unsupported collection change errors caused by the request. One error is produced for each unmodifiable field the caller attempts to change. |\n\n#### Collection change not supported\n\nEach individual Collection Change not Supported error has the following structure:\n\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `fieldKey` | String | Key of the field that cannot be changed. |\n| `message` | String | Error message explaining why the field cannot be changed. |\n\n```json\n{\n \"errorCode\": \"COLLECTION_CHANGE_NOT_SUPPORTED\",\n \"errorMessage\": \"Some fields in this collection cannot be changed.\",\n \"data\": {\n \"errors\": [\n {\n \"fieldKey\": \"firstName\",\n \"message\": \"This field cannot be changed.\"\n },\n {\n \"fieldKey\": \"lastName\",\n \"message\": \"This field cannot be changed.\"\n }\n ]\n }\n}\n```\n\n### Reference not found\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `referringItemId` | String | ID of the referring item. |\n| `referencedItemId` | String | ID of the referenced item. |\n\n```json\n{\n \"errorCode\": \"REFERENCE_NOT_FOUND\",\n \"errorMessage\": \"The requested reference was not found.\",\n \"data\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n}\n```\n\n### Reference already exists\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `referringItemId` | String | ID of the referring item. |\n| `referencedItemId` | String | ID of the referenced item. |\n\n```json\n{\n \"errorCode\": \"REFERENCE_ALREADY_EXISTS\",\n \"errorMessage\": \"The requested reference already exists for the referring item.\",\n \"data\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n}\n```\n\n### Validation violations\n\nThis `data` property of this error lists all individual [validation violations](fallback::#validation-violation) caused by the request.\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `violations` | Array of [validation violations](fallback::#validation-violation). | An array of all validation violations caused by the request. |\n\n#### Validation violation\n\nEach individual validation violation has the following structure:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `fieldPath` | String | Path to the invalid field. |\n| `rejectedValue` | String | The invalid value. |\n| `message` | String | Error message that describes the violation. |\n\n```json\n{\n \"errorCode\": \"VALIDATION_ERROR\",\n \"errorMessage\": \"Some fields contain invalid values.\",\n \"data\": {\n \"violations\": [\n {\n \"fieldPath\": \"userDateOfBirth\",\n \"rejectedValue\": \"16-12-1994\",\n \"message\": \"Invalid value for this field. See documentation for valid field values.\"\n },\n {\n \"fieldPath\": \"userImage\",\n \"rejectedValue\": \"https://mediaa.wix.com/6acbb8_7a7bd9193ffc4130ab8ff74f5dcedf8a.jpg\",\n \"message\": \"Invalid value for this field. See documentation for valid field values.\"\n }\n ]\n }\n}\n```\n","sourceRepo":"git@github.com:wix-private/cloud.git","path":"docs/errors.md"}],"components":{"schemas":{"com.wixpress.cloud.externaldatabasespi.v3.MainEntity":{"type":"object","properties":{"id":{"description":"Dummy ID.","readOnly":true,"format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MainEntity","description":"Dummy entity."},"com.wixpress.cloud.externaldatabasespi.v3.QueryDataItemsRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the collection to query.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"query":{"description":"Query preferences. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for information about handling data queries.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includeReferencedItems":{"description":"Fields for which to include the full referenced items in the query's results, rather than just their IDs.\nReturned items are sorted in ascending order by the creation date of the reference.\nIf the field being querried is a multi-reference field and the array is empty, the response does not return any items.","title":"includeReferencedItems","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.QueryDataItemsRequest.ReferencedItemToInclude"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Applicable if the external database is eventually consistent.","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"When `true`, the query response must include the total number of items that match the query.","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryDataItemsRequest","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.QueryV2":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`\n\n**Note:** Your endpoint must properly handle requests with filtering preferences that adhere to Wix Data data types. For example, a query request that includes filtering by a field whose type is Date and Time would contain an object in the following format: `\"someDateAndTimeFieldKey\": { \"$date\": \"YYYY-MM-DDTHH:mm:ss.sssZ\"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Array of projected fields. A list of specific field names to return.","title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryV2","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.QueryV2.pagingMethod"}]},"com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.QueryV2.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items. Paging mode is defined when the collection is created.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. Paging mode is defined when the collection is created.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":1000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wixpress.cloud.externaldatabasespi.v3.QueryDataItemsRequest.ReferencedItemToInclude":{"type":"object","properties":{"fieldKey":{"description":"Field name in the referencing collection.","title":"fieldKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"Maximum number of referenced items to return.","title":"limit","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter criteria to specify which items to include in the response.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReferencedItemToInclude","description":""},"com.wixpress.cloud.externaldatabasespi.v3.QueryDataItemsResponse":{"type":"object","properties":{"items":{"description":"Retrieved items.","title":"items","type":"array","items":{"type":"object"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Pagination information.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryDataItemsResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next page in the list of results.","title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous page in the list of results.","title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ItemAlreadyExistsError":{"type":"object","properties":{"itemId":{"description":"ID of the item that already exists.","maxLength":256,"title":"itemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemAlreadyExistsError","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ItemNotFoundError":{"type":"object","properties":{"itemId":{"description":"ID of the item that was not found.","maxLength":256,"title":"itemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemNotFoundError","description":""},"com.wixpress.cloud.externaldatabasespi.v3.CollectionAlreadyExistsError":{"type":"object","properties":{"collectionId":{"description":"ID of the collection that already exists.","maxLength":256,"title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CollectionAlreadyExistsError","description":""},"com.wixpress.cloud.externaldatabasespi.v3.CollectionNotFoundError":{"type":"object","properties":{"collectionId":{"description":"ID of the collection that was not found.","maxLength":256,"title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CollectionNotFoundError","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ReferenceAlreadyExistsError":{"type":"object","properties":{"referringItemId":{"description":"ID of the referring item.","maxLength":256,"title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemId":{"description":"ID of the referenced item.","maxLength":256,"title":"referencedItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReferenceAlreadyExistsError","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ReferenceNotFoundError":{"type":"object","properties":{"referringItemId":{"description":"ID of the referring item.","maxLength":256,"title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemId":{"description":"ID of the referenced item.","maxLength":256,"title":"referencedItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReferenceNotFoundError","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ValidationError":{"type":"object","properties":{"violations":{"description":"Violations that caused the validation to fail.","maxItems":100,"title":"violations","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ValidationViolation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValidationError","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ValidationViolation":{"type":"object","properties":{"fieldPath":{"description":"Path to the invalid field that caused the violation.","maxLength":1000,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rejectedValue":{"description":"The rejected value.","maxLength":1000,"title":"rejectedValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"Error message that describes the violation.","maxLength":10000,"title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValidationViolation","description":""},"com.wixpress.cloud.externaldatabasespi.v3.CollectionChangeNotSupported":{"type":"object","properties":{"errors":{"description":"Errors that caused the change to fail. Learn more about [errors](data/cloud-data-spi/proto-spi/docs/errors.md) in the External Database Connections service plugin.","maxItems":100,"title":"errors","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.CollectionChangeNotSupportedError"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CollectionChangeNotSupported","description":""},"com.wixpress.cloud.externaldatabasespi.v3.CollectionChangeNotSupportedError":{"type":"object","properties":{"fieldKey":{"description":"Key of collection field that can't be changed.","maxLength":250,"title":"fieldKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"Error message with additional details.","maxLength":1000,"title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CollectionChangeNotSupportedError","description":""},"com.wixpress.cloud.externaldatabasespi.v3.CountDataItemsRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the collection to query.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter to specify which items to count. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) for more information about handling data queries.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Applicable if the external database is eventually consistent.","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountDataItemsRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.CountDataItemsResponse":{"type":"object","properties":{"totalCount":{"description":"Number of items that match the query.","title":"totalCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountDataItemsResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the collection on which to run the aggregation.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initialFilter":{"description":"Filter to apply to the collection's data before aggregation. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) for more information about handling data queries.","title":"initialFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregation":{"description":"Aggregation to apply to the data.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Aggregation","summary":"aggregation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"finalFilter":{"description":"Filter to apply to the processed data after aggregation. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) for more information about handling data queries.","title":"finalFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sorting configuration.","title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Applicable if the external database is eventually consistent.","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"When `true`, the query response must include the total number of items that match the query.","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregateDataItemsRequest","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.pagingMethod"}]},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation":{"type":"object","properties":{"resultFieldName":{"description":"Name of the field that contains the results of the operation.","title":"resultFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Operation","description":"","oneOf":[{"description":"","summary":"calculate","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.calculate"}]},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.calculate":{"type":"object","title":"calculate","properties":{"average":{"description":"Calculate the average value of a specified field for all items in the grouping.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.Average","summary":"average","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"min":{"description":"Calculate the minimum value of a specified field for all items in the grouping.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.Min","summary":"min","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"max":{"description":"Calculate the maximum value of a specified field for all items in the grouping.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.Max","summary":"max","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sum":{"description":"Calculate the sum of values of a specified field for all items in the grouping.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.Sum","summary":"sum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemCount":{"description":"Calculate the number of items in the grouping.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.Count","summary":"itemCount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.Average":{"type":"object","properties":{"itemFieldName":{"description":"Name of the field for which to calculate the average value.","title":"itemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Average","description":""},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.Min":{"type":"object","properties":{"itemFieldName":{"description":"Name of the field for which to calculate the minimum value.","title":"itemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Min","description":""},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.Max":{"type":"object","properties":{"itemFieldName":{"description":"Name of the field for which to calculate the maximum value.","title":"itemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Max","description":""},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.Sum":{"type":"object","properties":{"itemFieldName":{"description":"Name of the field for which to calculate the sum.","title":"itemFieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sum","description":""},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation.Count":{"type":"object","properties":{},"title":"Count","description":""},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Aggregation":{"type":"object","properties":{"groupingFields":{"description":"Fields by which to group items for the aggregation, in the order they appear in the array. If empty, the aggregation must be applied to the entire collection.","title":"groupingFields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"operations":{"description":"Operations to carry out on the data in each grouping.","title":"operations","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsRequest.Operation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Aggregation","description":""},"com.wixpress.cloud.externaldatabasespi.v3.AggregateDataItemsResponse":{"type":"object","properties":{"items":{"description":"Aggregation results. Each result must contain a field for each `groupingFields` value, and a field for each `operations.resultFieldName` value.","title":"items","type":"array","items":{"type":"object"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging information.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregateDataItemsResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.QueryDistinctValuesRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the collection to query.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Filter to apply to the collection's data before aggregation. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) for more information about handling data queries.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldName":{"description":"Item field name for which to return all distinct values.","title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Order to by which to sort the results. Valid values are `ASC` and `DESC`.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Applicable if the external database is eventually consistent.","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"When `true`, the query response must include the total number of items that match the query.","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryDistinctValuesRequest","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.QueryDistinctValuesRequest.pagingMethod"}]},"com.wixpress.cloud.externaldatabasespi.v3.QueryDistinctValuesRequest.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.externaldatabasespi.v3.QueryDistinctValuesResponse":{"type":"object","properties":{"distinctValues":{"description":"List of distinct values contained in the field specified in `fieldName`. Values can be of any JSON type.\nIf the field is an array, values must be unwound, independent values. For example, if the field name contains `[\"a\", \"b\", \"c\"]`, the result must contain `\"a\"`, `\"b\"` and `\"c\"` as separate values.","title":"distinctValues","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging information.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryDistinctValuesResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemsRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the collection in which to insert the items.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"Items to insert.","minItems":1,"title":"items","type":"array","items":{"type":"object"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InsertDataItemsRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemsResponse":{"type":"object","properties":{"results":{"description":"Response must include either the inserted item or an error.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.DataItemModificationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InsertDataItemsResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.DataItemModificationResult":{"type":"object","properties":{},"title":"DataItemModificationResult","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.DataItemModificationResult.result"}]},"com.wixpress.cloud.externaldatabasespi.v3.DataItemModificationResult.result":{"type":"object","title":"result","properties":{"item":{"description":"Item that was inserted, updated or removed.","title":"item","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Error indicating why the operation failed for a particular item. Learn more about [error types](https://dev.wix.com/docs/rest/assets/data/external-database-spi/understanding-error-types-in-the-external-database-connections-spi) in the External Database Connections service plugin.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Error","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.externaldatabasespi.v3.Error":{"type":"object","properties":{"errorCode":{"description":"Error code.","minLength":3,"maxLength":100,"title":"errorCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"errorMessage":{"description":"Error description.","maxLength":10000,"title":"errorMessage","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Additional error data specific to the error code.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Error","description":""},"com.wixpress.cloud.externaldatabasespi.v3.UpdateDataItemsRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the collection in which to update the items.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"items":{"description":"Items to update.","minItems":1,"title":"items","type":"array","items":{"type":"object"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateDataItemsRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.UpdateDataItemsResponse":{"type":"object","properties":{"results":{"description":"Response must include either the updated item or an error.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.DataItemModificationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateDataItemsResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemsRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the collection from which to remove items.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"itemIds":{"description":"IDs of items to remove.","minItems":1,"title":"itemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveDataItemsRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemsResponse":{"type":"object","properties":{"results":{"description":"Response must include either the removed item or an error.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.DataItemModificationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveDataItemsResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.TruncateDataItemsRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the collection from which to remove all items.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TruncateDataItemsRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.TruncateDataItemsResponse":{"type":"object","properties":{},"title":"TruncateDataItemsResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.QueryReferencedDataItemsRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the collection to query.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringItemIds":{"description":"IDs of the referring items. If the array is empty, return results for all referring items.","maxItems":1000,"title":"referringItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemIds":{"description":"IDs of the referenced items. If the array is empty, return all referenced items for the referring items.","maxItems":1000,"title":"referencedItemIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Order to by which to sort the results. Valid values are `ASC` and `DESC`.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringFieldKey":{"description":"Field key to query in the referring collection.","title":"referringFieldKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consistentRead":{"description":"Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Applicable if the external database is eventually consistent.","title":"consistentRead","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsToReturn":{"description":"Fields to return in the referenced item. If the array is empty or not provided, all fields in the referenced item are returned.","title":"fieldsToReturn","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnTotalCount":{"description":"When `true`, the response includes the total number of the items that match the query.","title":"returnTotalCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"includeReferencedItems":{"description":"When `true`, the response includes the full referenced items. When `false`, only the IDs of referenced items be returned.","title":"includeReferencedItems","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryReferencedDataItemsRequest","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.QueryReferencedDataItemsRequest.pagingMethod"}]},"com.wixpress.cloud.externaldatabasespi.v3.QueryReferencedDataItemsRequest.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Offset-based paging","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor-based paging","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.externaldatabasespi.v3.QueryReferencedDataItemsResponse":{"type":"object","properties":{"items":{"description":"Retrieved references.","title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ReferencedItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging information.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryReferencedDataItemsResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ReferencedItem":{"type":"object","properties":{"referringItemId":{"description":"ID of the item in the referring collection.","title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemId":{"description":"ID of the item in the referenced collection.","title":"referencedItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItem":{"description":"Item in the referenced collection. If the external database does not support returning referenced items, this field can remain empty.","title":"referencedItem","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReferencedItem","description":""},"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemReferencesRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the referring collection.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringFieldKey":{"description":"Field key of the field in the referring collection to insert references into.","title":"referringFieldKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"references":{"description":"References to insert.","minItems":1,"title":"references","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ReferenceId"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InsertDataItemReferencesRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ReferenceId":{"type":"object","properties":{"referringItemId":{"description":"ID of the item in the referring collection.","title":"referringItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedItemId":{"description":"ID of the item in the referenced collection.","title":"referencedItemId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReferenceId","description":""},"com.wixpress.cloud.externaldatabasespi.v3.InsertDataItemReferencesResponse":{"type":"object","properties":{"results":{"description":"Response must include either the inserted reference or an error.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ReferenceModificationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InsertDataItemReferencesResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ReferenceModificationResult":{"type":"object","properties":{},"title":"ReferenceModificationResult","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ReferenceModificationResult.result"}]},"com.wixpress.cloud.externaldatabasespi.v3.ReferenceModificationResult.result":{"type":"object","title":"result","properties":{"reference":{"description":"Reference that was inserted or removed.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ReferenceId","summary":"reference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Error indicating why the operation failed for a particular item. Learn more about [error types](https://dev.wix.com/docs/rest/assets/data/external-database-spi/understanding-error-types-in-the-external-database-connections-spi) in the External Database Connections service plugin.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Error","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemReferencesRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the referring collection.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referringFieldKey":{"description":"Field key of the field in the referring collection to remove references from.","title":"referringFieldKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"references":{"description":"References to remove.","minItems":1,"title":"references","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ReferenceId"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveDataItemReferencesRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.RemoveDataItemReferencesResponse":{"type":"object","properties":{"results":{"description":"Response must include either the removed reference or an error.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ReferenceModificationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveDataItemReferencesResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ListCollectionsRequest":{"type":"object","properties":{"collectionIds":{"description":"IDs of collections to retrieve. If empty, all available collections are retrieved.","title":"collectionIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListCollectionsRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ListCollectionsResponse":{"type":"object","properties":{"collections":{"description":"List of the retrieved collections.","title":"collections","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Collection"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListCollectionsResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.Collection":{"type":"object","properties":{"id":{"description":"ID of the collection.","immutable":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayName":{"description":"Collection display name as it appears in the CMS. For example, `My First Collection`.","title":"displayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Collection fields.","title":"fields","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"capabilities":{"description":"Capabilities the collection supports. This is set by the external database, and is ignored in the body of the request.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.CollectionCapabilities","summary":"capabilities","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"permissions":{"description":"Levels of permission for accessing and modifying data. These are defined by the lowest role needed to perform each action.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Permissions","summary":"permissions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMode":{"description":"Whether the collection supports cursor- or offset-based paging. Each paging mode requires different configuration parameters.","readOnly":true,"title":"pagingMode","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.PagingMode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Collection","description":""},"com.wixpress.cloud.externaldatabasespi.v3.Field":{"type":"object","properties":{"key":{"description":"Field identifier.","title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayName":{"description":"Field display name as it appears in the CMS. For example, `First Name`.","title":"displayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Field description.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Field type.","title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.FieldType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"capabilities":{"description":"Capabilities the collection supports. This is set by the external database and is ignored in the body of the request.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.FieldCapabilities","summary":"capabilities","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"encrypted":{"description":"Whether the field value is encrypted and sent as an object. Encryption and decryption are handled by Wix. Default: `false`.","title":"encrypted","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Field","description":"","oneOf":[{"description":"","summary":"typeOptions","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Field.typeOptions"}]},"com.wixpress.cloud.externaldatabasespi.v3.Field.typeOptions":{"type":"object","title":"typeOptions","properties":{"singleReferenceOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.SingleReferenceOptions","summary":"singleReferenceOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"multiReferenceOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.MultiReferenceOptions","summary":"multiReferenceOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"arrayOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ArrayOptions","summary":"arrayOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"objectOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ObjectOptions","summary":"objectOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.externaldatabasespi.v3.FieldType":{"type":"string","description":"","title":"FieldType","enum":["UNKNOWN_FIELD_TYPE","TEXT","NUMBER","DATE","DATETIME","IMAGE","BOOLEAN","DOCUMENT","URL","RICH_TEXT","VIDEO","ANY","ARRAY_STRING","ARRAY_DOCUMENT","AUDIO","TIME","LANGUAGE","RICH_CONTENT","MEDIA_GALLERY","ADDRESS","REFERENCE","MULTI_REFERENCE","OBJECT","ARRAY"]},"com.wixpress.cloud.externaldatabasespi.v3.FieldCapabilities":{"type":"object","properties":{"sortable":{"description":"Whether the field can be used to sort the items in a collection. Default: `false`.","title":"sortable","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"queryOperators":{"description":"Query operators that can be used for this field.","title":"queryOperators","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.QueryOperator"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldCapabilities","description":""},"com.wixpress.cloud.externaldatabasespi.v3.QueryOperator":{"type":"string","description":"","title":"QueryOperator","enum":["EQ","LT","GT","NE","LTE","GTE","STARTS_WITH","ENDS_WITH","CONTAINS","HAS_SOME","HAS_ALL","EXISTS","URLIZED"]},"com.wixpress.cloud.externaldatabasespi.v3.SingleReferenceOptions":{"type":"object","properties":{"referencedCollectionId":{"description":"ID of the referenced collection.\n\nWhen the referring field is a single-reference field, it refers to the `_id` field of the referenced collection.","title":"referencedCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SingleReferenceOptions","description":""},"com.wixpress.cloud.externaldatabasespi.v3.MultiReferenceOptions":{"type":"object","properties":{"referencedCollectionId":{"description":"ID of the referenced collection.","title":"referencedCollectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedCollectionFieldKey":{"description":"Field key of the referenced field in the referenced collection.","title":"referencedCollectionFieldKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referencedCollectionFieldDisplayName":{"description":"Field display name of the referenced field in the referenced collection.","title":"referencedCollectionFieldDisplayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MultiReferenceOptions","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ArrayOptions":{"type":"object","properties":{"elementType":{"description":"Element data type.","title":"elementType","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.FieldType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ArrayOptions","description":"","oneOf":[{"description":"","summary":"typeOptions","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ArrayOptions.typeOptions"}]},"com.wixpress.cloud.externaldatabasespi.v3.ArrayOptions.typeOptions":{"type":"object","title":"typeOptions","properties":{"singleReferenceOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.SingleReferenceOptions","summary":"singleReferenceOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"multiReferenceOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.MultiReferenceOptions","summary":"multiReferenceOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"arrayOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ArrayOptions","summary":"arrayOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"objectOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ObjectOptions","summary":"objectOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.externaldatabasespi.v3.ObjectOptions":{"type":"object","properties":{"fields":{"description":"Fields within the object.","title":"fields","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ObjectOptions.ObjectField"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ObjectOptions","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ObjectOptions.ObjectField":{"type":"object","properties":{"key":{"description":"Field key.","title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayName":{"description":"Field display name.","title":"displayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Field type.","title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.FieldType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"capabilities":{"description":"Capabilities the object field supports.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.FieldCapabilities","summary":"capabilities","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ObjectField","description":"","oneOf":[{"description":"","summary":"typeOptions","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ObjectOptions.ObjectField.typeOptions"}]},"com.wixpress.cloud.externaldatabasespi.v3.ObjectOptions.ObjectField.typeOptions":{"type":"object","title":"typeOptions","properties":{"singleReferenceOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.SingleReferenceOptions","summary":"singleReferenceOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"multiReferenceOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.MultiReferenceOptions","summary":"multiReferenceOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"arrayOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ArrayOptions","summary":"arrayOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"objectOptions":{"description":"","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.ObjectOptions","summary":"objectOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.cloud.externaldatabasespi.v3.CollectionCapabilities":{"type":"object","properties":{"dataOperations":{"description":"Data operations that can be performed on items in the collection.","title":"dataOperations","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.DataOperation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CollectionCapabilities","description":""},"com.wixpress.cloud.externaldatabasespi.v3.DataOperation":{"type":"string","description":"","title":"DataOperation","enum":["QUERY","COUNT","QUERY_REFERENCED","AGGREGATE","DISTINCT","INSERT","UPDATE","REMOVE","TRUNCATE","INSERT_REFERENCES","REMOVE_REFERENCES"]},"com.wixpress.cloud.externaldatabasespi.v3.Permissions":{"type":"object","properties":{"insert":{"description":"Lowest role required to add a collection.","title":"insert","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Role","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"update":{"description":"Lowest role required to update a collection.","title":"update","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Role","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"remove":{"description":"Lowest role required to remove a collection.","title":"remove","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Role","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"read":{"description":"Lowest role required to read a collection.","title":"read","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Role","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Permissions","description":""},"com.wixpress.cloud.externaldatabasespi.v3.Role":{"type":"string","description":"","title":"Role","enum":["ADMIN","SITE_MEMBER_AUTHOR","SITE_MEMBER","ANYONE"]},"com.wixpress.cloud.externaldatabasespi.v3.PagingMode":{"type":"string","description":"","title":"PagingMode","enum":["UNKNOWN_PAGING_MODE","OFFSET","CURSOR"]},"com.wixpress.cloud.externaldatabasespi.v3.CreateCollectionRequest":{"type":"object","properties":{"collection":{"description":"Details of the collection to create.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Collection","summary":"collection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCollectionRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.CreateCollectionResponse":{"type":"object","properties":{"collection":{"description":"Details of the created collection.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Collection","summary":"collection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCollectionResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.UpdateCollectionRequest":{"type":"object","properties":{"collection":{"description":"Updated structure details for the specified collection.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Collection","summary":"collection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCollectionRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.UpdateCollectionResponse":{"type":"object","properties":{"collection":{"description":"Updated collection details.","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Collection","summary":"collection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateCollectionResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.DeleteCollectionRequest":{"type":"object","properties":{"collectionId":{"description":"ID of the collection to delete.","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteCollectionRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.DeleteCollectionResponse":{"type":"object","properties":{},"title":"DeleteCollectionResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.GetCapabilitiesRequest":{"type":"object","properties":{},"title":"GetCapabilitiesRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.GetCapabilitiesResponse":{"type":"object","properties":{"supportsCollectionModifications":{"description":"Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them.","title":"supportsCollectionModifications","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"supportedFieldTypes":{"description":"Field types the external database supports. This field only applies when `supportsCollectionModifications` is true.","title":"supportedFieldTypes","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.FieldType"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCapabilitiesResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.IndexOptions":{"type":"object","properties":{"supportsIndexes":{"description":"Whether the external database supports creating, listing and removing indexes.","title":"supportsIndexes","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxNumberOfRegularIndexesPerCollection":{"description":"Maximum number of regular (non-unique) indexes allowed for this collection.","title":"maxNumberOfRegularIndexesPerCollection","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxNumberOfUniqueIndexesPerCollection":{"description":"Maximum number of unique indexes allowed for this collection.","title":"maxNumberOfUniqueIndexesPerCollection","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"maxNumberOfIndexesPerCollection":{"description":"Maximum number of regular and unique indexes allowed for this collection.","title":"maxNumberOfIndexesPerCollection","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IndexOptions","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ListIndexesRequest":{"type":"object","properties":{"collectionId":{"description":"collection to list indexes from","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListIndexesRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ListIndexesResponse":{"type":"object","properties":{"indexes":{"description":"list of indexes","title":"indexes","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Index"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListIndexesResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.Index":{"type":"object","properties":{"name":{"description":"Index name","minLength":1,"maxLength":128,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields over which the index is defined","minItems":1,"maxItems":32,"title":"fields","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Index.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Indicates current status of index","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Index.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"unique":{"description":"If true index will enforce that values in the field are unique in scope of a collection. Default is false.","title":"unique","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"caseInsensitive":{"description":"If true index will be case-insensitive. Default is false.","title":"caseInsensitive","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"failure":{"description":"Contains details about failure reason when index is in *FAILED* status","readOnly":true,"$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Error","summary":"failure","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Index","description":""},"com.wixpress.cloud.externaldatabasespi.v3.Index.Field.Order":{"type":"string","description":"Order determines how values are ordered in the index. This is important when\nordering and/or range querying by indexed fields.","title":"Order","enum":["ASC","DESC"]},"com.wixpress.cloud.externaldatabasespi.v3.Index.Field":{"type":"object","properties":{"path":{"description":"Field to index. For example: title, options.price","minLength":1,"maxLength":128,"title":"path","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Order in which to keep the values. Default is ASC.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Index.Field.Order","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Field","description":""},"com.wixpress.cloud.externaldatabasespi.v3.Index.Status":{"type":"string","description":"","title":"Status","enum":["UNKNOWN","BUILDING","ACTIVE","DROPPING","DROPPED","FAILED","INVALID"]},"com.wixpress.cloud.externaldatabasespi.v3.CreateIndexRequest":{"type":"object","properties":{"collectionId":{"description":"collection to list indexes from","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"index":{"description":"index definition","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Index","summary":"index","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateIndexRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.CreateIndexResponse":{"type":"object","properties":{"index":{"description":"created index and it's status","$ref":"#/components/schemas/com.wixpress.cloud.externaldatabasespi.v3.Index","summary":"index","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateIndexResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.RemoveIndexRequest":{"type":"object","properties":{"collectionId":{"description":"collection to delete index from","title":"collectionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"indexName":{"description":"index name","title":"indexName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RemoveIndexRequest","description":""},"com.wixpress.cloud.externaldatabasespi.v3.RemoveIndexResponse":{"type":"object","properties":{},"title":"RemoveIndexResponse","description":""},"com.wixpress.cloud.externaldatabasespi.v3.ExternalDatabaseSpiConfig":{"type":"object","properties":{"uriConfig":{"description":"The URI where the service provider is deployed.","$ref":"#/components/schemas/wix.common.spi.SpiBaseUri","summary":"uriConfig","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespace":{"description":"The namespace of the external database. This can be used to access collections within the database, for example `namespace/collectionId`.","title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExternalDatabaseSpiConfig","description":""},"wix.common.spi.SpiBaseUri":{"type":"object","properties":{"baseUri":{"description":"URI that will be used by the host to call the implementer. The path-suffix defined on the method will be appended to it","minLength":6,"maxLength":2048,"title":"baseUri","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"alternativeUris":{"description":"override method mappings per method","title":"alternativeUris","type":"array","items":{"$ref":"#/components/schemas/wix.common.spi.SpiBaseUri.AlternativeUri"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SpiBaseUri","description":""},"wix.common.spi.SpiBaseUri.AlternativeUri":{"type":"object","properties":{"methodName":{"description":"name of the method as it appears in the proto","minLength":3,"maxLength":128,"title":"methodName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"absoluteUri":{"description":"absolute uri that will be used by the host to call that method. The path-suffix mapped from the method http option will NOT be appended to this URI. For TPAs. it must be https","minLength":6,"maxLength":2048,"title":"absoluteUri","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AlternativeUri","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.spi.Context":{"type":"object","properties":{"requestId":{"description":"A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs.","title":"requestId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currency":{"description":"[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"An object that describes the identity that triggered this request.","$ref":"#/components/schemas/wix.common.spi.Context.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"languages":{"description":"A string representing a language and region in the format of `\"xx-XX\"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash \"-\", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `\"en-US\"`.","title":"languages","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"The service provider app's instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Context","description":"this message is not directly used by any service,\nit exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.\ne.g. SPIs, event-handlers, etc..\nNOTE: this context object MUST be provided as the last argument in each Velo method signature.\n\nExample:\n```typescript\nexport function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {\n...\n}\n```"},"wix.common.spi.Context.IdentificationData.IdentityType":{"type":"string","description":"","title":"IdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]},"wix.common.spi.Context.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/wix.common.spi.Context.IdentificationData.IdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/wix.common.spi.Context.IdentificationData.id"}]},"wix.common.spi.Context.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}}}},"title":"","description":"","fqdn":"wix.data.externaldatabasespi.v3.main_entity"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the External Database Service Plugin\n\nAs an external database service plugin provider (formerly SPI), you can create a service that allows Wix sites to access and manage data stored anywhere, as if it were hosted natively on Wix. By implementing this service plugin, your service can:\n\n- Make external business data available to Wix sites.\n- Make an external database available to Wix site owners to store their business data.\n\nLearn more [about service plugins](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/service-plugins/about-service-plugin-extensions).\n\n## Managing data with Wix\n\nWix offers a variety of data management solutions to accommodate common user needs at different scales. This includes support for internal databases that are hosted directly on Wix, as well as [external databases](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ae9cab4a-b40b-48f1-b1b3-e659595e3440slug::introduction#internal-vs-external-databases*fallback::https://dev.wix.com/docs/rest/assets/wix-data/external-database-connection/introduction#internal-vs-external-databases) hosted outside the Wix ecosystem.\n\nYou can store and manage data directly on Wix using the [Wix Data API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::1730dc2b-f113-416f-80ed-17087ffc68c8*fallback::https://dev.wix.com/docs/rest/api-reference/wix-data/introduction). Wix also supports managing data hosted on external databases. The [External Database Connections API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ae9cab4a-b40b-48f1-b1b3-e659595e3440slug::introduction*fallback::https://dev.wix.com/docs/rest/api-reference/wix-data/external-database-connection/introduction) allows Wix Data to communicate with an external database as if it were hosted directly on Wix. Wix offers several out-of-the-box [external database integrations](fallback::https://dev.wix.com/docs/develop-websites/articles/databases/external-databases/overview/integrating-external-databases-with-your-wix-site#supported-databases) for common platforms such as Google Cloud Platform (GCP), Amazon Web Services (AWS), or Microsoft Azure. These integrations translate Wix Data requests into the external database's protocol, and translate the response back into a format that Wix APIs can read.\n\nTo allow Wix Data to communicate with any other data source, implement the External Database service plugin.\n\n## Become an external database service provider\n\nThe External Database service plugin defines endpoints you can implement to integrate an external database with Wix. Wix Data calls these endpoints to access and manage the items and collections the external database contains. The endpoints descriptions specify what type of request Wix Data sends to each endpoint, and what type of response each endpoint is expected to return.\n\nWhen the service is implemented and ready for use, you can make it available to users by [creating a Wix app and configuring it](fallback::#configuration) with the details of your service. This tells Wix Data where your service is deployed. After installing your app on their sites, site admins can use the [Wix Data APIs](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::1730dc2b-f113-416f-80ed-17087ffc68c8*fallback::https://dev.wix.com/docs/rest/api-reference/wix-data/introduction) to access and interact with the external database as if it were hosted on Wix.\n\n### Provide basic functionality\n\nWhile you aren't required to implement all the endpoints in this service plugin, make sure to implement at least the following endpoints to provide basic functionality:\n\n* [Get Capabilities](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::cc32e433-637d-4b53-af07-6747e142e0afslug::get-capabilities*fallback::https://dev.wix.com/docs/rest/assets/data/external-database-spi/get-capabilities): This endpoint lets Wix Data determine which capabilities are supported by the external database.\n* [List Collections](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::cc32e433-637d-4b53-af07-6747e142e0afslug::list-collections*fallback::https://dev.wix.com/docs/rest/assets/data/external-database-spi/list-collections): This endpoint enables Wix Data to view the collections stored in the external database.\n* [Query Data Items](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::cc32e433-637d-4b53-af07-6747e142e0afslug::query-data-items*fallback::https://dev.wix.com/docs/rest/assets/data/external-database-spi/query-data-items): This endpoint enables Wix Data to query items in an external collection.\n\n## Use Cases\n\nYour service can accommodate many scenarios that require Wix Data to communicate with external databases. These might include:\n\n* A business that wants to make its data available for Wix site owners.\n* A Wix site owner whose data is stored in an external database and wants to [query and display that data on their site](slug::sample-flows#query-real-estate-properties-in-an-external-database*fallback::./sample-flow.md#query-real-estate-properties-in-an-external-database).\n* A Wix app developer who wants to implement ready-for-use external database integrations for specific database services.\n* A growing business that wants to store its Wix collections on an external cloud service to scale as needed.\n\n## Configuration\n\nTo enable Wix Data to communicate with your service:\n\n1. Create an app in the [Wix Developers Center](fallback::https://dev.wix.com/apps).\n2. Select your new app and click the [Extensions](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/about-extensions) tab.\n3. Click **Create Extension**.\n4. Find and select **External Database Provider** and click **Create**.\n5. If it has not been set before, set up an app namespace. This is a unique identifier for your app that, once set, can't be changed. It is added as a prefix to the user's external collection names.\n ![wix app namespace modal](https://wixmp-833713b177cebf373f611808.wixmp.com/images/intro-md_docs_assets_app-namespace-modal.png)\n \n\n6. Use the built-in JSON editor to provide your extension’s configuration details. Make sure to include all the required fields as they appear in the table below. Once you're done, click **Save**.\n\n | Name | Type | Description |\n |-------------|--------|-------------------------------------------------------|\n | `namespace` | String | **Required**. A prefix for all the collections your application retrieves. It must be identical to your app namespace. |\n | `uriConfig` | Object | The URI configuration object. |\n | `uriConfig.baseUri` | String | **Required**. Base URI where your service is deployed. Wix Data uses this URI to call your service's endpoints. |\n | `componentName` | String | A unique name for this component. This is an internal name that appears in the [Wix Developers Center](fallback::https://dev.wix.com/apps) only. |\n \n For example:\n\n ```json\n {\n \"namespace\": \"@your-account-name/your-app-name\",\n \"uriConfig\": {\n \"baseUri\": \"https://my-external-db-collections-service.com\"\n },\n \"componentName\": \"myExternalCollections\"\n }\n ```\n\n## Terminology\n\n| Term | Definition |\n| --- | --- |\n| Collection | A schema that determines the structure of data items to be stored. The schema defines the fields each item contains and the data type of each field. |\n| Item | A single data entry in a collection. |\n| External Database | A database hosted by an external service outside of Wix. |\n| External Database Service Provider | A 3rd-party service that implements an interface to allow Wix Data to interact with an external database. |\n"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Flows\n\nThis article presents some sample use cases your service might support. You are not limited to these exact flows, but they can serve as good starting points to help you plan your external database integration.\n\n## Query real-estate properties in an external database\n\n> **Note:**\n> This sample flow requires the implementation of at least [the basic functionality endpoints](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/introduction#provide-basic-functionality) of this service plugin.\n\nA real-estate agency stores information about the properties it manages in an external database. The agency has a Wix site and wants to make its properties available to its visitors. The agency implements the relevant endpoints of the External Database Service Plugin and hosts them at the `https://www..com` base URL. It then [creates a Wix app](fallback::https://dev.wix.com/docs/build-an-app/develop-your-app/dev-center-setup/about-the-wix-dev-center#integrating-your-app), configures it with the [details of the service](portalId::63e3acd8-2a9c-421d-8f92-d02930eeb59eresourceId::09ddf515-a458-4034-9995-2d6719a8150a*fallback::https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions), and installs the app on its site. The site can then interact with the external database like this:\n\n1. On a dedicated search page, a site visitor searches for relevant properties with the following search and sorting criteria:\n\n - Locality: Springfield\n - Max number of rooms: 3\n - Price range: $550-$700\n - Sort: Low-to-high\n - Page limit: 3\n\n2. Based on the visitor's criteria, Wix Data automatically sends a [Query Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/query-distinct-values) request to the service endpoint hosted at `https://www..com/v3/items/query`. The request body looks like this:\n\n ```json\n {\n \"collectionId\": \"SpringfieldProperties\",\n \"query\": {\n \"filter\": {\n \"price\": {\n \"$gte\": 550,\n \"$lte\": 700\n }\n },\n \"sort\": [\n {\n \"fieldName\": \"price\"\n }\n ],\n \"fields\": [],\n \"paging\": {\n \"limit\": 3,\n \"offset\": 0\n }\n },\n \"includeReferencedItems\": [],\n \"consistentRead\": false,\n \"returnTotalCount\": false\n }\n ```\n\n3. The endpoint responds with the relevant items, filtered and sorted as specified in the query. For example:\n\n ```json\n {\n \"items\": [\n {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"address\": \"742 Evergreen Terrace\", \n \"floor\": 4,\n \"aptNum\": 2,\n \"numBedrooms\": 2,\n \"numBaths\": 1,\n \"price\": 600,\n \"pets\": true,\n \"airConditioning\": false\n },\n {\n \"_id\": \"e831385d-d067-4905-a98a-456f5a526ca2\",\n \"address\": \"247 Foreverblue Blvd\", \n \"floor\": 2,\n \"aptNum\": 2,\n \"numBedrooms\": 1,\n \"numBaths\": 1,\n \"price\": 680,\n \"pets\": false,\n \"airConditioning\": true\n }\n ],\n \"pagingMetadata\": {\n \"cursors\": {\n \"next\": \"0O52kwmAcT\",\n \"prev\": \"omZq6gTpR9\"\n }\n }\n }\n ```\n\n The site receives the data as if it were stored in a native Wix Data collection. It then parses the response and displays the results to the visitor.\n\n## Manage local job positions with an app\n\n> **Note:**\n> This sample flow requires the implementation of the following service plugin endpoints:\n>\n> - The [basic functionality endpoints](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/introduction#provide-basic-functionality)\n> - [Query Referenced Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/query-referenced-data-items)\n> - [Update Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/update-data-items)\n\nA large employment agency maintains its job listings in an external database. The agency has several branches. Each branch operates in a different area and has its own Wix site.\n\nTo enable each branch to independently access and manage the job listings stored in the database, the agency implements the External Database service plugin and hosts it on the `https://www..com` base URL. It then [creates a private app](fallback::https://dev.wix.com/docs/build-apps/get-started/overview/exposing-apps-publicly-and-privately#private-apps) and configures it with the [details of the service](portalId::63e3acd8-2a9c-421d-8f92-d02930eeb59eresourceId::09ddf515-a458-4034-9995-2d6719a8150a*fallback::https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions). Each branch installs the app on its site to gain independent access to the database. Site visitors can then query, sort, and filter relevant listings on the site branch most relevant to them.\n\nIn this flow, a site visitor searches for open kitchen staff positions on a branch's site. After finding a relevant position, they browse for other listings by the same employer. Once filled, the branch closes the position.\n\n1. On a dedicated search page, a site visitor searches for open listings using the following search and sorting criteria:\n\n - Locality: North Utah\n - Sector: Restaurants\n - Position: Kitchen Staff\n - Show listing details: Job Title, Employer, Address, Hourly Salary\n - Sort: New-to-old\n - Page limit: 5\n\n2. Based on these preferences, Wix Data automatically sends a [Query Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/query-data-items) request to the service endpoint hosted at `https://www..com/v3/items/query`. The request body looks like this:\n\n ```json\n {\n \"collectionId\": \"northUtahJobs\",\n \"query\": {\n \"filter\": {\n \"jobTitle\": \"kitchenStaff\",\n \"status\": \"OPEN\"\n },\n \"sort\": [{\n \"fieldName\": \"_updatedDate\",\n \"order\": \"DESC\"\n }\n ],\n \"paging\": {\n \"limit\": 5,\n \"offset\": 0\n },\n \"fields\": [\"_id\", \"jobTitle\", \"employer\", \"address\", \"salaryHourly\", \"_updatedDate\"] // The details of the listing to retrieve\n\n },\n \"includeReferencedItems\": [{\n \"fieldKey\": \"employer\",\n }],\n \"consistentRead\": false,\n \"returnTotalCount\": true\n }\n ```\n\n The endpoint responds with the relevant listings, filtered and sorted as specified in the query. For example:\n\n ```json\n {\n \"items\": [\n {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"jobTitle\": \"kitchenStaff\",\n \"employer\": \"hellsKitchen\",\n \"address\": \"616 Old Nick Road, Salt Lake City, Utah\",\n \"salaryHourly\": 10,\n \"_updatedDate\": {\n \"$date\": \"2021-02-03T04:05:06Z\"\n },\n \"employer\": {\n \"_id\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"name\": \"hellsKitchen\",\n \"address\": \"616 Old Nick Road, Salt Lake City, Utah\",\n \"numEmployees\": \"14\",\n \"reputation\": 4.4\n }\n },\n {\n \"_id\": \"528a0b23-d6d8-464a-82af-09e0c00f56b0\",\n \"jobTitle\": \"kitchenStaff\",\n \"employer\": \"Joe's Magic Burgers\",\n \"address\": \"23 Hawkins Street, Arborville, Utah\",\n \"salaryHourly\": 9.5,\n \"_updatedDate\": {\n \"$date\": \"2021-02-02T12:53:01Z\"\n },\n \"employer\": {\n \"_id\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"name\": \"Joe's Magic Burgers\",\n \"address\": \"46 Horseshoe Lane, Utah\",\n \"numEmployees\": \"38\",\n \"reputation\": 4.9\n }\n },\n ],\n \"pagingMetadata\": {\n \"total\": 2\n }\n }\n ```\n\n3. The site receives the data as if it were stored in a native Wix Data collection. It then parses the response and displays the results to the visitor.\n\n4. One of the listings retrieved by Wix Data is for a position offered by Hell's Kitchen. The visitor wants to check which other positions Hell's Kitchen offers. To do that, Wix Data sends a [Query Referenced Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/query-referenced-data-items) request to the service endpoint hosted at `https://www..com/v3/items/query-referenced`. For each position listed by this employer, the visitor is interested in the job title, work address, hourly salary, and position status. The request looks like this:\n\n ```json\n {\n \"collectionId\": \"employers\",\n \"referringItemIds\": [\"faa17edb-2d88-488d-8e95-24b9364c3284\"], // Hell's Kitchen's ID\n \"referencedItemIds\": [],\n \"order\": \"ASC\",\n \"referringFieldKey\": \"positions\",\n \"consistentRead\": false,\n \"fieldsToReturn\": [\"_id\", \"jobTitle\", \"address\", \"hourlySalary\", \"status\"],\n \"returnTotalCount\": false,\n \"includeReferencedItems\": true\n }\n ```\n\n The endpoint responds with all the job positions offered by Hell's Kitchen, filtered and sorted as specified in the query. For example:\n\n ```json\n {\n \"items\": [\n {\n \"referringItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"referencedItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\", \n \"referencedItem\": {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"jobTitle\": \"kitchenStaff\",\n \"address\": \"616 Old Nick Road, Utah\",\n \"hourlySalary\": \"10\",\n \"status\": \"OPEN\"\n }\n },\n {\n \"referringItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"referencedItemId\": \"d345e77c-4f6b-5g60-4fh7-d6b9dd70kf9\",\n \"referencedItem\": {\n \"_id\": \"d345e77c-4f6b-5g60-4fh7-d6b9dd70kf9\",\n \"jobTitle\": \"shiftManager\",\n \"address\": \"616 Old Nick Road, Utah\",\n \"hourlySalary\": \"14.5\",\n \"status\": \"OPEN\"\n }\n },\n {\n \"referringItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\",\n \"referencedItemId\": \"mir0958c-mfe8-kdo9-jf71-mfe0kfik4lkfp\",\n \"referencedItem\": {\n \"_id\": \"mir0958c-mfe8-kdo9-jf71-mfe0kfik4lkfp\",\n \"jobTitle\": \"hostPerson\",\n \"address\": \"616 Old Nick Road, Utah\",\n \"hourlySalary\": \"9.5\",\n \"status\": \"HIRED\"\n }\n },\n // Additional positions\n ],\n \"pagingMetadata\": {}\n }\n ```\n\n5. The site receives the data as if it were stored in a native Wix Data collection. It parses the data, filters for positions whose `status` is `OPEN`, and displays the results to the visitor.\n\n6. The Hell's Kitchen branch on Old Nick Road hires a new employee for the kitchen staff position. The employment agency's branch then closes the position. To do that, Wix Data sends an [Update Data Items](fallback::https://dev.wix.com/docs/rest/business-solutions/cms/external-database-service-plugin/update-data-items) request to the service endpoint hosted at `https://www..com/v3/items/update` to update the position's status as `HIRED`. The request looks like this:\n\n ```json\n {\n \"collectionId\": \"northUtahJobs\",\n \"items\": [\n {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"jobTitle\": \"kitchenStaff\",\n \"employer\": \"hellsKitchen\",\n \"address\": \"616 Old Nick Road, Utah\",\n \"salaryHourly\": 10,\n \"status\": \"HIRED\",\n \"_updatedDate\": {\n \"$date\": \"2021-02-15T15:22:36Z\"\n }\n } \n ]\n }\n ```\n\n The endpoint responds with the updated item:\n\n ```json\n {\n \"results\": [\n {\n \"item\": {\n \"_id\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"jobTitle\": \"kitchenStaff\",\n \"employer\": \"hellsKitchen\",\n \"address\": \"616 Old Nick Road, Utah\",\n \"salaryHourly\": 10,\n \"status\": \"HIRED\",\n \"_updatedDate\": {\n \"$date\": \"2021-02-15T15:22:36Z\"\n }\n }\n }\n ]\n }\n ```\n"},{"displayName":"Error Types","slugifyName":"error-types","content":"# Error Types in the External Database Collections Service Plugin\n\nSome endpoints in the external database service plugin must respond with errors if the request is invalid or cannot be successfully fulfilled. In such cases, your service must respond with an error specific to the particular issue in the request.\n\n## Error structure\n\nEach error type conforms to a predefined structure. It includes an error code, an error message, and a data object with additional error handling information. In addition, each error type has a corresponding HTTP code.\n\nError objects have the following properties:\n\n| Field | Type | Description |\n| ----- | ---- | --------------|\n| `errorCode` | String | A code that indicates why the request failed. |\n| `errorMessage` | String | A human-readable error message. |\n| `data` | Object | Additional error data specific to the error type. |\n\nFor example, your service might receive a request to query a collection that does not exist. In this case, your service must respond with the relevant error code, a descriptive message, and a data object with the `collectionId` of the collection that was not found. This type of error looks like this:\n\n```json\nHTTP/1.1 404 Not Found\nContent-Type: application/json\n\n{\n \"errorCode\": \"COLLECTION_NOT_FOUND\",\n \"errorMessage\": \"The requested collection was not found.\",\n \"data\": {\n \"collectionId\": \"catPictures\"\n }\n}\n```\n\n## Types of errors\n\nThe following table lists the errors your service must return based on the issue in the request:\n\n| Error Code | HTTP Status Code | Description |\n|-----------------------------------|------------------|-------------|\n| `ITEM_NOT_FOUND` | `Not Found (404)` | Item was not found in the specified collection. See corresponding [data object](fallback::#item-not-found). |\n| `ITEM_ALREADY_EXISTS` | `Conflict (409)` | Item with the same `id` already exists in the specified collection. See corresponding [data object](fallback::#item-already-exists) |\n| `COLLECTION_NOT_FOUND` | `Not Found (404)` | Collection was not found. See corresponding [data object](fallback::#collection-not-found). |\n| `COLLECTION_ALREADY_EXISTS` | `Conflict (409)` | Collection with the same `id` already exists. See corresponding [data object](fallback::#collection-already-exists). |\n| `COLLECTION_CHANGE_NOT_SUPPORTED` | `Bad Request (400)` | The service does not allow modifications to the specified collection. The corresponding [data object](fallback::#collection-changes-not-supported) lists the fields that caused the error. |\n| `REFERENCE_NOT_FOUND` | `Not Found (404)` | Reference was not found for the specified item. See corresponding [data object](fallback::#reference-not-found). |\n| `REFERENCE_ALREADY_EXISTS` | `Conflict (409)` | Reference already exists for the specified item. See corresponding [data object](fallback::#reference-already-exists). |\n| `VALIDATION_ERROR` | `Bad Request (400)` | One or more fields in the request are not valid. The corresponding [data object](fallback::#validation-violations) lists the validation errors caused by the request. |\n| `BAD_REQUEST` | `Bad Request (400)` | Generic error indicating an invalid request. Use the `errorMessage` field to provide more information. |\n\n## Error data object structures\n\nEach error object type has a unique `data` property structure. This section details the `data` structure associated with each type.\n\n### Item not found\n \n| Field | Type | Description |\n| --- | --- | --- |\n| `itemId` | String | ID of the item that was not found. |\n\n```json\n{\n \"errorCode\": \"ITEM_NOT_FOUND\",\n \"errorMessage\": \"The requested item was not found.\",\n \"data\": {\n \"itemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\"\n }\n}\n```\n\n### Item already exists\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `itemId` | String | ID of the item that already exists. |\n\n```json\n{\n \"errorCode\": \"ITEM_ALREADY_EXISTS\",\n \"errorMessage\": \"The item already exists in the collection.\",\n \"data\": {\n \"itemId\": \"c2f5e77c-a86b-4361-a55f-c6b934d70187\"\n }\n}\n```\n\n### Collection not found\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `collectionId` | String | ID of the collection that was not found. |\n\n```json\n{\n \"errorCode\": \"COLLECTION_NOT_FOUND\",\n \"errorMessage\": \"The requested collection was not found.\",\n \"data\": {\n \"collectionId\": \"cities\"\n }\n}\n```\n\n### Collection already exists\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `collectionId` | String | ID of the collection that already exists. |\n\n```json\n{\n \"errorCode\": \"COLLECTION_ALREADY_EXISTS\",\n \"errorMessage\": \"The specified collection already exists.\",\n \"data\": {\n \"collectionId\": \"countries\"\n }\n}\n```\n\n### Collection changes not supported\n\nThis `data` property of this error lists all fields that the request attempted, but failed, to change. Each such attempt causes an individual [Collection Change Not Supported](fallback::#collection-change-not-supported) error.\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `errors` | Array of [collection change not supported](fallback::#collection-change-not-supported) errors | An array of unsupported collection change errors caused by the request. One error is produced for each unmodifiable field the caller attempts to change. |\n\n#### Collection change not supported\n\nEach individual Collection Change not Supported error has the following structure:\n\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `fieldKey` | String | Key of the field that cannot be changed. |\n| `message` | String | Error message explaining why the field cannot be changed. |\n\n```json\n{\n \"errorCode\": \"COLLECTION_CHANGE_NOT_SUPPORTED\",\n \"errorMessage\": \"Some fields in this collection cannot be changed.\",\n \"data\": {\n \"errors\": [\n {\n \"fieldKey\": \"firstName\",\n \"message\": \"This field cannot be changed.\"\n },\n {\n \"fieldKey\": \"lastName\",\n \"message\": \"This field cannot be changed.\"\n }\n ]\n }\n}\n```\n\n### Reference not found\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `referringItemId` | String | ID of the referring item. |\n| `referencedItemId` | String | ID of the referenced item. |\n\n```json\n{\n \"errorCode\": \"REFERENCE_NOT_FOUND\",\n \"errorMessage\": \"The requested reference was not found.\",\n \"data\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n}\n```\n\n### Reference already exists\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `referringItemId` | String | ID of the referring item. |\n| `referencedItemId` | String | ID of the referenced item. |\n\n```json\n{\n \"errorCode\": \"REFERENCE_ALREADY_EXISTS\",\n \"errorMessage\": \"The requested reference already exists for the referring item.\",\n \"data\": {\n \"referringItemId\": \"c285e77c-a86b-4361-a55f-c6b934d70187\",\n \"referencedItemId\": \"faa17edb-2d88-488d-8e95-24b9364c3284\"\n }\n}\n```\n\n### Validation violations\n\nThis `data` property of this error lists all individual [validation violations](fallback::#validation-violation) caused by the request.\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `violations` | Array of [validation violations](fallback::#validation-violation). | An array of all validation violations caused by the request. |\n\n#### Validation violation\n\nEach individual validation violation has the following structure:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `fieldPath` | String | Path to the invalid field. |\n| `rejectedValue` | String | The invalid value. |\n| `message` | String | Error message that describes the violation. |\n\n```json\n{\n \"errorCode\": \"VALIDATION_ERROR\",\n \"errorMessage\": \"Some fields contain invalid values.\",\n \"data\": {\n \"violations\": [\n {\n \"fieldPath\": \"userDateOfBirth\",\n \"rejectedValue\": \"16-12-1994\",\n \"message\": \"Invalid value for this field. See documentation for valid field values.\"\n },\n {\n \"fieldPath\": \"userImage\",\n \"rejectedValue\": \"https://mediaa.wix.com/6acbb8_7a7bd9193ffc4130ab8ff74f5dcedf8a.jpg\",\n \"message\": \"Invalid value for this field. See documentation for valid field values.\"\n }\n ]\n }\n}\n```\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}