2.5.7 データ削除API

データ基盤に格納されたデータを削除するWeb APIです。

本APIはシステム管理者が使用することを想定しています。

データ検索API等で取得した伝票データIDを用いることで削除したいデータを指定します。

以下の場合、データ削除APIはエラーレスポンスを返します。

指定した伝票データIDがデータ基盤内に存在しない場合
削除が異常終了した場合
処理がタイムアウトした場合

2.5.7.2 リクエスト設計

2.5.7.2.1 リクエストフォーマット

項目		値		備考
APIエンドポイント (相対URI)		/delete/{ticket_id}
クエリパラメータ	なし
HTTPメソッド		DELETE
HTTPリクエストヘッダ	Authorization	任意	Bearer {token}	使用する認証サービスのユーザー認証用トークンを指定します

例）

curl -i -s  http://<開発実行環境サーバのIPアドレス>:<ポート番号(注)>/delete/01234567890123456789 -X DELETE

注)インベントリファイルのapi_tomcat_portに設定した値を指定

参照

Apache Tomcatに配備されたAPIエンドポイント(相対URI)は、Apache Tomcatの設定により異なります。

Apache Tomcatに配備されたAPIエンドポイント(相対URI)の確認方法については、“Apache Tomcatのオンラインマニュアル”などを参照してください。

2.5.7.3 レスポンス設計

2.5.7.3.1 レスポンスフォーマット

項目		値	備考
HTTPステータス		int(3桁)	正常時204、異常時は後述
HTTPレスポンスヘッダ	X-Request-Id	リクエストID	リクエストを一意に示す値
	X-Frame-Options	DENY
	X-Content-Type-Options	nosniff
	X-XSS-Protection	1; mode=block
	Date	日付
HTTPレスポンスボディ	なし

例）

HTTP/1.1 204
X-Request-Id: eddfd6da-3819-4102-8af3-0763936bc82
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Date: Thu, 27 Jan 2022 10:20:58 GMT

2.5.7.3.2 HTTPステータスコード

HTTPステータスコード	メッセージ	利用場面
204	No Content	リクエストの処理に成功した
404	Not Found	サーバがリクエストされたリソースを発見できない
408	Request Time-out	リクエストがタイムアウトした
500	Internal Server Error	APIで障害が発生した
503	Service Unavailable	APIが一時的に処理を行うことができない

2.5.7.4 メッセージボディ

HTTPステータスコード	メッセージボディ
204	なし
400/500番台	エラーコードと説明文を表示

2.5.7.5 エラーメッセージ

形式

分類	内容
code	エラーの詳細な種類（HTTPステータスコードではない）
message	エラーメッセージ本文

例）

HTTP/1.1 503
X-Request-Id: 18b3f055-ac65-4030-b14f-42f08bd496f1
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Wed, 02 Mar 2022 08:22:35 GMT
Connection: close

{"error_codes":[{"code":"303","message":"Service unavailable"}]}

エラーリスト

HTTPステータスコード	エラーコード	内容
401	201	認証用トークンによる認証に失敗した
403	202	アクセスが許可されていないユーザーのアクセスによる認可エラー
404	203	存在しない伝票データにアクセスした
408	204	データへのアクセスがタイムアウトした
500	301	予期せぬエラーが発生した場合
503	303	API側の不具合によるエラー

2.5.7 データ削除API

2.5.7.1 概要

2.5.7.2 リクエスト設計

2.5.7.2.1 リクエストフォーマット

2.5.7.3 レスポンス設計

2.5.7.3.1 レスポンスフォーマット

2.5.7.3.2 HTTPステータスコード

2.5.7.4 メッセージボディ

2.5.7.5 エラーメッセージ

2.5.7.6 キャッシュ

2.5.7.7 注意事項