移動先

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

グリッド・レイアウトの実行

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/grid/layout/{layout}

指定されたレイアウトのグリッドをレンダリングします。

リクエスト

パス・パラメータ

• applicationName(required): string

  グリッド・レイアウトのアプリケーション名。

• databaseName(required): string

  グリッド・レイアウトのデータベース名またはキューブ名。

• layout(required): string

  実行するレイアウトの名前。

問合せパラメータ

• user: string

  レイアウトの所有者。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

グリッド・レイアウトが正常にレンダリングされました。

本体()

ルート・スキーマ : Grid

型: object

ソースの表示

• alias: string

  グリッドのアクティブな別名表。

• dimensions: array dimensions

  含まれるEssbaseディメンションとその場所を示すグリッドの部分。

• slice: object Slice

  列、行およびデータを含むグリッドの部分。

{
    "type":"object",
    "properties":{
        "slice":{
            "$ref":"#/definitions/Slice",
            "description":"<p>The part of the grid that contains columns, rows and data.</p>"
        },
        "alias":{
            "type":"string",
            "description":"<p>The active alias table for the grid.</p>"
        },
        "dimensions":{
            "type":"array",
            "description":"<p>The part of the grid that describes the included Essbase dimensions and their locations.</p>",
            "items":{
                "$ref":"#/definitions/GridDimension"
            }
        }
    }
}

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

型: array

含まれるEssbaseディメンションとその場所を示すグリッドの部分。

ソースの表示

• 配列: object GridDimension

  ディメンションの位置を示すディメンション・オブジェクト配列。name、column、rowおよびpovが含まれます。column = 0の場合、ディメンションはグリッドの0番目の列にあります。row = 1の場合、これはグリッドの最初の行にあります。ディメンションにPOVが含まれている場合、そのディメンションはpovフィルタでマークされます。次の例では、Product (100-10)、Market (New York)およびScenario (Actual)がPOVに含まれ、Measures (Sales)が列にあり、Year (Jan)が行にあります。

  	100-10	New York	Actual
  	Sales
  Jan	1052

{
    "type":"array",
    "description":"<p>The part of the grid that describes the included Essbase dimensions and their locations.</p>",
    "items":{
        "$ref":"#/definitions/GridDimension"
    }
}

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

型: object

列、行およびデータを含むグリッドの部分。

ソースの表示

• columns: integer(int32)

  グリッドの列の数。

• data: object Data
• dirtyCells: array dirtyCells

  変更された値をマークするインデックスの配列。送信アクションの場合に必須。

• dirtyTexts: array dirtyTexts

  変更されたセル・コメントをマークするインデックスの配列。

• rows: integer(int32)

  グリッドの行の数。

{
    "type":"object",
    "description":"<p>The part of the grid that contains columns, rows and data.</p>",
    "properties":{
        "dirtyCells":{
            "type":"array",
            "description":"<p>Array of indexes marking which values are are changed. Required for submit action.</p>",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "dirtyTexts":{
            "type":"array",
            "description":"<p>Array of indexes marking which cell comments are changed.</p>",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "columns":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of columns in the grid.</p>"
        },
        "data":{
            "$ref":"#/definitions/Data",
            "description":"<p>Grid data, consisting of ranges. Ranges contain values, types, texts, statuses, enumIds, data, and dataFormats.</p>"
        },
        "rows":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of rows in the grid.</p>"
        }
    }
}

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

型: object

ディメンションの位置を示すディメンション・オブジェクト配列。name、column、rowおよびpovが含まれます。column = 0の場合、ディメンションはグリッドの0番目の列にあります。row = 1の場合、これはグリッドの最初の行にあります。ディメンションにPOVが含まれている場合、そのディメンションはpovフィルタでマークされます。次の例では、Product (100-10)、Market (New York)およびScenario (Actual)がPOVに含まれ、Measures (Sales)が列にあり、Year (Jan)が行にあります。

	100-10	New York	Actual
	Sales
Jan	1052

ソースの表示

• column: integer(int32)

  グリッド内のディメンションの列の場所。

• displayName: string
• expanded: boolean
• hidden: boolean
• name: string

  ディメンション名。

• pov: string

  ディメンションがPOVにある場合はメンバー名。POVは視点で、グリッドの開始コンテキストまたはスコープです。

• row: integer(int32)

  グリッド内のディメンションの行の場所。

{
    "type":"object",
    "description":"<p>Dimension object array describing the position of a dimension. Includes name, column, row, and pov. If column = 0, the dimension is located at 0th column in grid. If row = 1, it is located at first row in the grid. If the dimension contains a POV, then that dimension is marked with the pov filter. In the following example, Product (100-10), Market (New York), and Scenario (Actual) are in the POV, Measures (Sales) is on columns, and Year (Jan) is on rows. <table><tr><th>&nbsp;</th><th>100-10</th><th>New York</th><th>Actual</th></tr><tr><td>&nbsp;</td><td><strong>Sales</strong></td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td><strong>Jan</strong></td><td>1052</td><td>&nbsp;</td><td>&nbsp;</td></tr></table></p>",
    "properties":{
        "expanded":{
            "type":"boolean"
        },
        "pov":{
            "type":"string",
            "description":"<p>If dimension is in the POV, the member name. POV is point of view: the starting context or scope for the grid. </p>"
        },
        "row":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Row location of the dimension in the grid.</p>"
        },
        "column":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Column location of the dimension in the grid.</p>"
        },
        "displayName":{
            "type":"string"
        },
        "hidden":{
            "type":"boolean"
        },
        "name":{
            "type":"string",
            "description":"<p>Dimension name.</p>"
        }
    }
}

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

型: object

ソースの表示

• ranges: array ranges

{
    "type":"object",
    "properties":{
        "ranges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GridRange"
            }
        }
    }
}

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

型: array

変更された値をマークするインデックスの配列。送信アクションの場合に必須。

ソースの表示

• 配列: integer(int32)

{
    "type":"array",
    "description":"<p>Array of indexes marking which values are are changed. Required for submit action.</p>",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

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

型: array

変更されたセル・コメントをマークするインデックスの配列。

ソースの表示

• 配列: integer(int32)

{
    "type":"array",
    "description":"<p>Array of indexes marking which cell comments are changed.</p>",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

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

型: array

ソースの表示

• 配列: object GridRange

  グリッド・データを示す範囲。values、types、texts、statuses、enumIds、data、dataFormatsおよびstartポイントとendポイントが含まれます。

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

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

型: object

グリッド・データを示す範囲。values、types、texts、statuses、enumIds、data、dataFormatsおよびstartポイントとendポイントが含まれます。

ソースの表示

• dataFormats: array dataFormats

  フォーマット文字列が適用される場合はデータ・フォーマット。

• end: integer(int32)

  グリッド範囲内の要素の数。

• enumIds: array enumIds

  (内部使用)

• filters: array filters
• start: integer(int32)

  グリッド範囲の開始点。デフォルトでは0。

• statuses: array statuses

  セル・ステータス。セル・ステータスは、セル値に対して返される場合がある追加情報です。DC: 動的計算。RO: 読取り専用。CM: 計算済メンバー。LO: リンク・オブジェクト。

• texts: array texts

  セル・コメント。

• types: array types

  セルのデータ型。

  • 0: テキスト
  • 2: 倍精度
  • 7: 空

• values: array values

  単一ディメンション・フォーマットでのセルの値。

{
    "type":"object",
    "description":"<p>Range describing grid data. Includes values, types, texts, statuses, enumIds, data, dataFormats, and start and end points.</p>",
    "properties":{
        "statuses":{
            "type":"array",
            "description":"<p>Cell statuses. Cell status is additional information that may be returned for a cell value. DC: Dynamic Calc. RO: Read Only. CM: Calculated Member. LO: Linked Object.</p>",
            "items":{
                "type":"string"
            }
        },
        "enumIds":{
            "type":"array",
            "description":"<p>(Internal use)</p>",
            "items":{
                "type":"string"
            }
        },
        "texts":{
            "type":"array",
            "description":"<p>Cell comments.</p>",
            "items":{
                "type":"string"
            }
        },
        "dataFormats":{
            "type":"array",
            "description":"<p>Data formats, if format strings are applied.</p>",
            "items":{
                "type":"string"
            }
        },
        "types":{
            "type":"array",
            "description":"<p>Data types of the cells. <ul><li><code>0</code>: text</li><li><code>2</code>: double</li><li><code>7</code>: empty</li></ul></p>",
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "end":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Number of elements in the grid range.</p>"
        },
        "start":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Start of the grid range. 0 by default.</p>"
        },
        "values":{
            "type":"array",
            "description":"<p>Cell values, in single-dimension format.</p>",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

フォーマット文字列が適用される場合はデータ・フォーマット。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"<p>Data formats, if format strings are applied.</p>",
    "items":{
        "type":"string"
    }
}

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

型: array

(内部使用)

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"<p>(Internal use)</p>",
    "items":{
        "type":"string"
    }
}

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

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

セル・ステータス。セル・ステータスは、セル値に対して返される場合がある追加情報です。DC: 動的計算。RO: 読取り専用。CM: 計算済メンバー。LO: リンク・オブジェクト。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"<p>Cell statuses. Cell status is additional information that may be returned for a cell value. DC: Dynamic Calc. RO: Read Only. CM: Calculated Member. LO: Linked Object.</p>",
    "items":{
        "type":"string"
    }
}

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

型: array

セル・コメント。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"<p>Cell comments.</p>",
    "items":{
        "type":"string"
    }
}

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

型: array

セルのデータ型。

• 0: テキスト
• 2: 倍精度
• 7: 空

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"<p>Data types of the cells. <ul><li><code>0</code>: text</li><li><code>2</code>: double</li><li><code>7</code>: empty</li></ul></p>",
    "items":{
        "type":"string"
    }
}

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

型: array

単一ディメンション・フォーマットでのセルの値。

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"<p>Cell values, in single-dimension format.</p>",
    "items":{
        "type":"string"
    }
}

400 レスポンス

不正なリクエスト

検証が失敗しました。アプリケーション名、データベース名またはレイアウト名が不足しているか正しくない可能性があります。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、保存済のEssbaseレイアウトからグリッドをレンダリングする方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

cURLコマンドで、Sample Basicキューブにnamedlayout1として保存されているレイアウトのグリッドをリクエストします。

call properties.bat
curl -X GET https://myserver.example.com:9001/essbase/rest/v1/applications/SampleG/databases/Basic/grid/layout/namedlayout1 -H "Accept:application/json" -H "Content-Type:application/json" -o grid1.json -u %User%:%Password%

レスポンス・グリッド

grid1.jsonに書き込まれるレスポンス・オブジェクトは、サンプル表で示されているグリッドを示しています。

-	-	West
-	-	Actual
-	-	Profit
Diet Drinks	Jul	702
Diet Drinks	Aug	753
Diet Drinks	Sep	645
Diet Drinks	Qtr3	2100

グリッドで使用される別名表はDefaultという名前になります。キューブの各ディメンションがdimensionsオブジェクトにリストされます。sliceオブジェクトは、列と行の数およびデータ・セルの位置、値、データ型を示します。データ・セルのデータ型は、テキストの場合は0、倍精度の場合は2、空の場合は7です。

{
  "alias" : "Default",
  "dimensions" : [ {
    "name" : "Year",
    "row" : -1,
    "column" : 1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Measures",
    "row" : 2,
    "column" : -1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Product",
    "row" : -1,
    "column" : 0,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Market",
    "row" : 0,
    "column" : -1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Scenario",
    "row" : 1,
    "column" : -1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  } ],
  "slice" : {
    "columns" : 3,
    "rows" : 7,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 20,
        "values" : [ "", "", "West", "", "", "Actual", "", "", "Profit", "Diet Drinks", "Jul", "702.0", "Diet Drinks", "Aug", "753.0", "Diet Drinks", "Sep", "645.0", "Diet Drinks", "Qtr3", "2100.0" ],
        "types" : [ "7", "7", "0", "7", "7", "0", "7", "7", "0", "0", "0", "2", "0", "0", "2", "0", "0", "2", "0", "0", "2" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "dataFormats" : [ ],
        "statuses" : [ "0", "0", "402653202", "0", "0", "536870928", "0", "0", "134217746", "268435474", "16", "2", "268435474", "16", "2", "268435474", "16", "2", "268435474", "134", "1" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

先頭に戻る