Shënime
Çdo veprim në këtë grup: çfarë pranon, çfarë kthen dhe gabimet me të cilat mund të përgjigjet.
Veprimet
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.
Parametrat e shtegut
idstringE detyrueshmeThe thread the notes are on, as
GET /threadsreturns it.
Kthen
Every note on the thread, in display order.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe thread the notes are on, as
GET /threadsreturns it.
Trupi i kërkesës
contentstringE detyrueshmeThe text of the note, up to 20,000 characters. Leading and trailing spaces are trimmed.
Nga 1 deri në 20000 karakterecolorstringOne of the eight the app offers:
default,red,orange,yellow,green,blue,purpleorpink. Defaults todefault.Një nga"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanKeeps the note above the others. Defaults to false.
Kthen
The note.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe thread the notes are on, as
GET /threadsreturns it.
Trupi i kërkesës
idsstring[]E detyrueshme- Nga 1 deri në 200 elemente
Kthen
The notes, in their new order.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe thread the notes are on, as
GET /threadsreturns it.noteIdstringE detyrueshmeThe id of a note on that thread.
Trupi i kërkesës
contentstringThe new text, up to 20,000 characters.
Nga 1 deri në 20000 karakterecolorstringThe new colour.
Një nga"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanPins or unpins it.
Kthen
The note as it is now.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
DELETE/threads/{id}/notes/{noteId}
Delete a note
Gone for good. There is no bin for notes.
Requires the threads:write scope.
Parametrat e shtegut
idstringE detyrueshmeThe thread the notes are on, as
GET /threadsreturns it.noteIdstringE detyrueshmeThe id of a note on that thread.
Kthen
Deleted.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
Objektet
DeletedThreadNoteobject
objectstring- Një nga
"note" idstringthreadIdstringdeletedboolean- Një nga
true
ThreadNoteobject
objectstringE detyrueshme- Një nga
"note" idstringE detyrueshmethreadIdstringE detyrueshmecontentstringE detyrueshme- Deri në 20000 karaktere
colorstringE detyrueshme- Një nga
"default""red""orange""yellow""green""blue""purple""pink" pinnedbooleanE detyrueshmePinned notes are listed before the others.
orderintegerE detyrueshmeWhere it sits among the notes that share its pinned state, lowest first.
createdAtstringE detyrueshme- Formati
date-time updatedAtstringE detyrueshme- Formati
date-time
ThreadNoteListobject
objectstring- Një nga
"list" dataThreadNote[]