Hinweise
Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.
Operationen
Private notes pinned to a thread, the Notes panel of the reading pane.
Notes are private to a person. A key reads and writes the notes of the workspace owner, and an app those of the person who connected it. A key or an app limited to particular addresses reaches only the notes on threads that arrived at them.
GET/threads/{id}/notes
List the notes on a thread
Pinned notes first, then the rest in the order they were arranged. Notes are private to a person. A key reads and writes the notes of the workspace owner, and an app those of the person who connected it.
Requires the threads:read scope.
Pfadparameter
idstringErforderlichThe thread the notes are on, as
GET /threadsreturns it.
Rückgabe
Every note on the thread, in display order.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
POST/threads/{id}/notes
Add a note to a thread
A new note goes after the others. color is one of the eight the app offers, and pinned keeps it at the top. Notes are private to a person. A key reads and writes the notes of the workspace owner, and an app those of the person who connected it.
Requires the threads:write scope.
Pfadparameter
idstringErforderlichThe thread the notes are on, as
GET /threadsreturns it.
Request-Body
contentstringErforderlichThe text of the note, up to 20,000 characters. Leading and trailing spaces are trimmed.
1 bis 20000 ZeichencolorstringOne of the eight the app offers:
default,red,orange,yellow,green,blue,purpleorpink. Defaults todefault.Einer von"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanKeeps the note above the others. Defaults to false.
Rückgabe
The note.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
POST/threads/{id}/notes/reorder
Arrange the notes on a thread
Sets the order of every note on the thread at once, first to last. Pinned notes still come first. ids has to name each note exactly once, or the call is a 422 invalid_parameter on ids and nothing moves.
Requires the threads:write scope.
Pfadparameter
idstringErforderlichThe thread the notes are on, as
GET /threadsreturns it.
Request-Body
idsstring[]Erforderlich- 1 bis 200 Einträge
Rückgabe
The notes, in their new order.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
PATCH/threads/{id}/notes/{noteId}
Change a note
Changes its text, its colour or whether it is pinned. Give at least one. A note id that is not on this thread is a 404.
Requires the threads:write scope.
Pfadparameter
idstringErforderlichThe thread the notes are on, as
GET /threadsreturns it.noteIdstringErforderlichThe id of a note on that thread.
Request-Body
contentstringThe new text, up to 20,000 characters.
1 bis 20000 ZeichencolorstringThe new colour.
Einer von"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanPins or unpins it.
Rückgabe
The note as it is now.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
DELETE/threads/{id}/notes/{noteId}
Delete a note
Gone for good. There is no bin for notes.
Requires the threads:write scope.
Pfadparameter
idstringErforderlichThe thread the notes are on, as
GET /threadsreturns it.noteIdstringErforderlichThe id of a note on that thread.
Rückgabe
Deleted.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
Objekte
DeletedThreadNoteobject
objectstring- Einer von
"note" idstringthreadIdstringdeletedboolean- Einer von
true
ThreadNoteobject
objectstringErforderlich- Einer von
"note" idstringErforderlichthreadIdstringErforderlichcontentstringErforderlich- Bis zu 20000 Zeichen
colorstringErforderlich- Einer von
"default""red""orange""yellow""green""blue""purple""pink" pinnedbooleanErforderlichPinned notes are listed before the others.
orderintegerErforderlichWhere it sits among the notes that share its pinned state, lowest first.
createdAtstringErforderlich- Format
date-time updatedAtstringErforderlich- Format
date-time
ThreadNoteListobject
objectstring- Einer von
"list" dataThreadNote[]