Jump to

• Request
• Response
• Examples

Get Provision

get

/essbase/rest/v1/applications/{app}/permissions/{id}

Gets provisioning information on the specified application.

If you are using EPM Shared Services security mode, this operation is not available. Instead, manage users, groups, and permissions in the Shared Services Console.

Request

Path Parameters

• app: string

  Application name.

• id: string

  User or group ID.

Query Parameters

• group(optional): boolean

  If true, ID is for a group. If false, ID is for a user. Default is false (ID is considered to be for a user.)

  Default Value: false
• inherited(optional): boolean

  If true, consider roles derived through parent groups. Default is false.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Provisioning information returned 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

The logged in user may not have the appropriate application role.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get an application's provisioning details, using cURL to call 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 GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002?group=false&inherited=true"-H  "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "id": "User002",
  "role": "db_update",
  "links": [
    {
      "rel": "get",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "GET"
    },
    {
      "rel": "edit",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "PUT"
    },
    {
      "rel": "delete",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/permissions/User002",
      "method": "DELETE"
    }
  ]
}

Back to Top