1. REST API for Oracle Essbase
  2. Tasks
  3. Partitions

Update Partition

patch

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

Updates an existing partition.

Request

Supported Media Types
Path Parameters
Body ()

Partition information.

Root Schema : PartitionBean
Type: object
Show Source
Nested Schema : areas
Type: array
Show Source
Nested Schema : mappings
Type: array
Show Source
Nested Schema : ConnectionInfoBean
Type: object
Show Source
Nested Schema : AreaBean
Type: object
Show Source
  • slices

    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.

  • Partition source area/region, with optional list of slices containing specific member mappings.

  • 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.

  • Partition target area/region, with optional list of slices containing specific member mappings.

  • 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.

Nested Schema : slices
Type: array

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.

Show Source
Nested Schema : MemberMappingBean
Type: object
Show Source
Nested Schema : EsbToColMap
Type: object

For federated Essbase cube, map dimensions or members to columns in the fact table.

Show Source
Nested Schema : EssToDsMapDTO
Type: object
Show Source
Nested Schema : arr
Type: array
Show Source
Nested Schema : EsbToColMapInfo
Type: object

For federated Essbase cube, map dimensions or members to columns in the fact table.

Show Source
Nested Schema : dimensions
Type: array
Show Source
Nested Schema : Dimension
Type: object
Show Source
Nested Schema : AttributeOptions
Type: object
Show Source
Nested Schema : generations
Type: array
Show Source
Nested Schema : levels
Type: array
Show Source
Nested Schema : MeasureOptions
Type: object

Load rule definition properties relating primarily to the Accounts dimension.

Show Source

  • 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.

  • Allowed Values: [ "EXISTING", "NONE", "CATEGORY", "NO_CONVERSION" ]

    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).

  • 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

  • Allowed Values: [ "NONE", "NA", "MISSING", "ZERO", "MISSING_ZERO" ]

    If you set the timeBalanceOption 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.

  • Allowed Values: [ "EXISTING", "NONE", "FIRST", "LAST", "AVERAGE" ]

    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.

  • True to mark the dimension as using two-pass calculation.

  • Allowed Values: [ "EXISTING", "NON_EXPENSE", "EXPENSE" ]

    Whether to treat accounts members as expense items. EXISTING to keep the current setting.

Nested Schema : indepDimensions
Type: array
Show Source
Nested Schema : IndepDimension
Type: object
Show Source
Nested Schema : Level
Type: object
Show Source
Back to Top

Response

Supported Media Types

204 Response

OK

Partition updated successfully.

400 Response

Bad Request

Failed to update partition.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to update a partition on the current target cube.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command to Update a Transparent Partition

In the following REST API example, the target cube, P_Market.Demo, is based on the Essbase gallery sample Demo.Basic. The Market dimension of P_Market.Demo is comprised of transparent partitions to various source cubes (one for each individual market region: Boston, Dallas, Chicago, and 7 other cities).

call properties.bat
curl -X PATCH "https://myserver.example.com:9001/essbase/agent/essbase/rest/v1/applications/P_Market/databases/Demo/partitions" -H "accept: application/json" -H "Content-Type: application/json" --data-binary "@./input_partitioninfo.json" -u %User%:%Password%

Sample JSON Payload

The cURL example above delivers the following JSON payload in input_partitioninfo.json. 

{
    "type": "TRANSPARENT",
    "isNew": true,
    "sourceInfo": {
        "serverName": "https://myserver.example.com:9001/essbase/agent",
        "applicationName": "P_Boston",
        "databaseName": "Demo"
        },
    "targetInfo": {
        "serverName": "https://myserver.example.com:9001/essbase/agent",
        "applicationName": "P_Market",
        "databaseName": "Demo"
        },
    "areas": [ {
        "sourceArea": "\"Actual\", \"Budget\"",
        "targetArea": "\"Actual\", \"Budget\", \"Boston\""
        } ],
    "mappings": [ {
	    "targetMember": "\"Boston\""
        } ]
    }
Back to Top