Jump to

• Request
• Response
• Examples

Get Application Provisioning Report

get

/essbase/rest/v1/users/{userId}/provisionReport/applications/{application}

Gets a provisioning report for the specified application. The logged in user must have at least Database Manager role for the application. 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

• application: string

  Application name.

• userId: string

  User ID.

Query Parameters

• expand(optional): string

  Value can be all or none. Default value is none, meaning only links to roles, filters, and scripts are returned. If all is specified, provisioning information for all roles, filters, and scripts in the application is returned.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Provisioning report returned successfully.

Body ()

Root Schema : ApplicationProvisionReportItem

Type: object

Show Source

• filters(optional): object DatabaseProvisionReportItemList
• name(optional): string
• roles(optional): object ProvisionReportItemList
• scripts(optional): 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(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/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(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 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(optional): string
• items(optional): 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(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"
        }
    }
}

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

400 Response

Bad Request

The logged in user may not have the appropriate application role.

404 Response

Not Found

User not found.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get an application's user provisioning report.

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/users/User002/provisionReport/applications/Sample?expand=all" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "name": "Sample",
  "roles": {
    "items": [
      {
        "name": "db_update"
      }
    ]
  },
  "filters": {
    "items": []
  },
  "scripts": {
    "items": []
  }
}

Back to Top