사용자의 이벤트 알림 목록을 반환하는 API입니다.

API 만들기

<도구 | API> 메뉴에서 “EVENT” 유형 API를 만듭니다.

다양한 쓰리래빗츠 북 API를 만드는 방법을 설명합니다.

API 요청

GET 형식으로 요청해야 합니다.

요청 URL 형식입니다.

/r/api/${uuid}?action=NOTIFICATION_LIST_BY_USER&userId=${userId}

URL 파라미터 항목입니다.

URL 파라미터
이름	유형	설명	필수 여부	예
uuid	UUID	API UUID	예	5b969d63e97cfec7
action	문자열	작업 유형	예	NOTIFICATION_LIST_BY_USER
userId	문자열	사용자 아이디	예	user01
state	문자열	상태. 값이 없으면 `NONE`을 뺀 모든 상태의 알림을 반환합니다. 그 밖의 값을 보내면 `INVALID_PARAMETER` 예외를 반환합니다.	아니오	READ \| UNREAD \| NONE
time	long	마지막 조회 시간(밀리초). 이 값이 있으면 이 시각을 포함해 그 이후의 이벤트만 반환합니다. 숫자가 아니면 `INVALID_PARAMETER` 예외를 반환합니다.	아니오	1672733002536

요청 URL 예제입니다.

/r/api/5b969d63e97cfec7?action=NOTIFICATION_LIST_BY_USER&userId=user01

API 응답

`NOTIFICATION_LIST_BY_USER` 응답

JSON 형식의 응답은 다음과 같습니다.

`NOTIFICATION_LIST_BY_USER` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오
notifications	Notification 객체 배열	이벤트 알림 목록. 최신 알림부터 정렬합니다.	예

이벤트 알림이 없을 때는 notifications로 빈 배열을 반환합니다.

`Notification` 객체

`Notification` 객체
이름	유형	설명	필수 여부	예
id	UUID	이벤트 아이디	예	5b969d63e97cfec7
type	문자열	이벤트 유형	예	CHAPTER_CONTENT_UPDATE
targetId	UUID	이벤트 발생 타켓 아이디	예	f5838e77c8d9904d
title	문자열	이벤트 제목	예
description	문자열	이벤트 설명	아니오
time	long	이벤트 발생 시간	아니오
url	문자열	이동 링크	아니오

다음 유형을 지원합니다.

이벤트 알림 유형
유형	구분	설명
BOOK_COMMENT_CREATE	문서	웹 뷰어 댓글 생성
BOOK_COMMENT_UPDATE	문서	웹 뷰어 댓글 변경
BOOK_COMMENT_DELETE	문서	웹 뷰어 댓글 삭제
BOOK_FEEDBACK_CREATE	문서	웹 뷰어 피드백 생성
BOOK_PULL_REQUEST_CREATE	문서	병합 요청 생성
BOOK_PULL_REQUEST_MERGE	문서	병합 요청 병합
BOOK_PULL_REQUEST_CLOSE	문서	병합 요청 닫기
REPLY_TO_CHANGE_REQUEST	문서	수정 요청 답변
CHAPTER_CREATE	문서	장 생성
CHAPTER_DELETE	문서	장 삭제
CHAPTER_CONTENT_UPDATE	문서	장 내용 변경
NOTICE_CREATE	문서	공지사항 생성
NOTICE_DELETE	문서	공지사항 삭제
NOTICE_UPDATE	문서	공지사항 변경
NOTIFICATION_SEND	기타	알림 보내기
TASK_CREATE	태스크	태스크 생성
TASK_DELETE	태스크	태스크 삭제
TASK_UPDATE	태스크	태스크 변경
TASK_ASSIGNEE_CHANGE	태스크	태스크 담당자 변경
ANSWER_CREATE	태스크	답변 생성
ANSWER_DELETE	태스크	답변 삭제
ANSWER_UPDATE	태스크	답변 변경
ES_IMPORT	문서	외부 시스템 단락 가져오기
ES_UPDATE	문서	외부 시스템 단락 변경
TODO_CREATE	태스크	TODO 생성
BOOK_ALARM	태스크	문서 알람
CHAPTER_ALARM	태스크	장 알람
MY_ALARM	태스크	내 프로파일 알람
TASK_ALARM	태스크	태스크 알람
ACCOUNT_ALARM	태스크	계정 알람
CUSTOMER_ALARM	태스크	고객 알람
MAIL_IMPORT_FAILED	시스템	메일 가져오기 실패(관리자)
FILESTORE_USAGE_THRESHOLD_EXCEEDED	시스템	파일 저장소 사용량 기준 초과(관리자)
JAVA_VERSION_OUTDATED	시스템	오래된 자바 버전 사용(관리자)
DERBY_DATABASE_DEPRECATED	시스템	Derby 데이터베이스 사용(관리자)
LOG_LEVEL_TOO_DETAILED	시스템	로그 수준이 지나치게 상세함(관리자)
VISIT_DATA_NOT_MIGRATED	시스템	방문 데이터 이전 안 됨(관리자)
VECTOR_STORE_UPDATE_FAILED	시스템	챗봇 벡터 저장소 갱신 실패(관리자)

예외 항목

예외 항목은 다음과 같습니다.

NOTIFICATION_LIST_BY_USER 예외 항목
예외	설명
INVALID_PARAMETER	`state`나 `time`이 형식에 맞지 않을 때. `message`에 파라미터 이름을 담습니다.
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때
USER_NOT_EXIST	사용자가 존재하지 않을 때

예제

예제입니다.

{
    "status": "success",
    "notifications": [
		{
			"id": "ff68a610ee6ab4f4",
			"type": "TASK_CREATE",
			"targetId": "077432e6da4d9d12",
			"title": "태스크를 만들었습니다.",		
			"time": 1672733002537,
			"url": "http://127.0.0.1:1975/!#/r/task/view/077432e6da4d9d12"
    	},
		{
			"id": "b9c0451a065c571a",
			"type": "CHAPTER_CONTENT_UPDATE",
			"targetId": "74a5d6030e9f634a",
			"title": "릴리스 노트의 내용이 수정되었습니다.",		
			"time": 1672733002536,
			"url": "http://127.0.0.1:1975/r/differ/diff_chapter_point/5c9ac11366baa9a9/1672733002536/1672733002537"
    	}
	]
}