GET/users/{userId}/tasks/search

ユーザーのタスクを検索する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

task
task.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/tasks/search

Path Parameters

ParameterTypeDescription
userId string 

ユーザー ID


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Query Parameters

ParameterTypeDescription
query string 

検索語

  • 件名、タスク内容、担当者/依頼者の名前を検索する。
  • 検索語を指定しない場合には、assignorId、assigneeId、期間(startTime/endTime) のいずれかを指定する必要がある。
  • 大文字・小文字を区別しない。
  • URL エンコードして指定する。

minLength : 1
maxLength : 100
example : 週次会議 
assignorId string 

依頼者 ID

 
assigneeId string 

担当者 ID

 
startTime string 

検索対象の開始時刻

  • ISO-8601 形式 (YYYY-MM-DDThh:mm:ssTZD) で指定する。
  • startTime と endTime が指定されていない場合には、全期間を検索対象とする。
  • 最大検索期間に制限はない。

format : date-time 
endTime string 

検索対象の終了時刻

  • ISO-8601 形式 (YYYY-MM-DDThh:mm:ssTZD) で指定する。
  • startTime と endTime が指定されていない場合には、全期間を検索対象とする。
  • 最大検索期間に制限はない。

format : date-time 
status string 

タスクの完了ステータス


Allowed values : DONE, TODO 
hasDueDate boolean 

期限の有無

  • 指定しない場合には、期限付き・期限なしの両方のタスクを検索する
  • true : 期限付きのタスクのみを検索する
  • false : 期限のないタスクのみを検索する
 
hasAttachment boolean 

添付ファイルの有無

  • true : 添付ファイルがあるタスクのみを検索
  • false : 添付ファイルの有無にかかわらず検索

default : false 
orderBy string 

並べ替え基準

  • createdTime: 作成時刻
  • dueDate: 期限
    並べ替えの対象と方法は、スペース (URL エンコード値: %20) で区切る。
    並べ替え方法を指定しない場合、既定では昇順 (asc) となり、降順は (desc) を指定する。
    並べ替えは単一のフィールドのみを指定できる。

default : createdTime
example : createdTime%20desc 
count integer 

取得数


default : 50
maximum : 100 
cursor string 

リストのカーソル値 (URL エンコードする)

 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
tasks array (Task) 
 
responseMetaData object (responseMetaData) 
 

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: 未完了

参考

  • 担当者を追加する場合には、常に 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: 未完了

参考

  • 担当者を追加する場合には、常に TODO に設定する。
  • タスクの完了ステータスは、以下の API で変更する。
  • タスクの完了
  • タスクの完了取り消し
  • 自分のタスクの完了
  • 自分のタスクの完了取り消し

required
Allowed values : DONE, TODO 

responseMetaData

PropertyTypeDescription
nextCursor string 
 

Response Example

example

1{2  "tasks": [3    {4      "taskId": "95e426f5-9c85-4d28-9c41-f22950398c9c",5      "assignorId": "userf7da-f82c-4284-13e7-030f3b4c756x",6      "assignorName": "Susan Nielsen",7      "assignees": [8        {9          "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c754x",10          "assigneeName": "Assignee Name",11          "status": "TODO"12        }13      ],14      "completionCondition": "MUST_ALL",15      "title": "会議準備",16      "content": "会議室を予約する。",17      "status": "TODO",18      "dueDate": "2024-05-25",19      "resourceLocation": 14101,20      "createdTime": "2024-04-04T04:52:06.405Z",21      "modifiedTime": "2024-04-04T05:41:52.624Z"22    }23  ],24  "responseMetaData": {25    "nextCursor": "H4sIAAAAAAAA_6tWSk4sSU3PL6r0TFGyUkopTda1MDAwM7UwN1LSUUouLS7Jz_UvSkktUrKqVsqHMJRyc3NzKpRqawHgjprNPQAAAA"26  }27}