Rate this page
- ★★
- ★★
- ★★
- ★★
- ★★
Can we improve this page? Send us feedbackRate this page
- ★★
- ★★
- ★★
- ★★
- ★★
The file set of requests enable developers to work with all types of
Notefiles.
Used to perform queries on a single or multiple files to determine if
new Notes are available to read, or if there are unsynced Notes in
local Notefiles. Note: This request is a Notefile API request, only.
.qo Notes in Notehub are automatically ingested and stored, or sent
to applicable Routes.
filesarray of strings (optional)
One or more files to obtain change information from. Omit to return changes for all Notefiles.
trackerstring (optional)
ID of a change tracker to use to determine changes to Notefiles.
access_tokenstring (Notehub curl requests only)
A Notehub API bearer token.
projectUIDstring (Notehub curl requests only)
The ProjectUID of a Notehub project.
deviceUIDstring (Notehub curl requests only)
The globally-unique DeviceUID of a device that currently exists within the specified ProjectUID.
You may alternatively provide a device serial number by prefixing this argument
with sn:, for example sn:my-device.
totalinteger
The total of local Notes across all Notefiles. This includes Inbound Notes that have not been deleted, as well as outbound Notes that have yet to sync.
changesinteger
If a change tracker is used, the number of changes across all files.
infoJSON object
An object with a key for each Notefile that matched the request parameters,
and value object with the changes and total for each file.
{ "changes": 5, "total": 5, "info": { "my-settings.db": { "changes": 3, "total": 3 }, "other-settings.db": { "changes": 2, "total": 2 } } }
Returns info about file changes that are pending upload to Notehub or download to the Notecard.
access_tokenstring (Notehub curl requests only)
A Notehub API bearer token.
projectUIDstring (Notehub curl requests only)
The ProjectUID of a Notehub project.
deviceUIDstring (Notehub curl requests only)
The globally-unique DeviceUID of a device that currently exists within the specified ProjectUID.
You may alternatively provide a device serial number by prefixing this argument
with sn:, for example sn:my-device.
totalinteger
The total of unsynched notes across all Notefiles.
changesinteger
The number of changes across all files.
pendingboolean
true if there are pending changes.
infoJSON object
An object with a key for each Notefile
and value object with the changes and total for each file.
{ "total": 3, "changes": 3, "pending": true, "info": { "sensors.qo": {"changes":3,"total":3} } }
Deletes Notefiles and the Notes they contain.
filesarray of strings
One or more files to delete.
access_tokenstring (Notehub curl requests only)
A Notehub API bearer token.
projectUIDstring (Notehub curl requests only)
The ProjectUID of a Notehub project.
deviceUIDstring (Notehub curl requests only)
The globally-unique DeviceUID of a device that currently exists within the specified ProjectUID.
You may alternatively provide a device serial number by prefixing this argument
with sn:, for example sn:my-device.
{} means success.Gets resource statistics about local Notefiles.
file (Added in v1.5.6)string (optional)
Returns the stats for the specified Notefile only.
totalinteger
The total number of Notes across all Notefiles.
changesinteger
The number of Notes across all Notefiles pending sync.
syncboolean
true if a sync is recommended based on the number of pending notes.
{ "total": 83, "changes": 78, "sync": true }