(NEW!) Search Assets

COMING SOON!

There are two types of searches available:

  • Simple Keyword Search: Requesting user can get list of Assets against search terms/keywords list. For example ["keyword1", "keyword2"]
  • Facet Search: Requesting user can get list of Assets against Facet value list. For example ["Facet: facet_value"]

Specifying a value in the 'keywordSearchField' attribute in the request allows you to target keyword searches against Filename, Asset ID, Metadata, or Content (extracted text from documents.

By default, if not specified in the request, the search operation type will be set to 'AND' for search terms and/or facets. If the 'relevancy' field is passed as true, this will negate the operation selection used in legacy search and will leverage the relevancy search matching. When relevancy is set to true, the 'metadataDefinitionSearchField' field within the sortBy object should be set to 'relevance', and the 'order' field should be set to 'desc'.

By default, up to 50 Assets will return from the search. Should you want to limit the amount of assets returned in each response, the value for 'limit' can be set to a number up to 50. You can also set search offset by setting the 'from' property. For example, for the first page, set 'from' to 0. After that set 'from' to 50, 100, 150, etc.

This endpoint will only return a handful of metadata fields by default. To include more metadata fields in the response, those fields should be included in the 'includes' array. System metadata fields, such as Metadata Template ID, should be entered using camel case (ie, metadataTemplateId). Custom metadata fields should be entered by their attribute search term, prefixed by metadataDocument. For example, to retrieve an attribute called Published Channel, a user would include "metadataDocument.published_channel" in the includes array. Fields included in this array will be returned in an object called 'metadataDocument' if those attributes exist on the asset.

Average Response Time: 691ms

SecurityApiKeyAuth or BasicAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

The Request Body must be a JSON object

searchTerm
Array of strings

Comma separated array of search term values.

from
integer

Search offset from which index search will start

limit
integer <= 100

Limits the number of results that are returned.

includes
Array of strings

System metadata fields, such as Metadata Template ID, should be entered using camel case (ie, metadataTemplateId). Custom metadata fields should be entered by their attribute search term, prefixed by metadataDocument. For example, to retrieve an attribute called Published Channel, a user would include "metadataDocument.published_channel" in the includes array. Fields included in this array will be returned in an object called 'metadataDocument' if those attributes exist on the asset.

includeDeleted
boolean

Flag to denote whether or not to include Deleted assets in the result

includeVersions
boolean

Flag to denote whether or not to include prior versions of the asset in the result

Array of objects
operation
string

Operation between search terms

Enum: "AND" "OR"
aggregations
boolean

Boolean field to indicate whether or not to return filter menu aggregation counts for the search term. Set to false to significant improve speed and reduce payload size.

keywordSearchField
string

Specified Search Target. Valid values are - filename, assetId, metadata, content

Enum: "filename" "assetId" "metadata" "content"
relevancy
boolean

If the 'relevancy' field is passed as true, this will negate the operation selection used in legacy search and will leverage the relevancy search matching. When relevancy is set to true, the 'metadataDefinitionSearchField' field within the sortBy object should be set to 'relevance', and the 'order' field should be set to 'desc'.

Responses
200

The Response Body will be a JSON object

400

Bad Request

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Failed operation

post/search
Request samples
application/json
{
  • "searchTerm": [
    ],
  • "from": 0,
  • "limit": 50,
  • "includes": [
    ],
  • "includeDeleted": true,
  • "includeVersions": true,
  • "sortBy": [
    ],
  • "operation": "AND",
  • "aggregations": false,
  • "keywordSearchField": "filename",
  • "relevancy": true
}
Response samples
application/json
{}