Task API

Task CRUD

Method	url	description
GET	/api/task	전체 task 조회
GET	/api/task/:taskId	task 개별 조회
POST	/api/project/:projectId/section/:sectionId/task	task 생성
PATCH	/api/task/:taskId	task 수정
DELETE	/api/task/:taskId	task 삭제

Alarm CRUD

Method	url	description
POST	/api/task/:taskId/alarm	개별 task 알람 추가
PUT	/api/task/:taskId/alarm	개별 task 알람 변경
DELETE	/api/task/:taskId/alarm	개별 task 알람 삭제

Comment CRUD

Method	URL	Description
GET	/api/task/:taskId/comment	task에 달린 모든 comment 조회
POST	/api/task/:taskId/comment	task에 comment 생성
PUT	/api/task/:taskId/comment/:commentId	task에 달린 comment 수정
DELETE	/api/task/:taskId/comment/:commentId	task에 달린 comment 삭제

Bookmark CRUD

Method	URL	Description
GET	/api/task/:taskId/bookmark	bookmark 전체 조회
POST	/api/task/:taskId/bookmark	bookmark 생성
PUT	/api/task/:taskId/bookmark/:bookmarkId	bookmark 수정
DELETE	/api/task/:taskId/bookmark/:bookmarkId	bookmark 삭제

Task GET API (전체 작업)

URL

GET /api/task

Response Description

Name	Type	Description
tasks	ARRAY	검색 결과 일치하는 task 배열
id	STRING	task UUID
title	STRING	task title

Response Example

{
    tasks: [
        {
            id : 'UUID',
            title: '작업작업',
        },
    ]
}

Failed Response

Code	Common Message	Return Message	Description
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Task GET API (작업 상세)

URL

GET /api/task/:taskId

Response Description

Name	Type	Description
title	STRING	taskId에 해당하는 작업의 제목.
labels	ARRAY	작업에 할당된 라벨(id: number, title: string) 리스트. 라벨이 없으면 빈 배열([])
priority	OBJECT, NULL	작업에 할당된 우선순위(id: number, title: string) 우선순위가 없으면 null
alarm	OBJECT, NULL	작업에 할당된 알람(id: number) 알람이 없으면 null
dueDate	DATE	작업의 마감일.
position	NUMBER	화면상에서 작업의 위치
isDone	BOOLEAN	작업 완료 여부
createdAt	DATE	작업의 생성시간.
updatedAt	DATE	작업의 최신 업데이트 시간.
childTasks	ARRAY	하위 작업의 리스트. 하나의 작업 객체와 동일한 데이터가 들어감. 하위 작업이 없을시 빈 배열([]).

Response Example

task: {
    id : 1,
    title: '작업1',
    labels: [{id: 1, title: 'FE'},],
    priority: {id: 1, title: '우선순위1'},
    alarm: { ... },
    dueDate: '2020-11-18',
    position: 1,
    isDone: true,
    createdAt: '2020-11-18T07:12:41.000Z',
    updatedAt: '2020-11-18T07:12:41.000Z'
    childTasks: [{id: 2, title: ...},{}, ...],
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	id값이 올바르지 않습니다	작업 ID가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 작업이 아닌 경우 발생합니다.
404	Not Found	해당 작업이 존재하지 않습니다.	존재하지 않는 작업 id인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Task Post API

URL

POST /api/project/:projectId/section/:sectionId/task

Request Description

Name	Required	Type	Description
title	REQUIRED	STRING	작업의 제목
projectId	REQUIRED	NUMBER	작업이 할당된 프로젝트 고유 번호. default는 '관리함'의 고유번호
sectionId	REQUIRED	NUMBER	작업이 할당된 섹션 고유 번호.
labelIdList	CONDITIONAL	ARRAY	작업에 할당할 라벨 고유 번호의 리스트. 없을 경우 빈 배열
priorityId	CONDITIONAL	NUMBER	작업에 할당할 우선순위의 고유번호
alarmId	CONDITIONAL	NUMBER	작업에 할당할 알람의 고유번호
dueDate	REQUIRED	DATE	작업에 할당할 마감일
parentId	CONDITIONAL	NUMBER	상위작업의 고유번호. 하위작업일 경우만 할당
position	REQUIRED	NUMBER	화면 상에서 작업의 위치.

Request Example

{
    title : '할일',
    projectId: 1,
    sectionId: 1,
    labelIdList: [1,2,3],
    priorityId: 1,
    alarmId: 1,
    dueDate: '2020-11-18',
    parentId: 3,
    position: 1
}

Response Description

Name	Required	Type	Description
message	REQUIRED	STRING	요청이 성공했을 때 전달하는 메시지. 'ok'

Response Example

{
    message: 'ok'
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	title값이 올바르지 않습니다	타이틀이 String 타입이 아니거나 빈 문자열인 경우 발생합니다.
		duedate는 오늘 날짜 이전으로 설정할 수 없습니다	dueDate가 현재 시점보다 이전인 경우 혹은 요청이 잘못된 경우 발생합니다.
		parentId값이 올바르지 않습니다	하위 작업 생성 시, parentId 값이 String 타입이 아니거나 UUID4가 아닌 경우 발생합니다.
		불필요한 값이 포함되어 있습니다. => id	작업 생성 시, id를 지정할 수 없습니다.
		불필요한 값이 포함되어 있습니다. => projectId	작업 생성 시, request body에 projectId를 지정할 수 없습니다.
		불필요한 값이 포함되어 있습니다. => sectionId	작업 생성 시, request body에 sectionId를 지정할 수 없습니다.
		잘못된 입력입니다. => projectId, sectionId	작업 생성 시, 다른 프로젝트의 섹션 id가 입력된 경우 발생합니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 프로젝트가 아닌 경우 발생합니다.
			해당 유저의 섹션이 아닌 경우 발생합니다.
404	Not Found	존재하지 않는 섹션입니다.	존재하지 않는 섹션 id인 경우 발생합니다
		존재하지 않는 프로젝트입니다.	존재하지 않는 프로젝트 id인 경우 발생합니다
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Task Patch API

URL

PATCH /api/task/:taskId

Request Description

Name	Required	Type	Description
title	CONDITIONAL	STRING	작업의 제목
projectId	CONDITIONAL	NUMBER	작업이 할당된 프로젝트 고유 번호. default는 '관리함'의 고유번호
sectionId	CONDITIONAL	NUMBER	작업이 할당된 섹션 고유 번호.
labelIdList	CONDITIONAL	ARRAY	작업에 할당할 라벨 고유 번호의 리스트. 없을 경우 빈 배열
priorityId	CONDITIONAL	NUMBER	작업에 할당할 우선순위의 고유번호
isDone	CONDITIONAL	BOOLEAN	작업 완료 여부
alarmId	CONDITIONAL	NUMBER	작업에 할당할 알람의 고유번호
dueDate	CONDITIONAL	DATE	작업에 할당할 마감일
parentId	CONDITIONAL	NUMBER	상위작업의 고유번호. 하위작업일 경우만 할당
position	CONDITIONAL	NUMBER	화면 상에서 작업의 위치.

{
    title : '할일 변경'
    dueDate: '2020-11-19'
    projectId: 1,
    isDone: true
    labelIds: [1, 2, 3]
    priority: 3
    parentId : 1
    sectionId : 1
}

Response Description

Name	Required	Type	Description
message	REQUIRED	STRING	요청이 성공했을 때 전달하는 메시지. 'ok'

Response Example

{
    message: 'ok'
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	projectId값이 올바르지 않습니다	프로젝트 ID가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
		sectionId값이 올바르지 않습니다	섹션 ID가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
		alarmId값이 올바르지 않습니다	섹션 ID가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
		priorityId값이 올바르지 않습니다	섹션 ID가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
		isDone값이 올바르지 않습니다	isDone이 Boolean 타입이 아닌 경우 발생합니다.
		title값이 올바르지 않습니다	타이틀이 String 타입이 아니거나 빈 문자열인 경우 발생합니다.
		duedate는 오늘 날짜 이전으로 설정할 수 없습니다	dueDate가 현재 시점보다 이전인 경우 혹은 요청이 잘못된 경우 발생합니다.
		parentId값이 올바르지 않습니다	하위 작업 생성 시, parentId 값이 String 타입이 아니거나 UUID4가 아닌 경우 발생합니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 작업이 아닌 경우 발생합니다.
404	Not Found	존재하지 않는 작업입니다.	존재하지 않는 작업 id인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Task Position PATCH API

URL

PATCH /api/task/:taskId/position

Request Description

Name	Required	Type	Description
orderedTasks	REQUIRED	ARRAY	화면에 보여질 순서대로 정렬된 하위 task id 배열

Request

{
    orderedTasks : [uuid1, uuid2, uuid3, ...]
}

Response

{
    message: 'ok'
}

Task Delete API

URL

DELETE /api/task/:taskId

Request Description

Name	Required	Type	Description
taskId	REQUIRED	QUERY_STRING	삭제할 task의 UUID

Response Description

Name	Type	Description
message	STRING	작업 삭제에 성공했다는 'ok' 메시지
Response

{
    message: 'ok'
}

Task - Alarm Post API

URL

POST /api/task/:taskId/alarm

Request

Response

Task - Alarm Put API

URL

PUT /api/task/:taskId/alarm

Request

Response

Task - Alarm Delete API

URL

DELETE /api/task/:taskId/alarm

Response

Task - Comment Get API

URL

GET /api/task/:taskId/comment

Request Description

Name	Required	Type	Description
taskId	REQUIRED	QUERY_STRING	작업의 코멘트들을 조회할 task의 UUID

Response Description

Name	Type	Description
comments	ARRAY	코멘트 배열
id	STRING	코멘트 UUID
content	STRING	content 내용(일반 평문 or URL or IMAGE_URL)

Response

{
    comments:
    [
        {
            id: 12qwro34-14isetuj-sreio42,
            content: 'https://...',
            isImage: true
        }
    ]
}

Failed Response

Code	Common Message	Return Message	Description
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 작업이 아닌 경우 발생합니다.
404	Not Found	해당 작업이 존재하지 않습니다.	존재하지 않는 작업 id인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Task - Comment Post API

URL

POST /api/task/:taskId/comment

Request Description

Name	Required	Type	Description
taskId	REQUIRED	QUERY_STRING	코멘트를 남길 task의 UUID
content	REQUIRED	STRING	코멘트의 내용(평문
isImage	Optional	BOOLEAN	image 판별 boolean

Request

{
    content : '[내일 봐야할 것](https://www.naver.com) 공부하자!'
}

Response Description

Name	Type	Description
message	STRING	코멘트 생성에 성공했다는 'ok' 메시지

Response

{
    message: 'ok'
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	content값이 올바르지 않습니다	content 값이 String이 아니거나 빈 문자열인 경우 발생합니다.
		불필요한 값이 포함되어 있습니다. => id	댓글 생성 시, id를 지정할 수 없습니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 작업이 아닌 경우 발생합니다.
404	Not Found	해당 작업이 존재하지 않습니다.	존재하지 않는 작업 id인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Task - Comment PUT API

URL

PUT /api/task/:taskId/comment/:commentId

Request Description

Name	Required	Type	Description
taskId	REQUIRED	QUERY_STRING	코멘트를 수정할 task의 UUID
commentId	REQUIRED	QUERY_STRING	수정할 코멘트의 UUID
content	REQUIRED	STRING	수정할 코멘트의 내용(평문
isImage	REQUIRED	BOOLEAN	이미지인지 여부를 나타내는 boolean

Request

{
    'content': '코멘트 수정',
    'isImage': 'false'
}

Response Description
| Name   |    Type |     Description  |
| :-------------  |:--------------|:--------------|
| **message** |   **STRING** |  코멘트 수정에 성공했다는 'ok' 메시지 |

Response

{
    'message': 'ok'
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	content값이 올바르지 않습니다	content 값이 String이 아니거나 빈 문자열, 없는 경우 발생합니다.
		isImage값이 올바르지 않습니다	isImage가 없거나 boolean 타입이 아닌 경우 발생합니다.
		불필요한 값이 포함되어 있습니다. => id	id를 수정할 수 없습니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 작업이 아니거나 댓글이 아닌 경우 발생합니다.
404	Not Found	해당 작업이 존재하지 않습니다.	존재하지 않는 작업 id인 경우 발생합니다.
		해당 댓글이 존재하지 않습니다.	존재하지 않는 댓글 id인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Task - Comment DELETE API

URL

DELETE /api/task/:taskId/comment/:commentId

Request Description

Name	Required	Type	Description
taskId	REQUIRED	QUERY_STRING	코멘트를 삭제할 task의 UUID
commentId	REQUIRED	QUERY_STRING	삭제할 코멘트의 UUID

Response Description

Name	Type	Description
message	STRING	코멘트 삭제에 성공했다는 'ok' 메시지

Response

{
    'message': 'ok'
}

Task - Bookmark Get API

URL

GET /api/task/:taskId/bookmark

Request Description

Name	Required	Type	Description
taskId	REQUIRED	QUERY_STRING	조회할 task의 UUID

Response

{
    bookmarks:
    [
    	{
        	id: qwea123-w45sdf-14dgo45,
        	url: 'https://....'
    	},
    ]
}

Response Description

Name	Type	Description
bookmarks	Array	북마크 배열
id	STRING	북마크 UUID
url	STRING	북마크 URL 정보

Task - Bookmark Post API

URL

POST /api/task/:taskId/bookmark

Request Description

Name	Required	Type	Description
taskId	REQUIRED	QUERY_STRING	북마크를 생성할 task의 UUID
url	REQUIRED	STRING	북마크를 생성할 url

Request

{
    url : 'https://...'
}

Response Description

Name	Type	Description
message	STRING	생성에 성공했다는 'ok' 메시지

Response

{
    message: 'ok'
}

Task - Bookmark PUT API

URL

PUT /api/task/:taskId/bookmark/:bookmarkId

Request Description

Name	Required	Type	Description
taskId	REQUIRED	QUERY_STRING	북마크를 수정할 task의 UUID
bookmarkId	REQUIRED	QUERY_STRING	수정할 bookmark의 UUID
url	REQUIRED	STRING	새롭게 수정할 url

Request

{
    url : 'https://another...'
}

Response Description

Name	Type	Description
message	STRING	수정에 성공했다는 'ok' 메시지

Response

{
    'message': 'ok'
}

Task - Bookmark DELETE API

URL

DELETE /api/task/:taskId/bookmark/:bookmarkId

Request Description

Name	Required	Type	Description
taskId	REQUIRED	QUERY_STRING	북마크를 삭제할 task의 UUID
bookmarkId	REQUIRED	QUERY_STRING	삭제할 bookmark의 UUID

Response Description

Name	Type	Description
message	STRING	삭제에 성공했다는 'ok' 메시지

Response

{
    'message': 'ok'
}