11.5.2 指定したプロセスデータを含む案件の一覧取得
指定したプロセスデータを含む案件の一覧を取得します。この API を実行すると,BPMN連携ライブラリ Java APIのCIWBPMNLib.getPIIDListByProcessDataインタフェースが呼び出されます。
メソッドとURL
POST /v1/process-instance/process-data
リクエストボディ
項番 |
名前 |
型 |
指定要否 |
内容 |
---|---|---|---|---|
1 |
UserDescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
2 |
Sort |
文字列 |
省略可 |
取得した案件一覧をソートする場合の条件を指定します。昇順の場合は"ASC",降順の場合は"DESCを指定します。省略した場合は,昇順"ASC"でソートされます。空文字列は指定できません。 |
3 |
Offset |
数値 |
省略可 |
案件一覧を取得する場合のオフセットを指定します。先頭には0を指定します。省略した場合は0が指定されます。0未満の値は指定できません。 |
4 |
MaxCount |
数値 |
省略可 |
案件一覧を取得する場合の最大取得数を指定します。省略した場合デフォルト値が指定されます。すべてを取得する場合は,-1を指定します。-1未満の値は指定できません。 |
5 |
ProcessDataList |
配列 |
必須 |
プロセスデータ一覧を指定します。 |
6 |
ProcessData |
オブジェクト |
必須 |
プロセスデータオブジェクトを指定します。次の2 つの 要素(Key および Value)から構成されています。 |
7 |
Key |
文字列 |
必須 |
プロセスデータキー名を指定します。空文字列は指定で きません。 |
8 |
Value |
文字列 |
省略可 |
検索するプロセスデータ値を指定します。省略した場合,値が null のキーを検索します。空文字列は指定できません。 |
リクエストボディの構造を次に示します。
項番 |
名前 |
出現回数 |
|||
---|---|---|---|---|---|
1 |
Parameter |
1 |
|||
2 |
UserDescription |
0または1 |
|||
3 |
Sort |
0または1 |
|||
4 |
Offset |
0または1 |
|||
5 |
MaxCount |
0または1 |
|||
6 |
ProcessDataList |
1 |
|||
7 |
ProcessData |
1以上 |
|||
8 |
Key |
1 |
|||
9 |
Value |
0または1 |
リクエスト例
リクエストURL
POST http://restserver/csciwws/v1/process-instance/process-data
リクエストボディ(XMLの場合)
<?xml version="1.0" encoding="UTF-8" ?> <Parameter> <UserDescription>csciwuser</UserDescription> <Sort>ASC</Sort> <Offset>30</Offset> <MaxCount>50</MaxCount> <ProcessDataList> <ProcessData> <Key>$SdateStr</Key> <Value>April</Value> </ProcessData> <ProcessData> <Key>$Sproduct{}</Key> <Value>product1</Value> </ProcessData> <ProcessData> <Key>$Sproduct{}</Key> <Value>product2</Value> </ProcessData> <ProcessData> <Key>$Sdate{1}</Key> <Value>January</Value> </ProcessData> </ProcessDataList> </Parameter>
リクエストボディ(JSONの場合)
{ "UserDescription" : "csciwuser", "Sort" : "ASC", "Offset" : "30", "MaxCount" : "50", "ProcessDataList" : { "ProcessData" : [ { "Key" : "$SdateStr", "Value" : "April" }, { "Key" : "$Sproduct{}", "Value" : "product1" }, { "Key" : "$Sproduct{}", "Value" : "product2" }, { "Key" : "$Sdate{1}", "Value" : "January" } ] } }
レスポンス
案件一覧を返します。個々の案件のプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
---|---|---|---|
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>1</ID> <MovedDate></MovedDate> <Name>案件A</Name> <Priority>0</Priority> <ProcessDefinitionID>3001</ProcessDefinitionID> <ProcessDefinitionName>販売業務</ProcessDefinitionName> <StartDate>2016-12-06T15:31:12+09:00</StartDate> <StateCode>d</StateCode> </ProcessInstance> <ProcessInstance> <ClosedDate></ClosedDate> <Creator>csciwws</Creator> <Deadline></Deadline> <ID>2</ID> <MovedDate></MovedDate> <Name>案件B</Name> <Priority>0</Priority> <ProcessDefinitionID>3001</ProcessDefinitionID> <ProcessDefinitionName>販売業務</ProcessDefinitionName> <StartDate>2016-12-06T15:31:23+09:00</StartDate> <StateCode>d</StateCode> </ProcessInstance> </ProcessInstances>
レスポンス(JSONの場合)
{ "ProcessInstance" : [ { "ClosedDate" : "", "Creator" : "csciwws", "Deadline" : "", "ID" : "1", "MovedDate" : "", "Name" : "案件A", "Priority" : "0", "ProcessDefinitionID" : "3001", "ProcessDefinitionName" : "販売業務", "StartDate" : "2016-12-06T15:31:12+09:00", "StateCode" : "d" }, { "ClosedDate" : "", "Creator" : "csciwws", "Deadline" : "", "ID" : "2", "MovedDate" : "", "Name" : "案件B", "Priority" : "0", "ProcessDefinitionID" : "3001", "ProcessDefinitionName" : "販売業務", "StartDate" : "2016-12-06T15:31:23+09:00", "StateCode" : "d" } ] }