REST API for Oracle Essbase

Rename Filter

post

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

Renames the filter in the specified application and database and returns the created filter

Request

Supported Media Types

application/json
application/xml

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.

Filter rename details.

Root Schema : FilterCopy

Type: object

Show Source

from(required): string

Original filter name.
to(required): string

New filter name.

{
    "type":"object",
    "required":[
        "from",
        "to"
    ],
    "properties":{
        "from":{
            "type":"string",
            "description":"<p>Original filter name.</p>"
        },
        "to":{
            "type":"string",
            "description":"<p>New filter name.</p>"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Filter was renamed successfully. Returns filter details and 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 rename filter. The application name or database name may be incorrect, or a filter with that name may already exist.

415 Response

Not Acceptable

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

500 Response

Internal Server Error.

Examples

The following example shows how to rename 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/Efficient/databases/UserFilters/filters/filterops/rename?links=none" -H "Accept: application/json" -H "Content-Type:application/json" -d '{"from": "dslookupfilter", "to": "dynamicfilter"}' -u %User%:%Password%

Example of Response Body

{
  "name" : "dynamicfilter"
}