備考
このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。
オペレーション
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[]