objects

List objects

Retrieves a list of data objects. By default, objects are returned in reverse order of creation. Requires a collection name (class) parameter to specify which collection's objects to list, otherwise, returns an empty list.

get/objects

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/objects
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Query parameters

afterstring

A threshold UUID of the objects to retrieve after, using an UUID-based ordering. This object is not part of the set.

Must be used with collection name (class), typically in conjunction with limit.

Note after cannot be used with offset or sort.

For a null value similar to offset=0, set an empty string in the request, i.e. after= or after.

offsetinteger

The starting index of the result window. Note offset will retrieve offset+limit results and return limit results from the object with index offset onwards. Limited by the value of QUERY_MAXIMUM_RESULTS.

Should be used in conjunction with limit.

Cannot be used with after.

limitinteger

The maximum number of items to be returned per page. The default is 25 unless set otherwise as an environment variable.

includestring

Include additional information, such as classification information. Allowed values include: classification, vector and interpretation.

sortstring

Name(s) of the property to sort by - e.g. city, or country,city.

orderstring

Order parameter to tell how to order (asc or desc) data within given field. Should be used in conjunction with sort parameter. If providing multiple sort values, provide multiple order values in corresponding order, e.g.: sort=author_name,title&order=desc,asc.

classstring

The collection from which to query objects.

Note that if the collection name (class) is not provided, the response will not include any objects.

tenantstring

Specifies the tenant in a request targeting a multi-tenant collection (class).

Response

Successful response containing the list of objects. If the collection name (class) is not provided, the response will not include any objects.

totalResultsinteger

The total number of objects for the query. The number of items in a response may be smaller due to paging.

Changes

No recorded changes to this operation across all 1 revision of this API.