移動先

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

属性設定の取得

get

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

指定されたデータベースからアウトラインの属性設定を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

問合せパラメータ

• applicationNameForConnection: string

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

• connectionName: string

  Essbase接続名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

属性の設定が正常に返されました。

本体()

ルート・スキーマ : attributes

型: object

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

ソースの表示

• calcAverageMember: string

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

• calcCountMember: string

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

• calcDimensionName: string

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

• calcMaximumMember: string

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

• calcMinimumMember: string

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

• calcSumMember: string

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

• dateMemberNames: string

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

• falseMemberName: string

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

• numericRangesRepresent: string

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

• prefixSuffixFormat: string

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

• prefixSuffixSeparator: string

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

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

  値: NONE、PARENT、GRANDANDPARENT、ALLANCESTORS、DIMENSION

• trueMemberName: string

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

{
    "type":"object",
    "description":"<p>Specifications for handling member names in attribute dimensions.</p>",
    "properties":{
        "prefixSuffixValue":{
            "type":"string",
            "description":"A prefix or suffix value to use for attribute member names as needed to support member name uniqueness. <p>Values: <code>NONE</code>, <code>PARENT</code>, <code>GRANDANDPARENT</code>, <code>ALLANCESTORS</code>, <code>DIMENSION</code></p>"
        },
        "prefixSuffixSeparator":{
            "type":"string",
            "description":"<p>Separator character between the prefix or suffix and the attribute member name. Values: <code>UNDERSCORE</code>, <code>PIPE</code>, <code>CARET</code></p>"
        },
        "prefixSuffixFormat":{
            "type":"string",
            "description":"<p>If unique names are required for member names in Boolean, date, and numeric attribute dimensions in the outline, set <i>prefixSuffixValue</i> to something other than NONE and set this value to select a prefix or a suffix. Values: <code>PREFIX</code> or <code>SUFFIX</code>.</p>"
        },
        "trueMemberName":{
            "type":"string",
            "description":"<p>Name for True members in Boolean attribute dimensions.</p>"
        },
        "falseMemberName":{
            "type":"string",
            "description":"<p>Name for False members in Boolean attribute dimensions.</p>"
        },
        "dateMemberNames":{
            "type":"string",
            "description":"<p>Date member format in attribute dimensions. Values: <code>MMDDYYYY</code> for Month first or <code>DDMMYYYY</code> for day first.</p>"
        },
        "numericRangesRepresent":{
            "type":"string",
            "description":"<p>Date range setting for numeric attribute dimensions. Values: <code>UPPER_BOUND_INCLUSIVE</code>, <code>LOWER_BOUND_INCLUSIVE</code>, <code>UPPER_BOUND_NON_INCLUSIVE</code>, <code>LOWER_BOUND_NON_INCLUSIVE</code> </p>"
        },
        "calcDimensionName":{
            "type":"string",
            "description":"<p>The name of the attribute calculations dimension.</p>"
        },
        "calcSumMember":{
            "type":"string",
            "description":"<p>In an attribute calculations dimension, the name to use when requesting sum data.</p>"
        },
        "calcCountMember":{
            "type":"string",
            "description":"<p>In an attribute calculations dimension, the name to use when requesting count data.</p>"
        },
        "calcMinimumMember":{
            "type":"string",
            "description":"<p>In an attribute calculations dimension, the name to use when requesting minimum data.</p>"
        },
        "calcMaximumMember":{
            "type":"string",
            "description":"<p>In an attribute calculations dimension, the name to use when requesting maximum data.</p>"
        },
        "calcAverageMember":{
            "type":"string",
            "description":"<p>In an attribute calculations dimension, the name to use when requesting average data.</p>"
        }
    },
    "xml":{
        "name":"attributes"
    }
}

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/attributes" -H "accept: application/json"-u %User%:%Password%

レスポンス本体の例

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

先頭に戻る