REST API for Oracle Essbase

Get Permissions

get

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

Retrieves permissions associated with the named 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

The filter permissions were retrieved successfully.

Root Schema : schema

Type: array

Show Source

Array of: object result

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

Nested Schema : result

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":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserGroupProvisionInfo"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"result"
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object permission

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

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

Nested Schema : permission

Type: object

Show Source

group: boolean

true or false. Whether the id refers to a group.
id: string

User or group ID.
links: array links
name: string

User or group name.
role: string

User or group role.

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"<p>User or group ID.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>User or group name.</p>"
        },
        "role":{
            "type":"string",
            "description":"<p>User or group role.</p>"
        },
        "group":{
            "type":"boolean",
            "description":"<p><b>true</b> or <b>false</b>. Whether the <b>id</b> refers to a group.</p>"
        }
    },
    "xml":{
        "name":"permission"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

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"
        }
    }
}

400 Response

Bad Request

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

500 Response

Internal Server Error.

Examples

The following example shows how to retrieve what permissions Essbase users and groups have to a particular 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/permissions?links=none" -H "Accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "items" : [ {
    "id" : "FilterGroup",
    "group" : true
  } ]
}