Get Group
/essbase/rest/v1/groups/{id}
Gets group details.
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
-
id(required): string
Group ID.
Response
- application/json
- application/xml
200 Response
Group details
object-
description:
string
-
groups:
array groups
-
links:
array links
-
name:
string
The group name. Limit 256 characters. The following special characters are not permitted:
; , = + * ? [ ] | < > \ " ' / Space Tab. Additionally, a period (.) is not permitted in group names. -
role:
string
400 Response
Bad Request
Logged in user may not have appropriate permissions.
404 Response
Not Found
The group with that ID does not exist.
500 Response
Internal Server Error.
Examples
The following example shows how to get details for a specified Essbase group ID.
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 GET -i "https://myserver.example.com:9001/essbase/rest/v1/groups/ess_power_group?links=none" -H "Accept:application/json" -u %User%:%Password%Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"name" : "ess_power_group",
"description" : "Power Group",
"role" : "Power User"
}