11.5.9 案件の削除
指定したIDの案件を削除します。このAPIを実行すると，BPMN連携ライブラリ Java APIのCIWBPMNLib.deletePIインタフェースが呼び出されます。案件が削除済みだった（削除対象の案件が存在しなかった）場合は，リクエストは成功します（何もしないでステータスコード204を返します）。詳細については，「5.3 Java API利用時の注意事項」の「べき等性について」の説明を参照してください。
メソッドとURL
DELETE /v1/process-instance/<案件ID>
<案件ID>：削除する案件のID（必須）
クエリパラメタ
|
項番 |
名前 |
型 |
指定要否 |
内容 |
|---|---|---|---|---|
|
1 |
userdescription |
文字列 |
省略可 |
ユーザ記述子を指定します。省略した場合はデフォルト値が指定されます。空文字列は指定できません。 |
リクエスト例
リクエストURL
DELETE http://restserver/csciwws/v1/process-instance/5005
レスポンス
レスポンスボディは空になります。
ステータスコード
|
項番 |
ステータスコード |
内容 |
|---|---|---|
|
1 |
204 |
成功 |
|
2 |
400 |
リクエストパラメタの不正 |
|
3 |
500 |
内部処理エラー |
レスポンス例
レスポンスボディは空になります。