1. Oracle EssbaseのREST API
  2. タスク
  3. データベースの設定および統計

アウトライン設定の取得

get

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

指定されたデータベースのアウトライン設定を返します。expandパラメータを使用するとその他の設定を取得できます。

リクエスト

パス・パラメータ
問合せパラメータ

  • 接続のアプリケーション名。

  • Essbase接続名。

  • 一般アウトライン設定のみを表示するには(これがデフォルト)、noneを使用します。使用可能なその他のオプションとしては、attributeとallがあります。

    デフォルト値: none
    指定可能な値: [ "none", "attributes", "all" ]
先頭に戻る

レスポンス

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

200 レスポンス

OK

データベース・アウトライン設定が正常に返されました。拡張設定を取得するためのリンクが含まれています。

本体()
ルート・スキーマ : outlineSettings
型: object
ソースの表示
ネストされたスキーマ : attributes
型: object

属性ディメンションのメンバー名を処理するための指定。

ソースの表示

  • 属性計算ディメンションにおいて、平均データをリクエストするときに使用する名前。

  • 属性計算ディメンションにおいて、カウント・データをリクエストするときに使用する名前。

  • 属性計算ディメンションの名前。

  • 属性計算ディメンションにおいて、最大データをリクエストするときに使用する名前。

  • 属性計算ディメンションにおいて、最小データをリクエストするときに使用する名前。

  • 属性計算ディメンションにおいて、合計データをリクエストするときに使用する名前。

  • 属性ディメンションの日付メンバー・フォーマット。値: 月が先頭の場合はMMDDYYYY、日が先頭の場合はDDMMYYYY。

  • ブール属性ディメンションのFalseメンバーの名前。

  • 数値属性ディメンションの日付範囲設定。値: UPPER_BOUND_INCLUSIVE、LOWER_BOUND_INCLUSIVE、UPPER_BOUND_NON_INCLUSIVE、LOWER_BOUND_NON_INCLUSIVE

  • アウトラインのブール、日付および数値属性ディメンションのメンバー名に一意の名前が必要な場合は、prefixSuffixValueをNONE以外に設定し、この値を設定して接頭辞または接尾辞を選択します。値: PREFIXまたはSUFFIX。

  • 接頭辞または接尾辞と属性メンバー名の間の区切り文字。値: UNDERSCORE、PIPE、CARET

  • メンバー名の一意性をサポートするために、必要に応じて属性メンバー名に使用する接頭辞または接尾辞の値。

    値: NONE、PARENT、GRANDANDPARENT、ALLANCESTORS、DIMENSION

  • ブール属性ディメンションのTrueメンバーの名前。

ネストされたスキーマ : general
型: object
ソースの表示

400 レスポンス

不正なリクエスト

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

500 レスポンス

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

先頭に戻る

例

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

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/settings/outline?expand=all" -H "accept: application/json"-u %User%:%Password%

レスポンス本体の例

{
  "general": {
    "caseSensitiveMembers": false,
    "outlineType": "NORMAL",
    "allowDuplicateMemberNames": false,
    "typeMeasuresEnabled": true,
    "dateFormat": "yyyy-mm-dd",
    "varyingAttributesEnabled": false,
    "timeModified": 1586286662000
  },
  "attributes": {
    "prefixSuffixValue": "Parent",
    "prefixSuffixSeparator": "Underscore",
    "prefixSuffixFormat": "Prefix",
    "trueMemberName": "True",
    "falseMemberName": "False",
    "dateMemberNames": "Month First (mm-dd-yyyy)",
    "numericRangesRepresent": "Upper bound inclusive",
    "calcDimensionName": "Attribute Calculations",
    "calcSumMember": "Sum",
    "calcCountMember": "Count",
    "calcMinimumMember": "Min",
    "calcMaximumMember": "Max",
    "calcAverageMember": "Avg"
  },
  "links": [
    {
      "rel": "dateformats",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/settings/outline/dateformats",
      "method": "GET"
    },
    {
      "rel": "edit",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/settings/outline",
      "method": "PATCH"
    }
  ]
}
先頭に戻る