getPermissionsByRole

Purpose

Returns information about all of the entities of the given type, including permissions granted to the specified role. Throws an exception in the following cases:

  • entityType is menu, action, or field, and the specified roleID evaluates to Portal Guest, or Portal User
  • The specified roleID evaluates to Administrator, Server API or No Access

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/getPermissionsByRole

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

roleId

The original ID of the role.

entityType

The type of entity for which permissions should be listed. Can be one of the following: field, object, application, menu, view, action, report, chart.

objId

The original ID of the object definition.This is required only when entityType is field, view, action, report, or chart.

appId

The original ID of the application. This is required only when entityType is menu.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Permissions Required

Full administrative privileges.

Response

The name, ID, original ID, and permissions granted for that role in XML or JSON format. Permissions include true, false, and, for fields, conditional. See setPermissionsByRole for the possible permissions for each entity type.

Example

Output example in JSON format for entityType=application:

[
  {
    "name": "Progress Rollbase",
    "id": "46219010",
    "originalId": "836899",
    "View": "true"
  },
  {
    "name": "Organization Management",
    "id": "46219031",
    "originalId": "2354424",
    "View": "false"
  },
  {
    "name": "Library",
    "id": "46219857",
    "originalId": "5903",
    "View": "true"
  },
  {
    "name": "Room Reservation",
    "id": "46220403",
    "originalId": "7549",
    "View": "false"
  },
  {
    "name": "Order Management",
    "id": "46220807",
    "originalId": "150491448",
    "View": "false"
  }
]