11.5.1 案件の一覧取得
指定したフィルター条件を満たす案件の一覧を取得します。このAPIを実行すると,CSCIW Java APIのCIWServer.getProcessInstancesListインタフェースが呼び出されます。
メソッドとURL
GET /v1/process-instance
クエリパラメタ
項番 |
名前 |
型 |
指定要否 |
内容 |
---|---|---|---|---|
1 |
userdescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
2 |
filter |
文字列 |
省略可 |
案件一覧を取得する場合のフィルター条件を指定します。省略した場合はフィルター条件は指定されません。空文字列は指定できません。 |
3 |
sort |
文字列 |
省略可 |
取得した案件一覧をソートする場合の条件を指定します。省略した場合はソート条件は指定されません。空文字列は指定できません。 |
4 |
offset |
数値 |
省略可 |
案件一覧を取得する場合のオフセットを指定します。先頭は0になります。省略した場合は0が指定されます。0未満の値は指定できません。 |
5 |
maxcount |
数値 |
省略可 |
案件一覧を取得する場合の最大取得数を指定します。省略した場合デフォルト値が指定されます。すべてを取得する場合は,-1を指定します。-1未満の値は指定できません。 |
リクエスト例
リクエストURL
GET http://restserver/csciwws/v1/process-instance?filter=NAME%3D%27PI0001%27
レスポンス
案件一覧を返します。個々の案件のプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
---|---|---|---|
1 |
ClosedDate |
日付 |
案件の終了日時 |
2 |
Creator |
文字列 |
案件の投入者 |
3 |
Deadline |
日付 |
案件の処理期限の絶対日時 |
4 |
ID |
数値 |
案件のID |
5 |
MovedDate |
日付 |
案件の乗せ替え日時 |
6 |
Name |
文字列 |
案件の名称(案件キー) |
7 |
Priority |
数値 |
案件の優先度 |
8 |
ProcessDefinitionID |
数値 |
案件が所属するビジネスプロセス定義のID |
9 |
ProcessDefinitionName |
文字列 |
案件が所属するビジネスプロセス定義の名称 |
10 |
StartDate |
日付 |
案件の開始日時 |
11 |
StateCode |
文字列 |
案件の状態 |
レスポンスの構造を次に示します。
項番 |
名前 |
出現回数 |
||
---|---|---|---|---|
1 |
ProcessInstances |
1 |
||
2 |
ProcessInstance |
0または1以上 |
||
3 |
ClosedDate |
1 |
||
4 |
Creator |
1 |
||
5 |
Deadline |
1 |
||
6 |
ID |
1 |
||
7 |
MovedDate |
1 |
||
8 |
Name |
1 |
||
9 |
Priority |
1 |
||
10 |
ProcessDefinitionID |
1 |
||
11 |
ProcessDefinitionName |
1 |
||
12 |
StartDate |
1 |
||
13 |
StateCode |
1 |
ステータスコード
項番 |
ステータスコード |
内容 |
---|---|---|
1 |
200 |
成功(データが0件の場合も成功) |
2 |
400 |
リクエストパラメタの不正 |
3 |
500 |
内部処理エラー |
レスポンス例
レスポンス(XMLの場合)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ProcessInstances> <ProcessInstance> <ClosedDate></ClosedDate> <Creator>csciwws</Creator> <Deadline></Deadline> <ID>5001</ID> <MovedDate></MovedDate> <Name>PI0001</Name> <Priority>0</Priority> <ProcessDefinitionID>3001</ProcessDefinitionID> <ProcessDefinitionName>販売業務</ProcessDefinitionName> <StartDate>2016-12-06T15:31:12+09:00</StartDate> <StateCode>d</StateCode> </ProcessInstance> </ProcessInstances>
レスポンス(JSONの場合)
{ "ProcessInstance" : [ { "ClosedDate" : "", "Creator" : "csciwws", "Deadline" : "", "ID" : "5001", "MovedDate" : "", "Name" : "PI0001", "Priority" : "0", "ProcessDefinitionID" : "3001", "ProcessDefinitionName" : "販売業務", "StartDate" : "2016-12-06T15:31:12+09:00", "StateCode" : "d" } ] }