11.5.42　プロセスデータの登録

指定したプロセスデータを登録します。このAPIを実行すると，BPMN連携ライブラリ Java APIのCIWBPMNLib.setProcessDataインタフェースが呼び出されます。

メソッドとURL

POST /v1/process-data/set-process-data

リクエストボディ

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

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

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

リクエスト例

リクエストURL

POST http://restserver/csciwws/v1/process-data/set-process-data

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

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

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

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

レスポンス

レスポンスボディは空になります。

ステータスコード

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

ページの先頭へ

11.5.42 プロセスデータの登録

11.5.42　プロセスデータの登録