Oracle Essbase REST API

MDXレポートの更新

put

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

指定されたキューブのMDXレポートを更新します。

リクエスト

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

application/json
application/xml

パス・パラメータ

application(required): string

アプリケーション名。
database(required): string

データベース名。
query(required): string

MDXレポート名。

更新するMDXレポートの詳細。

ルート・スキーマ : Query

型: object

ソースの表示

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

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

型: object

ソースの表示

aliasTableName: string

memberIdentifierType: ALIASおよびaliasTableが有効な別名表名に設定されている場合、結果のmdxグリッドに指定された表のメンバー名が含まれています。このプロパティの値が設定されていない場合は、Default別名表から名前が選択されます。
cellAttributes: boolean

trueに設定すると、実際のデータ値の他にメタデータ属性のセットが問合せ結果から返されます。
dataless: boolean

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

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

trueに設定すると、セルのフォーマットされた値が返されます。
hideRestrictedData: boolean

trueに設定すると、出力の制限されたセル・データを非表示にします。
meaninglessCells: boolean

trueに設定すると、出力内の無意味なセル・データが抑制されます。たとえば、存在しないセルや構造的に無関係なセルなどです。
memberIdentifierType: string

指定可能な値: [ "NAME", "ALIAS", "UNIQUE_NAME" ]

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

trueに設定すると、出力のセルに関連付けられているすべてのテキスト値のカンマ区切りリストが返されます。
urlDrillThrough: boolean

trueに設定すると、適用可能な各セルにURLが追加され、ユーザーがソース・データをクリックスルーできるようになります。これは、Essbaseドリル・スルー・リンクが構成されている場合にのみ機能します。

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

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

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
nlq: string
preferences: object NamedQueriesPreferences
spec: string

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

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

型: object

ソースの表示

aliasTableName: string

memberIdentifierType: ALIASおよびaliasTableが有効な別名表名に設定されている場合、結果のmdxグリッドに指定された表のメンバー名が含まれています。このプロパティの値が設定されていない場合は、Default別名表から名前が選択されます。
cellAttributes: boolean

trueに設定すると、実際のデータ値の他にメタデータ属性のセットが問合せ結果から返されます。
dataless: boolean

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

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

trueに設定すると、セルのフォーマットされた値が返されます。
hideRestrictedData: boolean

trueに設定すると、出力の制限されたセル・データを非表示にします。
meaninglessCells: boolean

trueに設定すると、出力内の無意味なセル・データが抑制されます。たとえば、存在しないセルや構造的に無関係なセルなどです。
memberIdentifierType: string

指定可能な値: [ "NAME", "ALIAS", "UNIQUE_NAME" ]

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

trueに設定すると、出力のセルに関連付けられているすべてのテキスト値のカンマ区切りリストが返されます。
urlDrillThrough: boolean

trueに設定すると、適用可能な各セルにURLが追加され、ユーザーがソース・データをクリックスルーできるようになります。これは、Essbaseドリル・スルー・リンクが構成されている場合にのみ機能します。

{
    "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 レスポンス

不正なリクエスト

MDXレポートの更新に失敗しました。

先頭に戻る