11.5.10 案件の強制終了
指定したIDの案件を強制停止します。このAPIを実行すると，BPMN連携ライブラリ Java APIのCIWBPMNLib.terminatePIインタフェースが呼び出されます。案件が強制終了済みだった場合は，リクエストは成功します（何もしないでステータスコード200を返します）。詳細については，「5.3 Java API利用時の注意事項」の「べき等性について」の説明を参照してください。
メソッドとURL
PUT /v1/process-instance/<案件ID>/terminate
<案件ID>：強制停止する案件のID（必須）
リクエストボディ
項番 |
名前 |
型 |
指定要否 |
内容 |
|---|---|---|---|---|
1 |
UserDescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
リクエストボディの構造を次に示します。UserDescriptionを省略する場合は，リクエストボディを省略できます。リクエストボディを省略するときは，HTTPヘッダのContent-Typeを指定しないでください。
項番 |
名前 |
出現回数 |
|
|---|---|---|---|
1 |
Parameter |
1 |
|
2 |
UserDescription |
0または1 |
|
リクエスト例
リクエストURL
PUT http://restserver/csciwws/v1/process-instance/2034/terminate
レスポンス
強制停止した案件を返します。案件のプロパティを次に示します。
項番 |
名前 |
型 |
内容 |
|---|---|---|---|
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 |
ProcessInstance |
1 |
|
2 |
ClosedDate |
1 |
|
3 |
Creator |
1 |
|
4 |
Deadline |
1 |
|
5 |
ID |
1 |
|
6 |
MovedDate |
1 |
|
7 |
Name |
1 |
|
8 |
Priority |
1 |
|
9 |
ProcessDefinitionID |
1 |
|
10 |
ProcessDefinitionName |
1 |
|
11 |
StartDate |
1 |
|
12 |
StateCode |
1 |
|
ステータスコード
|
項番 |
ステータスコード |
内容 |
|---|---|---|
|
1 |
200 |
成功 |
|
2 |
400 |
リクエストパラメタの不正 |
|
3 |
404 |
データが見つからなかった |
|
4 |
500 |
内部処理エラー |
レスポンス例
レスポンス（XMLの場合）
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ProcessInstance> <ClosedDate>2016-12-15T12:16:19+09:00</ClosedDate> <Creator>csciwuser</Creator> <Deadline>2017-01-01T00:00:00+09:00</Deadline> <ID>2034</ID> <MovedDate></MovedDate> <Name>案件A</Name> <Priority>10</Priority> <ProcessDefinitionID>3002</ProcessDefinitionID> <ProcessDefinitionName>販売業務</ProcessDefinitionName> <StartDate>2016-12-15T11:50:51+09:00</StartDate> <StateCode>u</StateCode> </ProcessInstance>
レスポンス（JSONの場合）
{
"ClosedDate" : "2016-12-15T12:16:19+09:00",
"Creator" : "csciwuser",
"Deadline" : "2017-01-01T00:00:00+09:00",
"ID" : "2034",
"MovedDate" : "",
"Name" : "案件A",
"Priority" : "10",
"ProcessDefinitionID" : "3002",
"ProcessDefinitionName" : "販売業務",
"StartDate" : "2016-12-15T11:50:51+09:00",
"StateCode" : "u"
}