Oracle Essbase REST API

グリッド操作の実行

post

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

指定された操作のためにグリッドを返します。サポートされているグリッド操作は、ズーム・イン(zoomin)、ズーム・アウト(zoomout)、リフレッシュ(refresh)、選択項目のみ保持(keeponly)、選択項目のみ削除(removeonly)、送信(submit)、ピボット(pivot)およびPOVにピボット(pivotToPOV)です。

リクエスト

パス・パラメータ

applicationName(required): string

グリッド操作のアプリケーション名
databaseName(required): string

グリッド操作のデータベース名またはキューブ名。

実行するグリッド操作。

ルート・スキーマ : GridOperation

型: object

実行するグリッド操作。grid、action、coordinatesおよびrangesを指定します。

ソースの表示

action: string

指定可能な値: [ "ZOOMIN", "ZOOMOUT", "KEEPONLY", "REMOVEONLY", "REFRESH", "PIVOT", "PIVOTTOPOV", "SUBMIT" ]

グリッドに対して実行するアクションのタイプ。
alias: string

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

グリッド操作の座標配列。構文"coordinates": [index]を使用して指定します。indexは、最も左上にあるセルを0として、左から右へ1行ずつカウントしたセルの位置となります。
grid: object Grid
ranges: array ranges

zoomin、zoomout、keeponlyおよびremoveonlyグリッド操作に使用する範囲オブジェクト。構文"ranges": [rowNo,colNo,noOfRows,noOfCols]を使用し、1つ以上の範囲を配列として指定します。ここで、最初の引数は行番号(0から始まる)、2番目の引数は列(0から始まる)、3番目の引数は行の数および4番目の引数は列の数です。

{
    "type":"object",
    "description":"<p>Grid operation to perform, specifying the grid, action, coordinates, and ranges.</p>",
    "properties":{
        "grid":{
            "$ref":"#/definitions/Grid",
            "description":"<p>Grid object containing dimensions, the position of each dimension, and the slice consisting of data.</p>"
        },
        "action":{
            "type":"string",
            "description":"<p>Type of action to perform on the grid.</p>",
            "enum":[
                "ZOOMIN",
                "ZOOMOUT",
                "KEEPONLY",
                "REMOVEONLY",
                "REFRESH",
                "PIVOT",
                "PIVOTTOPOV",
                "SUBMIT"
            ]
        },
        "alias":{
            "type":"string",
            "description":"<p>The active alias table for the grid.</p>"
        },
        "coordinates":{
            "type":"array",
            "description":"<p>Coordinates array for grid operation. Specify using syntax <code>\"coordinates\": [<i>index</i>]</code>, where <i>index</i> describes a cell position, starting with 0 for the upper-left-most cell, and counting left to right, row by row.</p>",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "ranges":{
            "type":"array",
            "description":"<p>Range object used for zoomin, zoomout, keeponly, and removeonly grid operations. Specify one or more ranges as an array using the syntax: <code>\"ranges\": [<i>rowNo</i>,<i>colNo</i>,<i>noOfRows</i>,<i>noOfCols</i>]</code>, where the first argument is row number (start at 0), the second argument is column (start at 0), third argument is number of rows, and the fourth argument is number of columns.</p>",
            "items":{
                "type":"array",
                "items":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        }
    }
}

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

型: array

グリッド操作の座標配列。構文"coordinates": [index]を使用して指定します。indexは、最も左上にあるセルを0として、左から右へ1行ずつカウントしたセルの位置となります。

ソースの表示

配列: integer(int32)

{
    "type":"array",
    "description":"<p>Coordinates array for grid operation. Specify using syntax <code>\"coordinates\": [<i>index</i>]</code>, where <i>index</i> describes a cell position, starting with 0 for the upper-left-most cell, and counting left to right, row by row.</p>",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

ネストされたスキーマ : 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"
            }
        }
    }
}

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

型: array

zoomin、zoomout、keeponlyおよびremoveonlyグリッド操作に使用する範囲オブジェクト。構文"ranges": [rowNo,colNo,noOfRows,noOfCols]を使用し、1つ以上の範囲を配列として指定します。ここで、最初の引数は行番号(0から始まる)、2番目の引数は列(0から始まる)、3番目の引数は行の数および4番目の引数は列の数です。

ソースの表示

配列: array items

{
    "type":"array",
    "description":"<p>Range object used for zoomin, zoomout, keeponly, and removeonly grid operations. Specify one or more ranges as an array using the syntax: <code>\"ranges\": [<i>rowNo</i>,<i>colNo</i>,<i>noOfRows</i>,<i>noOfCols</i>]</code>, where the first argument is row number (start at 0), the second argument is column (start at 0), third argument is number of rows, and the fourth argument is number of columns.</p>",
    "items":{
        "type":"array",
        "items":{
            "type":"integer",
            "format":"int32"
        }
    }
}

ネストされたスキーマ : 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"
    }
}

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

型: array

ソースの表示

配列: integer(int32)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

グリッド操作が正常に完了しました。

ルート・スキーマ : 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

	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

ソースの表示

配列: 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コマンドで、入力gridsubmit.jsonに記述されているグリッドの送信操作を送信します。

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/grid" -H "Accept:application/json" -H "Content-Type:application/json" --data "@./gridsubmit.json" -o out_gridsubmit.json -u %User%:%Password%

JSONオブジェクトとして実行できるその他の操作の例を、送信の例の後に示します。

送信の例
リフレッシュの例
ズーム・インの例
ズーム・アウトの例
選択項目のみ保持の例
選択項目のみ削除の例
ピボットの例
POVにピボットの例

送信の例

次のグリッドの送信操作では、データ値1052を([Jan], [Sales], [Cola], [New York], [Actual])に送信します。

-	Cola	New York	Actual
-	Sales	-	-
Jan	1052	-	-

送信用の入力グリッド

入力グリッドおよび送信操作を送信するアクションはgridsubmit.jsonに含まれ、次のようになっています。

{
	"action": "submit",
	"grid": {
		"dimensions": [
			{
				"name": "Year",
				"column": 0
			},
			{
				"name": "Measures",
				"row": 1
			},
			{
				"name": "Product",
				"pov": "Product"
			},
			{
				"name": "Market",
				"pov": "Market"
			},
			{
				"name": "Scenario",
				"pov": "Scenario"
			}
		],
		"slice": {
			"columns": 4,
			"rows": 3,
			"dirtyCells": [ 9 ],
			"data": {
				"ranges": [
					{
						"end": 11,
						"values": [ "", "100-10", "New York", "Actual", "", "Sales", "", "", "Jan", "1052", "", "" ],
						"types": [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ]
					}
				]
			}
		}
	}
}

送信アクションにはdirtyCells配列が必要です。変更される値の1つまたはインデックスを指定します(values配列内の最初の値を0としてカウントしていきます)。次の構文を使用します。

"dirtyCells": [index]

ここで、index引数は、送信操作によって変更される1つ以上のセルの位置を示します。複数のindex引数は、カンマ区切りの配列で指定できます。

送信用のレスポンス・グリッド

out_gridsubmit.jsonに書き込まれる結果のレスポンスは、次のとおりです。

{
  "alias" : "Default",
  "dimensions" : [ {
    "name" : "Year",
    "row" : -1,
    "column" : 0,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Measures",
    "row" : 1,
    "column" : -1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Product",
    "row" : -1,
    "column" : -1,
    "pov" : "Cola",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Market",
    "row" : -1,
    "column" : -1,
    "pov" : "New York",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Scenario",
    "row" : -1,
    "column" : -1,
    "pov" : "Actual",
    "hidden" : false,
    "expanded" : false
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 11,
        "values" : [ "", "Cola", "New York", "Actual", "", "Sales", "", "", "Jan", "1052.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null ],
        "dataFormats" : [ ],
        "statuses" : [ "0", "268435472", "402653200", "536870928", "0", "134217744", "0", "0", "16", "2", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

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

リフレッシュの例

次のグリッドのリフレッシュ操作では、デフォルトのSample Basicグリッドに戻ります。

-	Product	Market	Scenario
-	Measures	-	-
Year	105522	-	-

リフレッシュ用の入力グリッド

入力グリッドおよびリフレッシュ操作を送信するアクションはgridrefresh.jsonに含まれ、次のようになっています。

{
"action" : "refresh",
"grid": {
  "dimensions" : [ {
    "name" : "Year",
    "column" : 0
  }, {
    "name" : "Measures",
    "row" : 1
  }, {
    "name" : "Product",
    "pov" : "Product"
  }, {
    "name" : "Market",
    "pov" : "Market"
  }, {
    "name" : "Scenario",
    "pov" : "Scenario"
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "end" : 11,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Year", "105522.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "135", "1", "0", "0" ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ],
        "dataFormats" : [ null, null, null, null, null, null, null, null, null, null, null, null ]
      } ]
    }
  }
 }
}

リフレッシュ用のレスポンス・グリッド

結果のレスポンス・グリッドは、次のとおりです。

{
  "alias" : "Default",
  "dimensions" : [ {
    "name" : "Year",
    "row" : -1,
    "column" : 0,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Measures",
    "row" : 1,
    "column" : -1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Product",
    "row" : -1,
    "column" : -1,
    "pov" : "Product",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Market",
    "row" : -1,
    "column" : -1,
    "pov" : "Market",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Scenario",
    "row" : -1,
    "column" : -1,
    "pov" : "Scenario",
    "hidden" : false,
    "expanded" : false
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 11,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Year", "105522.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null ],
        "dataFormats" : [ ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "135", "1", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

ズーム・インの例

次のグリッドのズームイン操作では、Yearディメンションを展開して四半期を分析します。

-	Product	Market	Scenario
-	Measures	-	-
Qtr1	24703	-	-
Qtr2	27107	-	-
Qtr3	27912	-	-
Qtr4	25800	-	-
Year	105522	-	-

ズーム・イン用の入力グリッド

入力グリッドおよびズーム・イン操作を送信するアクションはgridzoomin.jsonに含まれ、次のようになっています。

{
"action" : "zoomin",
"ranges": [[2,0,1,1]],
"grid": {
  "dimensions" : [ {
    "name" : "Year",
    "column" : 0
  }, {
    "name" : "Measures",
    "row" : 1
  }, {
    "name" : "Product",
    "pov" : "Product"
  }, {
    "name" : "Market",
    "pov" : "Market"
  }, {
    "name" : "Scenario",
    "pov" : "Scenario"
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "end" : 11,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Year", "105522.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "135", "1", "0", "0" ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ],
        "dataFormats" : [ null, null, null, null, null, null, null, null, null, null, null, null ]
      } ]
    }
  }
 }
}

ズーム・イン・アクションにはrangesオブジェクトが必要です。次の構文を使用して、1つ以上の範囲を配列として指定します。

"ranges": [rowNo,colNo,noOfRows,noOfCols]

ここで、最初の引数は行番号(0から始まる)、2番目の引数は列(0から始まる)、3番目の引数は行の数および4番目の引数は列の数です。たとえば、Sample Basicのデフォルト・グリッドの場合、

-	Product	Market	Scenario
-	Measures	-	-
Year	105522	-	-

Year (座標2,0)にズーム・インするには、actionの後に"ranges": [[2,0,1,1]]を指定します。複数のセルに同時にズーム・インするには、"ranges": [[2,0,1,1],[1,1,1,1]]のように複数の範囲を指定します。これは、YearとMeasuresの両方にズーム・インします。

ズーム・イン用のレスポンス・グリッド

結果のレスポンス・グリッドは、次のとおりです。

{
  "alias" : "Default",
  "dimensions" : [ {
    "name" : "Year",
    "row" : -1,
    "column" : 0,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Measures",
    "row" : 1,
    "column" : -1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Product",
    "row" : -1,
    "column" : -1,
    "pov" : "Product",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Market",
    "row" : -1,
    "column" : -1,
    "pov" : "Market",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Scenario",
    "row" : -1,
    "column" : -1,
    "pov" : "Scenario",
    "hidden" : false,
    "expanded" : false
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 7,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 27,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr1", "24703.0", "", "", "Qtr2", "27107.0", "", "", "Qtr3", "27912.0", "", "", "Qtr4", "25800.0", "", "", "Year", "105522.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "dataFormats" : [ ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "135", "1", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

ズーム・アウトの例

次のグリッドのズームアウト操作では、再度年合計のみを表示するように、Yearディメンションの四半期を縮小します。

ズーム・アウト用の入力グリッド

入力グリッドおよびズーム・アウト操作を送信するアクションはgridzoomout.jsonに含まれ、次のようになっています。

{
"action" : "zoomout",
"ranges": [[2,0,1,1]],
"grid":
{
  "dimensions" : [ {
    "name" : "Year",
    "column" : 0
  }, {
    "name" : "Measures",
    "row" : 1
  }, {
    "name" : "Product",
    "pov" : "Product"
  }, {
    "name" : "Market",
    "pov" : "Market"
  }, {
    "name" : "Scenario",
    "pov" : "Scenario"
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 6,
    "data" : {
      "ranges" : [ {
        "end" : 23,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr1", "24703.0", "", "", "Qtr2", "27107.0", "", "", "Qtr3", "27912.0", "", "", "Qtr4", "25800.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0" ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ],
        "dataFormats" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ]
      } ]
    }
  }
 }
}

ズーム・アウト・アクションにはrangesオブジェクトが必要です。次の構文を使用して、1つ以上の範囲を配列として指定します。

"ranges": [rowNo,colNo,noOfRows,noOfCols]

ここで、最初の引数は行番号(0から始まる)、2番目の引数は列(0から始まる)、3番目の引数は行の数および4番目の引数は列の数です。たとえば、Sample Basicの次のグリッドの場合、

-	Product	Market	Scenario
-	Measures	-	-
Qtr1	24703	-	-
Qtr2	27107	-	-
Qtr3	27912	-	-
Qtr4	25800	-	-
Year	105522	-	-

Qtr1 (座標2,0)に対してズーム・アウトするには、actionの後に"ranges": [[2,0,1,1]]を指定します。複数のセルに対して同時にズーム・アウトするには、"ranges": [[2,0,1,1],[1,1,1,1]]のように複数の範囲を指定します(Measuresはすでにズーム・アウトされているため、この例では適用されません)。

ズーム・アウト用のレスポンス・グリッド

結果のレスポンス・グリッドは、次のとおりです。

-	Product	Market	Scenario
-	Measures	-	-
Year	105522	-	-

{
  "alias" : "Default",
  "dimensions" : [ {
    "name" : "Year",
    "row" : -1,
    "column" : 0,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Measures",
    "row" : 1,
    "column" : -1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Product",
    "row" : -1,
    "column" : -1,
    "pov" : "Product",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Market",
    "row" : -1,
    "column" : -1,
    "pov" : "Market",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Scenario",
    "row" : -1,
    "column" : -1,
    "pov" : "Scenario",
    "hidden" : false,
    "expanded" : false
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 11,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Year", "105522.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null ],
        "dataFormats" : [ ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "135", "1", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

選択項目のみ保持の例

次のグリッドの選択項目のみ保持の例では、次のグリッドからQtr1以外のすべての四半期を削除します。

-	Product	Market	Scenario
-	Measures	-	-
Qtr1	24703	-	-
Qtr2	27107	-	-
Qtr3	27912	-	-
Qtr4	25800	-	-
Year	105522	-	-

選択項目のみ保持用の入力グリッド

入力グリッドおよび「選択項目のみ保持」操作を送信するアクションはgridkeeponly.jsonに含まれ、次のようになっています。

{
"action" : "keeponly",
"ranges": [[2,0,1,1]],
"grid":
{
  "dimensions" : [ {
    "name" : "Year",
    "column" : 0
  }, {
    "name" : "Measures",
    "row" : 1
  }, {
    "name" : "Product",
    "pov" : "Product"
  }, {
    "name" : "Market",
    "pov" : "Market"
  }, {
    "name" : "Scenario",
    "pov" : "Scenario"
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 6,
    "data" : {
      "ranges" : [ {
        "end" : 23,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr1", "24703.0", "", "", "Qtr2", "27107.0", "", "", "Qtr3", "27912.0", "", "", "Qtr4", "25800.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0" ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ],
        "dataFormats" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ]
      } ]
    }
  }
 }
}

選択項目のみ保持用のレスポンス・グリッド

結果のレスポンス・グリッドは、次のとおりです。

-	Product	Market	Scenario
-	Measures	-	-
Qtr1	24703	-	-

{
  "alias" : "Default",
  "dimensions" : [ {
    "name" : "Year",
    "row" : -1,
    "column" : 0,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Measures",
    "row" : 1,
    "column" : -1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Product",
    "row" : -1,
    "column" : -1,
    "pov" : "Product",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Market",
    "row" : -1,
    "column" : -1,
    "pov" : "Market",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Scenario",
    "row" : -1,
    "column" : -1,
    "pov" : "Scenario",
    "hidden" : false,
    "expanded" : false
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 11,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr1", "24703.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null ],
        "dataFormats" : [ ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

選択項目のみ削除の例

次のグリッドの「選択項目のみ削除」操作では、次のグリッドのYearディメンションからQtr1のみを削除します。

-	Product	Market	Scenario
-	Measures	-	-
Qtr1	24703	-	-
Qtr2	27107	-	-
Qtr3	27912	-	-
Qtr4	25800	-	-
Year	105522	-	-

選択項目のみ削除用の入力グリッド

入力グリッドおよび「選択項目のみ削除」操作を送信するアクションはgridremoveonly.jsonに含まれ、次のようになっています。

{
"action" : "removeonly",
"ranges": [[2,0,1,1]],
"grid":
{
  "dimensions" : [ {
    "name" : "Year",
    "column" : 0
  }, {
    "name" : "Measures",
    "row" : 1
  }, {
    "name" : "Product",
    "pov" : "Product"
  }, {
    "name" : "Market",
    "pov" : "Market"
  }, {
    "name" : "Scenario",
    "pov" : "Scenario"
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 6,
    "data" : {
      "ranges" : [ {
        "end" : 23,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr1", "24703.0", "", "", "Qtr2", "27107.0", "", "", "Qtr3", "27912.0", "", "", "Qtr4", "25800.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0" ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ],
        "dataFormats" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ]
      } ]
    }
  }
 }
}

選択項目のみ削除用のレスポンス・グリッド

結果のレスポンス・グリッドは、次のとおりです。

-	Product	Market	Scenario
-	Measures	-	-
Qtr2	27107	-	-
Qtr3	27912	-	-
Qtr4	25800	-	-
Year	105522	-	-

{
  "alias" : "Default",
  "dimensions" : [ {
    "name" : "Year",
    "row" : -1,
    "column" : 0,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Measures",
    "row" : 1,
    "column" : -1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Product",
    "row" : -1,
    "column" : -1,
    "pov" : "Product",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Market",
    "row" : -1,
    "column" : -1,
    "pov" : "Market",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Scenario",
    "row" : -1,
    "column" : -1,
    "pov" : "Scenario",
    "hidden" : false,
    "expanded" : false
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 5,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 19,
        "values" : [ "", "Product", "Market", "Scenario", "", "Measures", "", "", "Qtr2", "27107.0", "", "", "Qtr3", "27912.0", "", "", "Qtr4", "25800.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null ],
        "dataFormats" : [ ],
        "statuses" : [ "0", "268435475", "402653203", "536870923", "0", "134217739", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0", "134", "1", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

ピボットの例

次のグリッドのピボット操作では、New Yorkを行に移動します。ピボットは列を行に、または行を列に移動します。POVメンバーをピボットすると、それは行に移動します。グリッドは最初次のようになっています。

-	Cola	New York	Actual
-	Sales	-	-
Jan	1052	-	-

ピボット用の入力グリッド

入力グリッドおよびピボット操作を送信するアクションはgridpivot.jsonに含まれ、次のようになっています。

{
	"action": "pivot",
	"coordinates": [ 2 ],
	"grid": {
		"dimensions": [
			{
				"name": "Year",
				"column": 0
			},
			{
				"name": "Measures",
				"row": 1
			},
			{
				"name": "Product",
				"pov": "Product"
			},
			{
				"name": "Market",
				"pov": "Market"
			},
			{
				"name": "Scenario",
				"pov": "Scenario"
			}
		],
		"slice": {
			"columns": 4,
			"rows": 3,
			"data": {
				"ranges": [ {
					"end": 11,
					"values": [ "", "100-10", "New York", "Actual", "", "Sales", "", "", "Jan", "1051", "", "" ],
					"types": [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ]
					}
				]
			}
		}
	}
}

ピボット・アクションにはcoordinates配列が必要です。次の構文を使用して、座標を配列として指定します。

"coordinates": [index]

ここで、index引数は、最も左上にあるセルを0として、左から右へ1行ずつカウントした、ピボットするメンバーのセルの位置となります。

ピボット用のレスポンス・グリッド

結果のレスポンス・グリッドは、次のとおりです。

-	-	Cola	Actual
-	-	Sales	-
New York	Jan	1052	-

{
	"action": "pivot",
	"coordinates": [ 2 ],
	"grid": {
		"dimensions": [
			{
				"name": "Year",
				"column": 0
			},
			{
				"name": "Measures",
				"row": 1
			},
			{
				"name": "Product",
				"pov": "Product"
			},
			{
				"name": "Market",
				"pov": "Market"
			},
			{
				"name": "Scenario",
				"pov": "Scenario"
			}
		],
		"slice": {
			"columns": 4,
			"rows": 3,
			"data": {
				"ranges": [ {
					"end": 11,
					"values": [ "", "100-10", "New York", "Actual", "", "Sales", "", "", "Jan", "1051", "", "" ],
					"types": [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ]
					}
				]
			}
		}
	}
}

POVにピボットの例

次のグリッドは、前の例のグリッドから開始して、New YorkをPOVに戻します。

POVにピボット用の入力グリッド

入力グリッドおよび「POVにピボット」操作を送信するアクションはgridpivottopov.jsonに含まれ、次のようになっています。

{
	"action": "pivotToPOV",
	"coordinates": [ 8, 2 ],
	"grid": {
		"dimensions": [
			{
				"name": "Year",
				"column": 1
			},
			{
				"name": "Measures",
				"row": 1
			},
			{
				"name": "Product",
				"pov": "100-10"
			},
			{
				"name": "Market",
				"column": 0
			},
			{
				"name": "Scenario",
				"pov": "Actual"
			}
		],
		"slice": {
			"columns": 4,
			"rows": 3,
			"data": {
				"ranges": [
					{
						"end": 11,
						"values": [ "", "", "100-10", "Actual", "", "", "Sales", "", "New York", "Jan", "1051.0", "" ],
						"types": [ "7", "7", "0", "0", "7", "7", "0", "7", "0", "0", "2", "7" ],
						"texts": [ null, null, null, null, null, null, null, null, null, null, null, null ],
						"statuses": [ "0", "0", "268435472", "536870928", "0", "0", "134217744", "0", "402653200", "16", "2", "0" ],
						"enumIds": ["", "", "", "", "", "", "", "", "", "", "", "" ],
						"dataFormats": [ null, null, null, null, null, null, null, null, null, null, null, null ]
					}
				]
			}
		}
	}
}

POVにピボット用のレスポンス・グリッド

結果のレスポンス・グリッドは、次のとおりです。

-	New York	Cola	Actual
-	Sales	-	-
Jan	1052	-	-

{
  "alias" : "Default",
  "dimensions" : [ {
    "name" : "Year",
    "row" : -1,
    "column" : 0,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Measures",
    "row" : 1,
    "column" : -1,
    "pov" : "",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Product",
    "row" : -1,
    "column" : -1,
    "pov" : "Cola",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Market",
    "row" : -1,
    "column" : -1,
    "pov" : "New York",
    "hidden" : false,
    "expanded" : false
  }, {
    "name" : "Scenario",
    "row" : -1,
    "column" : -1,
    "pov" : "Actual",
    "hidden" : false,
    "expanded" : false
  } ],
  "slice" : {
    "columns" : 4,
    "rows" : 3,
    "data" : {
      "ranges" : [ {
        "start" : 0,
        "end" : 11,
        "values" : [ "", "New York", "Cola", "Actual", "", "Sales", "", "", "Jan", "1052.0", "", "" ],
        "types" : [ "7", "0", "0", "0", "7", "0", "7", "7", "0", "2", "7", "7" ],
        "texts" : [ null, null, null, null, null, null, null, null, null, null, null, null ],
        "dataFormats" : [ ],
        "statuses" : [ "0", "402653200", "268435472", "536870928", "0", "134217744", "0", "0", "16", "2", "0", "0" ],
        "filters" : [ ],
        "enumIds" : [ "", "", "", "", "", "", "", "", "", "", "", "" ]
      } ]
    }
  }
}

先頭に戻る