device

GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}

For .qi files, returns the queued up notes. For .db files, returns all notes in the notefile

Request

Base URL
https://api.notefile.net
URL
https://api.notefile.net/v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}
Auth
HTTP bearer

projectOrProductUIDstring required

deviceUIDstring required

notefileIDstring required

maxinteger

The maximum number of Notes to return in the request.

deletedboolean

true to return deleted notes.

deleteboolean

true to delete the notes returned by the request.

The note changes object

changesinteger

The number of pending changes in the Notefile.

notesobject

An object with a key for each note and a value object with the body of each Note and the time the Note was added.

totalinteger

The total number of notes.

Oct 2, 20261f4693048cb8 Revision changes
- breaking
  for the query request parameter max, the format changed from no format to int32
Jul 30, 20261887e880199a Revision changes
- breaking
  the response's body type changed from no type to object for status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status