移動先

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

グリッド・レイアウトの更新

put

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

指定されたキューブ内で、提供した詳細でレイアウトを更新します。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• application(required): string

  アプリケーション名。

• database(required): string

  データベース名。

• layout(required): string

  レイアウト名。

問合せパラメータ

• user: string

  ユーザー名。

本体()

更新するレイアウト詳細。

ルート・スキーマ : Layout

型: object

ソースの表示

• header: object LayoutHeader
• spec: object LayoutSpec

{
    "type":"object",
    "properties":{
        "header":{
            "$ref":"#/definitions/LayoutHeader",
            "description":"<p>Header information about the layout. Includes its name, the user who created it, whether it is the default layout for the cube, and whether it is the default layout for this user.</p>"
        },
        "spec":{
            "$ref":"#/definitions/LayoutSpec",
            "description":"<p>Layout specification object containing information about the dimensions and data in the layout.</p>"
        }
    }
}

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

型: object

ソースの表示

• databaseDefault: boolean
• name: string
• session: boolean
• user: string
• userDefault: boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "user":{
            "type":"string"
        },
        "databaseDefault":{
            "type":"boolean"
        },
        "userDefault":{
            "type":"boolean"
        },
        "session":{
            "type":"boolean"
        }
    }
}

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

型: object

ソースの表示

• description: string
• grid: object LayoutGrid
• preferences: object LayoutPreferences

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "grid":{
            "$ref":"#/definitions/LayoutGrid"
        },
        "preferences":{
            "$ref":"#/definitions/LayoutPreferences"
        }
    }
}

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

型: object

ソースの表示

• alias: string

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

• data: object LayoutData
• dimensions: array dimensions

{
    "type":"object",
    "properties":{
        "alias":{
            "type":"string",
            "description":"<p>The active alias table for the grid.</p>"
        },
        "dimensions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LayoutDimension"
            }
        },
        "data":{
            "$ref":"#/definitions/LayoutData"
        }
    }
}

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

型: object

ソースの表示

• cellText: boolean
• columnSuppression: object Suppression
• formulaRetention: object FormulaRetention
• includeDescriptionLabel: boolean
• includeSelection: boolean
• indentation: string
  指定可能な値: [ "NONE", "SUBITEMS", "TOTALS" ]
• maxRows: integer(int32)
• missingText: string
• navigate: boolean
• noAccessText: string

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

• removeUnSelectedGroup: boolean
• repeatMemberLabels: boolean
• rowSuppression: object Suppression
• withinSelectedGroup: boolean
• zoomIn: object ZoomIn

{
    "type":"object",
    "properties":{
        "indentation":{
            "type":"string",
            "enum":[
                "NONE",
                "SUBITEMS",
                "TOTALS"
            ]
        },
        "rowSuppression":{
            "$ref":"#/definitions/Suppression"
        },
        "columnSuppression":{
            "$ref":"#/definitions/Suppression"
        },
        "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",
            "description":"<p>The string displayed when you do not have the proper security access to view a data value. Default is #NoAccess.</p>"
        },
        "maxRows":{
            "type":"integer",
            "format":"int32"
        },
        "formulaRetention":{
            "$ref":"#/definitions/FormulaRetention"
        }
    }
}

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

型: object

ソースの表示

• dataFormats: array dataFormats
• enumIds: array enumIds
• filters: array filters
• statuses: array statuses
• texts: array texts
• types: array types
• values: array values

{
    "type":"object",
    "properties":{
        "values":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "types":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "texts":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "dataFormats":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "statuses":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "filters":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "enumIds":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object LayoutDimension

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: object

ソースの表示

• axis: string
  指定可能な値: [ "COLUMN", "ROW", "POV" ]
• displayName: string
• expanded: boolean
• hidden: boolean
• name: string
• page: integer(int32)
• position: integer(int32)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "page":{
            "type":"integer",
            "format":"int32"
        },
        "hidden":{
            "type":"boolean"
        },
        "expanded":{
            "type":"boolean"
        },
        "axis":{
            "type":"string",
            "enum":[
                "COLUMN",
                "ROW",
                "POV"
            ]
        },
        "position":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: object

ソースの表示

• derived: boolean
• emptyBlocks: boolean
• error: boolean
• invalid: boolean
• missing: boolean
• noAccess: boolean
• underScore: boolean
• zero: boolean

{
    "type":"object",
    "properties":{
        "missing":{
            "type":"boolean"
        },
        "invalid":{
            "type":"boolean"
        },
        "derived":{
            "type":"boolean"
        },
        "zero":{
            "type":"boolean"
        },
        "underScore":{
            "type":"boolean"
        },
        "noAccess":{
            "type":"boolean"
        },
        "emptyBlocks":{
            "type":"boolean"
        },
        "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"
        }
    }
}

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

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

レイアウトが正常に更新されました。

本体()

ルート・スキーマ : Layout

型: object

ソースの表示

• header: object LayoutHeader
• spec: object LayoutSpec

{
    "type":"object",
    "properties":{
        "header":{
            "$ref":"#/definitions/LayoutHeader",
            "description":"<p>Header information about the layout. Includes its name, the user who created it, whether it is the default layout for the cube, and whether it is the default layout for this user.</p>"
        },
        "spec":{
            "$ref":"#/definitions/LayoutSpec",
            "description":"<p>Layout specification object containing information about the dimensions and data in the layout.</p>"
        }
    }
}

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

型: object

ソースの表示

• databaseDefault: boolean
• name: string
• session: boolean
• user: string
• userDefault: boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "user":{
            "type":"string"
        },
        "databaseDefault":{
            "type":"boolean"
        },
        "userDefault":{
            "type":"boolean"
        },
        "session":{
            "type":"boolean"
        }
    }
}

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

型: object

ソースの表示

• description: string
• grid: object LayoutGrid
• preferences: object LayoutPreferences

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "grid":{
            "$ref":"#/definitions/LayoutGrid"
        },
        "preferences":{
            "$ref":"#/definitions/LayoutPreferences"
        }
    }
}

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

型: object

ソースの表示

• alias: string

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

• data: object LayoutData
• dimensions: array dimensions

{
    "type":"object",
    "properties":{
        "alias":{
            "type":"string",
            "description":"<p>The active alias table for the grid.</p>"
        },
        "dimensions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LayoutDimension"
            }
        },
        "data":{
            "$ref":"#/definitions/LayoutData"
        }
    }
}

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

型: object

ソースの表示

• cellText: boolean
• columnSuppression: object Suppression
• formulaRetention: object FormulaRetention
• includeDescriptionLabel: boolean
• includeSelection: boolean
• indentation: string
  指定可能な値: [ "NONE", "SUBITEMS", "TOTALS" ]
• maxRows: integer(int32)
• missingText: string
• navigate: boolean
• noAccessText: string

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

• removeUnSelectedGroup: boolean
• repeatMemberLabels: boolean
• rowSuppression: object Suppression
• withinSelectedGroup: boolean
• zoomIn: object ZoomIn

{
    "type":"object",
    "properties":{
        "indentation":{
            "type":"string",
            "enum":[
                "NONE",
                "SUBITEMS",
                "TOTALS"
            ]
        },
        "rowSuppression":{
            "$ref":"#/definitions/Suppression"
        },
        "columnSuppression":{
            "$ref":"#/definitions/Suppression"
        },
        "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",
            "description":"<p>The string displayed when you do not have the proper security access to view a data value. Default is #NoAccess.</p>"
        },
        "maxRows":{
            "type":"integer",
            "format":"int32"
        },
        "formulaRetention":{
            "$ref":"#/definitions/FormulaRetention"
        }
    }
}

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

型: object

ソースの表示

• dataFormats: array dataFormats
• enumIds: array enumIds
• filters: array filters
• statuses: array statuses
• texts: array texts
• types: array types
• values: array values

{
    "type":"object",
    "properties":{
        "values":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "types":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "texts":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "dataFormats":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "statuses":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "filters":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "enumIds":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

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

型: array

ソースの表示

• 配列: object LayoutDimension

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: array items

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: array

ソースの表示

• 配列: string

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

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

型: object

ソースの表示

• axis: string
  指定可能な値: [ "COLUMN", "ROW", "POV" ]
• displayName: string
• expanded: boolean
• hidden: boolean
• name: string
• page: integer(int32)
• position: integer(int32)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "page":{
            "type":"integer",
            "format":"int32"
        },
        "hidden":{
            "type":"boolean"
        },
        "expanded":{
            "type":"boolean"
        },
        "axis":{
            "type":"string",
            "enum":[
                "COLUMN",
                "ROW",
                "POV"
            ]
        },
        "position":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: object

ソースの表示

• derived: boolean
• emptyBlocks: boolean
• error: boolean
• invalid: boolean
• missing: boolean
• noAccess: boolean
• underScore: boolean
• zero: boolean

{
    "type":"object",
    "properties":{
        "missing":{
            "type":"boolean"
        },
        "invalid":{
            "type":"boolean"
        },
        "derived":{
            "type":"boolean"
        },
        "zero":{
            "type":"boolean"
        },
        "underScore":{
            "type":"boolean"
        },
        "noAccess":{
            "type":"boolean"
        },
        "emptyBlocks":{
            "type":"boolean"
        },
        "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"
        }
    }
}

ネストされたスキーマ : 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 レスポンス

不正なリクエスト

レイアウトの更新に失敗しました。

先頭に戻る