REST API for Oracle Essbase

Get Filter

get

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

Returns the named filter from the specified application and database.

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

The filter was retrieved successfully, with links to get, edit, or delete the filter, and to get the filter rows.

Root Schema : FilterBean

Type: object

Show Source

links: array links
name: string
rows: array rows

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "rows":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FilterRow"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : rows

Type: array

Show Source

Array of: object FilterRow

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

Nested Schema : Link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "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 the filter. The application name, database name, or filter name may be incorrect.

500 Response

Internal Server Error.

Examples

The following example shows how to get details of a named Essbase security filter.

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 -H "Accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "name" : "dslookupfilter",
  "links" : [ {
    "rel" : "get",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter",
    "method" : "GET"
  }, {
    "rel" : "delete",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter",
    "method" : "DELETE"
  }, {
    "rel" : "edit",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter",
    "method" : "PUT"
  }, {
    "rel" : "rows",
    "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter/rows",
    "method" : "GET"
  } ]
}