Jump to

• Request
• Response

Search or Export Groups

get

/essbase/rest/v1/groups

Gets a list of groups based on search results, or exports groups as CSV file.

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

Query Parameters

• expand(optional): string

  Value can be all or none. Default value is all, meaning service role and parent groups are returned for each group. If none is specified, service role and parent groups are not returned.

  Default Value: all
• filter(optional): string

  Group ID wildcard pattern. Filter by name of groups if header Accept='application/json' or Accept='application/xml'.

• limit(optional): integer(int32)

  Maximum number of groups to return, if header Accept='application/json' or Accept='application/xml'.

  Default Value: -1

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

List of groups matching search criteria. Response type can be either JSON, XML, or CSV stream, depending on the Accept header. If Accept='application/json' or Accept='application/xml', the search result is returned in the response. If Accept='application/octet-stream', search result is returned as stream (not shown due to a Swagger limitation).

Body ()

Root Schema : Groups

Type: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupBean"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object GroupBean

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupBean"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : GroupBean

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "description":{
            "type":"string"
        },
        "groups":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "role":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"<p>The group name. Limit 256 characters. The following special characters are not permitted: <code>; , = + * ? [ ] | < > \\ \" ' / Space Tab</code>. Additionally, a period (<code>.</code>) is not permitted in group names.</p>"
        }
    }
}

Nested Schema : groups

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

Logged in user may not have appropriate permissions.

500 Response

Internal Server Error.

Back to Top