ディメンション、子または検索の取得
get
/essbase/rest/v1/outline/{app}/{cube}
パラメータが指定されていない場合は、ディメンションのリストを返します。parentまたはparentUniqueNameパラメータが指定されている場合は、子メンバーのリストを返します。検索キーワード・パラメータが使用されている場合は、検索結果を返します。
リクエスト
パス・パラメータ
- app(required): string
アプリケーション名。
- cube(required): string
データベース名。
問合せパラメータ
- applicationNameForConnection: string
接続のアプリケーション名。
- connection: string
Essbase接続名。
- fields: string
フェッチするメンバー・プロパティのカンマ区切りリスト。
- isMbrId: string
親のID。
- keyword: string
メンバーを検索するためのキーワード。
- limit: integer(int32)
返される最大メンバー数。
デフォルト値:50 - matchWholeWord: boolean
メンバー名をキーワードと照合します。
デフォルト値:false - offset: integer(int32)
結果セットの先頭から省略するメンバーの数。
デフォルト値:0 - parent: string
親の名前。
- parentUniqueName: string
親の一意名(完全修飾)。
レスポンス
サポートされているメディア・タイプ
- application/json
- application/xml
200 レスポンス
OK
ディメンション、子または検索結果が正常に返されました。
ネストされたスキーマ : items
型:
object400 レスポンス
不正なリクエスト
メンバーまたは検索結果の取得に失敗しました。
500 レスポンス
サーバーの内部エラーです。
例
次の例では、Essbaseキューブ・アウトライン内のディメンションの取得、子の取得およびメンバーの検索を行う方法を示します。
この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。
Essbaseで表示されるメンバー情報の出力は、コンテキストに依存します。通常、デフォルトの情報は含まれていません。次に、メンバーの情報を問い合せたときに表示されない可能性のあるプロパティの例を示します。
- consolidation: メンバー集計演算子がデフォルトの加算(+)である場合は表示されません
- numberOfChildren: リーフレベルのメンバー(子のないメンバー)に対しては表示されません
- activeAliasName: 現在のセッションでデフォルト以外の別名表が使用されていない場合は表示されません
- attributeType: 属性ディメンション名であるメンバーに対してのみ表示されます
- shareMembers: ディメンション名のメンバーおよび属性に対しては表示されません。これらは共有メンバーのプロトタイプ・メンバーにできないためです。
- memberHasUniqueName: アウトラインが重複メンバー対応でない場合は表示されません
ディメンションの取得
cURLコマンドを含むスクリプト
次の例では、Essbaseキューブ・アウトライン内のディメンションを取得する方法を示します。
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/outline/Sample/Basic?links=none" -H Accept:application/json -H Content-Type:application/json -o output_dims.json -u %User%:%Password%レスポンス本体の例
次の情報がoutput_dims.jsonに書き込まれます。
{
"items": [
{
"name": "Year",
"numberOfChildren": 4,
"levelNumber": 2,
"aliases": {
"Long Names": null,
"ChineseNames": "not shown",
"JapaneseNames": "not shown",
"GermanNames": "Jahr",
"RussianNames": "not shown",
"Default": null
},
"uniqueName": "Year",
"memberId": "id__34",
"memberSolveOrder": 40,
"descendantsCount": 16,
"dimension": true,
"dimSolveOrder": 40,
"dimensionType": "TIME",
"dataStorageType": "DYNAMICCALC",
"formatString": null,
"dimStorageType": "DENSE"
},
{
"name": "Measures",
"numberOfChildren": 3,
"levelNumber": 3,
"aliases": {
"Long Names": null,
"ChineseNames": "not shown",
"JapaneseNames": "not shown",
"GermanNames": "not shown",
"RussianNames": "not shown",
"Default": null
},
"uniqueName": "Measures",
"memberId": "id__51",
"descendantsCount": 18,
"previousSiblingsCount": 1,
"dimension": true,
"account": true,
"dimSolveOrder": 30,
"dimensionType": "ACCOUNTS",
"dataStorageType": "LABELONLY",
"formatString": null,
"dimStorageType": "DENSE",
"currencyConversionCategory": ""
},
{
"name": "Product",
"numberOfChildren": 5,
"levelNumber": 2,
"aliases": {
"Long Names": null,
"ChineseNames": "not shown",
"JapaneseNames": "not shown",
"GermanNames": "Produkt",
"RussianNames": "not shown",
"Default": null
},
"uniqueName": "Product",
"memberId": "id__68",
"descendantsCount": 21,
"previousSiblingsCount": 2,
"dimension": true,
"dimSolveOrder": 10,
"associatedAttributes": [
{
"dimName": "Caffeinated",
"attributeValueAsString": "",
"attributeValue": false
},
{
"dimName": "Ounces",
"attributeValueAsString": "",
"attributeValue": 0.0
},
{
"dimName": "Pkg Type",
"attributeValueAsString": "",
"attributeValue": "Pkg Type"
},
{
"dimName": "Intro Date",
"attributeValueAsString": "",
"attributeValue": 0
}
],
"formatString": null,
"dimStorageType": "SPARSE"
},
{
"name": "Market",
"numberOfChildren": 4,
"levelNumber": 2,
"aliases": {
"Long Names": null,
"ChineseNames": "not shown",
"JapaneseNames": "not shown",
"GermanNames": "Markt",
"RussianNames": "not shown",
"Default": null
},
"uniqueName": "Market",
"memberId": "id__90",
"descendantsCount": 24,
"previousSiblingsCount": 3,
"dimension": true,
"dimSolveOrder": 10,
"allUdas": [
"Major Market",
"Small Market",
"New Market"
],
"associatedAttributes": [
{
"dimName": "Population",
"attributeValueAsString": "",
"attributeValue": 0.0
}
],
"formatString": null,
"dimStorageType": "SPARSE"
},
{
"name": "Scenario",
"numberOfChildren": 4,
"levelNumber": 1,
"aliases": {
"Long Names": null,
"ChineseNames": "not shown",
"JapaneseNames": "not shown",
"GermanNames": "Szenario",
"RussianNames": "not shown",
"Default": null
},
"uniqueName": "Scenario",
"memberId": "id__115",
"descendantsCount": 4,
"previousSiblingsCount": 4,
"dimension": true,
"dimSolveOrder": 50,
"dataStorageType": "LABELONLY",
"formatString": null,
"dimStorageType": "DENSE"
},
{
"name": "Caffeinated",
"numberOfChildren": 2,
"levelNumber": 1,
"aliases": {
"Long Names": null,
"ChineseNames": "not shown",
"JapaneseNames": "not shown",
"GermanNames": "Koffeinhaltig",
"RussianNames": "not shown",
"Default": null
},
"uniqueName": "Caffeinated",
"memberId": "id__31",
"memberSolveOrder": 90,
"descendantsCount": 2,
"previousSiblingsCount": 5,
"dimension": true,
"attribute": true,
"dimSolveOrder": 90,
"dimensionType": "ATTRIBUTE",
"attributeType": "BOOLEAN",
"associatedDimension": "Product",
"attributeAssocLevel": 0
},
{
"name": "Ounces",
"numberOfChildren": 4,
"levelNumber": 1,
"aliases": {
"Long Names": null,
"ChineseNames": "not shown",
"JapaneseNames": "not shown",
"GermanNames": "Unzen",
"RussianNames": "not shown",
"Default": null
},
"uniqueName": "Ounces",
"memberId": "id__26",
"memberSolveOrder": 90,
"descendantsCount": 4,
"previousSiblingsCount": 6,
"dimension": true,
"attribute": true,
"dimSolveOrder": 90,
"dimensionType": "ATTRIBUTE",
"attributeType": "NUMERIC",
"associatedDimension": "Product",
"attributeAssocLevel": 0
},
{
"name": "Pkg Type",
"numberOfChildren": 2,
"levelNumber": 1,
"aliases": {
"Long Names": null,
"ChineseNames": "not shown",
"JapaneseNames": "not shown",
"GermanNames": "Art der Verpackung",
"RussianNames": "not shown",
"Default": null
},
"uniqueName": "Pkg Type",
"memberId": "id__23",
"memberSolveOrder": 90,
"descendantsCount": 2,
"previousSiblingsCount": 7,
"dimension": true,
"attribute": true,
"dimSolveOrder": 90,
"dimensionType": "ATTRIBUTE",
"attributeType": "TEXT",
"associatedDimension": "Product",
"attributeAssocLevel": 0
},
{
"name": "Population",
"numberOfChildren": 3,
"levelNumber": 2,
"aliases": {
"Long Names": null,
"ChineseNames": "not shown",
"JapaneseNames": "not shown",
"GermanNames": "Einwohner",
"RussianNames": "not shown",
"Default": null
},
"uniqueName": "Population",
"memberId": "id__8",
"memberSolveOrder": 90,
"descendantsCount": 14,
"previousSiblingsCount": 8,
"dimension": true,
"attribute": true,
"dimSolveOrder": 90,
"dimensionType": "ATTRIBUTE",
"attributeType": "NUMERIC",
"associatedDimension": "Market",
"attributeAssocLevel": 0
},
{
"name": "Intro Date",
"numberOfChildren": 7,
"levelNumber": 1,
"aliases": {
"Long Names": null,
"ChineseNames": "not shown",
"JapaneseNames": "not shown",
"GermanNames": "not shown",
"RussianNames": "not shown",
"Default": null
},
"uniqueName": "Intro Date",
"memberId": "id__0",
"memberSolveOrder": 90,
"descendantsCount": 7,
"previousSiblingsCount": 9,
"dimension": true,
"attribute": true,
"dimSolveOrder": 90,
"dimensionType": "ATTRIBUTE",
"attributeType": "DATE",
"associatedDimension": "Product",
"attributeAssocLevel": 0
},
{
"name": "Attribute Calculations",
"numberOfChildren": 5,
"levelNumber": 1,
"aliases": {
"Long Names": null,
"ChineseNames": null,
"JapaneseNames": null,
"GermanNames": null,
"RussianNames": null,
"Default": null
},
"uniqueName": "Attribute Calculations",
"descendantsCount": 5,
"previousSiblingsCount": 10,
"dimension": true,
"dimSolveOrder": 90,
"dimensionType": "ATTRIBUTECALC",
"dataStorageType": "LABELONLY",
"formatString": null,
"dimStorageType": "SPARSE"
}
],
"hasMore": false,
"totalResults": 11,
"limit": 50,
"count": 11,
"offset": 0,
"links": []
}子の取得
cURLコマンドを含むスクリプト
次の例では、Essbaseキューブ・アウトライン内の指定された親メンバーの子を取得する方法を示します。
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/outline/ASOSamp/Basic?links=none&parent=Payment%20Type" -H Accept:application/json -H Content-Type:application/json -o output_children.json -u %User%:%Password%レスポンス本体の例
次の情報がoutput_children.jsonに書き込まれます。
{
"items": [
{
"name": "Cash",
"dimensionName": "Payment Type",
"generationNumber": 2,
"aliases": {
"Default": null
},
"uniqueName": "Cash",
"memberId": "id__480",
"parentName": "Payment Type",
"shareMembers": null,
"hierarchy": "MULTIPLEHIERARCHYNOTENABLED"
},
{
"name": "ATM",
"dimensionName": "Payment Type",
"generationNumber": 2,
"aliases": {
"Default": null
},
"uniqueName": "ATM",
"memberId": "id__481",
"previousSiblingsCount": 1,
"parentName": "Payment Type",
"shareMembers": null,
"hierarchy": "MULTIPLEHIERARCHYNOTENABLED"
},
{
"name": "Check",
"dimensionName": "Payment Type",
"generationNumber": 2,
"aliases": {
"Default": null
},
"uniqueName": "Check",
"memberId": "id__482",
"previousSiblingsCount": 2,
"parentName": "Payment Type",
"shareMembers": null,
"hierarchy": "MULTIPLEHIERARCHYNOTENABLED"
},
{
"name": "Credit Card",
"dimensionName": "Payment Type",
"generationNumber": 2,
"aliases": {
"Default": null
},
"uniqueName": "Credit Card",
"memberId": "id__483",
"previousSiblingsCount": 3,
"parentName": "Payment Type",
"shareMembers": null,
"hierarchy": "MULTIPLEHIERARCHYNOTENABLED"
}
],
"hasMore": false,
"totalResults": 4,
"limit": 50,
"count": 4,
"offset": 0,
"links": []
}メンバーの検索
cURLコマンドを含むスクリプト
次の例では、TVというキーワードを使用して、Essbaseキューブ・アウトライン内のメンバーを検索する方法を示します。
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/outline/ASOSamp/Basic?links=none&keyword=TV" -H Accept:application/json -H Content-Type:application/json -o output_search.json -u %User%:%Password%
レスポンス本体の例
次の情報がoutput_search.jsonに書き込まれます。
{
"items": [
{
"name": "TV Direct",
"dimensionName": "Stores",
"numberOfChildren": 24,
"levelNumber": 1,
"generationNumber": 3,
"aliases": {
"Default": null
},
"uniqueName": "TV Direct",
"memberId": "id__658",
"descendantsCount": 24,
"previousSiblingsCount": 9,
"parentName": "Brick & Mortar",
"shareMembers": null,
"hierarchy": "NOTHIERARCHY"
},
{
"name": "TVs Online",
"dimensionName": "Stores",
"numberOfChildren": 12,
"levelNumber": 1,
"generationNumber": 3,
"aliases": {
"Default": null
},
"uniqueName": "TVs Online",
"memberId": "id__747",
"descendantsCount": 12,
"previousSiblingsCount": 3,
"parentName": "Online",
"shareMembers": null,
"hierarchy": "NOTHIERARCHY"
}
],
"hasMore": false,
"totalResults": 2,
"limit": 2,
"count": 2,
"offset": 0,
"links": []
}