11.5.41 プロセスデータの取得
指定した案件のプロセスデータを取得します。このAPIを実行すると,BPMN連携ライブラリ Java APIのCIWBPMNLib.getProcessDataMapByMultiplePIIDインタフェースが呼び出されます。
メソッドとURL
POST /v1/process-data
リクエストボディ
項番 |
名前 |
型 |
指定要否 |
内容 |
---|---|---|---|---|
1 |
UserDescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
2 |
ProcessInstanceList |
配列 |
必須 |
プロセスデータを取得する案件一覧を指定します。 |
3 |
ID |
数値 |
必須 |
プロセスデータを取得する案件のIDを指定します。 |
4 |
ProcessDataList |
配列 |
省略可 |
プロセスデータ一覧を指定します。省略した場合は指定した案件のIDに合致したプロセスデータがすべて返されます。 |
5 |
Key |
文字列 |
必須 |
取得するプロセスデータキー名を指定します。空文字列は指定できません。 |
リクエストボディの構造を次に示します。
項番 |
名前 |
出現回数 |
||
---|---|---|---|---|
1 |
Parameter |
1 |
||
2 |
UserDescription |
0または1 |
||
3 |
ProcessInstanceList |
1 |
||
4 |
ID |
1以上 |
||
5 |
ProcessDataList |
0または1 |
||
6 |
Key |
1以上 |
リクエスト例
リクエストURL
POST http://restserver/csciwws/v1/process-data
リクエストボディ(XMLの場合)
<?xml version="1.0" encoding="UTF-8" ?> <Parameter> <UserDescription>csciwuser</UserDescription> <ProcessInstanceList> <ID>12100</ID> <ID>52331</ID> </ProcessInstanceList> <ProcessDataList> <Key>$SGYOUMU1STATE</Key> <Key>$SGYOUMU1DATE</Key> </ProcessDataList> </Parameter>
リクエストボディ(JSONの場合)
{ "UserDescription" : "csciwuser", "ProcessInstanceList" : { "ID" : [ "12100", "52331" ] }, "ProcessDataList" : { "Key" : [ "$SGYOUMU1STATE", "$SGYOUMU1DATE" ] } }
レスポンス
案件ごとのプロセスデータを返します。案件ごとのプロセスデータのプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
---|---|---|---|
1 |
ID |
数値 |
案件のID |
2 |
ProcessDataList |
配列 |
プロセスデータ一覧 |
3 |
ProcessData |
オブジェクト |
プロセスデータオブジェクト 次の2つの要素(KeyおよびValue)から構成されています。 |
4 |
Key |
文字列 |
プロセスデータキー名 |
5 |
Value |
文字列 |
プロセスデータ値 |
レスポンスの構造を次に示します。
項番 |
名前 |
出現回数 |
||||
---|---|---|---|---|---|---|
1 |
ProcessInstances |
1 |
||||
2 |
ProcessInstance |
0または1以上 |
||||
3 |
ID |
1 |
||||
4 |
ProcessDataList |
0または1 |
||||
5 |
ProcessData |
1以上 |
||||
6 |
Key |
1 |
||||
7 |
Value |
0または1 |
ステータスコード
項番 |
ステータスコード |
内容 |
---|---|---|
1 |
200 |
成功(データが0件の場合も成功) |
2 |
400 |
リクエストパラメタの不正 |
3 |
500 |
内部処理エラー |
レスポンス例
レスポンス(XMLの場合)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ProcessInstances> <ProcessInstance> <ID>12100</ID> <ProcessDataList> <ProcessData> <Key>$SGYOUMU1STATE</Key> <Value>d</Value> </ProcessData> <ProcessData> <Key>$SGYOUMU1DATE</Key> <Value>20120124</Value> </ProcessData> </ProcessDataList> </ProcessInstance> <ProcessInstance> <ID>52331</ID> <ProcessDataList> <ProcessData> <Key>$SGYOUMU1STATE</Key> <Value>j</Value> </ProcessData> <ProcessData> <Key>$SGYOUMU1DATE</Key> <Value>20110221</Value> </ProcessData> </ProcessDataList> </ProcessInstance> </ProcessInstances>
レスポンス(JSONの場合)
{ "ProcessInstance" : [ { "ID" : "12100", "ProcessDataList" : { "ProcessData" : [ { "Key" : "$SGYOUMU1STATE", "Value" : "d" }, { "Key" : "$SGYOUMU1DATE", "Value" : "20120124" } ] } }, { "ID" : "52331", "ProcessDataList" : { "ProcessData" : [ { "Key" : "$SGYOUMU1STATE ", "Value" : "j" }, { "Key" : "$SGYOUMU1DATE ", "Value" : "20110221" } ] } } ] }