Jump to

• Request
• Response
• Examples

Get Drill Through Report

get

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

Returns the specified drill through report from the specified application and database.

Request

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

• name: string

  Drill through report name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

The drill through report was retrieved successfully. Returns the links to get, edit, or delete the report.

Body ()

Root Schema : DrillthroughBean

Type: object

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).

Show Source

• columnMapping(optional): object columnMapping
  Additional Properties Allowed: ColumnMappingInfo

  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.

• columns(optional): array columns

  List of columns from the external Datasource that you want included in the drill through report.

• dataSourceName(optional): string

  Name of the Datasource used for this drill through report definition.

• drillableRegions(optional): array drillableRegions

  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)

• links(optional): array links
• name(optional): string

  Name of the drill through report definition.

• parameterMapping(optional): object parameterMapping
  Additional Properties Allowed: RunTimeParametersInfo

  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.

• type(optional): string

  Type of drill through report definition: DATASOURCE to drill through to an external source system or URL to drill through to a web URL.

• url(optional): string

  Static or dynamic URL string. Use if you are defining drill through to external data using URLs.

• useTempTables(optional): boolean

  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.

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

Nested Schema : columnMapping

Type: object

Additional Properties Allowed

Show Source

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

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.

Nested Schema : columns

Type: array

List of columns from the external Datasource that you want included in the drill through report.

Show Source

• Array of: 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"
    }
}

Nested Schema : drillableRegions

Type: array

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)

Show Source

• Array of: 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"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : parameterMapping

Type: object

Additional Properties Allowed

Show Source

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

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.

Nested Schema : ColumnMappingInfo

Type: object

Show Source

• dimension(optional): string
• generation(optional): string
• generationNumber(optional): integer(int32)
• level(optional): string
• type(optional): string
  Allowed Values: [ "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"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

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

Nested Schema : RunTimeParametersInfo

Type: object

Show Source

• dimension(optional): string
• generation(optional): string
• generationNumber(optional): integer(int32)
• level(optional): string
• type(optional): string
  Allowed Values: [ "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 Response

Bad Request

Failed to get the report. The application name, database name, or report name may be incorrect.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to retrieve information about a named drill through report in the Essbase cube.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

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%

Example of Response Body

The following example shows the contents of the response body in JSON format:

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

Back to Top