Jump to

• Request
• Response

Get Application Roles Provisioning Report

get

/essbase/rest/v1/groups/{groupId}/provisionReport/applications/{application}/roles

Gets a roles provisioning report for 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

• application: string

  Application name.

• groupId: string

  Group ID.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Provisioning report returned successfully.

Body ()

Root Schema : ProvisionReportItemList

Type: object

Show Source

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

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

Nested Schema : items

Type: array

Show Source

• Array of: object ProvisionReportItem

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

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

Nested Schema : ProvisionReportItem

Type: object

Show Source

• inheritedFromGroups(optional): array inheritedFromGroups
  Unique Items Required: true
• name(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "inheritedFromGroups":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : inheritedFromGroups

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

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

Failed to get provisioning report. The logged in user may not have the appropriate application role.

404 Response

Not Found

The group with that ID does not exist.

500 Response

Internal Server Error.

Back to Top