タスクの検索
検索 Markdown で表示
GET/api/search/task
条件に合うタスクを、参加しているプロジェクトの中から検索します。
パラメーター
projectId"@all" | integerquery必須- プロジェクト ID。
@allを渡すと、参加中の終了していないプロジェクトすべてが対象になります。 qstringquery- タスク名と説明から探すキーワード (200 文字まで)。スペースで区切ると、すべてに一致するタスクだけが対象です。
statusIdsstringquery- カンマ区切りのステータス ID (100 件まで)。
noneを渡すと未設定のタスクに一致します。 statusModeand | or | excludequerystatusIdsの使い方。andは列挙した値のいずれかに一致し、ほかの条件とも満たす必要があります。orは列挙した値のいずれかに一致し、orを指定した条件のどれか 1 つに合えば対象になります。excludeはどの値にも一致しないタスクを返します。省略するとandです。milestoneIdsstringquery- カンマ区切りのマイルストーン ID (100 件まで)。
noneを渡すと未設定のタスクに一致します。 milestoneModeand | or | excludequerymilestoneIdsの使い方。andは列挙した値のいずれかに一致し、ほかの条件とも満たす必要があります。orは列挙した値のいずれかに一致し、orを指定した条件のどれか 1 つに合えば対象になります。excludeはどの値にも一致しないタスクを返します。省略するとandです。prioritiesstringquery- カンマ区切りの優先度 (100 件まで)。
1が高、2が中、3が低です。noneを渡すと優先度が未設定のタスクに一致します。 priorityModeand | or | excludequeryprioritiesの使い方。andは列挙した値のいずれかに一致し、ほかの条件とも満たす必要があります。orは列挙した値のいずれかに一致し、orを指定した条件のどれか 1 つに合えば対象になります。excludeはどの値にも一致しないタスクを返します。省略するとandです。responsibleUserIdsstringquery- カンマ区切りの担当者のユーザー ID (100 件まで)。
noneを渡すと未設定のタスクに一致します。 responsibleUserModeand | or | excludequeryresponsibleUserIdsの使い方。andは列挙した値のいずれかに一致し、ほかの条件とも満たす必要があります。orは列挙した値のいずれかに一致し、orを指定した条件のどれか 1 つに合えば対象になります。excludeはどの値にも一致しないタスクを返します。省略するとandです。ballHoldingUserIdsstringquery- カンマ区切りのボール保持者 (次に動く人) のユーザー ID (100 件まで)。
noneを渡すと未設定のタスクに一致します。 ballHoldingUserModeand | or | excludequeryballHoldingUserIdsの使い方。andは列挙した値のいずれかに一致し、ほかの条件とも満たす必要があります。orは列挙した値のいずれかに一致し、orを指定した条件のどれか 1 つに合えば対象になります。excludeはどの値にも一致しないタスクを返します。省略するとandです。tagIdsstringquery- カンマ区切りのタグ ID (100 件まで)。
noneを渡すと未設定のタスクに一致します。 tagModeand | or | excludequerytagIdsの使い方。andは列挙した値のいずれかに一致し、ほかの条件とも満たす必要があります。orは列挙した値のいずれかに一致し、orを指定した条件のどれか 1 つに合えば対象になります。excludeはどの値にも一致しないタスクを返します。省略するとandです。dueDateFromintegerquery- この日時以降が期限のタスクだけを返します (Unix エポックミリ秒)。
dueDateTointegerquery- この日時以前が期限のタスクだけを返します (Unix エポックミリ秒)。
hasDueDate0 | 1 | true | falsequerytrueで期限のあるタスクだけ、falseで期限のないタスクだけを返します (true、false、1、0)。省略するとどちらも返します。includeClosed0 | 1 | true | falsequery- 完了済み (クローズされたステータス) のタスクを含めるかどうか (
true、false、1、0)。省略するとfalseです。 overdueOnly0 | 1 | true | falsequerytrueにすると、期限を過ぎた未完了のタスクだけを返します (完了済みのタスクは常に除きます)。省略するとfalseです。resultids | itemsquery- レスポンスの形。
idsは一致したタスクの ID、itemsはタスクの概要を 1 ページ 30 件で返します。省略するとidsです。 pageintegerquery- ページ番号 (1 から)。
resultがitemsのときだけ使われます。
レスポンス
200Matching tasks ({ taskIds, truncated } or { items, hasMore })400Invalid query401Authentication is required