移動先

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

世代の取得

get

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

指定された世代番号、アプリケーションおよびデータベースに基づいて、ディメンションの世代詳細を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

• dimensionName(required): string

  ディメンション名。

• generationNumber(required): integer(int32)

  世代番号。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

世代の詳細が正常に返されました。世代を取得または編集するためのリンクが含まれています。

本体()

ルート・スキーマ : 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/Sample/databases/Basic/dimensions/Market/generations/3?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

レスポンス本体の例

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

{
  "name" : "State",
  "actualName" : "State",
  "number" : 3
}

先頭に戻る