Open
Registry
2.0
Documentation

list_objects

Purpose

This operation returns a complete list of all of the objects that are registered in a collection, while enabling the registry to identify and register the presence of a peer. This operation is intended for machine to machine interaction.

URL Syntax (HTTP POST)

http://foo.bar/foo/collections/{collection_id}/objects.txt

Where

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

Mandatory Request Parameters

Parameters that must be found in the body of the request include:

Name Type Description
reciprocity string Complete valid URL of the Registry initiating this request. When the registry initiating this request does not wish to be recognized and published as a peer registry the value of this parameter shall be: 'none'.

Optional Request Parameters

Parameters that may be present in the body of the request include:

Name Type Description
start integer The index number (e.g. database record number) of the first object to be displayed. The value shall be a non-negative integer. When present, earlier objects shall not be displayed. When absent, the list shall include all of the objects in the collection.
include integer The number of objects to be included in the response. The value shall be a non-negative integer. When present, the number of objects returned shall match this number. When absent, the list shall include all of the (remaining) objects in the collection.

Note: All parameter names are case sensitive.

Examples

Where the body of the POST request might contain

reciprocity=http://foo.bar/foo
start=8001
include=1000

Response Forms

The normal response is a TXT document (mime type = text/plain). This document consists of a list of object URLs, one per line.