Perform a basic search
Changed onReturn files, datasets and/or collections matching query criteria. Search can be filtered by a specific resource ID, limited to tags or specific metadata fields.
Request
- Base URLhttps://clowder.ncsa.illinois.edu/clowder/api
- Auth
- HTTP basic
- or API key in header X-API-Key
- or API key in query parameter key
Query parameters
String term to search for. Can include regular expressions using Elasticsearch syntax.
Restrict search results to "file", "dataset", or "collection".
Return only resources belonging to a specific dataset.
Return only resources belonging to a specific collection.
Return only resources belonging to a specific space.
Return only resources belonging to a specific folder.
Restrict search to a specific metadata field, e.g. "Alternative Title".
Search for resources with a specific tag.
Starting index of first result; useful for pagination.
Number of search results to include; useful for pagination.
An alternative to "from" for pagination. Return the Nth page assuming "size" items per page.
A date or numeric field to sort by. If order is given but no field specified, created date is used.
Whether to scored in asc (ascending) or desc (descending) order. If a field is given without an order, asc is used.
Response
OK
Changes
- info
added the new optional
queryrequest parameterorder - info
added the new optional
queryrequest parametersort
- info
- info
added the new optional
queryrequest parameterfolderid - info
added the new optional
queryrequest parameterfrom - info
added the new optional
queryrequest parameterpage - info
added the new optional
queryrequest parametersize - info
added the new optional
queryrequest parameterspaceid
- info