ملاحظات
كل عملية في هذه المجموعة: ما تقبله وما تُرجعه والأخطاء التي قد تردّ بها.
العمليات
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[]