移動先

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

複数のサーバー変数の取得

get

/essbase/rest/v1/variables

Essbaseサーバーからすべての代替変数を返します。

リクエスト

問合せパラメータ

• all: string
  デフォルト値: false

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

変数を正常に取得しました。変数の詳細、および変数を取得、編集または削除するためのリンクが含まれています。

本体()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object VariableList

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

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

型: 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":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Variable"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: array

ソースの表示

• 配列: object Variable

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

• appName: string
• dbName: string
• links: array links
• name: string
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "appName":{
            "type":"string"
        },
        "dbName":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object Link

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

ネストされたスキーマ : 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"
        }
    }
}

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/variables?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%

レスポンス本体の例

{
  "items" : [ {
    "name" : "oci",
    "value" : "OCI;SERVICE=myorclhost:1521/orcl.example.com"
  }, {
    "name" : "Orcl_DSN",
    "value" : "TBC_ORA"
  }, {
    "name" : "FocusMarket",
    "value" : "East"
  }, {
    "name" : "Scenario",
    "value" : "Actual"
  }, {
    "name" : "CurrMonth",
    "value" : "Sep"
  } ]
}

先頭に戻る