プロセス・インスタンス・リストの取得
get
/ic/api/process/v1/processes
プロセス・インスタンス・リストを取得します。
リクエスト
問合せパラメータ
- assignmentFilter: string
割当てフィルタ。 有効な値: MY_AND_GROUP(デフォルト)、OWNER、REVIEWER、ADMIN、ALL MY_AND_GROUP -自分を含むすべてのユーザーに割り当てられたプロセス・インスタンスを、自分が属するグループに表示します。 OWNER - 自分が所有者であるプロセス・インスタンスが表示されます。 REVIEWER -自分がレビュー担当者であるプロセス・インスタンスを表示します。 ADMIN -管理ユーザーのすべてのプロセス・インスタンスを表示します。 このフィルタは管理者専用です。 ALL - 管理コンテキスト・ユーザーにフィルタリングなし;非管理者に対して作成されたすべてのプロセス・インスタンスを表示します。デフォルト値:
MY_AND_GROUP - cannedProcessFilter: string
事前に作成されたプロセス・フィルタ。このフィルタはassignmentFilterをオーバーライドします。 有効な値:DEFAULT、OWNED_BY_ME、STARTED_BY_ME、REVIEWED_BY_ME、ADMINISTERED_BY_ME。 DEFAULT - 非管理ユーザーの場合、これは、ユーザーがプロセス所有者である場合はOWNED_BY_MEと等しくなります。それ以外の場合は、STARTED_BY_MEです。 loggedIn adminユーザーの場合、これはADMINISTERED_BY_MEと同じです。 OWNED_BY_ME - assignmentFilter = OWNER STARTED_BY_MEのユーザーのプロセス・インスタンスを表示 - assignmentFilter = ALLで、プロセス作成者が現在のユーザーREVIEWED_BY_MEであるユーザーのプロセス・インスタンスを表示 - assignmentFilter = REVIEWER ADMINISTERED_BY_MEのユーザーのプロセス・インスタンスを表示 - assignmentFilter = ADMINの管理ユーザーのプロセス・インスタンスを表示
- dueDateFrom: string
期日範囲の開始をISO-8601形式YYYY-MM-DDTHH:MM:SS[.sss]Zで指定
- dueDateTo: string
ISO-8601形式YYYY-MM-DDTHH:MM:SS[.sss]Zの期限終了日
- keyword: string
インスタンス・タイトルのキーワード
- limit: integer(int32)
ページ当たりの最大アイテム数、デフォルト25デフォルト値:
25 - offset: integer(int32)
リスト項目のページにある最初の項目の索引デフォルト値:
0 - orderBy: string
結果を順序付けるフィールド
- priority: array[string]
コレクション形式:
multiプロセス優先度で、1 (最高)から5 (最低)またはAny (デフォルト)を指定します。 - processCreator: array[string]
コレクション形式:
multiプロセス・インスタンスの作成者 - processDefId: array[string]
コレクション形式:
multiプロセス定義ID - processDefIdLike: string
類似プロセス定義ID
- processName: array[string]
コレクション形式:
multiプロセス・インスタンス名 - processOwner: array[string]
コレクション形式:
multiプロセス・インスタンスの所有者のロール名で、そのロールに割り当てられている個々のユーザーではありません - processState: array[string]
コレクション形式:
multiプロセス状態 値: OPEN, ABORTED, CANCELED, FAULTED_RECOVERABLE, ERRORED, COMPLETED, SUSPENDED. デフォルト: OPEN.-
デフォルト値:
OPEN許容値:[ "OPEN", "ABORTED", "CANCELED", "FAULTED_RECOVERABLE", "ERRORED", "COMPLETED", "SUSPENDED" ]
-
- since: string
返されるアイテムは、ISO-8601形式YYYY-MM-DDTHH:MM:SS[.sss]Zで指定された時間より後で作成する必要があります
- totalResults: boolean
合計結果 - trueまたはfalseデフォルト値:
true - until: string
返品アイテムは、ISO-8601形式YYYY-MM-DDTHH:MM:SS[.sss]Zで指定された時間より前に作成する必要があります
- updatedSince: string
返されるアイテムは、指定した時間より後で更新する必要があります。ISO-8601書式はYYYY-MM-DDTHH:MM:SS[.sss]Zです。
- updatedUntil: string
返されるアイテムは、指定した時間より前に更新する必要があります。ISO-8601書式はYYYY-MM-DDTHH:MM:SS[.sss]Zです。
- view: string
ビュー名
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功
ルート・スキーマ: Collection
型:
object400レスポンス
不正リクエスト
401レスポンス
未認可
404レスポンス
Process list not found
500レスポンス
内部サーバー・エラー