Note API로 조직/그룹의 노트 게시글을 관리할 수 있다.
Note API를 호출하려면 구성원 계정으로 인증하여 얻은 Access Token이 필요하다. 서비스 계정으로 인증하여 얻은 Access Token으로는 API를 호출할 수 없다.
API scope는 다음과 같다.
group.note 또는 group.note.read: 조직/그룹 노트에 관한 Note API만 사용 가능조직/그룹 노트는 조직 및 그룹 기능의 일부이다. 따라서 조직/그룹 노트의 활성화/비활성화는 조직 또는 그룹을 관리하는 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 를 사용하여 활성화한 후, 실질적으로 조직/그룹 노트를 사용하려면 생성 API를 이용하여 노트를 생성하여야 한다.
| HTTP Request | Description |
|---|---|
| POST /groups/{groupId}/note | 조직/그룹 노트 생성 |
조직/그룹의 노트를 useNote 를 사용하여 비활성화했더라도 노트의 데이터는 계속 유지된다. 실질적으로 노트의 데이터를 삭제하려면 조직/그룹 노트의 삭제 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} | 조직/그룹 노트 - 게시글 첨부 파일 삭제 |
첨부 파일의 조회 방법은 파일 업로드/다운로드를 참고한다.