機械翻訳について

ジャンプ先

• 要求
• レスポンス

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

get

/essbase/rest/v1/preferences/grid

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

要求

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

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

グリッド・プリファレンスが正常に取得されました。

本文()

ルート・スキーマ : プリファレンス

タイプ: object

Show Source

• cellText(optional): boolean
• columnSupression(optional): object ColumnSuppression
• formulaRetention(optional): object FormulaRetention
• includeDescriptionLabel(optional): boolean
• includeSelection(optional): boolean
• indentation(optional): string
  許可される値: [ "NONE", "SUBITEMS", "TOTALS" ]
• maxColumns(optional): integer(int64)
• maxRows(optional): integer(int64)
• missingText(optional): string
• navigate(optional): boolean
• noAccessText(optional): string
• removeUnSelectedGroup(optional): boolean
• repeatMemberLabels(optional): boolean
• rowSupression(optional): object RowSuppression
• withinSelectedGroup(optional): boolean
• zoomIn(optional): object ZoomIn

{
    "type":"object",
    "properties":{
        "maxRows":{
            "type":"integer",
            "format":"int64"
        },
        "indentation":{
            "type":"string",
            "enum":[
                "NONE",
                "SUBITEMS",
                "TOTALS"
            ]
        },
        "rowSupression":{
            "$ref":"#/definitions/RowSuppression"
        },
        "columnSupression":{
            "$ref":"#/definitions/ColumnSuppression"
        },
        "cellText":{
            "type":"boolean"
        },
        "zoomIn":{
            "$ref":"#/definitions/ZoomIn"
        },
        "navigate":{
            "type":"boolean"
        },
        "includeSelection":{
            "type":"boolean"
        },
        "repeatMemberLabels":{
            "type":"boolean"
        },
        "withinSelectedGroup":{
            "type":"boolean"
        },
        "removeUnSelectedGroup":{
            "type":"boolean"
        },
        "includeDescriptionLabel":{
            "type":"boolean"
        },
        "missingText":{
            "type":"string"
        },
        "noAccessText":{
            "type":"string"
        },
        "formulaRetention":{
            "$ref":"#/definitions/FormulaRetention"
        },
        "maxColumns":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

タイプ: object

Show Source

• derived(optional): boolean
• emptyBlocks(optional): boolean
• error(optional): boolean
• invalid(optional): boolean
• missing(optional): boolean
• noAccess(optional): boolean
• underScore(optional): boolean
• zero(optional): boolean

{
    "type":"object",
    "properties":{
        "underScore":{
            "type":"boolean"
        },
        "noAccess":{
            "type":"boolean"
        },
        "emptyBlocks":{
            "type":"boolean"
        },
        "invalid":{
            "type":"boolean"
        },
        "missing":{
            "type":"boolean"
        },
        "derived":{
            "type":"boolean"
        },
        "zero":{
            "type":"boolean"
        },
        "error":{
            "type":"boolean"
        }
    }
}

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

タイプ: object

Show Source

• comments(optional): boolean
• fill(optional): boolean
• focus(optional): boolean
• retrive(optional): boolean
• zoom(optional): boolean

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

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

タイプ: object

Show Source

• derived(optional): boolean
• emptyBlocks(optional): boolean
• error(optional): boolean
• invalid(optional): boolean
• missing(optional): boolean
• noAccess(optional): boolean
• underScore(optional): boolean
• zero(optional): boolean

{
    "type":"object",
    "properties":{
        "underScore":{
            "type":"boolean"
        },
        "noAccess":{
            "type":"boolean"
        },
        "emptyBlocks":{
            "type":"boolean"
        },
        "invalid":{
            "type":"boolean"
        },
        "missing":{
            "type":"boolean"
        },
        "derived":{
            "type":"boolean"
        },
        "zero":{
            "type":"boolean"
        },
        "error":{
            "type":"boolean"
        }
    }
}

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

タイプ: object

Show Source

• ancestor(optional): string
  許可される値: [ "TOP", "BOTTOM" ]
• mode(optional): string
  許可される値: [ "CHILDREN", "DESCENDENTS", "BASE" ]

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

400 レスポンス

不正なリクエスト

グリッド・プリファレンスの取得に失敗しました。 セッションが無効である可能性があります。

500 レスポンス

内部サーバー・エラー。

先頭に戻る