Jump to

• Request
• Response

Update Group

put

/essbase/rest/v1/groups/{id}

Updates a group.

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

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string

  ID of group.

Body ()

Group details to update.

Root 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Group updated successfully.

Body ()

Root 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