Releases: mkdf/api-factory
v0.9.5
v0.9.4
v0.9.3
LIMIT parameter implemented to restrict number of returned entries.
Default max entries limited to 100 where no limit is supplied.
SORT parameter implemented to reverse sort order.
Notes for /changes/ endpoint
Data limits
By default, this API endpoint will only return a maximum of 100 items.
This can be changed by using either the timestamp parameter, the limit parameter, or
a combination of the two.
If only the timestamp parameter is specified, all entries since that timestamp will
be returned, with no limits. If you wish to limit the amount of data returned whilst
also specifying a timestamp parameter, simply also specify a limit parameter.
Please take care not to make repeated requests for unlimited change entries. Requesting
all entries since the creation of the dataset should generally
be done once only, when building or rebuilding a complete replica of a dataset. You should then
keep a record of the timestamp of when the most recent request was made and subsequently only
request incremental changes since that timestamp.
Examples
GET /changes/{dataset-id} - The most recent 100 entries will be returned
GET /changes/{dataset-id}?timestamp=1651363200 - return all entries since
Sunday, 1 May 2022 00:00:00, with no limits on the amount of entries returned
GET /changes/{dataset-id}?timestamp=1651363200&limit=20 - return entries since
Sunday, 1 May 2022 00:00:00, limited to the 20 most recent entries.
GET /changes/{dataset-id}?limit=200 - The most recent 200 entries will be returned,
regardless of timestamp.
Sorting
The /changes/ endpoint returns entries sorted in reverse chronological
order by default (most recent first). Specifying the parameter sort=1 will
reverse the default sort order, giving the oldest entries first. An example of returning
20 entries since Sunday, 1 May 2022 00:00:00 starting with the oldest would be:
GET /changes/{dataset-id}?timestamp=1651363200&limit=20&sort=1
v0.9.1
v0.9.0
Users can now retrieve details of write activity on a dataset (create/update/delete for both JSON documents and files), enabling the recreation of a dataset for mirroring and replication purposes, using the API function:
GET /activity/{dataset-id}
This functionality is available only to those with both read and write access to a dataset. Requests should be authenticated with an API key in the normal way.
