Sign in
generic

HISTORY: Retrieves incremental changes since timestamp

HISTORY operation is intended for continuous data synchronization with other systems. Every insertion, update and deletion will be included in the resulting JSON array of documents (since timestamp in Last-Modified request header value). All changes are listed chronologically in response with 200 HTTP status code. The maximum listed srvModified timestamp is also stored in Last-Modified and ETag response headers that you can use for future, directly following synchronization. You can also limit the array's length using limit parameter.

Deleted documents will appear with isValid = false field.

HISTORY operation has a fallback mechanism in place for documents, which were not created by API v3. For such documents srvModified is virtually assigned from the date field (for entries collection) or from the created_at field (for other collections).

This operation requires read permission for the API and the collection (e.g. api:treatments:read)

The only exception is the settings collection which requires admin permission (api:settings:admin), because the settings of each application should be isolated and kept secret. You need to know the concrete identifier to access the app's settings.

get/{collection}/history

Query parameters

limitinteger
Example:100

Maximum number of documents to get in result array

fieldsstring

A chosen set of fields to return in response. Either you can enumerate specific fields of interest or use the predefined set. Sample parameter values:

_all: All fields will be returned (default value)

date,insulin: Only fields date and insulin will be returned

Headers

Last-Modifiedstring required

Starting timestamp (defined with respect to server's clock) since which the changes in documents are to be listed, formatted as:

<day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT

Example:

<pre>Last-Modified&#58; Wed, 17 Oct 2018 05&#58;13&#58;00 GMT</pre>

Response

Changed documents since specified timestamp

statusinteger
resultDocumentArray — unresolved $ref

Changes

Changed in 5 of the 6 revisions of this API.10228

  • 5b0d424433e11See the full diff
    • ○

      the endpoint scheme security accessToken was removed from the API

      api-security-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8252719e8e34211See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ▲

      removed the success response with the status 204

      response-success-status-removed

    • ○

      the endpoint scheme security accessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security jwtoken was added to the API

      api-security-added

    • ○

      the endpoint scheme security apiKeyAuth was removed from the API

      api-security-removed

    • ○

      removed DeviceStatusArray EntryArray FoodArray ProfileArray SettingsArray TreatmentArray from the response body oneOf list for the response status 200

      response-body-one-of-removed

    • ○

      added the media type application/json for the response with the status 400

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 401

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 403

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 404

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 406

      response-media-type-added

    • ○

      added the optional property result to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 200 status

      response-optional-property-added

  • 4f4eedb269d03See the full diff
    • ○

      added the media type application/xml for the response with the status 200

      response-media-type-added

    • ○

      added the media type text/csv for the response with the status 200

      response-media-type-added

    • ○

      added the non-success response with the status 406

      response-non-success-status-added

  • 6b2eb690f4ab6See the full diff
    • ○

      added the optional property oneOf[DeviceStatusArray]/items/allOf[DocumentBase]/isReadOnly to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oneOf[EntryArray]/items/allOf[DocumentBase]/isReadOnly to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oneOf[FoodArray]/items/allOf[DocumentBase]/isReadOnly to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oneOf[ProfileArray]/items/allOf[DocumentBase]/isReadOnly to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oneOf[SettingsArray]/items/allOf[DocumentBase]/isReadOnly to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oneOf[TreatmentArray]/items/allOf[DocumentBase]/isReadOnly to the response with the 200 status

      response-optional-property-added

  • e3a793475629827See the full diff
    • ▲

      added DeviceStatusArray EntryArray FoodArray ProfileArray SettingsArray TreatmentArray to the response body oneOf list for the response status 200

      response-body-one-of-added

    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ▲

      removed the media type application/json for the response with the status 400

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status 401

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status 403

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status 404

      response-media-type-removed

    • ▲

      removed the media type application/xml for the response with the status 200

      response-media-type-removed

    • ▲

      removed the media type text/csv for the response with the status 200

      response-media-type-removed

    • ●

      removed the optional property result from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property status from the response with the 200 status

      response-optional-property-removed

    • ○

      the endpoint scheme security apiKeyAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security jwtoken was removed from the API

      api-security-removed

    • ○

      added the new optional header request parameter Date to all path's operations

      new-optional-request-default-parameter-to-existing-path

    • ○

      added the new optional query request parameter now to all path's operations

      new-optional-request-default-parameter-to-existing-path

    • ○

      added the new optional query request parameter token to all path's operations

      new-optional-request-default-parameter-to-existing-path

    • ○

      removed the non-success response with the status 406

      response-non-success-status-removed

    • ○

      added the success response with the status 204

      response-success-status-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog