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

Get Partitions

get

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

Returns a list of partitions defined on the database, or a specific partition.

  • With no parameters: Returns all available partitions.
  • With type parameter: Returns filtered partitions list.
  • With partition type, source server, source application, and source database parameters: Returns the specified partition details.

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK

Partition list or partition details returned successfully.

Body ()
Root Schema : PartitionList
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
Nested 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

  • Set to true for a new dimension that does not yet exist in the outline. If true, the new dimension will be created during the dimension build. If false, dimension build will fail for a new dimension.

  • Allowed Values: [ "GENERATION", "SIBLING_LOWEST_LEVEL", "CHILD", "SIBLING_MATCHING_STRING", "LEVEL", "PARENT_CHILD", "GEN_NULLS", "LEVEL_NULLS" ]

    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.

  • Allowed Values: [ "NOTOK", "OK", "IGNORE", "GEN2", "NOTGEN2" ]

    Set to OK 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 NOTOK if updateOption = RESET_DIMENSION.

  • AttributeOptions
  • Allowed Values: [ "EXISTING", "DENSE", "SPARSE" ]

  • Set to true to allow Essbase to create attribute members. If false, prevents Essbase from creating attribute members.

  • Solve order of the dimension.

  • generations
  • Allowed Values: [ "EXISTING", "MULTIPLE", "STORED", "DYNAMIC" ]

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

  • Set to true to sort members after Essbase has processed and added all members from the source data.

  • levels
  • MeasureOptions

    Load rule definition properties relating primarily to the Accounts dimension.

  • Parent member name under which to add children. Used with Add as child of build method.

  • Set to true if the dimension includes shared members.

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

  • Allowed Values: [ "NONE", "ASCENDING", "DESCENDING" ]

    Whether and how to sort this dimension's children in hierarchies: None (do not sort), ascending, or descending.

  • Allowed Values: [ "EXISTING", "STORE", "NEVER_SHARE", "LABEL_ONLY", "DYNAMIC_CALC_STORE", "DYNAMIC_CALC" ]
  • Allowed Values: [ "EXISTING", "NONE", "ACCOUNTS", "TIME", "COUNTRY", "ATTRIBUTES" ]
  • Allowed Values: [ "EXISTING", "UNIQUE", "DUPLICATE", "NONE" ]
  • Allowed Values: [ "MERGE", "REMOVE_UNSPECIFIED", "RESET_DIMENSION" ]

    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 addMemberOption = GENERATION, LEVEL, or PARENT_CHILD). 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. studio = true). 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, allowMoves should be NOTOK; otherwise, you cannot build shared hierarchies.

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

400 Response

Bad Request

Failed to get partition results.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get partitions defined on the current 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 get Transparent Partitions

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/SampTgt/databases/Basic/partitions?type=TRANSPARENT&links=none" -H "accept: application/json" -o output_partition_get.json -u %User%:%Password%

Example of Response Body (for a Transparent Partition target cube)

{
  "items": [
    {
      "type": "TRANSPARENT",
      "isNew": false,
      "updatable": false,
      "locked": false,
      "federatedTypeCR": false,
      "federatedTypeAV": false,
      "sourceInfo": {
        "connectionName": "",
        "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,
        "applicationName": "SampTgt",
        "databaseName": "Basic"
      },
      "areas": [
        {
          "sourceArea": "@idesc(\"100\")",
          "sourceCellCount": 0,
          "targetArea": "@idesc(\"100\")",
          "targetCellCount": 0,
          "slices": [
            {
              "sourceMember": "\"100-10\"",
              "targetMember": "\"555-55\""
            }
          ]
        }
      ],
      "mappings": [ ],
      "links": [ ],
  "totalResults": 1,
  "limit": 1,
  "count": 1
}

Script with cURL Command to get Federated Partition

call properties.bat
curl -X GET "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/databases/Basic/partitions?type=FEDERATED&links=none" -H  "accept: application/json" -o output_partition_get.json -u %User%:%Password%

Example of Response Body (for a Federated Partition cube)

{
  "items": [
    {
      "type": "FEDERATED",
      "isNew": false,
      "updatable": false,
      "locked": false,
      "federatedTypeCR": false,
      "federatedTypeAV": true,
      "sourceInfo": {
        "connectionName": "conn",
        "userName": "admin",
        "alterCredentials": false,
        "applicationLevelConnection": true,
        "applicationLevelDatasource": false,
        "measuresDimensionName": "Measures",
        "essbaseToColumnMap": {
          "arr": []
        },
        "essbaseToDataSourceMap": {
          "dimensions": [
            {
              "avDimensionId": 0,
              "isMeasureMember": false,
              "isAttribute": false,
              "dimensionName": "Year",
              "generations": [
                {
                  "generationNumber": 1,
                  "columnName": "YEAR"
                }
              ]
            },
            {
              "avDimensionId": 2,
              "isMeasureMember": false,
              "isAttribute": false,
              "dimensionName": "Product",
              "generations": [
                {
                  "generationNumber": 1,
                  "columnName": "PRODUCT"
                }
              ]
            },
            {
              "avDimensionId": 3,
              "isMeasureMember": false,
              "isAttribute": false,
              "dimensionName": "Market",
              "generations": [
                {
                  "generationNumber": 1,
                  "columnName": "MARKET"
                }
              ]
            },
            {
              "avDimensionId": 4,
              "isMeasureMember": false,
              "isAttribute": false,
              "dimensionName": "Scenario",
              "generations": [
                {
                  "generationNumber": 1,
                  "columnName": "SCENARIO"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Additions",
              "generations": [
                {
                  "generationNumber": 3,
                  "columnName": "ADDITIONS"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "COGS",
              "generations": [
                {
                  "generationNumber": 4,
                  "columnName": "COGS"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Ending Inventory",
              "generations": [
                {
                  "generationNumber": 3,
                  "columnName": "Ending Inventory"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Margin %",
              "generations": [
                {
                  "generationNumber": 3,
                  "columnName": "Margin %"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Marketing",
              "generations": [
                {
                  "generationNumber": 4,
                  "columnName": "MARKETING"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Misc",
              "generations": [
                {
                  "generationNumber": 4,
                  "columnName": "MISC"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Opening Inventory",
              "generations": [
                {
                  "generationNumber": 3,
                  "columnName": "Opening Inventory"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Payroll",
              "generations": [
                {
                  "generationNumber": 4,
                  "columnName": "PAYROLL"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Profit %",
              "generations": [
                {
                  "generationNumber": 3,
                  "columnName": "Profit %"
                }
              ]
            },
            {
              "avDimensionId": -1,
              "isMeasureMember": true,
              "isAttribute": false,
              "dimensionName": "Sales",
              "generations": [
                {
                  "generationNumber": 4,
                  "columnName": "SALES"
                }
              ]
            }
          ]
        },
        "factTableName": "SAMPLE_FACT"
      },
      "targetInfo": {
        "userName": "admin",
        "alterCredentials": false,
        "applicationLevelConnection": false,
        "applicationLevelDatasource": false,
        "applicationName": "Sample",
        "databaseName": "Basic"
      },
      "areas": [
        {
          "sourceArea": "\"Additions\", \"COGS\", \"Ending Inventory\", \"Margin %\", \"Marketing\", \"Misc\", \"Opening Inventory\", \"Payroll\", \"Profit %\", \"Sales\"",
          "sourceCellCount": 0,
          "targetArea": "\"Additions\", \"COGS\", \"Ending Inventory\", \"Margin %\", \"Marketing\", \"Misc\", \"Opening Inventory\", \"Payroll\", \"Profit %\", \"Sales\"",
          "targetCellCount": 0
        }
      ],
      "mappings": [ ],
      "links": [ ]
    }
  ],
  "totalResults": 1,
  "limit": 1,
  "count": 1
}
Back to Top