> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # IsReferencedDataItem # Package: cms # Namespace: DataItemService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/cms/data-items/is-referenced-data-item.md ## Permission Scopes: Read Data Items: SCOPE.DC-DATA.READ ## Introduction Checks whether a field in a referring item contains a reference to a specified item. --- ## REST API ### Schema ``` Method: isReferencedDataItem Description: Checks whether a field in a referring item contains a reference to a specified item. URL: https://www.wixapis.com/wix-data/v2/items/is-referenced Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: dataCollectionId, referringItemFieldName, referringItemId, referencedItemId Method parameters: param name: consistentRead | type: 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. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency). Default: `false` param name: dataCollectionId | type: dataCollectionId | description: GUID of the collection containing the referring data item. | required: true param name: referencedItemId | type: referencedItemId | description: GUID of the item that may be referenced. | required: true param name: referringItemFieldName | type: referringItemFieldName | description: Field to check for a reference to the item that may be referenced. | required: true param name: referringItemId | type: referringItemId | description: GUID of the referring item. | required: true Return type: IsReferencedDataItemResponse - name: isReferenced | type: boolean | description: Whether the specified reference exists. ``` ### Examples ### Is item referenced ```curl curl -X POST \ 'https://www.wixapis.com/wix-data/v2/items/is-referenced' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' \ -d '{ "dataCollectionId": "albums", "referringItemFieldName": "songs", "referringItemId": "37de298e-026d-4b2e-b87f-fbec11d53105", "referencedItemId": "99cb26d5-dd42-4384-af30-3bb6e4026bd0" }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.cms.DataItemService.isReferencedDataItem(dataCollectionId, field, referringItem, referencedItem, options) Description: Checks whether a field in a referring item contains a reference to a specified item. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: dataCollectionId, field, referringItem, referencedItem Method parameters: param name: dataCollectionId | type: string | description: GUID of the collection containing the referring data item. | required: true param name: field | type: string | description: Field to check for a reference to the item that may be referenced. | required: true param name: options | type: WixDataReadOptions none - name: consistentRead | type: boolean | 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. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency). Default: `false` - name: suppressHooks | type: boolean | description: Prevents hooks from running for the operation. Can only be used in the [backend code of a Wix site](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend.md). - name: showDrafts | type: boolean | description: When `true`, operations include draft items. Read operations include draft items in their response, and write operations modify draft items. Default: `false`. - name: appOptions | type: object | description: Options for [querying Wix app collections](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections.md). - name: language | type: string | description: Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. If provided, the result text is returned in the specified language. If not provided, the result text is not translated. > **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). param name: referencedItem | type: string | description: GUID of the item that may be referenced. | required: true param name: referringItem | type: string | description: GUID of the referring item. | required: true Return type: PROMISE EMPTY-OBJECT {} ``` ### Examples ### isReferenced ```javascript import { items } from '@wix/data'; async function isReferenced(dataCollectionId,field,referringItem,referencedItem,options) { const response = await items.isReferenced(dataCollectionId,field,referringItem,referencedItem,options); }; ``` ### isReferenced (with elevated permissions) ```javascript import { items } from '@wix/data'; import { auth } from '@wix/essentials'; async function myIsReferencedMethod(dataCollectionId,field,referringItem,referencedItem,options) { const elevatedIsReferenced = auth.elevate(items.isReferenced); const response = await elevatedIsReferenced(dataCollectionId,field,referringItem,referencedItem,options); } ``` ### isReferenced (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { items } from '@wix/data'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { items }, // Include the auth strategy and host as relevant }); async function isReferenced(dataCollectionId,field,referringItem,referencedItem,options) { const response = await myWixClient.items.isReferenced(dataCollectionId,field,referringItem,referencedItem,options); }; ``` ---