Примечания
Каждая операция этой группы: что она принимает, что возвращает и какими ошибками может ответить.
Операции
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.
Параметры пути
idstringОбязательноThe thread the notes are on, as
GET /threadsreturns it.
Возвращает
Every note on the thread, in display order.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe thread the notes are on, as
GET /threadsreturns it.
Тело запроса
contentstringОбязательноThe text of the note, up to 20,000 characters. Leading and trailing spaces are trimmed.
От 1 до 20000 символовcolorstringOne of the eight the app offers:
default,red,orange,yellow,green,blue,purpleorpink. Defaults todefault.Одно из"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanKeeps the note above the others. Defaults to false.
Возвращает
The note.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe thread the notes are on, as
GET /threadsreturns it.
Тело запроса
idsstring[]Обязательно- От 1 до 200 элементов
Возвращает
The notes, in their new order.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Параметры пути
idstringОбязательноThe thread the notes are on, as
GET /threadsreturns it.noteIdstringОбязательноThe id of a note on that thread.
Тело запроса
contentstringThe new text, up to 20,000 characters.
От 1 до 20000 символовcolorstringThe new colour.
Одно из"default""red""orange""yellow""green""blue""purple""pink"pinnedbooleanPins or unpins it.
Возвращает
The note as it is now.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
DELETE/threads/{id}/notes/{noteId}
Delete a note
Gone for good. There is no bin for notes.
Requires the threads:write scope.
Параметры пути
idstringОбязательноThe thread the notes are on, as
GET /threadsreturns it.noteIdstringОбязательноThe id of a note on that thread.
Возвращает
Deleted.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
Объекты
DeletedThreadNoteobject
objectstring- Одно из
"note" idstringthreadIdstringdeletedboolean- Одно из
true
ThreadNoteobject
objectstringОбязательно- Одно из
"note" idstringОбязательноthreadIdstringОбязательноcontentstringОбязательно- До 20000 символов
colorstringОбязательно- Одно из
"default""red""orange""yellow""green""blue""purple""pink" pinnedbooleanОбязательноPinned notes are listed before the others.
orderintegerОбязательноWhere it sits among the notes that share its pinned state, lowest first.
createdAtstringОбязательно- Формат
date-time updatedAtstringОбязательно- Формат
date-time
ThreadNoteListobject
objectstring- Одно из
"list" dataThreadNote[]