移動先

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

グリッド・レイアウトのリスト

get

/essbase/rest/v1/applications/{application}/databases/{database}/layouts

保存されている使用可能なグリッド・レイアウトをリストします。サービス管理者である場合は、他のユーザーが作成したレイアウトを含め、保存されているすべてのレイアウトがリストされます。

レイアウトとは、キューブに関連付けられている保存済のグリッドの形状です。将来的に再度使用するグリッドを作成する場合は、これをレイアウトとして保存できます。キューブが移行、エクスポートおよびライフサイクル管理(LCM)ツールを使用してコピーまたは移動される場合、レイアウトとレポートが含められます。

リクエスト

パス・パラメータ

• application(required): string

  アプリケーション名。

• database(required): string

  データベース名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

レイアウトのリストが正常に返されました。

本体()

ルート・スキーマ : Layouts

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

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

型: array

ソースの表示

• 配列: object LayoutMetadata

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

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

型: object

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

ソースの表示

• string

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

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

型: object

ソースの表示

• dbDefault: boolean
• links: array links
• name: string
• user: string
• userDefault: boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "user":{
            "type":"string"
        },
        "userDefault":{
            "type":"boolean"
        },
        "dbDefault":{
            "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 レスポンス

不正なリクエスト

レイアウトの取得に失敗しました。

先頭に戻る

例

次の例では、キューブに関連付けられた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/layouts?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

レスポンス本体の例

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

{
  "items" : [ {
    "name" : "Q1ColaSalesNY",
    "user" : "admin",
    "userDefault" : false,
    "dbDefault" : false
  }, {
    "name" : "Q2ColaSalesNY",
    "user" : "admin",
    "userDefault" : false,
    "dbDefault" : false
  } ],
  "count" : 2,
  "totalResults" : 2
}

先頭に戻る