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

Update Filter

put

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

Updates the named filter in the specified application and database, and returns the updated filter.

Request

Supported Media Types
Path Parameters
Body ()

Filter details.

Root Schema : FilterBean
Type: object
Show Source
Nested Schema : rows
Type: array
Show Source
Nested Schema : FilterRow
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK

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

Body ()
Root Schema : FilterBean
Type: object
Show Source
Nested Schema : rows
Type: array
Show Source
Nested Schema : FilterRow
Type: object
Show Source

400 Response

Bad Request

Failed to update the filter. The application name, database name, or filter name may be incorrect, or the named filter may not exist.

415 Response

Not Acceptable

The media type isn't supported or wasn't specified.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to update the definition of an existing Essbase security filter. The filter definition controls access levels to different regions of the database.

A filter definition update does not change the user or group permissions. To assign filters, see Add Permissions in 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 PUT "https://myserver.example.com:9001/essbase/rest/v1/applications/Efficient/databases/UserFilters/filters/dslookupfilter?links=none" -H "Accept: application/json" -H "Content-Type: application/json" --data "@./lookup_filter_update.json" -u %User%:%Password%

Example of Request Body

The input file, lookup_filter_update.json, consists of the following JSON information. 

{"name": "dslookupfilter",
  "rows":
   [
     {
      "access": "Read",
      "mbrSpec": "@datasourceLookup(\"EFFICIENT.UserDetails\",\"USERNAME\",$loginUser, \"COUNTRY\")"
     },
     {
      "access": "Read",
      "mbrSpec": "@datasourceLookup(\"EFFICIENT.UserDetails\",\"USERNAME\",$loginUser, \"BUSINESSUNIT\")"
     },
     {
      "access": "Read",
      "mbrSpec": "@datasourceLookup(\"EFFICIENT.UserDetails\",\"USERNAME\",$loginUser, \"COSTCENTER\")"
     }
   ]
}

Example of Response Body

{
  "name" : "dslookupfilter"
}
Back to Top