ジャンプ先

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

入力で指定された構成プロパティを作成または更新する。

put

/config/property/v1

作成または更新されたプロパティを返します。

リクエスト

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

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

• application/xml
• application/json

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

ルート・スキーマ: schema

型: array

オブジェクトは、構成プロパティを作成または更新するために使用されます。

ソースの表示

• 配列: object NameValPair
  一般的に使用できる名前と値のペア。

{
    "type":"array",
    "description":"The object is used to create or update Config Properties.",
    "items":{
        "$ref":"#/components/schemas/NameValPair"
    }
}

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

型: object

一般的に使用できる名前と値のペア。

ソースの表示

• name(required): string
  プロパティ名。
• value(required): string
  プロパティ値の文字列。

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Property name."
        },
        "value":{
            "type":"string",
            "description":"Property Value String."
        }
    },
    "description":"Name-value pair which can be used generically."
}

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

ルート・スキーマ: schema

型: array

オブジェクトは、構成プロパティを作成または更新するために使用されます。

ソースの表示

• 配列: object NameValPair
  一般的に使用できる名前と値のペア。

{
    "type":"array",
    "description":"The object is used to create or update Config Properties.",
    "items":{
        "$ref":"#/components/schemas/NameValPair"
    }
}

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

型: object

一般的に使用できる名前と値のペア。

ソースの表示

• name(required): string
  プロパティ名。
• value(required): string
  プロパティ値の文字列。

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Property name."
        },
        "value":{
            "type":"string",
            "description":"Property Value String."
        }
    },
    "description":"Name-value pair which can be used generically."
}

先頭に戻る

レスポンス

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

• application/xml
• application/json

200レスポンス

成功

本文()

ルート・スキーマ: ConfigPropertiesResponse

型: array

APIから返された構成プロパティが含まれます。

ソースの表示

• 配列: object NameValSource
  プロパティの名前、値およびソース。

{
    "type":"array",
    "description":"Contains Congfig Properties that are returned from API.",
    "items":{
        "$ref":"#/components/schemas/NameValSource"
    }
}

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

型: object

プロパティの名前、値およびソース。

ソースの表示

• name(required): string
  プロパティ名。
• source(required): string
  プロパティのロード元の場所。これは、ファイル(サービス実装の製品ファイル)、環境(サービスが実行されている場所)またはデータベース(サービスで使用される永続ストア)のいずれかです。
• value(required): string
  プロパティ値の文字列。

{
    "required":[
        "name",
        "source",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Property name."
        },
        "value":{
            "type":"string",
            "description":"Property Value String."
        },
        "source":{
            "type":"string",
            "description":"Where is property loaded from. This can be file(product files of service implementation), environment(where service is running)  or database(persistent store used by the service)."
        }
    },
    "description":"Name-value and source of the property."
}

406レスポンス

不正なデータ

本文()

ルート・スキーマ: ConfigAPIResponse

型: object

ソースの表示

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

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

先頭に戻る

例

次の例は、入力で指定された構成プロパティを作成または更新するサンプルのリクエストとレスポンスを示します。

JSON形式で構成プロパティを作成および更新するcURLコマンド

curl --location --request PUT '<OAAService>/policy/config/property/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '[
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress",
        "value": "[e-mail]"
    }
]’

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

[
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress",
        "value": "[e-mail]",
        "source": "database"
    }
]

XML形式で構成プロパティを作成および更新するcURLコマンド

curl --location --request PUT '<OAAService>/policy/config/property/v1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
<List>
    <NameValPair>
        <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress</name>
        <value>[e-mail]</value>
    </NameValPair>
</List>'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConfigPropertiesResponse>
    <NameValSource>
        <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress</name>
        <value>[e-mail]</value>
        <source>database</source>
    </NameValSource>
</ConfigPropertiesResponse>

先頭に戻る