機械翻訳について

ジャンプ先

• 要求
• レスポンス

パーティションの取得

get

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

データベースに定義されているパーティションまたは特定のパーティションのリストを返します。

• パラメータなし: 使用可能なすべてのパーティションを返します。
• typeパラメータを使用: フィルタされたパーティション・リストを返します。
• パーティション・タイプ、ソース・サーバー、ソース・アプリケーションおよびソース・データベース・パラメータを使用: 指定されたパーティションの詳細を返します。

要求

パス・パラメータ

• applicationName: string

  アプリケーション名

• databaseName: string

  データベース名

問合せパラメータ

• applicationLevelDatasource(optional): boolean

  データソースがアプリケーション・レベルで定義されているかどうかを指定します。

• applicationName(optional): string

  パーティション・ソース・アプリケーション名。

• databaseName(optional): string

  パーティション・ソース・データベース名。

• datasourceName(optional): string

  データソース名。

• limit(optional): integer(int32)

  返されるパーティションの最大数。

• measuresDimensionName(optional): string

  Measuresディメンション名。

• offset(optional): integer(int32)

  結果セットの先頭から除外するパーティションの数。

• serverName(optional): string

  パーティション・ソース・サーバー名。

• type(optional): array
  空の値を許可: true

  収集形式: multi

  パーティション・タイプ。 カンマ区切りを使用して、複数のタイプを追加できます。

  • [0]: string
    許可される値: [ "TRANSPARENT", "REPLICATED", "FEDERATED", "LAZY_TRANSPARENT" ]

  {
      "name":"type",
      "in":"query",
      "description":"<p>Partition type. Multiple types can be added with a comma separator.</p>",
      "required":false,
      "type":"array",
      "items":{
          "type":"string",
          "enum":[
              "TRANSPARENT",
              "REPLICATED",
              "FEDERATED",
              "LAZY_TRANSPARENT"
          ]
      },
      "collectionFormat":"multi",
      "allowEmptyValue":true
  }

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

パーティション・リストまたはパーティション詳細が正常に返されました。

本文()

ルート・スキーマ : PartitionList

タイプ: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  許可される追加プロパティ: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PartitionBean"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

タイプ: array

Show Source

• Array of: object PartitionBean

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

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

タイプ: object

許可される追加プロパティ

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

タイプ: object

Show Source

• areas(optional): array areas
• errorMessage(optional): string
• id(optional): string
• isNew(optional): boolean
• links(optional): array links
• locked(optional): boolean
• mappings(optional): array mappings
• sourceInfo(optional): object ConnectionInfoBean
• targetInfo(optional): object ConnectionInfoBean
• type(optional): string
• updatable(optional): boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "updatable":{
            "type":"boolean"
        },
        "isNew":{
            "type":"boolean"
        },
        "locked":{
            "type":"boolean"
        },
        "sourceInfo":{
            "$ref":"#/definitions/ConnectionInfoBean"
        },
        "targetInfo":{
            "$ref":"#/definitions/ConnectionInfoBean"
        },
        "areas":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AreaBean"
            }
        },
        "mappings":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MemberMappingBean"
            }
        },
        "errorMessage":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

ネストされたスキーマ : 領域

タイプ: array

Show Source

• Array of: object AreaBean

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

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

タイプ: array

Show Source

• Array of: object Link

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

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

タイプ: array

Show Source

• Array of: object MemberMappingBean

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

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

タイプ: object

Show Source

• alterCredentials(optional): boolean
• applicationLevelConnection(optional): boolean
• applicationLevelDatasource(optional): boolean
• applicationName(optional): string
• connectionName(optional): string
• databaseName(optional): string
• datasourceName(optional): string
• description(optional): string
• essbaseToColumnMap(optional): object EsbToColMap
• essbaseToDataSourceMap(optional): object EssToDsMapDTO
• measuresDimensionName(optional): string
• password(optional): string
• serverName(optional): string
• userName(optional): string

{
    "type":"object",
    "properties":{
        "connectionName":{
            "type":"string"
        },
        "serverName":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        },
        "password":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "applicationName":{
            "type":"string"
        },
        "databaseName":{
            "type":"string"
        },
        "datasourceName":{
            "type":"string"
        },
        "measuresDimensionName":{
            "type":"string"
        },
        "essbaseToColumnMap":{
            "$ref":"#/definitions/EsbToColMap"
        },
        "essbaseToDataSourceMap":{
            "$ref":"#/definitions/EssToDsMapDTO"
        },
        "alterCredentials":{
            "type":"boolean"
        },
        "applicationLevelConnection":{
            "type":"boolean"
        },
        "applicationLevelDatasource":{
            "type":"boolean"
        }
    }
}

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

タイプ: object

Show Source

• slices(optional): array slices
• sourceArea(optional): string
• sourceCellCount(optional): integer(int64)
• targetArea(optional): string
• targetCellCount(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "sourceArea":{
            "type":"string"
        },
        "targetArea":{
            "type":"string"
        },
        "sourceCellCount":{
            "type":"integer",
            "format":"int64"
        },
        "targetCellCount":{
            "type":"integer",
            "format":"int64"
        },
        "slices":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MemberMappingBean"
            }
        }
    }
}

ネストされたスキーマ : スライス

タイプ: array

Show Source

• Array of: object MemberMappingBean

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

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

タイプ: object

Show Source

• sourceMember(optional): string
• targetMember(optional): string

{
    "type":"object",
    "properties":{
        "sourceMember":{
            "type":"string"
        },
        "targetMember":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : リンク

タイプ: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

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

タイプ: object

Show Source

• arr(optional): array arr

{
    "type":"object",
    "properties":{
        "arr":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EsbToColMapInfo"
            }
        }
    }
}

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

タイプ: object

Show Source

• dimensions: array dimensions

{
    "type":"object",
    "required":[
        "dimensions"
    ],
    "properties":{
        "dimensions":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"dimensions"
                },
                "$ref":"#/definitions/Dimension"
            }
        }
    },
    "xml":{
        "name":"EssToDsMapDTO"
    }
}

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

タイプ: array

Show Source

• Array of: object EsbToColMapInfo

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

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

タイプ: object

Show Source

• columnName(optional): string
• essbaseName(optional): string

{
    "type":"object",
    "properties":{
        "essbaseName":{
            "type":"string"
        },
        "columnName":{
            "type":"string"
        }
    }
}

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

タイプ: array

Show Source

• Array of: object Dimension

{
    "type":"array",
    "items":{
        "xml":{
            "name":"dimensions"
        },
        "$ref":"#/definitions/Dimension"
    }
}

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

タイプ: object

Show Source

• added(optional): boolean
• addMemberOption(optional): string
  許可される値: [ "GENERATION", "SIBLING_LOWEST_LEVEL", "CHILD", "SIBLING_MATCHING_STRING", "LEVEL", "PARENT_CHILD", "GEN_NULLS", "LEVEL_NULLS" ]
• aggregateLevelUsage(optional): integer(int32)
• allowassociationChanges(optional): boolean
• allowFormulaChanges(optional): boolean
• allowMoves(optional): string
  許可される値: [ "NOTOK", "OK", "IGNORE", "GEN2", "NOTGEN2" ]
• allowPropertyChanges(optional): boolean
• allowUDAChanges(optional): boolean
• attributeOptions(optional): object AttributeOptions
• autoFixSharedMember(optional): boolean
• configOption(optional): string
  許可される値: [ "EXISTING", "DENSE", "SPARSE" ]
• createAttributeMembers(optional): boolean
• dimensionSolveOrder(optional): integer(int32)
• flexible(optional): boolean
• generations(optional): array generations
• hierarchyType(optional): string
  許可される値: [ "EXISTING", "MULTIPLE", "STORED", "DYNAMIC" ]
• incrementalSort(optional): boolean
• levels(optional): array levels
• measureOptions(optional): object MeasureOptions
• memberName(optional): string
• name(optional): string
• share(optional): boolean
• solveOrder(optional): integer(int32)
• sortOption(optional): string
  許可される値: [ "NONE", "ASCENDING", "DESCENDING" ]
• storageType(optional): string
  許可される値: [ "EXISTING", "STORE", "NEVER_SHARE", "LABEL_ONLY", "DYNAMIC_CALC_STORE", "DYNAMIC_CALC" ]
• type(optional): string
  許可される値: [ "EXISTING", "NONE", "ACCOUNTS", "TIME", "COUNTRY", "ATTRIBUTES" ]
• unique(optional): string
  許可される値: [ "EXISTING", "UNIQUE", "DUPLICATE", "NONE" ]
• updateOption(optional): string
  許可される値: [ "MERGE", "REMOVE_UNSPECIFIED" ]

{
    "type":"object",
    "properties":{
        "generations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Level"
            }
        },
        "levels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Level"
            }
        },
        "allowassociationChanges":{
            "type":"boolean"
        },
        "allowFormulaChanges":{
            "type":"boolean"
        },
        "allowPropertyChanges":{
            "type":"boolean"
        },
        "allowUDAChanges":{
            "type":"boolean"
        },
        "measureOptions":{
            "$ref":"#/definitions/MeasureOptions"
        },
        "aggregateLevelUsage":{
            "type":"integer",
            "format":"int32"
        },
        "addMemberOption":{
            "type":"string",
            "enum":[
                "GENERATION",
                "SIBLING_LOWEST_LEVEL",
                "CHILD",
                "SIBLING_MATCHING_STRING",
                "LEVEL",
                "PARENT_CHILD",
                "GEN_NULLS",
                "LEVEL_NULLS"
            ]
        },
        "attributeOptions":{
            "$ref":"#/definitions/AttributeOptions"
        },
        "configOption":{
            "type":"string",
            "enum":[
                "EXISTING",
                "DENSE",
                "SPARSE"
            ]
        },
        "unique":{
            "type":"string",
            "enum":[
                "EXISTING",
                "UNIQUE",
                "DUPLICATE",
                "NONE"
            ]
        },
        "hierarchyType":{
            "type":"string",
            "enum":[
                "EXISTING",
                "MULTIPLE",
                "STORED",
                "DYNAMIC"
            ]
        },
        "sortOption":{
            "type":"string",
            "enum":[
                "NONE",
                "ASCENDING",
                "DESCENDING"
            ]
        },
        "storageType":{
            "type":"string",
            "enum":[
                "EXISTING",
                "STORE",
                "NEVER_SHARE",
                "LABEL_ONLY",
                "DYNAMIC_CALC_STORE",
                "DYNAMIC_CALC"
            ]
        },
        "type":{
            "type":"string",
            "enum":[
                "EXISTING",
                "NONE",
                "ACCOUNTS",
                "TIME",
                "COUNTRY",
                "ATTRIBUTES"
            ]
        },
        "updateOption":{
            "type":"string",
            "enum":[
                "MERGE",
                "REMOVE_UNSPECIFIED"
            ]
        },
        "allowMoves":{
            "type":"string",
            "enum":[
                "NOTOK",
                "OK",
                "IGNORE",
                "GEN2",
                "NOTGEN2"
            ]
        },
        "solveOrder":{
            "type":"integer",
            "format":"int32"
        },
        "createAttributeMembers":{
            "type":"boolean"
        },
        "share":{
            "type":"boolean"
        },
        "incrementalSort":{
            "type":"boolean"
        },
        "autoFixSharedMember":{
            "type":"boolean"
        },
        "flexible":{
            "type":"boolean"
        },
        "memberName":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "dimensionSolveOrder":{
            "type":"integer",
            "format":"int32"
        },
        "added":{
            "type":"boolean"
        }
    }
}

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

タイプ: object

Show Source

• baseDimension(optional): string
• indepDimensions(optional): array indepDimensions
• modified(optional): boolean
• scaassociationMode(optional): string
  許可される値: [ "NOOVERWRITE", "OVERWRITE" ]
• scadisAssociationMode(optional): string
  許可される値: [ "NOOVERWRITE", "OVERWRITE", "EXTEND" ]
• type(optional): string
  許可される値: [ "NUMERIC", "BOOLEAN", "TEXT", "DATE", "EXISTING" ]

{
    "type":"object",
    "properties":{
        "indepDimensions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IndepDimension"
            }
        },
        "type":{
            "type":"string",
            "enum":[
                "NUMERIC",
                "BOOLEAN",
                "TEXT",
                "DATE",
                "EXISTING"
            ]
        },
        "baseDimension":{
            "type":"string"
        },
        "modified":{
            "type":"boolean"
        },
        "scaassociationMode":{
            "type":"string",
            "enum":[
                "NOOVERWRITE",
                "OVERWRITE"
            ]
        },
        "scadisAssociationMode":{
            "type":"string",
            "enum":[
                "NOOVERWRITE",
                "OVERWRITE",
                "EXTEND"
            ]
        }
    }
}

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

タイプ: array

Show Source

• Array of: object Level

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

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

タイプ: array

Show Source

• Array of: object Level

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

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

タイプ: object

Show Source

• currencyCategory(optional): string
• currencyConversion(optional): string
  許可される値: [ "EXISTING", "NONE", "CATEGORY", "NO_CONVERSION" ]
• currencyName(optional): string
• skip(optional): string
  許可される値: [ "NONE", "NA", "MISSING", "ZERO", "MISSING_ZERO" ]
• timeBalanceOption(optional): string
  許可される値: [ "EXISTING", "NONE", "FIRST", "LAST", "AVERAGE" ]
• twoPass(optional): boolean
• varianceReporting(optional): string
  許可される値: [ "EXISTING", "NON_EXPENSE", "EXPENSE" ]

{
    "type":"object",
    "properties":{
        "currencyCategory":{
            "type":"string"
        },
        "currencyName":{
            "type":"string"
        },
        "currencyConversion":{
            "type":"string",
            "enum":[
                "EXISTING",
                "NONE",
                "CATEGORY",
                "NO_CONVERSION"
            ]
        },
        "skip":{
            "type":"string",
            "enum":[
                "NONE",
                "NA",
                "MISSING",
                "ZERO",
                "MISSING_ZERO"
            ]
        },
        "timeBalanceOption":{
            "type":"string",
            "enum":[
                "EXISTING",
                "NONE",
                "FIRST",
                "LAST",
                "AVERAGE"
            ]
        },
        "varianceReporting":{
            "type":"string",
            "enum":[
                "EXISTING",
                "NON_EXPENSE",
                "EXPENSE"
            ]
        },
        "twoPass":{
            "type":"boolean"
        }
    }
}

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

タイプ: array

Show Source

• Array of: object IndepDimension

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

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

タイプ: object

Show Source

• name(optional): string
• type(optional): string
  許可される値: [ "CONTINUOUS", "DISCRETE" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "CONTINUOUS",
                "DISCRETE"
            ]
        }
    }
}

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

タイプ: object

Show Source

• name(optional): string
• number(optional): integer(int32)
• unique(optional): boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "number":{
            "type":"integer",
            "format":"int32"
        },
        "unique":{
            "type":"boolean"
        }
    }
}

400 レスポンス

不正なリクエスト

パーティション結果の取得に失敗しました。

500 レスポンス

内部サーバー・エラー。

先頭に戻る