Jump to

• Request
• Response

Update MDX Report

put

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

Update the MDX report for the specified cube.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• application(required): string

  Application name.

• database(required): string

  Database name.

• query(required): string

  MDX report name.

Body ()

Details of MDX report to be updated.

Root Schema : Query

Type: object

Show Source

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

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

Nested Schema : NamedQueriesPreferences

Type: object

Show Source

• aliasTableName: string

  When the memberIdentifierType: ALIAS and the aliasTable are set to a valid alias table name, the resulting mdx grid contains member names from the specified table. If the value of this property is not set then names are picked from the Default alias table.

• cellAttributes: boolean

  Set to true to enable query result to return a set of metadata attributes besides the actual data value.

• dataless: boolean

  Set to true to omit data values from the output set. Default is false.

• formatString: boolean

  Set to true to return the formatted values for cells of type text or date, or cells associated with a format string. Default is true.

• formatValues: boolean

  Set to true to return the formatted values for cells.

• hideRestrictedData: boolean

  Set to true to hide the restricted cell data in the output.

• meaninglessCells: boolean

  Set to true to suppress the meaningless cell data in the output. For example, missing or structurally irrelevant cells.

• memberIdentifierType: string
  Allowed Values: [ "NAME", "ALIAS", "UNIQUE_NAME" ]

  Specify whether metadata in the output should refer to member names, member aliases, or unique member names (in case of duplicate member enabled outlines).

• textList: boolean

  Set to true to return a comma-separated list of all text values associated with the cell in the output.

• urlDrillThrough: boolean

  Set to true to add URLs to each applicable cell so users can click through to the source data. This works only if the Essbase drill-through links are configured.

{
    "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",
            "description":"<p>Set to <b>true</b> to hide the restricted cell data in the output.</p>"
        },
        "cellAttributes":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to enable query result to return a set of metadata attributes besides the actual data value.</p>"
        },
        "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",
            "description":"<p>Set to <b>true</b> to return the formatted values for cells.</p>"
        },
        "meaninglessCells":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to suppress the meaningless cell data in the output. For example, missing or structurally irrelevant cells.</p>"
        },
        "textList":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to return a comma-separated list of all text values associated with the cell in the output.</p>"
        },
        "urlDrillThrough":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to add URLs to each applicable cell so users can click through to the source data. This works only if the Essbase drill-through links are configured.</p>"
        },
        "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"
            ]
        },
        "aliasTableName":{
            "type":"string",
            "description":"<p>When the <b>memberIdentifierType: ALIAS</b> and the <b>aliasTable</b> are set to a valid alias table name, the resulting mdx grid contains member names from the specified table. If the value of this property is not set then names are picked from the <b>Default</b> alias table.</p>"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

MDX report updated successfully.

Body ()

Root Schema : NamedQuery

Type: object

Show Source

• name: string
• query: object Query
• type: string
  Allowed Values: [ "MDX", "DATA_SOURCE" ]

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

Nested Schema : Query

Type: object

Show Source

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

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

Nested Schema : NamedQueriesPreferences

Type: object

Show Source

• aliasTableName: string

  When the memberIdentifierType: ALIAS and the aliasTable are set to a valid alias table name, the resulting mdx grid contains member names from the specified table. If the value of this property is not set then names are picked from the Default alias table.

• cellAttributes: boolean

  Set to true to enable query result to return a set of metadata attributes besides the actual data value.

• dataless: boolean

  Set to true to omit data values from the output set. Default is false.

• formatString: boolean

  Set to true to return the formatted values for cells of type text or date, or cells associated with a format string. Default is true.

• formatValues: boolean

  Set to true to return the formatted values for cells.

• hideRestrictedData: boolean

  Set to true to hide the restricted cell data in the output.

• meaninglessCells: boolean

  Set to true to suppress the meaningless cell data in the output. For example, missing or structurally irrelevant cells.

• memberIdentifierType: string
  Allowed Values: [ "NAME", "ALIAS", "UNIQUE_NAME" ]

  Specify whether metadata in the output should refer to member names, member aliases, or unique member names (in case of duplicate member enabled outlines).

• textList: boolean

  Set to true to return a comma-separated list of all text values associated with the cell in the output.

• urlDrillThrough: boolean

  Set to true to add URLs to each applicable cell so users can click through to the source data. This works only if the Essbase drill-through links are configured.

{
    "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",
            "description":"<p>Set to <b>true</b> to hide the restricted cell data in the output.</p>"
        },
        "cellAttributes":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to enable query result to return a set of metadata attributes besides the actual data value.</p>"
        },
        "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",
            "description":"<p>Set to <b>true</b> to return the formatted values for cells.</p>"
        },
        "meaninglessCells":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to suppress the meaningless cell data in the output. For example, missing or structurally irrelevant cells.</p>"
        },
        "textList":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to return a comma-separated list of all text values associated with the cell in the output.</p>"
        },
        "urlDrillThrough":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to add URLs to each applicable cell so users can click through to the source data. This works only if the Essbase drill-through links are configured.</p>"
        },
        "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"
            ]
        },
        "aliasTableName":{
            "type":"string",
            "description":"<p>When the <b>memberIdentifierType: ALIAS</b> and the <b>aliasTable</b> are set to a valid alias table name, the resulting mdx grid contains member names from the specified table. If the value of this property is not set then names are picked from the <b>Default</b> alias table.</p>"
        }
    }
}

400 Response

Bad Request

Failed to update MDX report.

Back to Top