移動先

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

アウトライン設定の更新

patch

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

指定されたデータベースのアウトライン設定を更新します。この操作には容量が制限されています。アウトライン更新オプションの詳細は、「バッチ・アウトライン編集の実行」のAPIのotlUpdateアクションを参照してください。

リクエスト

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

• 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 レスポンス

OK

アウトラインの設定が正常に更新されました。

400 レスポンス

不正なリクエスト

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

415 レスポンス

受入れできません

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

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、キューブのアウトライン設定を更新する方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

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

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

サンプルのJSONペイロード

前述のcURLの例では、一般的なアウトライン設定の日付書式を更新するために、次のJSONペイロードをotlgeneraldate.jsonで提供しています。

[
  {"op":"replace", "path":"/general/dateFormat", "value": "dd/mm/yy"}
]

先頭に戻る