API の一覧

タスクの検索

検索 Markdown で表示

GET/api/search/task

条件に合うタスクを、参加しているプロジェクトの中から検索します。

パラメーター

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

レスポンス

  • 200Matching tasks ({ taskIds, truncated } or { items, hasMore })
  • 400Invalid query
  • 401Authentication is required

Repsonaはクッキーを使ってサービスを提供しています。当社のウェブサイトにアクセスすることにより、Cookieポリシー に記載されているCookieの使用に同意するものとします。