Jump to

• Request
• Response
• Examples

Get Partitions

get

/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

• applicationName(required):

  Application name.

• databaseName(required):

  Database name.

Query Parameters

• applicationLevelDatasource:

  Specify whether the Datasource is defined at application level.

• applicationName:

  Partition source application name.

• databaseName:

  Partition source database name.

• datasourceName:

  Datasource name.

• limit:

  Maximum number of partitions to return.

• measuresDimensionName:

  Pivot dimension name. Can be Measures dimension but does not have to be.

• offset:

  Number of partitions to omit from the start of the result set.

• serverName:

  Partition source server URL, ending in /essbase/agent.

• type:
  Allow Empty value: true

  Partition type. Multiple types can be added with a comma separator.

Back to Top

Response

200 Response

OK

Partition list or partition details returned successfully.

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