Add or Import Group(s)
/essbase/rest/v1/groups
Adds or imports one or more groups.
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
- application/json
- application/xml
Group details to add group if header Content-Type='application/json'
or 'application/xml'
; otherwise, if header Content-Type='application/octet-stream'
, CSV file to import group(s).
object
-
description(optional):
string
-
groups(optional):
array groups
-
links(optional):
array links
-
name(optional):
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(optional):
string
Response
- application/json
- application/xml
200 Response
OK
Group added successfully. For Content-Type='application/json'
or 'application/xml'
, added group is returned; otherwise, for Content-Type='application/octet-stream'
, the group was imported successfully.
object
-
description(optional):
string
-
groups(optional):
array groups
-
links(optional):
array links
-
name(optional):
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(optional):
string
400 Response
Bad Request
Logged in user may not have appropriate permissions.
500 Response
Internal Server Error.