TaskList

現行ユーザーに割り当てられたタスクのリスト (未完了タスクのリストと完了タスクのリスト) を取得するには、このリソースを使用します。

メソッドの要約

HTTP メソッド	パス	説明
取得	/scr/api/TaskList	現行ユーザーに割り当てられたタスクのリスト (未完了タスクのリストと完了タスクのリスト) を取得します。

取得 /scr/api/TaskList

説明: 現行ユーザーに割り当てられたタスクのリスト (未完了タスクのリストと完了タスクのリスト) を取得するには、このメソッドを使用します。

リソース情報

要件	説明
応答フォーマット	JSON
認証が必要	はい
OAuth 2 クライアント資格情報のサポート	はい (実行管理機能カテゴリーを含むユーザー・サービス ID を使用)
指定時間内の数の制限	現在はなし

パラメーター

名前	Location	説明	必須	タイプ
X-On-Behalf-Of	ヘッダー	ユーザー・コンテキスト。値は、アカウントに含まれるユーザー名でなければなりません。ユーザーは、アカウント内と、親スペースを指定した場合はその親スペース内でアクションを実行する権限を持っている必要があります。	サービス ID OAuth 資格情報を使用する場合は必須です。ユーザー・サービス ID OAuth 資格情報を使用する場合は不要です。	ストリング
type	照会	返されるリストのタイプ。サポートされる値は、`assigned` または `completed` です。値がサポートされない値の場合は、応答コード `400` が返されます。	はい	ストリング
version	照会	要求する API のバージョン。使用できる値は `20110917` のみです。	はい	ストリング
limit	照会	返されるタスクの最大数。このパラメーターが指定されていない場合は、デフォルト値 `100` が使用されます。	いいえ	整数
startFrom	照会	このパラメーターを指定した場合、返されるリストは、リスト内のこのインデックスにあるタスクから始まります (ゼロ・ベース)。前の呼び出し制限で、有効なタスクの数が返されるタスクの数を上回っている場合は、このパラメーターを使用します。	いいえ	整数

応答

入力例

ユーザー・サービス ID OAuth 2 クライアント資格情報の使用:

curl -i -H "Authorization: Bearer access_token"
"https://your_server_url/scr/api/TaskList?type=completed&version=20110917"

サービス ID OAuth 2 クライアント資格情報とユーザー・コンテキストの使用:

curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com"
    "https://your_server_url/scr/api/TaskList?type=completed&version=20110917"

出力例

{
      "work":[
         {           
            "name":"ProcessApp 1 - Multiple process apps.",        
            "id":"5f501e1345eda"
         },
         {           
            "name":"ProcessApp 2 - Multiple process apps.",        
            "id":"5f500e134a57f"
         },
     ]
}

応答プロパティー

version

応答の作成に使用した API のバージョン。

more

次のいずれかの値になります。

サーバー上にさらにタスクがある場合は、true
当該タスク・エントリーに有効なタスクがすべて含まれている場合は、false

type

リスト内のタスクのタイプ。可能な値は、assigned または completed です。これらの値は、タイプ・パラメーターで渡すことのできるタイプのいずれかと一致しています。

tasks

タスクの配列。タスクは、dueDate の日時の新しいものから順にリストされます。 dueDate が同じ項目は、インスタンス ID とタスク ID でソートされます。

task.name

タスク名。

task.id

タスクの ID。

task.workId

関連付けられている作業の ID。このプロパティーは、作業配列内のいずれかのエントリーの ID プロパティーと一致しています。複数のタスクが同じ作業エントリーを参照することができます。

task.dueDate

オプションのパラメーター。タスクの期限。タスクに期限がない場合、このフィールドは存在しません。期限は、エポック、すなわち協定世界時 (UTC) 1970 年 1 月 1 日真夜中からの経過時間 (ミリ秒) でリストされます。

work

作業項目の配列。作業項目は順不同です。タスク配列内の workId の固有値ごとに、この配列内にエントリーが 1 つ存在します。

work.name

作業インスタンスの開始時に、その作業インスタンスに付けられた名前。

work.id

作業インスタンスの ID。

応答メッセージ

HTTP コード	理由
200	要求は正常に完了しました。
400	要求の処理中にエラーが発生しました。必須パラメーターが欠落していたか、無効な値が含まれていました。
401	ユーザーには、要求を行う権限がありません。