Notlar
Bu gruptaki her işlem: neyi kabul ettiği, ne döndürdüğü ve hangi hatalarla yanıt verebileceği.
İşlemler
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.
Yol parametreleri
idstringZorunluThe thread the notes are on, as
GET /threadsreturns it.
Döndürür
Every note on the thread, in display order.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe thread the notes are on, as
GET /threadsreturns it.
İstek gövdesi
contentstringZorunluThe text of the note, up to 20,000 characters. Leading and trailing spaces are trimmed.
1 ile 20000 karakter arasıcolorstringOne of the eight the app offers:
default,red,orange,yellow,green,blue,purpleorpink. Defaults todefault.Şunlardan biri"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanKeeps the note above the others. Defaults to false.
Döndürür
The note.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe thread the notes are on, as
GET /threadsreturns it.
İstek gövdesi
idsstring[]Zorunlu- 1 ile 200 arası öğe
Döndürür
The notes, in their new order.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe thread the notes are on, as
GET /threadsreturns it.noteIdstringZorunluThe id of a note on that thread.
İstek gövdesi
contentstringThe new text, up to 20,000 characters.
1 ile 20000 karakter arasıcolorstringThe new colour.
Şunlardan biri"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanPins or unpins it.
Döndürür
The note as it is now.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
DELETE/threads/{id}/notes/{noteId}
Delete a note
Gone for good. There is no bin for notes.
Requires the threads:write scope.
Yol parametreleri
idstringZorunluThe thread the notes are on, as
GET /threadsreturns it.noteIdstringZorunluThe id of a note on that thread.
Döndürür
Deleted.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
Nesneler
DeletedThreadNoteobject
objectstring- Şunlardan biri
"note" idstringthreadIdstringdeletedboolean- Şunlardan biri
true
ThreadNoteobject
objectstringZorunlu- Şunlardan biri
"note" idstringZorunluthreadIdstringZorunlucontentstringZorunlu- En çok 20000 karakter
colorstringZorunlu- Şunlardan biri
"default""red""orange""yellow""green""blue""purple""pink" pinnedbooleanZorunluPinned notes are listed before the others.
orderintegerZorunluWhere it sits among the notes that share its pinned state, lowest first.
createdAtstringZorunlu- Biçim
date-time updatedAtstringZorunlu- Biçim
date-time
ThreadNoteListobject
objectstring- Şunlardan biri
"list" dataThreadNote[]