PATCH/tasks/{taskId}

할 일을 부분 수정한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증를 참고한다.

Scope

task

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/tasks/{taskId}

Path Parameters

ParameterTypeDescription
taskId string 

할 일 ID


required
example : 4f9373d8-0e34-45b3-8b04-5459fad4e855 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
assignorId string 

요청자 ID

 
assignees array (Assignee) 

할 일 담당자 정보

 
title string 

할 일 제목

 
content string 

할 일 내용

 
dueDate string 

할 일 완료일(완료일이 있는 경우)

  • 형식: YYYY-MM-DD
  • 예: 2024-03-08

nullable : true 
completionCondition string 

할 일 완료 옵션

  • ANY_ONE: 1명만 완료해도 되는 일
  • MUST_ALL: 모두 완료해야 하는 일

참고

  • 할 일 수정 시에는 담당자가 2명 이상인 경우에만 입력한다.

Allowed values : ANY_ONE, MUST_ALL 

Assignee

PropertyTypeDescription
assigneeId string 

담당자 ID

  • 삭제된 구성원인 경우 빈값으로 응답한다.

required 
status string 

할 일 완료/미완료 상태

  • DONE: 완료 상태
  • TODO: 미완료 상태

참고

  • 추가되는 담당자의 status는 항상 TODO로 설정한다.
  • 할 일 상태는 다음의 API로 변경한다.
  • 할 일 완료 처리
  • 할 일 미완료 처리
  • 담당자의 할 일 완료 처리
  • 담당자의 할 일 미완료 처리

required
Allowed values : DONE, TODO 

Request Example

example

1{2  "assignorId": "userf7da-f82c-4284-13e7-030f3b4c756x",3  "assignees": [4    {5      "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c756x",6      "status": "TODO"7    },8    {9      "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c754x",10      "status": "TODO"11    }12  ],13  "title": "주간 회의 준비",14  "content": "회의실 예약하기",15  "dueDate": "2024-10-25",16  "completionCondition": "ANY_ONE"17}

Response

HTTP 200

OK

PropertyTypeDescription
task object (task) 

할 일

 

task

PropertyTypeDescription
assignees array (Assignee) 

담당자 정보

 
assignorId string 

요청자 ID

  • 삭제된 구성원인 경우 빈값으로 응답한다.
 
assignorName string 

요청자 이름

 
completionCondition string 

할 일 완료 옵션

  • ANY_ONE: 1명만 완료해도 되는 일
  • MUST_ALL: 모두 완료해야 하는 일

참고

  • 할 일 수정 시에는 담당자가 2명 이상인 경우에만 입력한다.

Allowed values : ANY_ONE, MUST_ALL 
content string 

내용

 
createdTime string 

생성 시각(YYYY-MM-DDThh:mm:ssTZD)


readOnly : true 
dueDate string 

기한(YYYY-MM-DD)


nullable : true 
modifiedTime string 

수정 시각(YYYY-MM-DDThh:mm:ssTZD)


readOnly : true 
resourceLocation integer 

원본 할 일이 위치한 인스턴스


readOnly : true 
status string 

할 일 완료/미완료 상태

  • DONE: 완료 상태
  • TODO: 미완료 상태

참고

  • 추가되는 담당자의 status는 항상 TODO로 설정한다.
  • 할 일 상태는 다음의 API로 변경한다.
  • 할 일 완료 처리
  • 할 일 미완료 처리
  • 담당자의 할 일 완료 처리
  • 담당자의 할 일 미완료 처리

Allowed values : DONE, TODO 
taskId string 

할 일 ID

 
title string 

제목

 

Assignee

PropertyTypeDescription
assigneeId string 

담당자 ID

  • 삭제된 구성원인 경우 빈값으로 응답한다.

required 
assigneeName string 

담당자 이름


readOnly : true 
status string 

할 일 완료/미완료 상태

  • DONE: 완료 상태
  • TODO: 미완료 상태

참고

  • 추가되는 담당자의 status는 항상 TODO로 설정한다.
  • 할 일 상태는 다음의 API로 변경한다.
  • 할 일 완료 처리
  • 할 일 미완료 처리
  • 담당자의 할 일 완료 처리
  • 담당자의 할 일 미완료 처리

required
Allowed values : DONE, TODO 

Response Example

example

1{2  "assignees": [3    {4      "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c754x",5      "assigneeName": "홍길동",6      "status": "TODO"7    },8    {9      "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c756x",10      "assigneeName": "김철수",11      "status": "TODO"12    }13  ],14  "assignorId": "userf7da-f82c-4284-13e7-030f3b4c756x",15  "assignorName": "김철수",16  "completionCondition": "MUST_ALL",17  "content": "",18  "createdTime": "2024-04-04T04:52:06.405Z",19  "dueDate": null,20  "modifiedTime": "2024-04-04T05:41:52.624Z",21  "resourceLocation": 14101,22  "status": "TODO",23  "taskId": "95e426f5-9c85-4d28-9c41-f22950398c9c",24  "title": "할 일 내용"25}