Oracle Essbase REST API

設定の更新

patch

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

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

リクエスト

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

application/json
application/xml

パス・パラメータ

applicationName(required): string

アプリケーション名。
databaseName(required): string

データベース名。

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

ルート・スキーマ : schema

型: array

ソースの表示

配列: object PatchElement

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

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

型: object

ソースの表示

from: string
op: string

パッチ適用操作。例: replace。
path: string

パッチを適用する設定へのパス。例を参照してください。
value: 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コマンドを含むスクリプト

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

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

サンプルのJSONペイロード

前述のcURLの例では、次のJSONペイロードがdbsettings.jsonで配信されます。

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

結果の例

更新の実行後に、一般設定の取得を使用して変更内容を表示できます。

{
  "general": {
    "description": "Cube for query tracking",
    "queryTracking": true
  },
  "links": [ ]
}

データベース設定へのパッチ適用のためのその他の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
  }
]

先頭に戻る