Jump to

• Request
• Response

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: string

  Application name.

• databaseName: string

  Database name.

Body ()

Filter rename details.

Root Schema : FilterCopy

Type: object

Show Source

• from: string
• to: string

{
    "type":"object",
    "required":[
        "from",
        "to"
    ],
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Filter was renamed successfully. Returns filter details and links to get, edit, or delete the filter, and to get the filter rows.

Body ()

Root Schema : FilterBean

Type: object

Show Source

• links(optional): array links
• name(optional): string
• rows(optional): 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(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : FilterRow

Type: object

Show Source

• access: string
• mbrSpec: 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.

Back to Top