移動先

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

グリッド・プリファレンスの取得

get

/essbase/rest/v1/preferences/grid

セッションからグリッドのプリファレンスを返します。

リクエスト

この操作にはリクエスト・パラメータはありません。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

グリッドのプリファレンスを正常に取得しました。

本体()

ルート・スキーマ : Preferences

型: object

ソースの表示

• cellText: boolean
• columnSupression: object ColumnSuppression
• formulaRetention: object FormulaRetention
• includeDescriptionLabel: boolean
• includeSelection: boolean

  選択したメンバーと、操作の結果として取得されたメンバーを表示します。

• indentation: string
  指定可能な値: [ "NONE", "SUBITEMS", "TOTALS" ]

  階層レベルのインデント方法。NONE: インデントなし。SUBITEMS: 子孫をインデントします。祖先は列で左揃えになります。TOTALS: 祖先をインデントします。子孫は列で左揃えになります。

• maxColumns: integer(int64)
• maxRows: integer(int64)
• missingText: string

  データ値のないセルに表示される文字列。デフォルトは#Missingです。

• navigate: boolean
• noAccessText: string

  データ値を表示するための適切なセキュリティ・アクセス権がない場合に表示される文字列。デフォルトは#NoAccessです。

• removeUnSelectedGroup: boolean

  「ズーム・イン」または「ズーム・アウト」では、選択したメンバー、およびズームの結果として取得されたメンバーを除くすべてのディメンションとメンバーが除去されます。

• repeatMemberLabels: boolean

  データ・ポイントを表す各行セルまたは列セルでメンバー・ラベルを繰り返すかどうか。trueに設定すると、グリッドが大きくなって読みやすくなり、スクロールが必要になります。

• rowSupression: object RowSuppression
• withinSelectedGroup: boolean

  選択したセルのグループに対してのみアド・ホック操作を実行し、選択されていないセルはそのままにします。この設定が有意義なのは、グリッドの下位の行として、またはグリッド全体にわたる列として2つ以上のディメンションがある場合です。「ズーム」、「選択項目のみ保持」および「選択項目のみ削除」の場合。

• zoomIn: object ZoomIn

{
    "type":"object",
    "properties":{
        "indentation":{
            "type":"string",
            "description":"<p>How hierarchy levels are indented. NONE: No indentation. SUBITEMS: Indent descendants. Ancestors are left-justified in the column. TOTALS: Indent ancestors. Descendants are left-justified in the column.</p>",
            "enum":[
                "NONE",
                "SUBITEMS",
                "TOTALS"
            ]
        },
        "navigate":{
            "type":"boolean"
        },
        "includeSelection":{
            "type":"boolean",
            "description":"<p>Display the selected member and the members retrieved as a result of the operation.</p>"
        },
        "repeatMemberLabels":{
            "type":"boolean",
            "description":"<p>Whether to repeat member labels in each row or column cell that represents a data point. Setting to true can help with legibility in large grids that require scrolling.</p>"
        },
        "withinSelectedGroup":{
            "type":"boolean",
            "description":"<p>Perform ad hoc operations only on the selected group of cells, leaving unselected cells as is. This setting is meaningful only when there are two or more dimensions down the grid as rows or across the grid as columns. For Zoom, Keep Only, and Remove Only.</p>"
        },
        "removeUnSelectedGroup":{
            "type":"boolean",
            "description":"<p>For Zoom In or Zoom Out, remove all dimensions and members except the selected member and the members retrieved as a result of zooming.</p>"
        },
        "includeDescriptionLabel":{
            "type":"boolean"
        },
        "missingText":{
            "type":"string",
            "description":"<p>The string displayed for cells that have no data value. Default is #Missing.</p>"
        },
        "noAccessText":{
            "type":"string",
            "description":"<p>The string displayed when you do not have the proper security access to view a data value. Default is #NoAccess.</p>"
        },
        "formulaRetention":{
            "$ref":"#/definitions/FormulaRetention"
        },
        "maxColumns":{
            "type":"integer",
            "format":"int64"
        },
        "rowSupression":{
            "$ref":"#/definitions/RowSuppression",
            "description":"<p>Row suppression options.</p>"
        },
        "columnSupression":{
            "$ref":"#/definitions/ColumnSuppression",
            "description":"<p>Column suppression options.</p>"
        },
        "cellText":{
            "type":"boolean"
        },
        "zoomIn":{
            "$ref":"#/definitions/ZoomIn",
            "description":"<p> Zoom-In options.</p>"
        },
        "maxRows":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: object

ソースの表示

• derived: boolean

  計算から導出されたデータのみを含む列を抑制するかどうか。

• emptyBlocks: boolean

  データベース内にデータが存在しないセルのみを含む列を抑制するかどうか。

• error: boolean
• invalid: boolean

  無効な値(コンテキスト属性または可変属性に関連付けられていないという理由のみで空になっているセル)のみを含む列を抑制するかどうか。

• missing: boolean

  #Missing値のみを含む列を抑制するかどうか。

• noAccess: boolean

  表示するためのセキュリティ・アクセス権がない値のみを含む列を抑制するかどうか。

• underScore: boolean

  メンバー名にアンダースコア文字を含む列を抑制するかどうか。

• zero: boolean

  ゼロのみを含む列を抑制するかどうか。

{
    "type":"object",
    "properties":{
        "zero":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns that contain only zeroes.</p>"
        },
        "missing":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns containing only #Missing values.</p>"
        },
        "underScore":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns that contain underscore characters in member names.</p>"
        },
        "derived":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns containing only data derived from a calculation.</p>"
        },
        "noAccess":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns containing only values that you do not have the security access to view.</p>"
        },
        "emptyBlocks":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns containing only cells for which no data exists in the database.</p>"
        },
        "invalid":{
            "type":"boolean",
            "description":"<p>Whether to suppress columns that contain only invalid values -- cells that are empty only because they are not associated with the context attribute or varying attribute.</p>"
        },
        "error":{
            "type":"boolean"
        }
    }
}

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

型: object

ソースの表示

• comments: boolean
• fill: boolean
• focus: boolean
• retrive: boolean
• zoom: boolean

{
    "type":"object",
    "properties":{
        "comments":{
            "type":"boolean"
        },
        "zoom":{
            "type":"boolean"
        },
        "focus":{
            "type":"boolean"
        },
        "retrive":{
            "type":"boolean"
        },
        "fill":{
            "type":"boolean"
        }
    }
}

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

型: object

ソースの表示

• derived: boolean

  計算から導出されたデータのみを含む行を抑制するかどうか。

• emptyBlocks: boolean

  データベース内にデータが存在しないセルのみを含む行を抑制するかどうか。

• error: boolean
• invalid: boolean

  無効な値(コンテキスト属性または可変属性に関連付けられていないという理由のみで空になっているセル)のみを含む行を抑制するかどうか。

• missing: boolean

  #Missing値のみを含む行を抑制するかどうか。

• noAccess: boolean

  表示するためのセキュリティ・アクセス権がない値のみを含む行を抑制するかどうか。

• underScore: boolean

  メンバー名にアンダースコア文字を含む行を抑制するかどうか。

• zero: boolean

  ゼロのみを含む行を抑制するかどうか。

{
    "type":"object",
    "properties":{
        "zero":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows that contain only zeroes.</p>"
        },
        "missing":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows containing only #Missing values.</p>"
        },
        "underScore":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows that contain underscore characters in member names.</p>"
        },
        "derived":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows containing only data derived from a calculation.</p>"
        },
        "noAccess":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows containing only values that you do not have the security access to view.</p>"
        },
        "emptyBlocks":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows containing only cells for which no data exists in the database.</p>"
        },
        "invalid":{
            "type":"boolean",
            "description":"<p>Whether to suppress rows that contain only invalid values -- cells that are empty only because they are not associated with the context attribute or varying attribute.</p>"
        },
        "error":{
            "type":"boolean"
        }
    }
}

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

型: object

ソースの表示

• ancestor: string
  指定可能な値: [ "TOP", "BOTTOM" ]
• mode: string
  指定可能な値: [ "CHILDREN", "DESCENDENTS", "BASE" ]

{
    "type":"object",
    "properties":{
        "ancestor":{
            "type":"string",
            "enum":[
                "TOP",
                "BOTTOM"
            ]
        },
        "mode":{
            "type":"string",
            "enum":[
                "CHILDREN",
                "DESCENDENTS",
                "BASE"
            ]
        }
    }
}

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/preferences/grid" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

レスポンス本体の例

{
  "maxRows" : 0,
  "indentation" : "SUBITEMS",
  "cellText" : true,
  "columnSupression" : {
    "zero" : false,
    "missing" : false,
    "underScore" : false,
    "derived" : false,
    "noAccess" : false,
    "emptyBlocks" : false,
    "invalid" : false,
    "error" : false
  },
  "zoomIn" : {
    "ancestor" : "top",
    "mode" : "children"
  },
  "navigate" : true,
  "includeSelection" : true,
  "repeatMemberLabels" : true,
  "withinSelectedGroup" : false,
  "removeUnSelectedGroup" : false,
  "includeDescriptionLabel" : false,
  "missingText" : "#Missing",
  "noAccessText" : "#No Access",
  "formulaRetention" : {
    "comments" : false,
    "retrive" : false,
    "zoom" : false,
    "focus" : false,
    "fill" : false
  },
  "maxColumns" : 0,
  "rowSupression" : {
    "zero" : false,
    "missing" : false,
    "underScore" : false,
    "derived" : false,
    "noAccess" : false,
    "emptyBlocks" : false,
    "invalid" : false,
    "error" : false
  }
}

先頭に戻る