Sign in

v1

latestOpenAPI 3.0.02026-07-237913196.9 KB
Recordsets

Returns a single page of records from a recordset.

The records which are returned as a result of this call are paged.

The page numbering starts at 1 and is affected by filters that are applied to the recordset.

Each page of the response will contain {resultsPerPage} results, except for the final page which may be shorter.

The Fields objects defines the properties returned for each record as well as the sort order for the records.

When used internally, the user must have VIEW permission or better for the holding that the recordset is attached to in order to make this call

get/api/recordsets/{id}/data

Path parameters

idinteger required

The recordset to present data from.

Query parameters

pageinteger

The page of results that should be returned, if not specified, 1 is assumed.

resultsPerPageinteger

The number of entries that should be used for each page of results, if not specified 20 is assumed

filtersstring

The filters which define the records that should be returned from the recordset.

        If not specified all records are returned
fieldsstring

The fields for which data should be returned as a http string-encoded json object.

        If not specified all fields are returned
asAtstring date-time

Get a specific version of the recordset by date, if not specified, then return latest version

orderBystring

Specify column name to sort by. Prefix with "-" to reverse order.

Response

Ok