설명
이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.
작업
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[]