11.5.43　リスト型プロセスデータのインデクス取得

指定したリスト型プロセスデータの要素が，リストの何番目の要素かのインデクスを取得します。このAPIを実行すると，BPMN連携ライブラリ Java APIのCIWBPMNLib.getListProcessDataIndexインタフェースが呼び出されます。

メソッドとURL

POST /v1/process-data/list-index

リクエストボディ

項番	名前	型	指定要否	内容
1	UserDescription	文字列	省略可	ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。
2	ID	数値	必須	プロセスデータのインデクスを取得する案件のIDを指定します。
3	ProcessData	オブジェクト	必須	プロセスデータオブジェクトを指定します。次の2つの要素（KeyおよびValue)から構成されています。
4	Key	文字列	必須	インデクスを取得するリスト型プロセスデータの全要素を示すキー名を指定します。空文字列は指定できません。
5	Value	文字列	省略可	インデクスを取得するリスト型プロセスデータの値を指定します。省略した場合，値がnullのプロセスデータを検索します。空文字列は指定できません。

リクエストボディの構造を次に示します。

項番	名前			出現回数
1	Parameter			1
2		UserDescription		0または1
3		ID		1
4		ProcessData		1
5			Key	1
6			Value	0または1

リクエスト例

リクエストURL

POST http://restserver/csciwws/v1/process-data/list-index

リクエストボディ（XMLの場合）

<?xml version="1.0" encoding="UTF-8" ?>
<Parameter>
  <UserDescription>csciwuser</UserDescription>
  <ID>12100</ID>
  <ProcessData>
    <Key>$SSTATE{}</Key>
    <Value>ACTIVE</Value>
  </ProcessData>
</Parameter>

リクエストボディ（JOINの場合）

{
  "UserDescription" : "csciwuser",
  "ID" : "12100",
  "ProcessData" : {
    "Key" : "$SSTATE{}",
    "Value" : "ACTIVE"
  }
}

レスポンス

リスト型プロセスデータのインデクスを返します。

項番	名前	型	内容
1	Index	文字列	リスト型プロセスデータのインデクスを返します。案件が見つからなかった場合は，ステータスコード404を返します。プロセスデータが見つからなかった場合は，ステータスコード200を返し，Indexの値は-1になります。

レスポンスの構造を次に示します。

項番	名前		出現回数
1	Resources		1
2		Index	1

ステータスコード

項番	ステータスコード	内容
1	200	成功
2	400	リクエストパラメタの不正
3	404	データが見つからなかった
4	500	内部処理エラー

レスポンス例

レスポンス（XMLの場合）

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resources>
  <Index>3</Index>
</Resources>

レスポンス（JSONの場合）

{
  "Index" : "3"
}

ページの先頭へ

11.5.43 リスト型プロセスデータのインデクス取得

11.5.43　リスト型プロセスデータのインデクス取得