Search content
As a developer, you need to identify the right assets and content to display within websites, applications, and other channels. To provide you with the required search capabilities, Acoustic Content is built on the powerful enterprise search platform Solr. You can quickly access the published asset or content that you want through search.
When your editors create, update, and publish assets or content, Content stores related data in search collections. When your editors delete assets or content, Content removes the corresponding data from the underlying search collections. Additionally, Content tracks your categories, content types, image profiles, and taxonomies in its authoring search collections.
Note:
Check out the following samples provided by Acoustic Content:
The data from the search collections include fields that you can use to retrieve the items that you need. For example,
name - Contains the name of an item.
description - Contains the description of an item.
classification- Describes the type of item, for example, asset, category, content, content-type, image-profile, taxonomy.
created- Contains the creation date of the item.
creator - Contains the name of the user that created the item.
lastModified- Contains the last modification date of the item.
lastModifier- Contains the name of the user that last modified the item.
categories- Contains a list of all category selections for the asset or content.
tags- Contains the list of tags.
assetType- If the result is an asset, the value is document, file, image, or video.
mediaType- If the result is an asset, the value is the media type.
For a complete list, refer to the search REST API documentation that is available in the API Reference.
As a developer, you can access the indexed items by using the REST APIs. To allow for a separation of the authoring system and the delivery system, two different Content APIs are available for search.
The delivery search service supports the same query format as the authoring search service. The key differences between the authoring search and delivery search service are
- You do not need prior authentication to use the delivery search service.
- The delivery search service contains only published items and assets. Unpublished draft content is not available in the delivery search service and your search results do not include any draft items.
- The content that is returned by the delivery search service is in the delivery format as transformed by the publishing process.
For example, to search for all published assets that contain the string test in the asset name, you can use the following URL pattern:
https://{API URL}/delivery/v1/search?fq=classification:asset&q=name:test
You can get the {API URL} from Developer > URL information.
Searching published items
All assets and content items are published to your delivery system and the categories are automatically registered at your delivery search service. You can search for content that is published and available on the Content delivery system. The assets and content that are published in the delivery system and the categories are indexed. You can access the indexed content through the delivery search API. Use the delivery search API to query items that are available on the delivery system by the publishing process. The corresponding URL looks like this https://{API URL}/delivery/v1/search/{search-query}.
You can get the {API URL} from Developer > URL information.
Replace the {search-query} with the URL query parameters that specify your search query.
Note:
The delivery search collection APIs do not require authentication.
When an asset or content is deleted from your authoring system, the deleted asset or content is removed from your delivery search service.
You can find the corresponding API documentation for the delivery search service in the API Reference.
Searching unpublished items
You can search for content that is available on the Content authoring system. The content from the authoring system such as assets, content, categories, content types, image profiles, and taxonomies are indexed. You can access the indexed content through the authoring search API. Use the authoring search API to query items in all states, for example, draft, ready, and retired. The corresponding URL looks like this https://{API URL}/authoring/v1/search/{search-query}. You can get the {API URL} from Developer > URL information.
Replace the {search-query} with the URL query parameters that specify your search query.
Note:
You must be authenticated to use the authoring search service APIs.
For more information about authentication, see login service REST API. More information on this API can be found here: API Reference.
Updated about 1 year ago