진척 관리 항목 상태를 변경하는 API입니다.

API 만들기

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

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

API 요청

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

JSON 요청 형식입니다.

이름	유형	설명	필수 여부	예
action	문자열	작업 이름	예	DOC_TASK_STATUS_UPDATE
taskId	문자열	상태를 변경할 문서 태스크 아이디	예	d6ad4918c5632a61
status	문자열	변경할 상태	예	APPROVED \| REJECTED

진척 관리 상태를 결제 완료(APPROVED)로 변경하는 예제입니다.

{
    "action": "DOC_TASK_STATUS_UPDATE",
    "taskId": "d6ad4918c5632a61",
    "status": "APPROVED"
}

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

`DOC_TASK_STATUS_UPDATE` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오

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

예외	설명
INVALID_PARAMETER	상태 값이 APPROVED 또는 REJECTED이 아닐 때
INVALID_STATUS_TRANSITION	REQUESTED 상태가 아닌 문서 태스크에 대해서 호출했을 때
INVALID_TASK_TYPE	문서 태스크 유형이 “수정 요청” 또는 “검토 요청”이 아닐 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때
TASK_NOT_EXIST	문서 태스크가 존재하지 않을 때

예제입니다.

{
	"status": "success"
}