機械翻訳について

ジャンプ先

• 要求
• レスポンス

レイアウト詳細の取得

get

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

指定されたレイアウトの詳細を取得します。

要求

パス・パラメータ

• application: string

  アプリケーション名

• database: string

  データベース名

• layout: string

  レイアウト名。

問合せパラメータ

• user(optional): string

  ユーザー名

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

レイアウト詳細が正常に返されました。

本文()

ルート・スキーマ : レイアウト

タイプ: object

Show Source

• header(optional): object LayoutHeader
• spec(optional): object LayoutSpec

{
    "type":"object",
    "properties":{
        "header":{
            "$ref":"#/definitions/LayoutHeader"
        },
        "spec":{
            "$ref":"#/definitions/LayoutSpec"
        }
    }
}

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

タイプ: object

Show Source

• databaseDefault(optional): boolean
• name(optional): string
• session(optional): boolean
• user(optional): string
• userDefault(optional): boolean

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

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

タイプ: object

Show Source

• description(optional): string
• grid(optional): object LayoutGrid
• preferences(optional): object LayoutPreferences

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

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

タイプ: object

Show Source

• alias(optional): string
• data(optional): object LayoutData
• dimensions(optional): array dimensions

{
    "type":"object",
    "properties":{
        "alias":{
            "type":"string"
        },
        "dimensions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LayoutDimension"
            }
        },
        "data":{
            "$ref":"#/definitions/LayoutData"
        }
    }
}

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

タイプ: object

Show Source

• cellText(optional): boolean
• columnSuppression(optional): object Suppression
• formulaRetention(optional): object FormulaRetention
• includeDescriptionLabel(optional): boolean
• includeSelection(optional): boolean
• indentation(optional): string
  許可される値: [ "NONE", "SUBITEMS", "TOTALS" ]
• maxRows(optional): integer(int32)
• missingText(optional): string
• navigate(optional): boolean
• noAccessText(optional): string
• removeUnSelectedGroup(optional): boolean
• repeatMemberLabels(optional): boolean
• rowSuppression(optional): object Suppression
• withinSelectedGroup(optional): boolean
• zoomIn(optional): 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"
        },
        "maxRows":{
            "type":"integer",
            "format":"int32"
        },
        "formulaRetention":{
            "$ref":"#/definitions/FormulaRetention"
        }
    }
}

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

タイプ: object

Show Source

• dataFormats(optional): array dataFormats
• enumIds(optional): array enumIds
• filters(optional): array filters
• statuses(optional): array statuses
• texts(optional): array texts
• types(optional): array types
• values(optional): 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

Show Source

• Array of: object LayoutDimension

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

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

タイプ: array

Show Source

• Array of: array items

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

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

タイプ: array

Show Source

• Array of: array items

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

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

タイプ: array

Show Source

• Array of: array items

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

ネストされたスキーマ : ステータス

タイプ: array

Show Source

• Array of: array items

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

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

タイプ: array

Show Source

• Array of: array items

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

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

タイプ: array

Show Source

• Array of: array items

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

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

タイプ: array

Show Source

• Array of: array items

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

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

タイプ: array

Show Source

• Array of: string

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

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

タイプ: array

Show Source

• Array of: string

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

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

タイプ: array

Show Source

• Array of: string

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

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

タイプ: array

Show Source

• Array of: string

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

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

タイプ: array

Show Source

• Array of: string

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

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

タイプ: array

Show Source

• Array of: string

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

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

タイプ: array

Show Source

• Array of: string

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

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

タイプ: object

Show Source

• axis(optional): string
  許可される値: [ "COLUMN", "ROW", "POV" ]
• displayName(optional): string
• expanded(optional): boolean
• hidden(optional): boolean
• name(optional): string
• page(optional): integer(int32)
• position(optional): 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"
        }
    }
}

ネストされたスキーマ : 抑止

タイプ: 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":{
        "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

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"
        }
    }
}

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

不正なリクエスト

レイアウト詳細の取得に失敗しました。

先頭に戻る