ジャンプ先

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

ロケールのテーマ・プロパティの作成/更新

put

/oaa-drss/v1/themes/{locale}

ロケールのテーマ・プロパティを作成または更新します。存在しないプロパティが作成されます。

リクエスト

パス・パラメータ

• locale(required): string
  テーマのロケール

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

• application/xml
• application/json

リクエスト本文 - application/xml ()

ルート・スキーマ: schema

型: object

ソースを表示

• properties(required): object ThemeProperties
  テーマ・プロパティのキーと値のペア
• status(required): integer
  指定できる値: [ 0, 1 ]

  テーマ・プロパティのステータス(アクティブの場合は1、非アクティブの場合は0)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"Status of the theme properties (1 for active, 0 for inactive)",
            "enum":[
                0,
                1
            ]
        },
        "properties":{
            "$ref":"#/components/schemas/ThemeProperties"
        }
    },
    "required":[
        "status",
        "properties"
    ]
}

ネストされたスキーマ: ThemeProperties

型: object

テーマ・プロパティのキーと値のペア

ソースを表示

• CPFT_COMMAND_LINK_FORGOT_PASSWORD: string
  例: Forgot password
• CPFT_COMMAND_LINK_LOGIN_WITH_PASSWORD: string
  例: Login with password

{
    "type":"object",
    "description":"Key-value pairs of theme properties",
    "properties":{
        "CPFT_COMMAND_LINK_LOGIN_WITH_PASSWORD":{
            "type":"string",
            "example":"Login with password"
        },
        "CPFT_COMMAND_LINK_FORGOT_PASSWORD":{
            "type":"string",
            "example":"Forgot password"
        }
    }
}

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

ソースを表示

• properties(required): object ThemeProperties
  テーマ・プロパティのキーと値のペア
• status(required): integer
  指定できる値: [ 0, 1 ]

  テーマ・プロパティのステータス(アクティブの場合は1、非アクティブの場合は0)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"Status of the theme properties (1 for active, 0 for inactive)",
            "enum":[
                0,
                1
            ]
        },
        "properties":{
            "$ref":"#/components/schemas/ThemeProperties"
        }
    },
    "required":[
        "status",
        "properties"
    ]
}

ネストされたスキーマ: ThemeProperties

型: object

テーマ・プロパティのキーと値のペア

ソースを表示

• CPFT_COMMAND_LINK_FORGOT_PASSWORD: string
  例: Forgot password
• CPFT_COMMAND_LINK_LOGIN_WITH_PASSWORD: string
  例: Login with password

{
    "type":"object",
    "description":"Key-value pairs of theme properties",
    "properties":{
        "CPFT_COMMAND_LINK_LOGIN_WITH_PASSWORD":{
            "type":"string",
            "example":"Login with password"
        },
        "CPFT_COMMAND_LINK_FORGOT_PASSWORD":{
            "type":"string",
            "example":"Forgot password"
        }
    }
}

先頭に戻る

レスポンス

204レスポンス

指定されたロケールのテーマ・プロパティを更新しました

400レスポンス

不正なリクエスト - 入力データまたはロケールが無効です

401レスポンス

未許可アクセス

404レスポンス

指定されたロケールのテーマが見つかりません

500レスポンス

内部サーバー・エラー

先頭に戻る

例

次の例は、ロケールのテーマを作成または更新するサンプルのリクエストとレスポンスを示します。

JSON形式でロケールのテーマを作成または更新するcURLコマンド

curl --location --request PUT '<DRSS>/v1/themes/en_US' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--header 'Content-Type: application/json' \
--data '{
    "status": 1,
    "properties": {
        "Logo": "Qk2KsAEAAAAAAIoAAAB8AAAAwAAAAMAAAAABABgAAAAAAetc..",
        "CPFT_TILE_IMAGE": "Login with Example Company Username",
        "CPFT_EDIT_TEXT_DEFAULT": "Example Company Username",
        "CPFT_PASSWORD_TEXT": "Example Company Password",
        "CPFT_SMALL_TEXT": "Choose a factor to login:",
        "CPFT_COMMAND_LINK_LOGIN_WITH_PASSWORD": "Login with your password",
        "CPFT_COMMAND_LINK_NOT_USER": "Click if Not",
        "CPFT_COMMAND_LINK_FORGOT_PASSWORD": "Forgot your password?",
        "CPFT_COMMAND_LINK_CHANGE_PASSWORD": "Change your password?",
        "CPFT_COMMAND_LINK_SIGN_IN_OPTION" : "Login with another factor",
        "OUACP_ERR_MSG_0000": "Example Company Universal Authenticator",
        "OUACP_ERR_MSG_0001": "Incorrect Microsoft Windows Credentials, please try again.",
        "OUACP_ERR_MSG_0002": "User access is denied. Please contact your administrator.",
        "OUACP_ERR_MSG_0004": "Did not receive approval from device. Please retry.",
        "OUACP_ERR_MSG_0006": "Password validation failed. Please retry.",
        "OUACP_ERR_MSG_0007": "The system is currently offline. Enter your password to proceed. Not all features will be available. To restore all features, please logout and login again when system is online.",
        "OUACP_ERR_MSG_0008": "The device for this user is blocked. Please contact your administrator.",
        "OUACP_ERR_MSG_0009": "Device is blocked for all users. Please contact your administrator."
    }
}'

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

204 コンテンツなし以外のレスポンスは返されません。

先頭に戻る