アウトライン設定の取得
get
/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings/outline
指定されたデータベースのアウトライン設定を戻します。 追加設定は、expand
パラメータを使用して取得できます。
要求
パス・パラメータ
- applicationName: string
アプリケーション名
- databaseName: string
データベース名
問合せパラメータ
- expand(optional): string
none
を使用して、一般的なアウトライン設定のみを表示します(これがデフォルトです)。 使用可能なその他のオプションは、attribute
およびall
です。デフォルト値:none
許可される値:[ "none", "attributes", "all" ]
レスポンス
サポートされるメディア・タイプ
- application/json
- application/xml
200 レスポンス
OK
データベース・アウトライン設定が、展開された設定を取得するためのリンクとともに正常に返されました。
ネストされたスキーマ : attributes
タイプ:
Show Source
object
- calcAverageMember(optional): string
- calcCountMember(optional): string
- calcDimensionName(optional): string
- calcMaximumMember(optional): string
- calcMinimumMember(optional): string
- calcSumMember(optional): string
- dateMemberNames(optional): string
- falseMemberName(optional): string
- numericRangesRepresent(optional): string
- prefixSuffixFormat(optional): string
- prefixSuffixSeparator(optional): string
- prefixSuffixValue(optional): string
- trueMemberName(optional): string
400 レスポンス
不正なリクエスト
設定の取得に失敗しました。 アプリケーション名またはデータベース名が正しくない可能性があります。
500 レスポンス
内部サーバー・エラー。
例
次の例は、cURLを使用してWindowsシェル・スクリプトからREST APIにアクセスし、キューブのアウトライン設定を取得する方法を示しています。
コール元のユーザーIDおよびパスワードは、properties.bat
で値が設定される変数です。
cURLコマンドを含むスクリプト
call properties.bat
curl -X GET "https://192.0.2.1:443/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://192.0.2.1:443/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/settings/outline/dateformats",
"method": "GET"
},
{
"rel": "edit",
"href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/settings/outline",
"method": "PATCH"
}
]
}