機械翻訳について

ジャンプ先

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

システム設定の取得

get

/api/20210901/system/settings

システム設定のリストを返します。

リクエスト

問合せパラメータ

• key: array[string]
  問い合せた設定のリストを返します。 省略すると、すべての設定が返されます。
• pending: boolean
  trueの場合、まだ適用されていない、つまり保留中のシステム設定のリストを返します。 falseの場合、現在適用されているシステム設定のリストを返します。 pendingパラメータが定義されていない場合は、すべてのシステム設定が返されます。
• type: string
  オプション。 返すシステム設定のタイプ。`default`: デフォルト値、つまり変更されていない設定を含むシステム設定を返します。`updated`: カスタマイズされた値、つまり変更された設定を含むシステム設定を返します。

  指定できる値: [ "default", "updated" ]

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功した操作。

本文()

ルート・スキーマ: schema

Type: object

ソースを表示

• items: array items

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

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

Type: array

ソースを表示

• Array of: object Settings
  システムレベルのプロパティを表すオブジェクト。

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

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

Type: object

システムレベルのプロパティを表すオブジェクト。

ソースを表示

• displayName(必須): string
• pending(必須): boolean

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateSettingsDetails"
        }
    ],
    "description":"An object which represents a system-level property.",
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "pending":{
            "type":"boolean"
        }
    },
    "required":[
        "key",
        "displayName",
        "value",
        "pending"
    ]
}

すべてに一致

システムレベルのプロパティを表すオブジェクト。

ソースを表示

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UpdateSettingsDetails"
        }
    ],
    "description":"An object which represents a system-level property.",
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "pending":{
            "type":"boolean"
        }
    },
    "required":[
        "key",
        "displayName",
        "value",
        "pending"
    ]
}

ネストされたスキーマ: 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"
    ]
}

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"
    ]
}

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インスタンスの最新のシステム設定情報を取得する方法を示しています。

• 例1 - すべてのシステム設定とその現行値のリストの取得
• 例2 - システム設定の特定セットの現行値の取得
• 例3 - まだ適用されていないシステム設定のリストの取得

例1 すべてのシステム設定のリストの取得

この例では、すべてのシステム設定、その現在の値、およびそれらがまだ適用されているかどうかのリストを取得します。

cURLの例:

curl -i \
  --header 'Authorization: Bearer <token>' \
  --request GET 'https://<hostname>/api/20210901/system/settings'

リクエスト本文の例

適用不可。

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

適用不可。

レスポンス本文の例

成功した場合、レスポンス本文には、次の構造を持つシステム設定の配列が含まれます。

{
 "items":[
   {
      "key":"String",
      "value":"String",
      "displayName":"String",
      "pending": Boolean 
   }
]

たとえば:

Status 200:

{
   "items":[
      {
         "key":"UserInactivityTimeout",
         "value":"60",
         "displayName":"User Inactivity Timeout (minutes)",
         "pending": true 
      },
      {...
      }
   ]
}

例2 システム設定の特定セットの現行値の取得

この例では、2つのシステム設定「接続外部化の有効化」および「HTML/JavaScript/CSSコンテンツの許可」に関する情報をリクエストします。 これらの設定のREST APIキーは、EnableConnectionExternalizationおよびAllowHTMLJavaScriptCSSContentです。

他のシステム設定のキー値を検索するには、「システム設定のREST APIキー」を参照してください。

cURLの例:

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

次に、必要なキー値を指定してこのcURLコマンドを実行します。

curl -i \
  --header 'Authorization: Bearer <token>' \
  --request GET 'https://<hostname>/api/20210901/system/settings?key=EnableConnectionExternalization&key=AllowHTMLJavaScriptCSSContent'

リクエスト本文の例

適用不可。

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

適用不可。

レスポンス本文の例

成功した場合、レスポンス本文には、次の構造を持つリクエストされたシステム設定の配列が含まれます。

たとえば:

Status 200:

{
   "items":[
      {
         "key":"EnableConnectionExternalization",
         "value":"true",
         "displayName":"Connection Externalization Enabled",
         "pending": true 
      },
      {
         "key":"AllowHTMLJavaScriptCSSContent",
         "value":"never",
         "displayName":"Allow HTML/JavaScript/CSS Content",
         "pending": false 
      }
   ]
}

例3 まだ適用されていないシステム設定のリストの取得

この例では、更新が進行中、つまり適用を待機している(pending=true)システム設定のリストをリクエストします。

cURLの例:

curl -i --header 'Authorization: Bearer <token>' --request GET 'https://<hostname>/api/20210901/system/settings?pending=true'

リクエスト本文の例

適用不可。

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

適用不可。

レスポンス本文の例

成功した場合、レスポンス本文には、pending値がtrueのシステム設定の配列が次の形式で含まれます。

{
 "items":[
   {
      "key":"String",
      "value":"String",
      "displayName":"String",
      "pending": true 
   }
]

たとえば:

Status 200:

{
   "items":[
      {
         "key":"UserInactivityTimeout",
         "value":"60",
         "displayName":"User Inactivity Timeout (minutes)",
         "pending": true 
      }
   ]
}

先頭に戻る