移動先

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

ドリル・スルー・レポートの取得

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/reports/{name}

指定されたアプリケーションおよびデータベースから、指定されたドリル・スルー・レポートを返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

• name(required): string

  ドリル・スルー・レポート名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

ドリル・スルー・レポートを正常に取得しました。レポートを取得、編集または削除するためのリンクを返します。

本体()

ルート・スキーマ : DrillthroughBean

型: object

ドリル・スルー・レポートの定義です。外部情報に対してユーザーが持っている必要があるアクセス権を決定します。ドリル・スルー・レポート定義はキューブに関連付けられています。また、列マッピング(必須)、ドリル可能領域(必須)およびランタイム・パラメータのマッピング(オプション。データソース問合せがパラメータ化されている場合に使用可能)が含まれています。

ソースの表示

• columnMapping: object columnMapping
  使用可能なその他のプロパティ: ColumnMappingInfo

  ドリル・スルー・レポートに含める外部ソース列、それらの列がマップするEssbaseディメンションおよび(オプションで)提供するアクセスの深さを示す生成/レベルのフィルタ条件を指定します。

• columns: array columns

  ドリル・スルー・レポートに含める外部データソースの列のリスト。

• dataSourceName: string

  このドリル・スルー・レポート定義に使用されるデータソースの名前。

• drillableRegions: array drillableRegions

  ドリル・スルー・レポート(またはURL)へのアクセスを提供するセル交差を指定します。Essbaseメンバー名および(オプションで)メンバーセット計算関数を使用して指定します。例: Market,Year,Scenario,Sales,@LEVMBRS(Product,1)

• links: array links
• name: string

  ドリル・スルー・レポート定義の名前。

• parameterMapping: object parameterMapping
  使用可能なその他のプロパティ: RunTimeParametersInfo

  オプションで、ランタイム・パラメータのディメンション、生成またはレベル・マッピングを指定します(データソースに実装されている場合)。変数のコンテキストに基づいて、ドリル・スルー・レポートの結果をさらにカスタマイズできます。

• type: string

  ドリル・スルー・レポート定義のタイプ: 外部ソース・システムにドリル・スルーする場合はDATASOURCE、Web URLにドリル・スルーする場合はURL。

• url: string

  静的または動的なURL文字列。URLを使用して外部データへのドリル・スルーを定義する場合に使用します。

• useTempTables: boolean

  SQL ???IN???句に大量の値がある問合せについて、ドリル・スルーのパフォーマンスを向上させるためにEssbaseで一時表を作成するかどうか。

{
    "type":"object",
    "description":"<p>Drill through report definition. Determines the access users should have to external information. Drill through report definitions are associated with a cube, and include a column mapping (required), a drillable region (required), and a mapping for runtime parameters (optional - can be used if the Datasource query is parameterized).</p>",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "drillableRegions":{
            "type":"array",
            "description":"<p>Specification of which cell intersections offer access to drill through reports (or a URL). Specify using Essbase member names and (optionally) member-set calculation functions. Example: Market,Year,Scenario,Sales,@LEVMBRS(Product,1)</p>",
            "items":{
                "type":"string"
            }
        },
        "useTempTables":{
            "type":"boolean",
            "description":"<p>Whether Essbase should create temporary tables for drill through performance improvement for queries that have a large number of values in the SQL ???IN??? clause.</p>"
        },
        "columnMapping":{
            "type":"object",
            "description":"<p>Specification of which external source columns should be included in the drill through report, which Essbase dimensions those columns map to, and (optionally) a generation/level filter condition indicating how much depth of access to provide.</p>",
            "additionalProperties":{
                "$ref":"#/definitions/ColumnMappingInfo"
            }
        },
        "parameterMapping":{
            "type":"object",
            "description":"<p>Optional specification of dimension, generation, or level mapping for runtime parameters (if implemented in a Datasource), enabling further customization of drill through report results based on the variable context.</p>",
            "additionalProperties":{
                "$ref":"#/definitions/RunTimeParametersInfo"
            }
        },
        "dataSourceName":{
            "type":"string",
            "description":"<p>Name of the Datasource used for this drill through report definition.</p>"
        },
        "url":{
            "type":"string",
            "description":"<p>Static or dynamic URL string. Use if you are defining drill through to external data using URLs.</p>"
        },
        "columns":{
            "type":"array",
            "description":"<p>List of columns from the external Datasource that you want included in the drill through report.</p>",
            "items":{
                "type":"string"
            }
        },
        "type":{
            "type":"string",
            "description":"<p>Type of drill through report definition: <code>DATASOURCE</code> to drill through to an external source system or <code>URL</code> to drill through to a web URL.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>Name of the drill through report definition.</p>"
        }
    }
}

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

型: object

使用可能なその他のプロパティ

ソースの表示

• object ColumnMappingInfo

{
    "type":"object",
    "description":"<p>Specification of which external source columns should be included in the drill through report, which Essbase dimensions those columns map to, and (optionally) a generation/level filter condition indicating how much depth of access to provide.</p>",
    "additionalProperties":{
        "$ref":"#/definitions/ColumnMappingInfo"
    }
}

ドリル・スルー・レポートに含める外部ソース列、それらの列がマップするEssbaseディメンションおよび(オプションで)提供するアクセスの深さを示す生成/レベルのフィルタ条件を指定します。

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

型: array

ドリル・スルー・レポートに含める外部データソースの列のリスト。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"<p>List of columns from the external Datasource that you want included in the drill through report.</p>",
    "items":{
        "type":"string"
    }
}

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

型: array

ドリル・スルー・レポート(またはURL)へのアクセスを提供するセル交差を指定します。Essbaseメンバー名および(オプションで)メンバーセット計算関数を使用して指定します。例: Market,Year,Scenario,Sales,@LEVMBRS(Product,1)

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"<p>Specification of which cell intersections offer access to drill through reports (or a URL). Specify using Essbase member names and (optionally) member-set calculation functions. Example: Market,Year,Scenario,Sales,@LEVMBRS(Product,1)</p>",
    "items":{
        "type":"string"
    }
}

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

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

使用可能なその他のプロパティ

ソースの表示

• object RunTimeParametersInfo

{
    "type":"object",
    "description":"<p>Optional specification of dimension, generation, or level mapping for runtime parameters (if implemented in a Datasource), enabling further customization of drill through report results based on the variable context.</p>",
    "additionalProperties":{
        "$ref":"#/definitions/RunTimeParametersInfo"
    }
}

オプションで、ランタイム・パラメータのディメンション、生成またはレベル・マッピングを指定します(データソースに実装されている場合)。変数のコンテキストに基づいて、ドリル・スルー・レポートの結果をさらにカスタマイズできます。

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

型: object

ソースの表示

• dimension: string
• generation: string
• generationNumber: integer(int32)
• level: string
• type: string
  指定可能な値: [ "DIMENSION", "GENERATION", "LEVEL0", "PARENT_CHILD" ]

{
    "type":"object",
    "properties":{
        "dimension":{
            "type":"string"
        },
        "generation":{
            "type":"string"
        },
        "level":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "DIMENSION",
                "GENERATION",
                "LEVEL0",
                "PARENT_CHILD"
            ]
        },
        "generationNumber":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

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

型: object

ソースの表示

• dimension: string
• generation: string
• generationNumber: integer(int32)
• level: string
• type: string
  指定可能な値: [ "DIMENSION", "GENERATION", "LEVEL0", "PARENT_CHILD" ]

{
    "type":"object",
    "properties":{
        "dimension":{
            "type":"string"
        },
        "generation":{
            "type":"string"
        },
        "level":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "DIMENSION",
                "GENERATION",
                "LEVEL0",
                "PARENT_CHILD"
            ]
        },
        "generationNumber":{
            "type":"integer",
            "format":"int32"
        }
    }
}

400 レスポンス

不正なリクエスト

レポートの取得に失敗しました。アプリケーション名、データベース名またはレポート名が正しくない可能性があります。

500 レスポンス

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

先頭に戻る

例

次の例では、Essbaseキューブ内の指定されたドリル・スルー・レポートの情報を取得する方法を示します。

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

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/drill2" -H Accept:application/json -H Content-Type:application/octet-stream -u %User%:%Password%

レスポンス本体の例

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

{
  "name" : "drill2",
  "columns" : [ "DIMENSION_PRODUCT", "DIMENSION_MARKET", "DIMENSION_YEAR", "DIMENSION_SCENARIO", "SALES", "COGS", "MARKETING", "PAYROLL", "MISC", "INITIAL_INVENTORY", "ADDITIONS" ],
  "dataSourceName" : "phx_DS",
  "drillableRegions" : [ "@DESCENDANTS(\"Measures\")" ],
  "columnMapping" : {
    "DIMENSION_PRODUCT" : {
      "dimension" : "Product",
      "type" : "DIMENSION"
    },
    "DIMENSION_MARKET" : {
      "dimension" : "Market",
      "level" : "Level0",
      "type" : "LEVEL0"
    },
    "DIMENSION_YEAR" : {
      "dimension" : "Year",
      "generation" : "Quarter",
      "type" : "GENERATION",
      "generationNumber" : 2
    },
    "DIMENSION_SCENARIO" : {
      "dimension" : "Scenario",
      "generation" : "Gen1",
      "type" : "GENERATION",
      "generationNumber" : 1
    }
  },
  "parameterMapping" : {
    "Param1" : {
      "dimension" : "Year",
      "level" : "Level0",
      "type" : "LEVEL0"
    }
  },
  "type" : "DATASOURCE",
  "useTempTables" : false,
  "links" : [ {
    "rel" : "get",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/drill2",
    "method" : "GET"
  }, {
    "rel" : "delete",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/drill2",
    "method" : "DELETE"
  }, {
    "rel" : "edit",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/drill2",
    "method" : "PUT"
  } ]
}

先頭に戻る