移動先

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

ディメンションのリスト

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/dimensions

指定されたアプリケーションおよびデータベースからすべてのディメンションを返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

ディメンションを正常に取得しました。ディメンションに関する詳細、および各ディメンションの世代とレベルを取得するためのリンクが含まれています。

本体()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object DimensionList

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

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

型: 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/DimensionBean"
            }
        },
        "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 DimensionBean

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

• links: array links
• members: integer(int32)
• name: string
• storedMembers: integer(int32)
• type: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "members":{
            "type":"integer",
            "format":"int32"
        },
        "storedMembers":{
            "type":"integer",
            "format":"int32"
        },
        "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/applications/Sample/databases/Basic/dimensions?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

レスポンス本体の例

次の例では、レスポンス本体の内容をJSON形式で示します。

{
  "items" : [ {
    "name" : "Year",
    "type" : "DENSE",
    "members" : 19,
    "storedMembers" : 12
  }, {
    "name" : "Measures",
    "type" : "DENSE",
    "members" : 17,
    "storedMembers" : 11
  }, {
    "name" : "Product",
    "type" : "SPARSE",
    "members" : 22,
    "storedMembers" : 19
  }, {
    "name" : "Market",
    "type" : "SPARSE",
    "members" : 25,
    "storedMembers" : 25
  }, {
    "name" : "Scenario",
    "type" : "DENSE",
    "members" : 5,
    "storedMembers" : 2
  }, {
    "name" : "Caffeinated",
    "type" : "SPARSE",
    "members" : 3,
    "storedMembers" : 0
  }, {
    "name" : "Ounces",
    "type" : "SPARSE",
    "members" : 5,
    "storedMembers" : 0
  }, {
    "name" : "Pkg Type",
    "type" : "SPARSE",
    "members" : 3,
    "storedMembers" : 0
  }, {
    "name" : "Population",
    "type" : "SPARSE",
    "members" : 15,
    "storedMembers" : 0
  }, {
    "name" : "Intro Date",
    "type" : "SPARSE",
    "members" : 8,
    "storedMembers" : 0
  } ]
}

先頭に戻る