Oracle EssbaseのREST API

機械翻訳について

設定の更新

patch

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings

指定したデータベースの設定を更新します。

要求

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

application/json
application/xml

パス・パラメータ

applicationName: string

アプリケーション名
databaseName: string

データベース名

データベース設定パッチ・リスト。

ルート・スキーマ : schema

タイプ: array

Show Source

Array of: object PatchElement

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PatchElement"
    }
}

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

タイプ: object

Show Source

from(optional): string
op(optional): string

パッチ操作。例: replace。
path(optional): string

パッチを適用する設定へのパス。例を参照してください。
value(optional): object value

パッチを適用する設定の新しい値。例を参照してください。

{
    "type":"object",
    "properties":{
        "op":{
            "type":"string",
            "description":"<p>Patch operation. Example: <b>replace</b>.</p>"
        },
        "path":{
            "type":"string",
            "description":"<p>Path to setting you want to patch. See examples.</p>"
        },
        "value":{
            "type":"object",
            "description":"<p>New value of setting you want to patch. See examples.</p>"
        },
        "from":{
            "type":"string"
        }
    }
}

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

タイプ: object

パッチを適用する設定の新しい値。例を参照してください。

先頭に戻る

レスポンス

204 レスポンス

設定は正常に更新されました。

400 レスポンス

不正なリクエスト

設定の更新に失敗しました。アプリケーション名またはデータベース名が正しくないか、設定のJSONが正しくない可能性があります。

415 レスポンス

受入れ不可

メディア・タイプがサポートされていないか、指定されていません。

500 レスポンス

内部サーバー・エラー。

先頭に戻る

例

次の例では、cURLを使用してWindowsシェル・スクリプトからREST APIにアクセスし、キューブの一般設定を更新する方法を示します。

コール元のユーザーIDおよびパスワードは、properties.batで値が設定される変数です。

cURLコマンドを含むスクリプト

-dataオプションを使用して、キューブの説明を更新し、問合せトラッキングを有効にするためのJSON本文パラメータを渡します(集約ストレージ・キューブでのみ使用可能)。

call properties.bat
curl -X PATCH "https://192.0.2.1:443/essbase/rest/v1/applications/ASOSamp/databases/Basic/settings"
     -H Accept:application/json 
     -H Content-Type:application/json 
     --data "@./dbsettings.json"
     -u %User%:%Password%

JSONファイルの内容(dbsettings.json):

[
  {
   "op":"replace", 
   "path":"/general/description",
   "value": "Cube for query tracking"
  },
  {
   "op":"replace",
   "path":"/general/queryTracking",
   "value": true
  }
]

結果の例

更新後、GET一般設定を使用して変更を確認できます:

{
  "general": {
    "description": "Cube for query tracking",
    "queryTracking": true
  },
  "links": [
    {
      "rel": "buffers",
      "href": "https://192.0.2.1:443/essbase/rest/v1/applications/ASOSamp/databases/Basic/settings/buffers",
      "method": "GET"
    },
    {
      "rel": "compression",
      "href": "https://192.0.2.1:443/essbase/rest/v1/applications/ASOSamp/databases/Basic/settings/compression",
      "method": "GET"
    },
    {
      "rel": "edit",
      "href": "https://192.0.2.1:443/essbase/rest/v1/applications/ASOSamp/databases/Basic/settings",
      "method": "PATCH"
    }
  ]
}

データベース設定にパッチを適用するためのその他のJSONオプションの例

次のキューブ設定パッチの例は、ブロック・ストレージ・キューブに適用できます。

[
  {
   "op":"replace", 
   "path":"/startup/startDatabaseWhenApplicationStarts",
   "value": false
  },  
  {
   "op":"replace", 
   "path":"/calculation/aggregateMissingValues",
   "value": false
  },
  {
   "op":"replace", 
   "path":"/buffers/dataRetrievalBufferSize",
   "value": 20500
  },
  {
   "op":"replace",
   "path":"/caches/dataCacheSetting",
   "value": 3150000
  },
  {
   "op":"replace",
   "path":"/transactions/concurrencyPreImageAccess",
   "value": false
  }
]

先頭に戻る