टिप्पणियाँ
इस समूह का हर ऑपरेशन: वह क्या लेता है, क्या लौटाता है और किन त्रुटियों के साथ जवाब दे सकता है।
ऑपरेशन
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[]