Note API では、組織/グループノートの投稿を管理することができます。
Note API は、User Account 認証で発行された Access Token でのみ呼び出すことができます。Service Account 認証 (JWT) で発行された Access Token では呼び出すことができません。
Scopes: group.note, group.note.read
組織/グループノートは、組織またはグループ機能の一部です。組織/グループノートの有効化・無効化は、組織またはグループを管理する API で、useNote プロパティで指定できます。
組織の管理には orgunit または directory scope が、グループの管理には group または directory scope が必要です。
| HTTP Request | Description |
|---|---|
| POST /orgunits | 組織の登録 |
| PUT /orgunits/{orgUnitId} | 組織の更新 |
| PATCH /orgunits/{orgUnitId} | 組織の部分更新 |
| HTTP Request | Description |
|---|---|
| POST /groups | グループの登録 |
| PUT /groups/{groupId} | グループの更新 |
| PATCH /groups/{groupId} | グループの部分更新 |
組織/グループノートを有効化 (useNote = true) した後、以下の API によりノートを作成することで、組織/グループノートが利用できます。
| HTTP Request | Description |
|---|---|
| POST /groups/{groupId}/note | 組織/グループノートの作成 |
組織/グループノートのデータを削除するには、以下の API を利用します。
| HTTP Request | Description |
|---|---|
| DELETE /groups/{groupId}/note | 組織/グループノートの削除 |
組織/グループノートの投稿は、以下の API で管理します。API を呼び出す際には、組織またはグループの ID groupId を指定します。
| HTTP Request | Description |
|---|---|
| POST /groups/{groupId}/note/posts | 組織/グループノートの投稿登録 |
| GET /groups/{groupId}/note/posts | 組織/グループノートの投稿のリストの取得 |
| GET /groups/{groupId}/note/posts/{postId} | 組織/グループノートの投稿取得 |
| PUT /groups/{groupId}/note/posts/{postId} | 組織/グループノートの投稿の更新 |
| PATCH /groups/{groupId}/note/posts/{postId} | 組織/グループノートの投稿の部分更新 |
| DELETE /groups/{groupId}/note/posts/{postId} | 組織/グループノートの投稿削除 |
書き込みは件名 title と内容 body を指定して登録する。内容 body には HTML タグを記載することができる。 また、他人の編集を許可するかどうか enableCollaboration やお知らせ登録するかどうか isNotice、書き込み生成のお知らせ送信するかどうか sendNotifications を指定することができる。
{ "title": "投稿の件名", "body": "<h1>書き込み</h1>本文", "enableCollaboration": false, "isNotice": false, "sendNotifications": false}組織/グループノートの投稿には、ファイルを添付することができます。
| HTTP Request | Description |
|---|---|
| POST /groups/{groupId}/note/posts/{postId}/attachments | 組織/グループノートの投稿の添付ファイル登録 |
| GET /groups/{groupId}/note/posts/{postId}/attachments | 組織/グループノートの投稿の添付ファイルのリスト取得 |
| GET /groups/{groupId}/note/posts/{postId}/attachments/{attachmentId} | 組織/グループノートの投稿の添付ファイル取得 |
| DELETE /groups/{groupId}/note/posts/{postId}/attachments/{attachmentId} | 組織/グループノートの投稿の添付ファイル削除 |
添付ファイルの登録・取得方法の詳細は ファイルアップロード / ダウンロード を参照します。