移動先

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

EssbaseスクリプトのRTSVの取得

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/rtsv

指定されたスクリプト名において使用されている実行時代替変数を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

• scriptName(required): string

  スクリプト名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

実行時代替変数のリストが正常に返されました。

本体()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object result

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

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

型: object

ソースの表示

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• offset: integer(int64)
• properties: object properties
  使用可能なその他のプロパティ: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RTSV"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"result"
    }
}

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

型: array

ソースの表示

• 配列: object RTSV

  ランタイム代替変数の詳細。

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

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

型: object

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

ソースの表示

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

型: object

ランタイム代替変数の詳細。

ソースの表示

• allowMissing: boolean

  データが存在しないデータ・セルを許可する場合はtrueを、抑制する場合はfalseに設定します。

• description: string

• dimension: string

  この変数が情報を取得するディメンションの名前。type = MEMBERの場合のみサポートされます。

• limit: string
• name: string

  ランタイム代替変数の名前。

• singleChoice: boolean

  ランタイム代替変数に渡すことができるコンテキスト・メンバー選択肢が1つのみの場合は、trueに設定します。グリッドまたはPOVに単一のメンバーがある場合、そのメンバーが使用されます。ディメンションがPOVにある場合、アクティブ・メンバーが使用されます。ディメンションがPOVにあり、複数のメンバーがある場合、エラーが発生します。

  グリッドまたはPOVのすべてのディメンション・メンバーが含まれている場合は、falseに設定します。

• type: string
  指定可能な値: [ "STRING", "NUMBER", "DATE", "MEMBER" ]

  変数がメンバー、文字列または番号のどちらに対するものであるかを指定します。

• value: object value

  ランタイム代替変数のデフォルト値。RTSV値には、文字列、定数、メンバー名またはメンバーの組合せを指定できます。

  RTSVがSmart Viewで実行される計算用に設計されている場合、その値を定数POVに設定して、スプレッドシート・グリッドに存在する現在のデータ・スライスのみが計算されるようにする必要があります。

{
    "type":"object",
    "description":"<p>Details about the runtime substitution variable.</p>",
    "properties":{
        "name":{
            "type":"string",
            "description":"<p>Name of the runtime substitution variable.</p>"
        },
        "description":{
            "type":"string",
            "description":"<p></p>"
        },
        "allowMissing":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to allow data cells for which no data exists, or <b>false</b> to suppress them.</p>"
        },
        "dimension":{
            "type":"string",
            "description":"<p>The name of the dimension from which this variable pulls information. Supported only if <i>type</i> = MEMBER.</p>"
        },
        "singleChoice":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> if only one contextual member selection may be passed to the runtime substitution variable. If there is a single member on the grid or POV, that member is used. If a dimension is on the POV, the active member is used. If a dimension is on the POV and there are multiple members, an error occurs. </p><p>Set to <b>false</b> if all dimension members on the grid or the POV are included.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>Specification of whether the variable is for a member, string, or number.</p>",
            "enum":[
                "STRING",
                "NUMBER",
                "DATE",
                "MEMBER"
            ]
        },
        "value":{
            "type":"object",
            "description":"<p>Default value of the runtime substitution variable. RTSV values can be strings,  constants, member names, or member combinations.</p><p>If the RTSV is designed for calcs executed in Smart View, its value must be set to the constant <code>POV</code>, to indicate that only the current data slice present in the spreadsheet grid should be calculated.</p>"
        },
        "limit":{
            "type":"string"
        }
    }
}

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

型: object

ランタイム代替変数のデフォルト値。RTSV値には、文字列、定数、メンバー名またはメンバーの組合せを指定できます。

RTSVがSmart Viewで実行される計算用に設計されている場合、その値を定数POVに設定して、スプレッドシート・グリッドに存在する現在のデータ・スライスのみが計算されるようにする必要があります。

400 レスポンス

不正なリクエスト

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

500 レスポンス

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

先頭に戻る

例

次の例では、Essbase REST APIを使用して、計算スクリプトに関連付けられたランタイム代替変数(RTSV)を取得する方法を示します。

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

計算スクリプト・ランタイム代替変数の取得

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

レスポンス本体の例

{
  "items" : [ {
    "name" : "rtsvEntity",
    "description" : "Entities to Copy",
    "allowMissing" : false,
    "dimension" : "Entity",
    "singleChoice" : false,
    "type" : "MEMBER",
    "value" : "POV"
  }, {
    "name" : "rtsvScenario",
    "description" : "Scenarios to Copy",
    "allowMissing" : false,
    "dimension" : "Scenario",
    "singleChoice" : false,
    "type" : "MEMBER",
    "value" : "POV"
  }, {
    "name" : "rtsvPeriod",
    "description" : "Period to Copy",
    "allowMissing" : false,
    "dimension" : "Period",
    "singleChoice" : true,
    "type" : "MEMBER",
    "value" : "POV"
  } ]
}

先頭に戻る