Search all assets

get

/resources/v1/search/assets

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

Note: To access this resource, at least one of the search criteria should be specified.

• Request
• Response
• Examples

The following tables summarize the client request.

Query Parameters

Name	Description	Format
countonly	Accepts a Boolean value. Setting it to true displays only the count, and no results are returned. The default is false.	boolean
field:[fieldname]:[operation]	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.	string
fields	Accepts a comma-separated list of attribute names for each search result. By default only name and description are given for each search result.	string
limit	Specify the total number of items to be returned.	number
links	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).	string
offset	Specify the starting index from where the results will be returned.	number
orderBy	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".	string
q	Specify a query string, the search engine-specific query that was specified during the configuration. (The default search engine is Lucene.)	string
searchengine	Specify what search engine to use to find the results. The default search engine is Lucene.	string
totalResults	Accepts a Boolean value. Setting it to true displays the total results field in the response. The default is false.	boolean

The following tables summarize the server response.

Supported Media Types

• application/json
• application/xml

200 Response

List of all assets

The following example shows how to get all assets whose name starts with "1" in WebCenter Sites, by submitting a GET request on the REST resource using cURL.

Query param details:

• "field:name:startswith=1": The field name starts with "1".

curl -i -H "Accept: application/json" -X GET "http://<host>:<port>/<context>/REST/resources/v1/search/assets?field:name:startswith=1"

Example of Response Header

The following example shows the response header.

Cache-Control: max-age=0 
ETag: "28ee44a36ad3a790ffca5d531468e6718d2df423cd4d84f2c5a4d247613e334d" 
Content-Type: application/json;charset=utf-8

Example of Response Body

The following example shows the contents of the response body, in JSON format.

{
  "offset": 0,
  "limit": 2,
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/search/assets?field:name:startswith=1",
      "rel": "self",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/search/assets?field:name:startswith=1",
      "rel": "canonical",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/metadata-catalog/search/assets",
      "rel": "describedby",
      "templated": false,
      "mediaType": "application/schema+json",
      "method": "GET",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/search/assets?field:name:startswith=1&offset=0",
      "rel": "first",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    },
    {
      "href": "http://<host>:<port>/<context>/REST/resources/v1/search/assets?field:name:startswith=1&offset=0",
      "rel": "last",
      "templated": false,
      "mediaType": "",
      "method": "",
      "profile": ""
    }
  ],
  "items": [
    {
      "name": "10 Important Baseball Rules for beginners",
      "link": {
        "href": "",
        "rel": "assetReference",
        "templated": false,
        "mediaType": "",
        "method": "GET",
        "profile": ""
      },
      "description": "",
      "id": "AVIArticle:1330881074927"
    },
    {
      "name": "100 Meter Sprint Versus A Marathon",
      "link": {
        "href": "",
        "rel": "assetReference",
        "templated": false,
        "mediaType": "",
        "method": "GET",
        "profile": ""
      },
      "description": "",
      "id": "AVIArticle:1363104065090"
    }
  ]
}