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

Validate Filter

post

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/filters/filterops/validate

Validates the filter in the specified application and database.

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

200 Response

OK

The filter was validated successfully.

400 Response

Bad Request

Failed to validate the filter. The application name or database name may be incorrect, or the filter rows may be incomplete.

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 use the REST API to validate the syntax of an 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 POST https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/filters/filterops/validate -H "Accept: application/json" -H "Content-Type: application/json" --data "@./filter_validate.json" -u %User%:%Password%

Example of Request Body

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

{"name": "filter8",
 "rows":
  [
    {
      "access": "MetaRead",
      "mbrSpec": "Qtr3"
    },
    {
      "access": "Read",
      "mbrSpec": "Qtr1"
    },
    {
      "access": "Write",
      "mbrSpec": "Qtr2"
    }
   ]
}

Example of Response Body

A response is only returned if there are errors in the filter definition.

{
  "errorMessage" : "Invalid syntax in filter line [1] with error number [1200315] - see application log file",
  "errorCode" : 1054012
}
Back to Top