Open
Registry
2.0
Documentation

find_objects

Purpose

This operation returns a browsable page listing some or all of the objects that are registered in a collection. The number of objects returned is determined by the server, and navigation to previous and subsequent pages is also the responsibility of the server.

URL Syntax (HTTP GET)

http://foo.bar/foo/collections/{collection_id}/find.{format}

Where

  • {collection_id} is the collection identifier as listed in the registry.collections response

  • {format} determines the format of the response and is one of the following:

    • html
    • json

Optional Query Parameters

Parameters that may be present in the query portion of the url include:

Name Type Description
text string Search terms that will be applied to the content of an object, including such aspects as embedded metadata. One or more search terms (keywords) that will be used to restrict the responses to the Find operation, in space-delimited format.
tag string Search terms that will be applied to any user-supplied tags associated with an object. One or more search terms (keywords) that will be used to restrict the responses to the Find operation, in space-delimited format.
latlong string A point or a pair of decimal degree coordinates in WGS84. The server shall use this information to restrict hits to those members of the collection that contain this point or region. Point coordinates take the form "Lat,Long" (e.g. "45,-77"), while a pair of coordinates takes the form "S,W..N,E" (e.g. "45,-77..46.5,-74.2").
minmax string A numeric value or range of values (e.g. map scale). The server shall use this information to restrict hits to those members of the collection that have this numeric value (or, in the case of a range, within this range of values). A range of values takes the form "Minimum..Maximum" (e.g. "50000..100000").
time string A time or a range of times in ISO 8601 format according to the W3C profile found at http://www.w3.org/TR/NOTE-datetime (e.g. "1997-07-16" or "1997-07-16T19:20:30+01:00"). The server shall use this information to restrict hits to those members of the collection that include this time (or, in the case of a range, include all or part of this range of times). A range of times takes the form "MinTime..MaxTime" (e.g. "1997-07-16..1997-08-16").
rating string Numeric rating value, or range of rating values. Ratings are on a scale of 0 - 10 where 0 is the worst possible rating and 10 is the best. The server shall use this information to restrict the content of the response. A range of values takes the form "lowest..highest" (e.g. "8..10").
start integer Starting number for the range of hits that is requested. When absent, the starting number shall be the first hit which is identified by the query.

Note: All parameter names are case sensitive.

Examples

Response Forms

When format=html then the normal response is a HTML document (mime type = text/html). The layout, structure, and precise content of this document are determined by the owner of the registry.

When format=json then the normal response is a JSON document (mime type = application/json). This document complies with the Objects JSON structure.