11.5.47 アドホック・サブプロセスの状態の変更
指定されたアドホック・サブプロセスの状態を変更します。このAPIを実行すると，BPMN連携ライブラリ Java APIのCIWBPMNLib.changeStateAdHocSubProcessインタフェースが呼び出されます。アドホック・サブプロセスの状態が変更済みの場合は，リクエストは成功します（何もしないでステータスコード204を返します）。詳細については，「5.3 Java API利用時の注意事項」の「べき等性について」の説明を参照してください。
メソッドとURL
PUT /v1/adhoc-sub-process/change-state
リクエストボディ
|
項番 |
名前 |
型 |
指定要否 |
内容 |
|---|---|---|---|---|
|
1 |
UserDescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
|
2 |
ProcessInstanceID |
数値 |
必須 |
対象であるアドホック・サブプロセスが所属する案件IDを指定します。 |
|
3 |
AdHocSubProcessID |
文字列 |
省略可（AdHocSubProcessNameを省略した場合は必須） |
状態変更するアドホック・サブプロセスのアドホック・サブプロセスIDを指定します。省略した場合，アドホック・サブプロセスIDは指定されません。空文字列は指定できません。 |
|
4 |
AdHocSubProcessName |
文字列 |
省略可（AdHocSubProcessIDを省略した場合は必須） |
状態変更するアドホック・サブプロセスのアドホック・サブプロセス名を指定します。省略した場合，アドホック・サブプロセス名は指定されません。 |
|
5 |
MIIndex |
数値 |
省略可 |
状態変更するアドホック・サブプロセスのマルチインスタンスインデクスを指定します。省略した場合，マルチインスタンスインデクスは指定されません。 |
|
6 |
ProcessDataList |
配列 |
省略可 |
プロセスデータ一覧を指定します。省略した場合，プロセスデータは更新されません。 |
|
7 |
ProcessData |
オブジェクト |
必須 |
プロセスデータオブジェクトを指定します。次の2つの要素（KeyおよびValue）から構成されています。 |
|
8 |
Key |
文字列 |
必須 |
プロセスデータのキー名を指定します。空文字列は指定できません。 |
|
9 |
Value |
文字列 |
省略可 |
プロセスデータ値を指定します。省略した場合，キーに対応する値は設定されません。空文字列は指定できません。 |
|
10 |
StateCode |
文字列 |
必須 |
変更するアドホック・サブプロセスの状態に対応する作業の状態をコード値で指定します。アドホック・サブプロセスの状態の詳細については，「1.5.6 アドホック・サブプロセスの状態遷移モデル」を参照してください。 |
リクエストボディの構造を次に示します。
|
項番 |
名前 |
出現回数 |
|||
|---|---|---|---|---|---|
|
1 |
Parameter |
1 |
|||
|
2 |
UserDescription |
0または1 |
|||
|
3 |
ProcessInstanceID |
1 |
|||
|
4 |
AdHocSubProcessID |
0または1 |
|||
|
5 |
AdHocSubProcessName |
0または1 |
|||
|
6 |
MIIndex |
0または1 |
|||
|
7 |
ProcessDataList |
0または1 |
|||
|
8 |
ProcessData |
1以上 |
|||
|
9 |
Key |
1 |
|||
|
10 |
Value |
0または1 |
|||
|
11 |
StateCode |
1 |
|||
リクエスト例
リクエストURL
PUT http://restserver/csciwws/v1/adhoc-sub-process/change-state
リクエストボディ（XMLの場合）
<?xml version="1.0" encoding="UTF-8" ?> <Parameter> <UserDescription>csciwuser</UserDescription> <ProcessInstanceID>3315</ProcessInstanceID> <AdHocSubProcessID>AdHocSub1</AdHocSubProcessID> <AdHocSubProcessName>AdHocSubProcess</AdHocSubProcessName> <StateCode>r</StateCode> </Parameter>
リクエストボディ（JSONの場合）
{
"UserDescription" : "csciwuser",
"ProcessInstanceID" : "3315",
"AdHocSubProcessID" : "AdHocSub1",
"AdHocSubProcessName" : "AdHocSubProces"
"StateCode" : "r"
}
レスポンス
レスポンスボディは空になります。
ステータスコード
|
項番 |
ステータスコード |
内容 |
|---|---|---|
|
1 |
204 |
成功 |
|
2 |
400 |
リクエストパラメタの不正 |
|
3 |
404 |
データが見つからなかった |
|
4 |
500 |
内部処理エラー |