DELETE/inventory

これは、LiftIgniterの[inventory]から指定したコンテンツを削除する[DELETE]リクエストです。

定義

ドキュメント

📘

コンテンツの特定

DELETEの処理を行う上では、バージョン番号は必要ありません。

inventoryIdFieldとしてurl以外のフィールドを使用している場合は、urlの代わりにそのフィールドを含める必要があります。DELETEの処理では、このフィールド以外のフィールドはすべて無視されます。もし inventoryIdFieldが存在しない場合や、その値がインベントリに存在するアイテムに合致するものがない場合は、何も処理が行われません。

DELETEのリクエストに対するレスポンスには、 inventoryIdFieldの情報が含まれます。

🚧

DELETEの処理において指定される正規表現(regex)はありません

各組織のインベントリ設定には正規表現(regex)がありますが、この正規表現(regex)は書き込みの処理の際のみ確認を行い、DELETE処理の際には使用されません。これは、アイテムを削除する前に正規表現(regex)を変更することができるようにして、新しい正規表現(regex)に合致しないアイテムを削除できるようにするためです。

🚧

存在しないアイテムに対しても、DELETEのリクエストをマークすることができます。

DELETEリクエストが送信されても、APIはそのアイテムが存在するかどうかを確認しません。その代わりに単純にそのアイテムをDELETEの処理対象にマークします。もしアイテムが存在しない場合は何も処理が行われず、アイテムが存在する場合はDELETE処理が行われます。

この仕組の主な利点は、大量のアイテムに対してDELETEのコマンドを送ることができるようになり、送られたリストからアイテムの存在確認を都度行わずに即時でリクエストを受け取りることができるようになることです。

DELETEのリクエストを送る前に、インベントリGETエンドポイントを使用して、アイテムの存在確認を行うことができます。

Language
Click Try It! to start a request and see the response here!