REST API for Oracle Essbase

Get Filter Rows

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/filters/{filterName}/rows

Returns the access definition rows from the specified filter.

Request

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.
filterName(required): string

Filter name.

Response

Supported Media Types

application/json
application/xml

200 Response

Filter rows were retrieved successfully.

Root Schema : FilterRowList

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: integer(int64)

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

Nested Schema : items

Type: array

Show Source

Array of: object FilterRow

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

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

Nested Schema : FilterRow

Type: object

Show Source

access(required): string
mbrSpec(required): string

{
    "type":"object",
    "required":[
        "access",
        "mbrSpec"
    ],
    "properties":{
        "access":{
            "type":"string"
        },
        "mbrSpec":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get filter rows. The application name, database name, or filter name may be incorrect.

500 Response

Internal Server Error.

Examples

The following example shows how to use Essbase REST API to retrieve the access definition details of a named security filter. The filter's row contents define the access details.

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

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter/rows?links=none" -H "Accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "items" : [ {
    "access" : "MetaRead",
    "mbrSpec" : "@datasourceLookup(\"EFFICIENT.UserDetails\",\"USERNAME\",$loginUser, \"COUNTRY\")"
  }, {
    "access" : "MetaRead",
    "mbrSpec" : "@datasourceLookup(\"EFFICIENT.UserDetails\",\"USERNAME\",$loginUser, \"BUSINESSUNIT\")"
  }, {
    "access" : "MetaRead",
    "mbrSpec" : "@datasourceLookup(\"EFFICIENT.UserDetails\",\"USERNAME\",$loginUser, \"COSTCENTER\")"
  } ]
}