ジャンプ先

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

非推奨 - ユーザー・プリファレンスが削除される。

delete

/oaa/runtime/preferences/v1

非推奨。deleteuserpreferencessecurely APIを使用してください。このAPIによって、特定のユーザーIDおよびグループに対するユーザーのプリファレンスが削除されます

リクエスト

問合せパラメータ

• devicename: string
  factorkeyに関連付けられたユーザー・プリファレンスで削除されるデバイスの名前。これはオプションのフィールドで、このパラメータを指定する場合はfactorykeyも必要です。
• factorkey: string
  ユーザー・プリファレンスで削除するファクタ・キー。これはオプション・フィールドです。フィールドがない場合は、ユーザー・プロファイル内のすべてのファクタが削除されます。
• groupId: string
  プリファレンス・データを削除するユーザーのGroupId/ApplicationId。このパラメータが存在しない場合は、Defaultという値が使用されます。
• uniqueUserId: string
  外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
• userId(required): string
  プリファレンス・データを削除するユーザーのuserIdまたはloginId。

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

先頭に戻る

レスポンス

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

• application/xml
• application/json
• text/plain

201レスポンス

ユーザー・プリファレンスが削除されました。

本文()

ルート・スキーマ: PrefAPIResponse

型: object

ソースの表示

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

401レスポンス

未認可

412レスポンス

無効な入力

本文()

ルート・スキーマ: PrefAPIResponse

型: object

ソースの表示

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

次の例は、ユーザーのプリファレンスを削除するサンプルのリクエストとレスポンスを示します。OAAシステムからユーザーが実際に削除されることはありません。プリファレンスを削除したユーザーは、プリファレンスの作成(POST操作)を再度起動できません。かわりに、プリファレンスの更新を使用する必要があります。

JSON形式でユーザーのプリファレンスを削除するcURLコマンド

curl --location --request DELETE '<OAAService>/oaa/runtime/preferences/v1?userId=testuser1&groupId=default \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

JSON形式のサンプル・レスポンス

{
    "responseCode": "202",
    "responseMessage": "Deletion is complete"
}

先頭に戻る