Search for Collections. Return a list of Collections.

Retrieve the collection list against the list of search terms/keywords. By default AND operation will be applied between the search terms.

By default 50 collections will return, you can also set search offset by setting from attribute, for example for first page set from to zero and after that you set 50, 100, 150 and so on.

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-formatted list of collections which include the following properties.

from
integer

Search offset from which index search will start

searchTerm
Array of strings

List of search terms with AND operation be default

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 (Search_sortBy)
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"
Responses
200

The Response Body must be a JSON object

400

Bad Request

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

returns JSON object with error description.

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