OAAランタイムAPI

ユーザー・プリファレンスが切り捨てられる。

put

/oaa/runtime/preferences/v1/truncateuserpreferencessecurely

ユーザー・プリファレンスを切り捨てる。このAPIは、ユーザーのプリファレンスを切り捨てます。OAAシステムからユーザーが実際に削除されることはありません。

リクエスト

この操作にはリクエスト・パラメータはありません。

先頭に戻る

レスポンス

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

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レスポンス

サービス使用不可

先頭に戻る

例

次の例は、ユーザーのチャレンジ・プリファレンスを切り捨てるためのリクエストとレスポンスのサンプルを示しています。

JSON形式でチャレンジ・プリファレンスを切り捨てるcURLコマンド

curl --location --request PUT '<OAAService>/oaa/runtime/preferences/v1/truncateuserpreferencessecurely' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "userId": "testuser4",
    "groupId": "testfinanceapp4"
}'

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

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

XML形式でチャレンジ・プリファレンスを切り捨てるcURLコマンド

curl --location --request PUT '<OAAService>/oaa/runtime/preferences/v1/truncateuserpreferencessecurely' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <PrefTruncateRequest>
     <userId>testuser4</userId>
     <groupId>testfinanceapp4</groupId>
 </PrefTruncateRequest>
'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <PrefAPIResponse
     <responseCode>202</responseCode>
     <responseMessage>Deletion is complete</responseMessage>
 </PrefAPIResponse

先頭に戻る