Perform a Keyword Search. Return a list of Assets.

To Retrieve the Assets list there is 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"]

Targeted Search: Requesting user can target keyword searches against Filename, Asset ID, Metadata, or Content (extracted text from documents) by passing the optional property of keywordSearchField.

Requesting user can apply the combination of both searches and if there is no keyword/facet in requesting body it will apply wildcard search.

By default AND operation will be applied with search terms and/or facets.

By default, up to 50 Assets will return from the search.You can also set search offset by setting the from property. For example, for the first page, set from to zero. After that set from to 50, 100, 150, etc.

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

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 will be a JSON object

400

Bad Request

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Failed operation

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