Jump to

• Request
• Response

Add Permissions

post

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

Adds permissions, in the named filter, for the named user or group.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

• filterName: string

  Filter name.

Body ()

User or group details.

Root Schema : permission

Type: object

Show Source

• group(optional): boolean
• id(optional): string
• links(optional): array links
• name(optional): string
• role(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "group":{
            "type":"boolean"
        }
    },
    "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(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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

The filter permissions were added successfully.

Body ()

Root Schema : permission

Type: object

Show Source

• group(optional): boolean
• id(optional): string
• links(optional): array links
• name(optional): string
• role(optional): string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "group":{
            "type":"boolean"
        }
    },
    "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(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"
        }
    }
}

400 Response

Bad Request

Failed to add the filter permissions. The application name, database name, filter name, or user or group name may be incorrect, or the specified user or group may not have enough privileges.

415 Response

Not Acceptable

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

500 Response

Internal Server Error.

Back to Top