Jump to

• Request
• Response

Search assets in a given site

get

/resources/v1/search/sites/{siteName}/assets

The resource endpoint returns the list of all assets in a site.
It is a Collection Resource.

Request

Path Parameters

• siteName: string
  Name of the site

Query Parameters

• countonly: boolean
  Accepts a Boolean value. Setting it true displays only the count, and no results are returned. The default is false.
• field:[fieldname]:[operation]: string
  Specify a query condition for a field of [fieldname] with the specified operation. [Operation] is optional and can be one of equals, range, startswith, phrase, wildcard, similar, or contains; the default is contains. For the range operation, the value's format is {lower bound}:{upper bound}; for example, 1:10.
• fields: string
  Accepts a comma-separated list of attribute names for each search result. By default only name and description are given for each search result.
• limit: number
  Specify the total number of items to be returned.
• links: string
  Accepts a comma-separated list of link names. By default, this parameter gives all the links (next, prev, first, last, schema, self, and canonical resources).
• offset: number
  Specify the starting index from where the results will be returned.
• orderBy: string
  Specify the field on which the results should be sorted.
  Usage: orderBy=[fieldname]:[asc/des].
  Note: For Lucene, sorting is possible only for fields that were indexed as "not tokenized".
• q: string
  Specify a query string, the search engine-specific query that was specified during the configuration. (The default search engine is Lucene.)
• searchengine: string
  Specify what search engine to use to find the results. the default search engine is Lucene.
• totalResults: boolean
  Accepts a Boolean value. Setting it to true displays the total results field in the response. The default is false.

Response

Supported Media Types

• application/json
• application/xml

200 Response

List of all assets in a site.