REST API for Oracle Essbase

Get Full Provisioning Report

get

/essbase/rest/v1/groups/{groupId}/provisionReport

Gets a full provisioning report for the service and all applications. Service roles are included in the response only if the logged in user has Service Administrator role. The logged in user must have at least Database Manager role for applications to get application provisioning reports. Application roles are included in the report only if the logged in user has at least Application Manager role for the 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

groupId(required): string

Group ID.

Query Parameters

expand: string

Use all to get provisioning information for all applications.

Response

Supported Media Types

application/json
application/xml

200 Response

Provisioning report returned successfully.

Root Schema : MainProvisionReport

Type: object

Show Source

applications: object ApplicationProvisionReportItemList
links: array links
service: object ServiceProvisionReportItem

{
    "type":"object",
    "properties":{
        "service":{
            "$ref":"#/definitions/ServiceProvisionReportItem"
        },
        "applications":{
            "$ref":"#/definitions/ApplicationProvisionReportItemList"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ApplicationProvisionReportItemList

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
links: array links
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationProvisionReportItem"
            }
        },
        "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 : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : ServiceProvisionReportItem

Type: object

Show Source

roles: object ProvisionReportItemList

{
    "type":"object",
    "properties":{
        "roles":{
            "$ref":"#/definitions/ProvisionReportItemList"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object ApplicationProvisionReportItem

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

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 : ApplicationProvisionReportItem

Type: object

Show Source

filters: object DatabaseProvisionReportItemList
name: string
roles: object ProvisionReportItemList
scripts: object DatabaseProvisionReportItemList

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "roles":{
            "$ref":"#/definitions/ProvisionReportItemList"
        },
        "filters":{
            "$ref":"#/definitions/DatabaseProvisionReportItemList"
        },
        "scripts":{
            "$ref":"#/definitions/DatabaseProvisionReportItemList"
        }
    }
}

Nested Schema : DatabaseProvisionReportItemList

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
links: array links
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DatabaseProvisionReportItem"
            }
        },
        "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 : ProvisionReportItemList

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
links: array links
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: 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 DatabaseProvisionReportItem

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

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 : DatabaseProvisionReportItem

Type: object

Show Source

database: string
items: array items

{
    "type":"object",
    "properties":{
        "database":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProvisionReportItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object ProvisionReportItem

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

Nested Schema : ProvisionReportItem

Type: object

Show Source

inheritedFromGroups: array inheritedFromGroups

Unique Items Required: true
name: 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: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

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

404 Response

Not Found

The group with that ID does not exist.

500 Response

Internal Server Error.

Examples

The following example shows how to retrieve a particular group's service role and application level provisioning.

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 https://myserver.example.com:9001/essbase/rest/v1/groups/dbupdaters/provisionReport -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "service" : {
    "roles" : {
      "items" : [ {
        "name" : "user"
      } ]
    }
  },
  "applications" : {
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/groups/dbupdaters/provisionReport/applications",
      "method" : "GET"
    } ]
  }
}