1. Oracle EssbaseのREST API
  2. タスク
  3. アウトライン・ビューア

メンバー情報の取得

get

/essbase/rest/v1/outline/{app}/{cube}/{memberUniqueName}

すべてのメンバー・プロパティ、またはリクエストされたメンバー・プロパティを返します。

リクエスト

パス・パラメータ

  • アプリケーション名。

  • データベース名。

  • 一意のメンバー名(完全修飾名)。メンバー名、メンバーIDまたは別名を指定できます。メンバー名が(重複メンバー対応のアウトラインで)一意でない場合は、完全修飾メンバー名を使用するか、メンバーIDを使用します。

問合せパラメータ
先頭に戻る

レスポンス

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

200 レスポンス

OK

メンバー情報を正常に取得しました。

本体()
ルート・スキーマ : MemberBean
型: object

Essbaseで表示されるメンバー情報の出力は、コンテキストに依存します。次に、メンバーの情報をリクエストしたときに表示されない可能性のあるプロパティの例を示します。

  • consolidation: メンバー集計がデフォルトの加算(+)である場合は表示されません
  • numberOfChildren: リーフレベルのメンバー(子のないメンバー)に対しては表示されません
  • activeAliasName: セッションでデフォルト以外の別名表が使用されていない場合は表示されません
  • attributeType: 属性ディメンション名であるメンバーに対してのみ表示されます
  • shareMembers: ディメンション名のメンバーおよび属性に対しては表示されません。これらは共有メンバーのプロトタイプ・メンバーにできないためです。
  • memberHasUniqueName: アウトラインが重複メンバー対応でない場合は表示されません

ソースの表示

  • このメンバーが勘定科目ディメンションのメンバーである場合はtrue。

  • デフォルト以外の別名表が現在のセッションで使用されている場合は、このメンバーの現在アクティブな別名。

  • aliases
    使用可能なその他のプロパティ: additionalProperties

  • このメンバーが属性ディメンションのメンバーである場合はtrue。

  • このメンバーの子孫の数。

  • このメンバーが最上位レベルのディメンション・メンバー(メンバー名 = ディメンション名)の場合はtrue。

  • このメンバーが属するディメンションの名前。

  • このメンバーの世代番号。ディメンション名は世代1のメンバーであり、世代番号はリーフ・メンバーに1ステップ近づくたびに1ずつ増加します。

  • このメンバーのレベル番号。リーフ・メンバーはレベル0であり、レベル番号はディメンション・ルート・メンバーに1ステップ近づくたびに1ずつ増加します。

  • links

  • このメンバー名がアウトライン内で重複する名前の場合はfalse、その名前が一意の場合はtrue。重複メンバー対応のアウトラインにのみ適用できます。

  • メンバーの名前とは別の、メンバーの永続的な一意の識別子。EssbaseがメンバーIDを自動生成する場合、IDは増分命名パターン(id__0、id__1、id__2など)に従います。

  • このメンバーに割り当てられている場合は、解決順。割り当てられていない場合、メンバーはディメンションの解決順を継承します。解決順には0から127を指定できます。下位の解決順のメンバーは、上位のメンバーの前に計算されます。

  • メンバー名。

  • このメンバーの子の数。

  • アウトラインでこのメンバーの前にある兄弟の数。

  • 指定可能な値: [ "NONE", "NUMERIC", "SMARTLIST", "DATE" ]

    メンバーがメジャーの場合にのみ適用できます。メジャーに指定されている型。たとえば、日付フォーマットを使用して分類されたメジャーの場合はDATE、テキストベースのメジャーの場合はSMARTLIST、NUMERICです。

  • アウトラインでのこのメンバーの一意の名前。アウトラインが重複メンバー対応で、メンバー名が一意でない場合、この一意の名前は、同じ名前を持つ他のメンバーと区別する修飾名になります。たとえば、[Market].[New York].[New York]は一意の名前です。

ネストされたスキーマ : aliases
型: object
使用可能なその他のプロパティ
ソースの表示

400 レスポンス

不正なリクエスト

メンバー情報の取得に失敗しました。

500 レスポンス

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

先頭に戻る

例

次の例では、アウトライン内の指定されたメンバーのEssbaseメンバー・プロパティを取得する方法を示します。

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

様々な方法でメンバーを指定できます。

Essbaseで表示されるメンバー情報の出力は、コンテキストに依存します。通常、デフォルトの情報は含まれていません。次に、メンバーの情報を問い合せたときに表示されない可能性のあるプロパティの例を示します。

  • consolidation: メンバー集計演算子がデフォルトの加算(+)である場合は表示されません
  • numberOfChildren: リーフレベルのメンバー(子のないメンバー)に対しては表示されません
  • activeAliasName: 現在のセッションでデフォルト以外の別名表が使用されていない場合は表示されません
  • attributeType: 属性ディメンション名であるメンバーに対してのみ表示されます
  • shareMembers: ディメンション名のメンバーおよび属性に対しては表示されません。これらは共有メンバーのプロトタイプ・メンバーにできないためです。
  • memberHasUniqueName: アウトラインが重複メンバー対応でない場合は表示されません

メンバー名

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

この例では、Sample Basicアウトライン内のProductという名前のメンバーに関する情報を取得します。 

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/outline/Sample/Basic/Product?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

レスポンス本体の例

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

別名

この例では、Sample Basicアウトライン内のColasという別名を持つメンバーに関する情報を取得します。

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

call properties.bat
curl -X GET  "https://myserver.example.com:9001/essbase/rest/v1/outline/Sample/Basic/Colas?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

レスポンス本体の例

{
	"name": "100",
	"dimensionName": "Product",
	"numberOfChildren": 3,
	"levelNumber": 1,
	"generationNumber": 2,
	"aliases": {
		"Long Names": null,
		"ChineseNames": "not shown",
		"JapaneseNames": "not shown",
		"GermanNames": "not shown",
		"RussianNames": "not shown",
		"Default": "Colas"
	},
	"activeAliasName": "Colas",
	"uniqueName": "100",
	"memberId": "id__69",
	"descendantsCount": 3,
	"parentName": "Product",
	"shareMembers": null
}

共有メンバー

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

次の例では、共有メンバーのプロパティをリクエストします。プロトタイプ・メンバーと区別するために、完全修飾メンバー名[High End Merchandise].[HDTV]を指定します。

HTTPリクエストで正しく解釈されるように、次の文字にURLエンコーディング(パーセントエンコーディング)を使用します。

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/outline/ASOSamp/Basic/%5BHigh%20End%20Merchandise%5D.%5BHDTV%5D?links=none" -H Accept:application/json -H Content-Type:application/json -o output.json -u %User%:%Password%

レスポンス本体の例

{
	"name": "HDTV",
	"dimensionName": "Products",
	"generationNumber": 3,
	"aliases": {
		"Default": null
	},
	"uniqueName": "[High End Merchandise].[HDTV]",
	"memberId": "id__545",
	"previousSiblingsCount": 1,
	"dataStorageType": "SHAREDMEMBER",
	"parentName": "High End Merchandise",
	"shareMembers": null,
	"hierarchy": "NOTHIERARCHY"
}

メンバーID

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

この例では、Sample Basicアウトライン内のid__68というメンバーIDを持つメンバーに関する情報を取得します。 

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/outline/Sample/Basic/id__68?links=none" -H Accept:application/json -H Content-Type:application/json -o output.json -u %User%:%Password%

レスポンス本体の例

{
	"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"
}
先頭に戻る