Oracle Analytics ServerのためのREST API

システム設定の更新

put

/api/20210901/system/settings

1つ以上のシステム設定を有効なキーおよび値で更新します。

リクエスト

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

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

application/json

ルート・スキーマ: schema

Type: object

ソースを表示

items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UpdateSettingsDetails"
            }
        }
    }
}

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

Type: array

ソースを表示

Array of: object UpdateSettingsDetails

設定更新ペイロードを表すオブジェクト。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UpdateSettingsDetails"
    }
}

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

Type: object

設定更新ペイロードを表すオブジェクト。

ソースを表示

key(必須): string
value(必須): string

{
    "description":"An object representing the settings update payload.",
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "required":[
        "key",
        "value"
    ]
}

先頭に戻る

レスポンス

200レスポンス

成功した操作。

400レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

401レスポンス

未承認(資格情報の欠落や期限切れなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403レスポンス

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

409レスポンス

競合(操作によって制約違反が発生し、操作が現在の状態と互換性がないなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500レスポンス

内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

先頭に戻る

例

これらの例は、Oracle Analytics Serverで1つ以上のシステム設定を更新する方法を示しています。

例1 - JSONファイルを使用したシステム設定の更新
例2 - システム設定の直接更新

例1 JSONファイルを使用したシステム設定の更新

この例では、Oracle Analytics Serverから送信される電子メールのサイズ(KB)と電子メール受信者の数を制限します。この動作を制御するシステム設定は、「最大電子メール・サイズ(KB)」および「電子メール当たりの最大受信者数」です。これらの設定のREST APIキーは、EmailMaxEmailSizeKBおよびEmailMaxRecipientsです。

cURLの例

まず、更新するシステム設定のREST APIキー値を取得します。システム設定のREST APIキーを参照してください。

次に、更新するシステム設定とその新しい値を含むJSONファイルを作成します。たとえば、「最大電子メール・サイズ(KB)」および「電子メール当たりの最大受信者数」を更新する場合は、次のようなペイロードを持つupdate_system_settings.jsonというJSONファイルを作成します。

{
     "items":[               
       {                   
         "key": "EmailMaxRecipients",                   
         "value": "512"               
       },               
       {                   
         "key": "EmailMaxEmailSizeKB",                   
         "value": "10240"               
       }           
      ]
 }

単一の設定を更新する場合、ペイロードは次のようになります。

{
     "items":[               
       {                   
         "key": "EmailMaxRecipients",                   
         "value": "512"               
       }           
      ]
 }

JSONファイルをコールするcURLコマンドを実行します(たとえば、update_system_settings.json)。

curl -i \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --request PUT 'https://<hostname>/api/20210901/system/settings' \
  --data @update_system_settings.json

レスポンス・ヘッダーの例

適用不可。

レスポンス本文の例

成功すると、レスポンス本文で200レスポンス・コードが返されます。たとえば:

Status 200

例2 システム設定の直接更新

この例では、システム設定「電子メール当たりの最大受信者数」を使用して、電子メール受信者の数を制限します。この設定のREST APIキーはEmailMaxRecipientsです。

cURLの例

まず、更新するシステム設定のREST APIキー値を取得します。システム設定のREST APIキーを参照してください。

単一の設定を更新する場合、ペイロードは次のようになります。

{
     "items":[               
       {                   
         "key": "EmailMaxRecipients",                   
         "value": "512"               
       }           
      ]
 }

cURLコマンドを実行します。

curl -i \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --request PUT 'https://<hostname>/api/20210901/system/settings' \
  --data '{"items":[ {   \                
         "key": "EmailMaxRecipients",  \                 
         "value": "512"   \         
       } ] }'

レスポンス・ヘッダーの例

適用不可。

レスポンス本文の例

成功すると、レスポンス本文で200レスポンス・コードが返されます。たとえば:

Status 200

先頭に戻る