移動先

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

レベルのリスト

get

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

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

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

• dimensionName(required): string

  ディメンション名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

レベルを正常に取得しました。各レベルを取得または編集するためのリンクが含まれています。

本体()

ルート・スキーマ : schema

型: array

ソースの表示

• 配列: object GenerationLevelList

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

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

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

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

• actualName: string
• links: array links
• name: string
• number: integer(int32)
• unique: boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "actualName":{
            "type":"string"
        },
        "number":{
            "type":"integer",
            "format":"int32"
        },
        "unique":{
            "type":"boolean"
        },
        "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/ASOSamp/databases/Basic/dimensions/Products/levels?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

レスポンス本体の例

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

{
  "items" : [ {
    "name" : "Lev0",
    "number" : 0
  }, {
    "name" : "Lev1",
    "number" : 1
  }, {
    "name" : "Lev2",
    "number" : 2
  }, {
    "name" : "Lev3",
    "number" : 3
  }, {
    "name" : "Lev4",
    "number" : 4
  }, {
    "name" : "Lev5",
    "number" : 5
  } ]
}

先頭に戻る