ジャンプ先

• リクエスト
• レスポンス

入力で指定された構成プロパティを削除する。

delete

/config/property/v1

削除するプロパティが存在するかどうかにかかわらず、200レスポンスが返されます。入力に構成プロパティが指定されていない場合、構成プロパティでは何も変更されず、200レスポンスが返されます。削除できるのは、永続ストアに格納されているプロパティのみです。製品ファイルおよび製品環境をソースとするプロパティは、このAPIを使用して削除できません。このAPIはAPIレスポンスを返します。APIレスポンスには、すべての場合に空のプロパティ配列が含まれています。

リクエスト

問合せパラメータ

• propertyName(required): string
  削除するプロパティ名。可能な場合は、入力と完全に一致する名前のプロパティが削除されます。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/xml
• application/json

200レスポンス

成功

本文()

ルート・スキーマ: ConfigAPIResponse

型: object

ソースの表示

• responseCode(required): string
• responseMessage(required): string

{
    "required":[
        "responseCode",
        "responseMessage"
    ],
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

406レスポンス

不正なデータ

本文()

ルート・スキーマ: ConfigAPIResponse

型: object

ソースの表示

• responseCode(required): string
• responseMessage(required): string

{
    "required":[
        "responseCode",
        "responseMessage"
    ],
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

先頭に戻る