移動先

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

MDXレポート詳細の取得

get

/essbase/rest/v1/applications/{application}/databases/{database}/queries/{query}

指定されたMDXレポートの詳細を取得します。

MDXレポートはキューブ・コンテンツに保存されます。

関連項目:

• MDXレポートの保存
• MDXレポートのリスト
• MDXレポートの削除
• MDXレポートの更新
• MDXレポートの実行

リクエスト

パス・パラメータ

• application(required): string

  アプリケーション名。

• database(required): string

  データベース名。

• query(required): string

  MDXレポート名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

MDXレポートの詳細が正常に返されました。

本体()

ルート・スキーマ : NamedQuery

型: object

ソースの表示

• name: string
• query: object Query
• type: string
  指定可能な値: [ "MDX", "DATA_SOURCE" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "MDX",
                "DATA_SOURCE"
            ]
        },
        "query":{
            "$ref":"#/definitions/Query"
        }
    }
}

ネストされたスキーマ : Query

型: object

ソースの表示

• description: string
• preferences: object NamedQueriesPreferences
• spec: string

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "spec":{
            "type":"string"
        },
        "preferences":{
            "$ref":"#/definitions/NamedQueriesPreferences"
        }
    }
}

ネストされたスキーマ : NamedQueriesPreferences

型: object

ソースの表示

• cellAttributes: boolean
• dataless: boolean

  出力セットからのデータ値を省略する場合は、trueに設定します。デフォルトはfalseです。

• formatString: boolean

  タイプがテキストまたは日付のセル、またはフォーマット文字列に関連付けられたセルのフォーマットされた値を返す場合は、trueに設定します。デフォルトはtrueです。

• formatValues: boolean
• hideRestrictedData: boolean
• meaninglessCells: boolean
• memberIdentifierType: string
  指定可能な値: [ "NAME", "ALIAS", "UNIQUE_NAME" ]

  出力のメタデータがメンバー名、メンバー別名または一意のメンバー名(重複メンバー対応のアウトラインの場合)のいずれを指すか指定します。

• textList: boolean
• urlDrillThrough: boolean

{
    "type":"object",
    "properties":{
        "dataless":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to omit data values from the output set. Default is <b>false</b>.</p>"
        },
        "hideRestrictedData":{
            "type":"boolean"
        },
        "cellAttributes":{
            "type":"boolean"
        },
        "formatString":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to return the formatted values for cells of type text or date, or cells associated with a format string. Default is <b>true</b>.</p>"
        },
        "formatValues":{
            "type":"boolean"
        },
        "meaninglessCells":{
            "type":"boolean"
        },
        "textList":{
            "type":"boolean"
        },
        "urlDrillThrough":{
            "type":"boolean"
        },
        "memberIdentifierType":{
            "type":"string",
            "description":"<p>Specify whether metadata in the output should refer to member names, member aliases, or unique member names (in case of duplicate member enabled outlines).</p>",
            "enum":[
                "NAME",
                "ALIAS",
                "UNIQUE_NAME"
            ]
        }
    }
}

400 レスポンス

不正なリクエスト

MDXレポート詳細の取得に失敗しました。

先頭に戻る

例

次の例では、Essbaseキューブのコンテキストに保存されたMDXレポートの詳細を取得する方法を示します。

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

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

call properties.bat
curl -X GET https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/queries/closingperiod -H "Accept:application/json" -u %User%:%Password%

レスポンス本体の例

次の例では、レスポンス本体の内容をJSON形式で示します。

{
  "name" : "closingperiod",
  "type" : "MDX",
  "query" : {
    "spec" : "WITH\nMEMBER [Measures].[Starting Inventory] AS\n'\nIIF (\n IsLeaf (Year.CurrentMember),\n  [Measures].[Opening Inventory],\n  ([Measures].[Opening Inventory],\n   OpeningPeriod (\n     [Year].Levels(0),\n     [Year].CurrentMember\n   )\n  )\n)'\n\nMEMBER [Measures].[Closing Inventory] AS\n'\nIIF (\n   Isleaf(Year.CurrentMember),\n    [Measures].[Ending Inventory],  \n   ([Measures].[Closing Inventory],\n    ClosingPeriod (\n    [Year].Levels(0),\n    [Year].CurrentMember\n    )\n)\n)'\nSELECT\nCrossJoin (\n { [100-10] },\n { [Measures].[Starting Inventory], [Measures].[Closing Inventory] }\n)\nON COLUMNS,\nHierarchize ( [Year].Members , POST)\nON ROWS\nFROM Sample.Basic"
  },
  "links" : [ {
    "rel" : "self",
    "method" : "GET"
  }, {
    "rel" : "delete",
    "method" : "DELETE"
  }, {
    "rel" : "update",
    "method" : "PUT"
  }, {
    "rel" : "Get data In JSON",
    "method" : "GET"
  }, {
    "rel" : "Get data in HTML",
    "href" : "?format=HTML",
    "method" : "GET"
  }, {
    "rel" : "Get data in Excel",
    "href" : "?format=XLSX",
    "method" : "GET"
  }, {
    "rel" : "Get data in CSV",
    "href" : "?format=CSV",
    "method" : "GET"
  } ]
}

先頭に戻る