search

Perform a basic search

Changed on

Return files, datasets and/or collections matching query criteria. Search can be filtered by a specific resource ID, limited to tags or specific metadata fields.

get/search

Request

  • Base URL
    https://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

querystring

String term to search for. Can include regular expressions using Elasticsearch syntax.

resource_typestring

Restrict search results to "file", "dataset", or "collection".

datasetidstring

Return only resources belonging to a specific dataset.

collectionidstring

Return only resources belonging to a specific collection.

spaceidstring

Return only resources belonging to a specific space.

folderidstring

Return only resources belonging to a specific folder.

fieldstring

Restrict search to a specific metadata field, e.g. "Alternative Title".

tagstring

Search for resources with a specific tag.

frominteger

Starting index of first result; useful for pagination.

sizeinteger

Number of search results to include; useful for pagination.

pageinteger

An alternative to "from" for pagination. Return the Nth page assuming "size" items per page.

sortstring

A date or numeric field to sort by. If order is given but no field specified, created date is used.

order'asc' | 'desc'

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 query request parameter order

    • info

      added the new optional query request parameter sort

    • info

      added the new optional query request parameter folderid

    • info

      added the new optional query request parameter from

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter size

    • info

      added the new optional query request parameter spaceid