タスク・リストの取得
get
/bpm/api/4.0/tasks
現在のユーザーのタスク・リストを取得します。
リクエスト
問合せパラメータ
- assignment: string
タスク割当先 - MY, GROUP, MY_AND_GROUP (default), MY_AND_GROUP_ALL, REPORTEES, OWNER, REVIEWER, PREVIOUS, ALL, ADMIN. MY - 自分に排他的に割り当てられているタスクを表示します。 GROUP - 自分がメンバーであるグループに割り当てられているタスクを表示します。 MY_AND_GROUP -自分を含むすべてのユーザーに割り当てられたタスクを、自分が属するグループに表示します。to.Thisは、自分が属するグループ内の他のユーザーが取得したタスクをフェッチしません。 MY_AND_GROUP_ALL -自分を含むすべてのユーザーに割り当てられたタスクを、自分が属するグループに表示します。to.Thisは、自分が属するグループ内の他のユーザーが取得したタスクもフェッチします。 REPORTEES - 自分が所有者の報告者に割り当てられているタスクの表示 - ユーザーがタスク所有者であるタスクが表示されます。 REVIEWER:自分がレビュー担当者であるタスクが表示されます - 自分が以前すべて更新したタスクの表示 - フィルタリングなし。割り当てまたは作成者に関係なく、すべてのタスクを表示します。 ADMIN - フィルタリングなし。割り当てまたは作成者に関係なく、すべてのタスクを表示します。デフォルト値:
MY_AND_GROUP
- createdBy: string
指定した場合、指定されたユーザーが作成したタスクのみが返されます
- dueDateFrom: string
期日の範囲の開始(書式YYYY-MM-DDTHH:MM:SS[.sss]Z)
- dueDateTo: string
期日範囲の終了(書式YYYY-MM-DDTHH:MM:SS[.sss]Z)
- fields: array
選択したタスク属性のみを表示します。これには、createdDate、creator、updatedDate、fromUser、tasknumber、priority、ownerUser、state、approvalDuration、taskDefinitionName、taskNameSpace、taskId、category、assignedDate、dueDate、outcome、ecid、identificationKeyが含まれます
- fromuser(required): array
前のタスク担当者
- identificationKey: string
指定した場合、指定されたタスク識別キーを持つタスクのみが返されます
- keyword: string
タスク・タイトルのキーワード
- limit: integer(int32)
ページ当たりの最大アイテム数(できれば1から100まで)、デフォルトは25です。 ゼロまたは負の値を指定すると、パラメータが適用不可になり、すべての結果が単一ページに返されますデフォルト値:
25
- metadataFlag: boolean
metadataFlag - trueまたはfalse。metadataFlagがtrueの場合、タスク詳細URLが移入されます。デフォルト値:
false
- offset: integer(int32)
リスト・アイテムのページの最初のアイテムの索引。 負の値を指定すると、パラメータが適用不可になりますデフォルト値:
0
- orderBy: string
結果の順序付けに使用するフィールド。 orderBy=fieldname:asc/descの場合、サポートされるascending.Field名はcreatedDate、creator、updatedDate、fromUser、tasknumber、priority、ownerUser、state、approvalDuration、taskDefinitionName、taskNameSpace、taskId、category、assignedDate、dueDate、outcome、ecid、identificationKeyです
- outcome: string
指定した場合、指定したタスク結果値を持つタスクのみが返されます
- pattern: string
パターン値が'ToDo'に設定されている場合、ToDoタスクのみが返されます。
- priority: array
タスク優先度1(最高)から5(最低)またはAny(デフォルト)
- showActionFlag: boolean
アクションの表示 - trueまたはfalse
- showPermissionFlag: boolean
権限の表示 - trueまたはfalse
- since: string
返されたアイテムは、指定された時間より後に、ISO-8601書式YYYY-MM-DDTHH:MM:SS[.sss]Zで作成する必要があります
- status: array
タスク・ステータス(タスク・ステータスCOMPLETEDは、次の割当とともに使用する場合に有効です - ADMIN, ALL, PREVIOUS)
- totalResults: boolean
合計結果 - trueまたはfalseデフォルト値:
true
- until: string
返されたアイテムは、指定された時間より前に、ISO-8601書式YYYY-MM-DDTHH:MM:SS[.sss]Zで作成する必要があります
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json
200 レスポンス
成功
ネストされたスキーマ : タスク
タイプ:
Show Source
object
-
actionList: array actionList
-
applicationContext: string
-
applicationName: string
-
assignedDate: string
-
assignees: object Collection
-
attachments: array attachments
-
comments: object comments
-
createdBy: string
-
createdDate: string
-
detailsURL: object Link
-
dueDate: string
-
externalUIURL: string
-
formMetadata: string
-
fromUserDisplayName: string
-
fromUserName: string
-
getcListURL: object Link
-
groupByName: string
-
groupByValue: string
-
hasSubTasksFlag: boolean
デフォルト値:
false
-
history: object taskHistories
-
href(required): string (uri)
-
hreflang: string
-
identificationKey: string
-
length: integer (int32)
-
linkId: string
-
links: array links
-
mediaType(required): string
-
number: integer (int32)
-
outcome: string
-
ownerGroup: string
-
ownerRole: string
-
ownerUser: string
-
payload: object payload
-
permissions: array permissions
-
priority: integer (int32)
-
rel(required): string
-
rootTaskNumber: string
-
startDate: string
-
state: string
-
taskDefinitionName: string
-
taskId: string
-
taskNamespace: string
-
title: string
-
titlePrefix: string
現在の担当者またはタスクの作成者にのみ表示されます
-
type: string
-
updatedDate: string
ネストされたスキーマ : リンク
タイプ:
Show Source
object
-
href(required): string
-
rel(required): string
許可された値:
[ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]
206 レスポンス
部分コンテンツ
400 レスポンス
不正なリクエストです
401 レスポンス
承認されていません
404 レスポンス
タスク・リストが見つかりません
500 レスポンス
内部サーバー・エラーです