Oracle Essbase REST API

パーティションのセル数の取得

post

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

パーティション領域定義のソース・セル数およびターゲット・セル数を取得します。パーティション領域には、ソース内とターゲット内で同じ数のセルが含まれている必要があります。

リクエスト

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

application/json
application/xml

パス・パラメータ

applicationName(required): string

アプリケーション名。
databaseName(required): string

データベース名。

パーティション情報。

ルート・スキーマ : PartitionBean

型: object

ソースの表示

areas: array areas
errorMessage: string

パーティション検証に関連付けられているエラー・メッセージ。
federatedTypeAV: boolean

Autonomous Databaseに対するフェデレーテッド・パーティションが有効かどうか。trueの場合、キューブ・データはAutonomous Data Warehouseに格納され、分析ビュー・オブジェクトがEssbaseメタデータに対して使用されます。
federatedTypeCR: boolean

廃止。
id: string

パーティションID。
isNew: boolean

パーティション定義が新規かどうか。
links: array links
locked: boolean

パーティション・オブジェクトがロックされているかどうか。
mappings: array mappings
sourceInfo: object ConnectionInfoBean
targetInfo: object ConnectionInfoBean
type: string

パーティション・タイプ。TRANSPARENT、REPLICATEDまたはFEDERATED。
updatable: boolean

パーティション定義を更新できるかどうか。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"<p>Partition ID.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>Partition type. TRANSPARENT, REPLICATED, or FEDERATED.</p>"
        },
        "updatable":{
            "type":"boolean",
            "description":"<p>Whether the partition definition can be updated.</p>"
        },
        "isNew":{
            "type":"boolean",
            "description":"<p>Whether the partition definition is new.</p>"
        },
        "locked":{
            "type":"boolean",
            "description":"<p>Whether the partition object is locked.</p>"
        },
        "federatedTypeCR":{
            "type":"boolean",
            "description":"<p>Obsolete.</p>"
        },
        "federatedTypeAV":{
            "type":"boolean",
            "description":"<p>Whether federated partition to Autonomous Database is enabled. If true, the cube data is stored in Autonomous Data Warehouse, and Analytic View objects are used for Essbase metadata.</p>"
        },
        "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",
            "description":"<p>An error message associated with partition validation.</p>"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

ソースの表示

配列: object AreaBean

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

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

型: array

ソースの表示

配列: object Link

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

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

型: array

ソースの表示

配列: object MemberMappingBean

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

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

型: object

ソースの表示

alterCredentials: boolean
applicationLevelConnection: boolean

グローバルではなく、アプリケーション・レベルに接続が定義されている場合は、trueと指定する必要があります。
applicationLevelDatasource: boolean

グローバルではなく、アプリケーション・レベルにデータソースが定義されている場合は、trueと指定する必要があります。
applicationName: string

アプリケーションの名前。
connectionName: string

パーティション接続に使用される接続名。単一Essbaseインスタンスの外部にあるデータにアクセスするパーティションの場合、必須です。
databaseName: string

Essbaseデータベース/キューブの名前。
datasourceName: string

パーティション接続に使用されるデータソース名。
description: string
essbaseToColumnMap: object EsbToColMap

フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。
essbaseToDataSourceMap: object EssToDsMapDTO
factTableName: string

数値およびキーを格納するAutonomous Databaseのファクト表の名前。
isFactManagedByFederatedCube: boolean

true: フェデレーテッド・パーティション・ファクト表が、Autonomous Data Warehouseスキーマ管理者ではなくEssbaseによって管理されている場合。
measuresDimensionName: string

フェデレーテッド・パーティションに定義されているピボット・ディメンション名。メジャー・ディメンションでも構いませんが、そうである必要はありません。
password: string

認証情報がパーティション定義に埋め込まれている場合、パーティション・ユーザーのパスワード。
schemaName: string

データベース・スキーマの名前(フェデレーテッド・パーティションのリポジトリ・データベースとして使用)。
serverName: string

EssbaseサーバーのURL。essbase/agentで終わります。
userName: string

認証情報がパーティション定義に埋め込まれている場合、パーティション・ユーザー名。

{
    "type":"object",
    "properties":{
        "connectionName":{
            "type":"string",
            "description":"<p>Connection name used for partition connectivity. Required for partitions accessing data outside of a single Essbase instance.</p>"
        },
        "serverName":{
            "type":"string",
            "description":"<p>URL of the Essbase server, ending in <code>essbase/agent</code>.</p>"
        },
        "userName":{
            "type":"string",
            "description":"<p>Partition user name, if authentication info is embedded in the partition definition.</p>"
        },
        "password":{
            "type":"string",
            "description":"<p>Partition user password, if authentication info is embedded in the partition definition.</p>"
        },
        "description":{
            "type":"string"
        },
        "applicationName":{
            "type":"string",
            "description":"<p>Name of application.</p>"
        },
        "databaseName":{
            "type":"string",
            "description":"<p>Name of Essbase database/cube.</p>"
        },
        "datasourceName":{
            "type":"string",
            "description":"<p>Datasource name used for partition connectivity.</p>"
        },
        "measuresDimensionName":{
            "type":"string",
            "description":"<p>Pivot dimension name defined in federated partition. Can be Measures dimension, but does not have to be.</p>"
        },
        "schemaName":{
            "type":"string",
            "description":"<p>The name of the database schema (used as the repository database for federated partition).</p>"
        },
        "factTableName":{
            "type":"string",
            "description":"<p>The name of the fact table in Autonomous Database that stores numeric values and keys.</p>"
        },
        "isFactManagedByFederatedCube":{
            "type":"boolean",
            "description":"<p><b>true</b> if the federated partition fact table is managed by Essbase, instead of by the Autonomous Data Warehouse schema administrator.</p>"
        },
        "essbaseToColumnMap":{
            "description":"<p>If any federated Essbase cube's outline dimensions or members cannot be mapped to a column in the fact table, you need to map them in this definition.</p>",
            "$ref":"#/definitions/EsbToColMap"
        },
        "essbaseToDataSourceMap":{
            "$ref":"#/definitions/EssToDsMapDTO"
        },
        "alterCredentials":{
            "type":"boolean"
        },
        "applicationLevelConnection":{
            "type":"boolean",
            "description":"<p>Must be specified as <b>true</b> if the connection is defined at the application level rather than globally.</p>"
        },
        "applicationLevelDatasource":{
            "type":"boolean",
            "description":"<p>Must be specified as <b>true</b> if the Datasource is defined at the application level rather than globally.</p>"
        }
    }
}

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

型: object

ソースの表示

slices: array slices

ソースおよびターゲット・メンバーのマッピングを定義するオプションのスライス定義。ターゲットとソースで一部のメンバーおよびディメンションに異なる名前を使用している場合、Essbaseではこの情報を使用して、ターゲットにデータを入力する方法が決定します。
sourceArea: string

パーティションのソース領域/リージョン。特定のメンバーのマッピングが含まれるスライスのオプション・リストを指定できます。
sourceCellCount: integer(int64)

パーティションのソース領域のセル数。透過またはレプリケート・パーティションのソースおよびターゲットの領域には、同じ数のセルが含まれている必要があります。属性ディメンションのセルはセル数に含まれません。
targetArea: string

パーティションのターゲット領域/リージョン。特定のメンバーのマッピングが含まれるスライスのオプション・リストを指定できます。
targetCellCount: integer(int64)

パーティションのターゲット領域のセル数。透過またはレプリケート・パーティションのソースおよびターゲットの領域には、同じ数のセルが含まれている必要があります。属性ディメンションのセルはセル数に含まれません。

{
    "type":"object",
    "properties":{
        "sourceArea":{
            "type":"string",
            "description":"<p>Partition source area/region, with optional list of slices containing specific member mappings.</p>"
        },
        "targetArea":{
            "type":"string",
            "description":"<p>Partition target area/region, with optional list of slices containing specific member mappings.</p>"
        },
        "sourceCellCount":{
            "type":"integer",
            "description":"<p>Cell count of the partition source area. The source and target areas of a transparent or replicated partition should contain the same number of cells. Cell count does not include the cells of attribute dimensions.</p>",
            "format":"int64"
        },
        "targetCellCount":{
            "type":"integer",
            "description":"<p>Cell count of the partition target area. The source and target areas of a transparent or replicated partition should contain the same number of cells. Cell count does not include the cells of attribute dimensions.</p>",
            "format":"int64"
        },
        "slices":{
            "type":"array",
            "description":"<p>Optional slice definition defining source and target member mappings. Essbase uses this information to determine how to put data into the target if the  target and the source use different names for some members and dimensions.</p>",
            "items":{
                "$ref":"#/definitions/MemberMappingBean"
            }
        }
    }
}

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

型: array

ソースおよびターゲット・メンバーのマッピングを定義するオプションのスライス定義。ターゲットとソースで一部のメンバーおよびディメンションに異なる名前を使用している場合、Essbaseではこの情報を使用して、ターゲットにデータを入力する方法が決定します。

ソースの表示

配列: object MemberMappingBean

{
    "type":"array",
    "description":"<p>Optional slice definition defining source and target member mappings. Essbase uses this information to determine how to put data into the target if the  target and the source use different names for some members and dimensions.</p>",
    "items":{
        "$ref":"#/definitions/MemberMappingBean"
    }
}

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

型: object

ソースの表示

sourceMember: string

ターゲットの一致するリージョンにマップするパーティション・ソースのメンバー名。
targetMember: string

ソースの一致するリージョンにマップするパーティション・ターゲットのメンバー名。

{
    "type":"object",
    "properties":{
        "sourceMember":{
            "type":"string",
            "description":"<p>A member name on the partition source to map to a congruent region on the target.</p>"
        },
        "targetMember":{
            "type":"string",
            "description":"<p>A member name on the partition target to map to a congruent region on the source.</p>"
        }
    }
}

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

型: object

ソースの表示

href: string
method: string
rel: string
type: string

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

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

型: object

フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。

ソースの表示

arr: array arr

{
    "type":"object",
    "description":"<p>For federated Essbase cube, map dimensions or members to columns in the fact table.</p>",
    "properties":{
        "arr":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EsbToColMapInfo"
            }
        }
    }
}

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

型: object

ソースの表示

dimensions: array dimensions

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

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

型: array

ソースの表示

配列: object EsbToColMapInfo

フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。

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

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

型: object

フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。

ソースの表示

columnName: string

外部ファクト表の列名。
essbaseName: string

Essbaseディメンションまたはメンバーの名前。

{
    "type":"object",
    "description":"<p>For federated Essbase cube, map dimensions or members to columns in the fact table.</p>",
    "properties":{
        "essbaseName":{
            "type":"string",
            "description":"<p>Essbase dimension or member name.</p>"
        },
        "columnName":{
            "type":"string",
            "description":"<p>Column name in external fact table.</p>"
        }
    }
}

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

型: array

ソースの表示

配列: object Dimension

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

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

型: object

ソースの表示

added: boolean

アウトラインにまだ存在しない新しいディメンションの場合は、trueに設定します。trueの場合、新しいディメンションがディメンション構築中に作成されます。falseの場合、新しいディメンションのディメンション構築は失敗します。
addMemberOption: string

指定可能な値: [ "GENERATION", "SIBLING_LOWEST_LEVEL", "CHILD", "SIBLING_MATCHING_STRING", "LEVEL", "PARENT_CHILD", "GEN_NULLS", "LEVEL_NULLS" ]

このディメンションに含まれるディメンション、メンバーおよび別名を追加、変更または削除する構築方法アルゴリズム。ソース・データのプロパティに基づいている必要があります。たとえば、各レコードで親、その後に子メンバーをこの順序で指定している場合、PARENT_CHILDが適切な方法です。
aggregateLevelUsage: integer(int32)
allowassociationChanges: boolean
allowFormulaChanges: boolean
allowMoves: string

指定可能な値: [ "NOTOK", "OK", "IGNORE", "GEN2", "NOTGEN2" ]

メンバーおよびその子を新しい親に移動できるようにする場合はOKに設定し、Essbaseがプライマリ・メンバーを認識してそれらをソース・データと照合できるようにします。重複メンバーのアウトラインには使用できません。updateOption = RESET_DIMENSIONの場合は、NOTOKのままにします。
allowPropertyChanges: boolean
allowUDAChanges: boolean
attributeOptions: object AttributeOptions
autoFixSharedMember: boolean
configOption: string

指定可能な値: [ "EXISTING", "DENSE", "SPARSE" ]
createAttributeMembers: boolean

Essbaseで属性メンバーを作成できるようにするには、trueに設定します。falseの場合、Essbaseでは属性メンバーを作成できません。
dimensionSolveOrder: integer(int32)

ディメンションの解決順。
flexible: boolean
generations: array generations
hierarchyType: string

指定可能な値: [ "EXISTING", "MULTIPLE", "STORED", "DYNAMIC" ]

このディメンションで複数の階層を有効にする必要がある場合はMULTIPLE (集約ストレージ・キューブにのみ適用可能)。設定をそのままにする場合はEXISTING。集約ストレージ保存階層タイプ(式なし)の場合はSTORED。式を使用して集約する集約ストレージ階層タイプ(勘定科目ディメンションを含む)の場合はDYNAMIC。
incrementalSort: boolean

Essbaseがソース・データからのすべてのメンバーを処理および追加した後にメンバーをソートする場合は、trueに設定します。
levels: array levels
measureOptions: object MeasureOptions

主に勘定科目ディメンションに関連するロード・ルール定義プロパティ。
memberName: string

子を追加する親メンバーの名前。「次の子として追加」構築方法とともに使用します。
name: string
share: boolean

ディメンションに共有メンバーが含まれる場合はtrueに設定します。
solveOrder: integer(int32)

ディメンションまたはメンバーが計算される優先度(0から127)。解決順の値が大きいほどそのメンバーは後で計算されることになります。解決順が割り当てられていないメンバーは、そのディメンションから解決順を継承します。
sortOption: string

指定可能な値: [ "NONE", "ASCENDING", "DESCENDING" ]

このディメンションの階層内の子をソートするかどうかと、ソート方法: なし(ソートしない)、昇順または降順。
storageType: string

指定可能な値: [ "EXISTING", "STORE", "NEVER_SHARE", "LABEL_ONLY", "DYNAMIC_CALC_STORE", "DYNAMIC_CALC" ]
type: string

指定可能な値: [ "EXISTING", "NONE", "ACCOUNTS", "TIME", "COUNTRY", "ATTRIBUTES" ]
unique: string

指定可能な値: [ "EXISTING", "UNIQUE", "DUPLICATE", "NONE" ]
updateOption: string

指定可能な値: [ "MERGE", "REMOVE_UNSPECIFIED", "RESET_DIMENSION" ]

増分ディメンション構築の更新オプション。増分ディメンション構築は、メンバーの追加、移動、削除および順序変更によって既存のディメンションを更新するプロセスです。MERGE (デフォルト)では、新しいメンバーを追加しますが、既存のメンバーも保持します。REMOVE_UNSPECIFIEDでは、ソースで指定されていないメンバーを削除します(addMemberOption = GENERATION、LEVELまたはPARENT_CHILDの場合のみ使用可能)。メンバーの削除によってレベル0の式のない動的計算メンバーになる場合、アウトラインは無効です。RESET_DIMENSIONは、インデックスベースのルール(つまり、studio = true)にのみ使用可能です。ディメンションのリセットは、ディメンション全体を再構築します。このオプションでは、増分ディメンション構築中の挿入、順序変更、移動および削除操作を使用可能にし、階層内のメンバーの配置を最後に移動するのではなく、そのままにします。ディメンションのリセットを使用するには、allowMovesをNOTOKにする必要があります。そうしないと、共有階層を構築できません。

{
    "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",
            "description":"<p>The build method algorithm to add, change, or remove dimensions, members, and aliases in this dimension. Should be based on the properties of the source data; for example, if each record specifies a parent and later a child member, in that order, then PARENT_CHILD is a good method.</p>",
            "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",
            "description":"<p>MULTIPLE if multiple hierarchies should be enabled in this dimension (applicable to aggregate storage cube only). EXISTING to keep the setting unchanged. STORED for aggregate storage stored hierarchy type (no formulas). DYNAMIC for aggregate storage hierarchy type that aggregates using formulas (includes Accounts dimension).</p>",
            "enum":[
                "EXISTING",
                "MULTIPLE",
                "STORED",
                "DYNAMIC"
            ]
        },
        "sortOption":{
            "type":"string",
            "description":"<p>Whether and how to sort this dimension's children in hierarchies: None (do not sort), ascending, or descending.</p>",
            "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",
            "description":"<p>Incremental dimension build update option. Incremental dimension building is the process of updating existing dimensions by adding, moving, deleting, and reordering members. MERGE (the default) adds new members while retaining existing members. REMOVE_UNSPECIFIED removes members that are not specified in the source (available only when <i>addMemberOption</i> = <code>GENERATION</code>, <code>LEVEL</code>, or <code>PARENT_CHILD</code>). Outlines are invalid if removing members results in level 0 Dynamic Calc members without formulas. RESET_DIMENSION is available only for Index-based rules (i.e. <i>studio</i> = <code>true</code>). Reset Dimension rebuilds the entire dimension. This option enables insert, reorder, move, and delete operations during incremental dimension build, persisting member placement in the hierarchy instead of moving them to the end. To use Reset Dimension, <i>allowMoves</i> should be <code>NOTOK</code>; otherwise, you cannot build shared hierarchies.</p>",
            "enum":[
                "MERGE",
                "REMOVE_UNSPECIFIED",
                "RESET_DIMENSION"
            ]
        },
        "allowMoves":{
            "type":"string",
            "description":"<p>Set to <b>OK</b> to allow moving of members and their children to new parents, allowing Essbase to recognize primary members and match them with the source data. Not available for duplicate member outlines. Leave as <b>NOTOK</b> if <i>updateOption</i> = <code>RESET_DIMENSION</code>.</p>",
            "enum":[
                "NOTOK",
                "OK",
                "IGNORE",
                "GEN2",
                "NOTGEN2"
            ]
        },
        "solveOrder":{
            "type":"integer",
            "description":"<p>Priority in which the dimension or member is calculated (0 to 127). Higher solve order means the member is calculated later. Members not assigned a solve order inherit it from their dimension.</p>",
            "format":"int32"
        },
        "createAttributeMembers":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to allow Essbase to create attribute members. If <b>false</b>, prevents Essbase from creating attribute members.</p>"
        },
        "share":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> if the dimension includes shared members.</p>"
        },
        "incrementalSort":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to sort members after Essbase has processed and added all members from the source data.</p>"
        },
        "autoFixSharedMember":{
            "type":"boolean"
        },
        "flexible":{
            "type":"boolean"
        },
        "memberName":{
            "type":"string",
            "description":"<p>Parent member name under which to add children. Used with Add as child of build method.</p>"
        },
        "name":{
            "type":"string"
        },
        "dimensionSolveOrder":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Solve order of the dimension.</p>"
        },
        "added":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> for a new dimension that does not yet exist in the outline. If <b>true</b>, the new dimension will be created during the dimension build. If <b>false</b>, dimension build will fail for a new dimension.</p>"
        }
    }
}

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

型: object

ソースの表示

baseDimension: string
indepDimensions: array indepDimensions
modified: boolean
scaassociationMode: string

指定可能な値: [ "NOOVERWRITE", "OVERWRITE" ]
scadisAssociationMode: string

指定可能な値: [ "NOOVERWRITE", "OVERWRITE", "EXTEND" ]
type: 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"
        },
        "scadisAssociationMode":{
            "type":"string",
            "enum":[
                "NOOVERWRITE",
                "OVERWRITE",
                "EXTEND"
            ]
        },
        "scaassociationMode":{
            "type":"string",
            "enum":[
                "NOOVERWRITE",
                "OVERWRITE"
            ]
        }
    }
}

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

型: array

ソースの表示

配列: object Level

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

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

型: array

ソースの表示

配列: object Level

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

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

型: object

主に勘定科目ディメンションに関連するロード・ルール定義プロパティ。

ソースの表示

currencyCategory: string

ディメンションが通貨換算アプリケーションに関連付けられている場合は、通貨カテゴリ。これは通貨キューブからの勘定科目メンバーです。例: P&L。
currencyConversion: string

指定可能な値: [ "EXISTING", "NONE", "CATEGORY", "NO_CONVERSION" ]

ディメンション構築中に実行する通貨換算アクション。通貨換算しないメンバーにはNO_CONVERSIONのマークを付けます。NONEは、換算しないことを示すのではなく、換算カテゴリが未指定である(つまり、継承される)ことを示します。
currencyName: string

ディメンションが通貨換算アプリケーションに関連付けられている場合は、通貨名。これは通貨キューブからの国ディメンション・タイプ・メンバーです。例: USD、CND、GPB、EUR
skip: string

指定可能な値: [ "NONE", "NA", "MISSING", "ZERO", "MISSING_ZERO" ]

timeBalanceOptionをFIRST、LASTまたはAVERAGEとして設定する場合は、スキップ・プロパティを使用して、欠落値またはゼロ値が出現した場合の親値の計算方法を示します。NONE: 親値を計算するときにデータをスキップしません。MISSING: #MISSINGデータをスキップします。ZERO: ゼロに等しい値をスキップします。MISSING_ZERO: #MISSINGデータとゼロに等しいデータをスキップします。
timeBalanceOption: string

指定可能な値: [ "EXISTING", "NONE", "FIRST", "LAST", "AVERAGE" ]

タイム・バランス・プロパティ(使用する場合)。デフォルトでは、時間ディメンション内の親はその子の集計および式に基づいて計算されます。たとえば、Sample.Basicデータベースでは、Qtr1メンバーはその子(Jan、FebおよびMar)の合計です。ただし、タイム・バランス・プロパティを設定すると、親(たとえば、Qtr1)は異なる方法でロールアップされます。
twoPass: boolean

2パス計算を使用するとしてディメンションにマークを付ける場合はtrue。
varianceReporting: string

指定可能な値: [ "EXISTING", "NON_EXPENSE", "EXPENSE" ]

勘定科目メンバーを費用アイテムとして処理します。現在の設定を保持する場合はEXISTING。

{
    "type":"object",
    "description":"<p>Load rule definition properties relating primarily to the Accounts dimension.</p>",
    "properties":{
        "currencyCategory":{
            "type":"string",
            "description":"<p>If the dimension is associated with a currency conversion application, the currency category. This is an Accounts member from the currency cube. Example: P&L.</p>"
        },
        "currencyName":{
            "type":"string",
            "description":"<p>If the dimension is associated with a currency conversion application, the currency name. This is a Country dimension type member from the currency cube. Examples: USD, CND, GPB, EUR</p>"
        },
        "currencyConversion":{
            "type":"string",
            "description":"<p>Currency conversion action to take during the dimension build. Mark any members that should not be currency-converted as NO_CONVERSION. NONE does not indicate no conversion; rather, it indicates that the conversion category is unspecified (thus inherited).</p>",
            "enum":[
                "EXISTING",
                "NONE",
                "CATEGORY",
                "NO_CONVERSION"
            ]
        },
        "skip":{
            "type":"string",
            "description":"<p>If you set the <i>timeBalanceOption</i> as FIRST, LAST, or AVERAGE, then use the skip property to indicate how to calculate the parent value when missing- or zero-values  are encountered. NONE: Does not skip data when calculating parent value. MISSING: Skips #MISSING data. ZERO: Skips data that equals zero. MISSING_ZERO: Skips #MISSING data and data that equals zero.</p>",
            "enum":[
                "NONE",
                "NA",
                "MISSING",
                "ZERO",
                "MISSING_ZERO"
            ]
        },
        "timeBalanceOption":{
            "type":"string",
            "description":"<p>The time balance property, if used. By default, a parent in the time dimension is calculated based on the consolidation and formulas of its children. For example, in the Sample.Basic database, the Qtr1 member is the sum of its children (Jan, Feb, and Mar). However, setting a time balance property causes parents, for example Qtr1, to roll up differently.</p>",
            "enum":[
                "EXISTING",
                "NONE",
                "FIRST",
                "LAST",
                "AVERAGE"
            ]
        },
        "varianceReporting":{
            "type":"string",
            "description":"<p>Whether to treat accounts members as expense items. EXISTING to keep the current setting.</p>",
            "enum":[
                "EXISTING",
                "NON_EXPENSE",
                "EXPENSE"
            ]
        },
        "twoPass":{
            "type":"boolean",
            "description":"<p>True to mark the dimension as using two-pass calculation.</p>"
        }
    }
}

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

型: array

ソースの表示

配列: object IndepDimension

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

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

型: object

ソースの表示

name: string
type: string

指定可能な値: [ "CONTINUOUS", "DISCRETE" ]

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

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

型: object

ソースの表示

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

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

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

パーティション領域のセル数が正常に返されました。

ルート・スキーマ : PartitionBean

型: object

ソースの表示

areas: array areas
errorMessage: string

パーティション検証に関連付けられているエラー・メッセージ。
federatedTypeAV: boolean

Autonomous Databaseに対するフェデレーテッド・パーティションが有効かどうか。trueの場合、キューブ・データはAutonomous Data Warehouseに格納され、分析ビュー・オブジェクトがEssbaseメタデータに対して使用されます。
federatedTypeCR: boolean

廃止。
id: string

パーティションID。
isNew: boolean

パーティション定義が新規かどうか。
links: array links
locked: boolean

パーティション・オブジェクトがロックされているかどうか。
mappings: array mappings
sourceInfo: object ConnectionInfoBean
targetInfo: object ConnectionInfoBean
type: string

パーティション・タイプ。TRANSPARENT、REPLICATEDまたはFEDERATED。
updatable: boolean

パーティション定義を更新できるかどうか。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"<p>Partition ID.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>Partition type. TRANSPARENT, REPLICATED, or FEDERATED.</p>"
        },
        "updatable":{
            "type":"boolean",
            "description":"<p>Whether the partition definition can be updated.</p>"
        },
        "isNew":{
            "type":"boolean",
            "description":"<p>Whether the partition definition is new.</p>"
        },
        "locked":{
            "type":"boolean",
            "description":"<p>Whether the partition object is locked.</p>"
        },
        "federatedTypeCR":{
            "type":"boolean",
            "description":"<p>Obsolete.</p>"
        },
        "federatedTypeAV":{
            "type":"boolean",
            "description":"<p>Whether federated partition to Autonomous Database is enabled. If true, the cube data is stored in Autonomous Data Warehouse, and Analytic View objects are used for Essbase metadata.</p>"
        },
        "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",
            "description":"<p>An error message associated with partition validation.</p>"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

ソースの表示

配列: object AreaBean

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

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

型: array

ソースの表示

配列: object Link

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

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

型: array

ソースの表示

配列: object MemberMappingBean

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

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

型: object

ソースの表示

alterCredentials: boolean
applicationLevelConnection: boolean

グローバルではなく、アプリケーション・レベルに接続が定義されている場合は、trueと指定する必要があります。
applicationLevelDatasource: boolean

グローバルではなく、アプリケーション・レベルにデータソースが定義されている場合は、trueと指定する必要があります。
applicationName: string

アプリケーションの名前。
connectionName: string

パーティション接続に使用される接続名。単一Essbaseインスタンスの外部にあるデータにアクセスするパーティションの場合、必須です。
databaseName: string

Essbaseデータベース/キューブの名前。
datasourceName: string

パーティション接続に使用されるデータソース名。
description: string
essbaseToColumnMap: object EsbToColMap

フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。
essbaseToDataSourceMap: object EssToDsMapDTO
factTableName: string

数値およびキーを格納するAutonomous Databaseのファクト表の名前。
isFactManagedByFederatedCube: boolean

true: フェデレーテッド・パーティション・ファクト表が、Autonomous Data Warehouseスキーマ管理者ではなくEssbaseによって管理されている場合。
measuresDimensionName: string

フェデレーテッド・パーティションに定義されているピボット・ディメンション名。メジャー・ディメンションでも構いませんが、そうである必要はありません。
password: string

認証情報がパーティション定義に埋め込まれている場合、パーティション・ユーザーのパスワード。
schemaName: string

データベース・スキーマの名前(フェデレーテッド・パーティションのリポジトリ・データベースとして使用)。
serverName: string

EssbaseサーバーのURL。essbase/agentで終わります。
userName: string

認証情報がパーティション定義に埋め込まれている場合、パーティション・ユーザー名。

{
    "type":"object",
    "properties":{
        "connectionName":{
            "type":"string",
            "description":"<p>Connection name used for partition connectivity. Required for partitions accessing data outside of a single Essbase instance.</p>"
        },
        "serverName":{
            "type":"string",
            "description":"<p>URL of the Essbase server, ending in <code>essbase/agent</code>.</p>"
        },
        "userName":{
            "type":"string",
            "description":"<p>Partition user name, if authentication info is embedded in the partition definition.</p>"
        },
        "password":{
            "type":"string",
            "description":"<p>Partition user password, if authentication info is embedded in the partition definition.</p>"
        },
        "description":{
            "type":"string"
        },
        "applicationName":{
            "type":"string",
            "description":"<p>Name of application.</p>"
        },
        "databaseName":{
            "type":"string",
            "description":"<p>Name of Essbase database/cube.</p>"
        },
        "datasourceName":{
            "type":"string",
            "description":"<p>Datasource name used for partition connectivity.</p>"
        },
        "measuresDimensionName":{
            "type":"string",
            "description":"<p>Pivot dimension name defined in federated partition. Can be Measures dimension, but does not have to be.</p>"
        },
        "schemaName":{
            "type":"string",
            "description":"<p>The name of the database schema (used as the repository database for federated partition).</p>"
        },
        "factTableName":{
            "type":"string",
            "description":"<p>The name of the fact table in Autonomous Database that stores numeric values and keys.</p>"
        },
        "isFactManagedByFederatedCube":{
            "type":"boolean",
            "description":"<p><b>true</b> if the federated partition fact table is managed by Essbase, instead of by the Autonomous Data Warehouse schema administrator.</p>"
        },
        "essbaseToColumnMap":{
            "description":"<p>If any federated Essbase cube's outline dimensions or members cannot be mapped to a column in the fact table, you need to map them in this definition.</p>",
            "$ref":"#/definitions/EsbToColMap"
        },
        "essbaseToDataSourceMap":{
            "$ref":"#/definitions/EssToDsMapDTO"
        },
        "alterCredentials":{
            "type":"boolean"
        },
        "applicationLevelConnection":{
            "type":"boolean",
            "description":"<p>Must be specified as <b>true</b> if the connection is defined at the application level rather than globally.</p>"
        },
        "applicationLevelDatasource":{
            "type":"boolean",
            "description":"<p>Must be specified as <b>true</b> if the Datasource is defined at the application level rather than globally.</p>"
        }
    }
}

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

型: object

ソースの表示

slices: array slices

ソースおよびターゲット・メンバーのマッピングを定義するオプションのスライス定義。ターゲットとソースで一部のメンバーおよびディメンションに異なる名前を使用している場合、Essbaseではこの情報を使用して、ターゲットにデータを入力する方法が決定します。
sourceArea: string

パーティションのソース領域/リージョン。特定のメンバーのマッピングが含まれるスライスのオプション・リストを指定できます。
sourceCellCount: integer(int64)

パーティションのソース領域のセル数。透過またはレプリケート・パーティションのソースおよびターゲットの領域には、同じ数のセルが含まれている必要があります。属性ディメンションのセルはセル数に含まれません。
targetArea: string

パーティションのターゲット領域/リージョン。特定のメンバーのマッピングが含まれるスライスのオプション・リストを指定できます。
targetCellCount: integer(int64)

パーティションのターゲット領域のセル数。透過またはレプリケート・パーティションのソースおよびターゲットの領域には、同じ数のセルが含まれている必要があります。属性ディメンションのセルはセル数に含まれません。

{
    "type":"object",
    "properties":{
        "sourceArea":{
            "type":"string",
            "description":"<p>Partition source area/region, with optional list of slices containing specific member mappings.</p>"
        },
        "targetArea":{
            "type":"string",
            "description":"<p>Partition target area/region, with optional list of slices containing specific member mappings.</p>"
        },
        "sourceCellCount":{
            "type":"integer",
            "description":"<p>Cell count of the partition source area. The source and target areas of a transparent or replicated partition should contain the same number of cells. Cell count does not include the cells of attribute dimensions.</p>",
            "format":"int64"
        },
        "targetCellCount":{
            "type":"integer",
            "description":"<p>Cell count of the partition target area. The source and target areas of a transparent or replicated partition should contain the same number of cells. Cell count does not include the cells of attribute dimensions.</p>",
            "format":"int64"
        },
        "slices":{
            "type":"array",
            "description":"<p>Optional slice definition defining source and target member mappings. Essbase uses this information to determine how to put data into the target if the  target and the source use different names for some members and dimensions.</p>",
            "items":{
                "$ref":"#/definitions/MemberMappingBean"
            }
        }
    }
}

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

型: array

ソースの表示

配列: object MemberMappingBean

{
    "type":"array",
    "description":"<p>Optional slice definition defining source and target member mappings. Essbase uses this information to determine how to put data into the target if the  target and the source use different names for some members and dimensions.</p>",
    "items":{
        "$ref":"#/definitions/MemberMappingBean"
    }
}

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

型: object

ソースの表示

sourceMember: string

ターゲットの一致するリージョンにマップするパーティション・ソースのメンバー名。
targetMember: string

ソースの一致するリージョンにマップするパーティション・ターゲットのメンバー名。

{
    "type":"object",
    "properties":{
        "sourceMember":{
            "type":"string",
            "description":"<p>A member name on the partition source to map to a congruent region on the target.</p>"
        },
        "targetMember":{
            "type":"string",
            "description":"<p>A member name on the partition target to map to a congruent region on the source.</p>"
        }
    }
}

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

型: object

ソースの表示

href: string
method: string
rel: string
type: string

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

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

型: object

フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。

ソースの表示

arr: array arr

{
    "type":"object",
    "description":"<p>For federated Essbase cube, map dimensions or members to columns in the fact table.</p>",
    "properties":{
        "arr":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EsbToColMapInfo"
            }
        }
    }
}

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

型: object

ソースの表示

dimensions: array dimensions

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

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

型: array

ソースの表示

配列: object EsbToColMapInfo

フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。

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

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

型: object

フェデレーテッドEssbaseキューブの場合、ディメンションまたはメンバーをファクト表内の列にマップします。

ソースの表示

columnName: string

外部ファクト表の列名。
essbaseName: string

Essbaseディメンションまたはメンバーの名前。

{
    "type":"object",
    "description":"<p>For federated Essbase cube, map dimensions or members to columns in the fact table.</p>",
    "properties":{
        "essbaseName":{
            "type":"string",
            "description":"<p>Essbase dimension or member name.</p>"
        },
        "columnName":{
            "type":"string",
            "description":"<p>Column name in external fact table.</p>"
        }
    }
}

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

型: array

ソースの表示

配列: object Dimension

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

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

型: object

ソースの表示

added: boolean

アウトラインにまだ存在しない新しいディメンションの場合は、trueに設定します。trueの場合、新しいディメンションがディメンション構築中に作成されます。falseの場合、新しいディメンションのディメンション構築は失敗します。
addMemberOption: string

指定可能な値: [ "GENERATION", "SIBLING_LOWEST_LEVEL", "CHILD", "SIBLING_MATCHING_STRING", "LEVEL", "PARENT_CHILD", "GEN_NULLS", "LEVEL_NULLS" ]

このディメンションに含まれるディメンション、メンバーおよび別名を追加、変更または削除する構築方法アルゴリズム。ソース・データのプロパティに基づいている必要があります。たとえば、各レコードで親、その後に子メンバーをこの順序で指定している場合、PARENT_CHILDが適切な方法です。
aggregateLevelUsage: integer(int32)
allowassociationChanges: boolean
allowFormulaChanges: boolean
allowMoves: string

指定可能な値: [ "NOTOK", "OK", "IGNORE", "GEN2", "NOTGEN2" ]

メンバーおよびその子を新しい親に移動できるようにする場合はOKに設定し、Essbaseがプライマリ・メンバーを認識してそれらをソース・データと照合できるようにします。重複メンバーのアウトラインには使用できません。updateOption = RESET_DIMENSIONの場合は、NOTOKのままにします。
allowPropertyChanges: boolean
allowUDAChanges: boolean
attributeOptions: object AttributeOptions
autoFixSharedMember: boolean
configOption: string

指定可能な値: [ "EXISTING", "DENSE", "SPARSE" ]
createAttributeMembers: boolean

Essbaseで属性メンバーを作成できるようにするには、trueに設定します。falseの場合、Essbaseでは属性メンバーを作成できません。
dimensionSolveOrder: integer(int32)

ディメンションの解決順。
flexible: boolean
generations: array generations
hierarchyType: string

指定可能な値: [ "EXISTING", "MULTIPLE", "STORED", "DYNAMIC" ]

このディメンションで複数の階層を有効にする必要がある場合はMULTIPLE (集約ストレージ・キューブにのみ適用可能)。設定をそのままにする場合はEXISTING。集約ストレージ保存階層タイプ(式なし)の場合はSTORED。式を使用して集約する集約ストレージ階層タイプ(勘定科目ディメンションを含む)の場合はDYNAMIC。
incrementalSort: boolean

Essbaseがソース・データからのすべてのメンバーを処理および追加した後にメンバーをソートする場合は、trueに設定します。
levels: array levels
measureOptions: object MeasureOptions

主に勘定科目ディメンションに関連するロード・ルール定義プロパティ。
memberName: string

子を追加する親メンバーの名前。「次の子として追加」構築方法とともに使用します。
name: string
share: boolean

ディメンションに共有メンバーが含まれる場合はtrueに設定します。
solveOrder: integer(int32)

ディメンションまたはメンバーが計算される優先度(0から127)。解決順の値が大きいほどそのメンバーは後で計算されることになります。解決順が割り当てられていないメンバーは、そのディメンションから解決順を継承します。
sortOption: string

指定可能な値: [ "NONE", "ASCENDING", "DESCENDING" ]

このディメンションの階層内の子をソートするかどうかと、ソート方法: なし(ソートしない)、昇順または降順。
storageType: string

指定可能な値: [ "EXISTING", "STORE", "NEVER_SHARE", "LABEL_ONLY", "DYNAMIC_CALC_STORE", "DYNAMIC_CALC" ]
type: string

指定可能な値: [ "EXISTING", "NONE", "ACCOUNTS", "TIME", "COUNTRY", "ATTRIBUTES" ]
unique: string

指定可能な値: [ "EXISTING", "UNIQUE", "DUPLICATE", "NONE" ]
updateOption: string

指定可能な値: [ "MERGE", "REMOVE_UNSPECIFIED", "RESET_DIMENSION" ]

増分ディメンション構築の更新オプション。増分ディメンション構築は、メンバーの追加、移動、削除および順序変更によって既存のディメンションを更新するプロセスです。MERGE (デフォルト)では、新しいメンバーを追加しますが、既存のメンバーも保持します。REMOVE_UNSPECIFIEDでは、ソースで指定されていないメンバーを削除します(addMemberOption = GENERATION、LEVELまたはPARENT_CHILDの場合のみ使用可能)。メンバーの削除によってレベル0の式のない動的計算メンバーになる場合、アウトラインは無効です。RESET_DIMENSIONは、インデックスベースのルール(つまり、studio = true)にのみ使用可能です。ディメンションのリセットは、ディメンション全体を再構築します。このオプションでは、増分ディメンション構築中の挿入、順序変更、移動および削除操作を使用可能にし、階層内のメンバーの配置を最後に移動するのではなく、そのままにします。ディメンションのリセットを使用するには、allowMovesをNOTOKにする必要があります。そうしないと、共有階層を構築できません。

{
    "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",
            "description":"<p>The build method algorithm to add, change, or remove dimensions, members, and aliases in this dimension. Should be based on the properties of the source data; for example, if each record specifies a parent and later a child member, in that order, then PARENT_CHILD is a good method.</p>",
            "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",
            "description":"<p>MULTIPLE if multiple hierarchies should be enabled in this dimension (applicable to aggregate storage cube only). EXISTING to keep the setting unchanged. STORED for aggregate storage stored hierarchy type (no formulas). DYNAMIC for aggregate storage hierarchy type that aggregates using formulas (includes Accounts dimension).</p>",
            "enum":[
                "EXISTING",
                "MULTIPLE",
                "STORED",
                "DYNAMIC"
            ]
        },
        "sortOption":{
            "type":"string",
            "description":"<p>Whether and how to sort this dimension's children in hierarchies: None (do not sort), ascending, or descending.</p>",
            "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",
            "description":"<p>Incremental dimension build update option. Incremental dimension building is the process of updating existing dimensions by adding, moving, deleting, and reordering members. MERGE (the default) adds new members while retaining existing members. REMOVE_UNSPECIFIED removes members that are not specified in the source (available only when <i>addMemberOption</i> = <code>GENERATION</code>, <code>LEVEL</code>, or <code>PARENT_CHILD</code>). Outlines are invalid if removing members results in level 0 Dynamic Calc members without formulas. RESET_DIMENSION is available only for Index-based rules (i.e. <i>studio</i> = <code>true</code>). Reset Dimension rebuilds the entire dimension. This option enables insert, reorder, move, and delete operations during incremental dimension build, persisting member placement in the hierarchy instead of moving them to the end. To use Reset Dimension, <i>allowMoves</i> should be <code>NOTOK</code>; otherwise, you cannot build shared hierarchies.</p>",
            "enum":[
                "MERGE",
                "REMOVE_UNSPECIFIED",
                "RESET_DIMENSION"
            ]
        },
        "allowMoves":{
            "type":"string",
            "description":"<p>Set to <b>OK</b> to allow moving of members and their children to new parents, allowing Essbase to recognize primary members and match them with the source data. Not available for duplicate member outlines. Leave as <b>NOTOK</b> if <i>updateOption</i> = <code>RESET_DIMENSION</code>.</p>",
            "enum":[
                "NOTOK",
                "OK",
                "IGNORE",
                "GEN2",
                "NOTGEN2"
            ]
        },
        "solveOrder":{
            "type":"integer",
            "description":"<p>Priority in which the dimension or member is calculated (0 to 127). Higher solve order means the member is calculated later. Members not assigned a solve order inherit it from their dimension.</p>",
            "format":"int32"
        },
        "createAttributeMembers":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to allow Essbase to create attribute members. If <b>false</b>, prevents Essbase from creating attribute members.</p>"
        },
        "share":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> if the dimension includes shared members.</p>"
        },
        "incrementalSort":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to sort members after Essbase has processed and added all members from the source data.</p>"
        },
        "autoFixSharedMember":{
            "type":"boolean"
        },
        "flexible":{
            "type":"boolean"
        },
        "memberName":{
            "type":"string",
            "description":"<p>Parent member name under which to add children. Used with Add as child of build method.</p>"
        },
        "name":{
            "type":"string"
        },
        "dimensionSolveOrder":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Solve order of the dimension.</p>"
        },
        "added":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> for a new dimension that does not yet exist in the outline. If <b>true</b>, the new dimension will be created during the dimension build. If <b>false</b>, dimension build will fail for a new dimension.</p>"
        }
    }
}

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

型: object

ソースの表示

baseDimension: string
indepDimensions: array indepDimensions
modified: boolean
scaassociationMode: string

指定可能な値: [ "NOOVERWRITE", "OVERWRITE" ]
scadisAssociationMode: string

指定可能な値: [ "NOOVERWRITE", "OVERWRITE", "EXTEND" ]
type: 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"
        },
        "scadisAssociationMode":{
            "type":"string",
            "enum":[
                "NOOVERWRITE",
                "OVERWRITE",
                "EXTEND"
            ]
        },
        "scaassociationMode":{
            "type":"string",
            "enum":[
                "NOOVERWRITE",
                "OVERWRITE"
            ]
        }
    }
}

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

型: array

ソースの表示

配列: object Level

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

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

型: array

ソースの表示

配列: object Level

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

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

型: object

主に勘定科目ディメンションに関連するロード・ルール定義プロパティ。

ソースの表示

currencyCategory: string

ディメンションが通貨換算アプリケーションに関連付けられている場合は、通貨カテゴリ。これは通貨キューブからの勘定科目メンバーです。例: P&L。
currencyConversion: string

指定可能な値: [ "EXISTING", "NONE", "CATEGORY", "NO_CONVERSION" ]

ディメンション構築中に実行する通貨換算アクション。通貨換算しないメンバーにはNO_CONVERSIONのマークを付けます。NONEは、換算しないことを示すのではなく、換算カテゴリが未指定である(つまり、継承される)ことを示します。
currencyName: string

ディメンションが通貨換算アプリケーションに関連付けられている場合は、通貨名。これは通貨キューブからの国ディメンション・タイプ・メンバーです。例: USD、CND、GPB、EUR
skip: string

指定可能な値: [ "NONE", "NA", "MISSING", "ZERO", "MISSING_ZERO" ]

timeBalanceOptionをFIRST、LASTまたはAVERAGEとして設定する場合は、スキップ・プロパティを使用して、欠落値またはゼロ値が出現した場合の親値の計算方法を示します。NONE: 親値を計算するときにデータをスキップしません。MISSING: #MISSINGデータをスキップします。ZERO: ゼロに等しい値をスキップします。MISSING_ZERO: #MISSINGデータとゼロに等しいデータをスキップします。
timeBalanceOption: string

指定可能な値: [ "EXISTING", "NONE", "FIRST", "LAST", "AVERAGE" ]

タイム・バランス・プロパティ(使用する場合)。デフォルトでは、時間ディメンション内の親はその子の集計および式に基づいて計算されます。たとえば、Sample.Basicデータベースでは、Qtr1メンバーはその子(Jan、FebおよびMar)の合計です。ただし、タイム・バランス・プロパティを設定すると、親(たとえば、Qtr1)は異なる方法でロールアップされます。
twoPass: boolean

2パス計算を使用するとしてディメンションにマークを付ける場合はtrue。
varianceReporting: string

指定可能な値: [ "EXISTING", "NON_EXPENSE", "EXPENSE" ]

勘定科目メンバーを費用アイテムとして処理します。現在の設定を保持する場合はEXISTING。

{
    "type":"object",
    "description":"<p>Load rule definition properties relating primarily to the Accounts dimension.</p>",
    "properties":{
        "currencyCategory":{
            "type":"string",
            "description":"<p>If the dimension is associated with a currency conversion application, the currency category. This is an Accounts member from the currency cube. Example: P&L.</p>"
        },
        "currencyName":{
            "type":"string",
            "description":"<p>If the dimension is associated with a currency conversion application, the currency name. This is a Country dimension type member from the currency cube. Examples: USD, CND, GPB, EUR</p>"
        },
        "currencyConversion":{
            "type":"string",
            "description":"<p>Currency conversion action to take during the dimension build. Mark any members that should not be currency-converted as NO_CONVERSION. NONE does not indicate no conversion; rather, it indicates that the conversion category is unspecified (thus inherited).</p>",
            "enum":[
                "EXISTING",
                "NONE",
                "CATEGORY",
                "NO_CONVERSION"
            ]
        },
        "skip":{
            "type":"string",
            "description":"<p>If you set the <i>timeBalanceOption</i> as FIRST, LAST, or AVERAGE, then use the skip property to indicate how to calculate the parent value when missing- or zero-values  are encountered. NONE: Does not skip data when calculating parent value. MISSING: Skips #MISSING data. ZERO: Skips data that equals zero. MISSING_ZERO: Skips #MISSING data and data that equals zero.</p>",
            "enum":[
                "NONE",
                "NA",
                "MISSING",
                "ZERO",
                "MISSING_ZERO"
            ]
        },
        "timeBalanceOption":{
            "type":"string",
            "description":"<p>The time balance property, if used. By default, a parent in the time dimension is calculated based on the consolidation and formulas of its children. For example, in the Sample.Basic database, the Qtr1 member is the sum of its children (Jan, Feb, and Mar). However, setting a time balance property causes parents, for example Qtr1, to roll up differently.</p>",
            "enum":[
                "EXISTING",
                "NONE",
                "FIRST",
                "LAST",
                "AVERAGE"
            ]
        },
        "varianceReporting":{
            "type":"string",
            "description":"<p>Whether to treat accounts members as expense items. EXISTING to keep the current setting.</p>",
            "enum":[
                "EXISTING",
                "NON_EXPENSE",
                "EXPENSE"
            ]
        },
        "twoPass":{
            "type":"boolean",
            "description":"<p>True to mark the dimension as using two-pass calculation.</p>"
        }
    }
}

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

型: array

ソースの表示

配列: object IndepDimension

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

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

型: object

ソースの表示

name: string
type: string

指定可能な値: [ "CONTINUOUS", "DISCRETE" ]

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

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

型: object

ソースの表示

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

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

400 レスポンス

不正なリクエスト

パーティション領域のセル数の取得に失敗しました。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、ソースおよびターゲットのパーティション領域定義のセル数をカウントする方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/SampTgt/databases/Basic/partitions/cellcount" -H  "accept: application/json" -H  "Content-Type: application/json" --data-binary "@./input_partitioninfo.json" -o output.json -u %User%:%Password%

サンプルのJSONペイロード

前述のcURLの例では、次のJSONペイロードがinput_partitioninfo.jsonで配信されます。

{
  "type": "TRANSPARENT",
   "isNew": true,
   "federatedTypeCR": false,
   "federatedTypeAV": false,
   "sourceInfo": {
       "serverName": "https://myserver.example.com:9001/essbase/agent",
       "applicationName": "SampSrc",
       "databaseName": "Basic"
       },
    "areas": [
       {
        "sourceArea": "@idesc(\"100\")",
        "targetArea": "@idesc(\"100\")",
        "slices": [
           {
            "sourceMember": "\"100-10\"",
            "targetMember": "\"555-55\""
           }
         ]
       }
      ],
     "mappings": []
}

レスポンス本体の例

次の出力がoutput.jsonに書き込まれます。

{
  "type" : "TRANSPARENT",
  "isNew" : true,
  "updatable" : false,
  "locked" : false,
  "federatedTypeCR" : false,
  "federatedTypeAV" : false,
  "sourceInfo" : {
    "serverName" : "https://myserver.example.com:9001/essbase/agent",
    "alterCredentials" : false,
    "applicationLevelConnection" : false,
    "applicationLevelDatasource" : false,
    "applicationName" : "SampSrc",
    "databaseName" : "Basic"
  },
  "targetInfo" : {
    "serverName" : "https://myserver.example.com:9001/essbase/agent",
    "alterCredentials" : false,
    "applicationLevelConnection" : false,
    "applicationLevelDatasource" : false
  },
  "areas" : [ {
    "sourceArea" : "@idesc(\"100\")",
    "sourceCellCount" : 95200,
    "targetArea" : "@idesc(\"100\")",
    "targetCellCount" : 95200,
    "slices" : [ {
      "sourceMember" : "\"100-10\"",
      "targetMember" : "\"555-55\""
    } ]
  } ],
  "mappings" : []
}

先頭に戻る