Role APIs

The ‘’‘Role Setup’‘’ page allows user to manage roles.

List of APIs

API Purpose
GET role/all/(tenant_id) Returns an array of roles, filtered by tenant_id if available.
POST role/active/{role_id}/(tenant_id) Sets a role to be active.
POST role/deactive/{role_id}/(tenant_id) Sets a role to be inactive.
DELETE role/{role_id} Deletes a role.
GET role/{role_id} Returns a role.
GET role/availableRole/{type}/(tenant_id) Returns a list of available roles for Access (type=0) or Scheduling (type=1), filtered by tenant_id if available.
GET role/availableCategory/{type}/(tenant_id)

Deprecated since version 2.0.0: superseded by POST role/availableCategory

Returns a list of available categories for Report/Template (type=0) or Dashboard (type=1), filtered by tenant_id if available.

POST role/availableCategory Returns a list of available categories, with total number of items.
POST role Saves a role.
GET role/summaries/(tenant_id) Returns an array of roles filtered by tenant_id.
POST role/allowedSharingRoles Returns a list of roles allowed to be selected in report/dashboard access.
POST role/intergration/saveRole Adds or updates an external role.
POST role/accessLimits Lazy load access limit data for each role.
POST role/scheduleLimits Lazy load schedule limit data for each role.

POST role/loadPartialDataModelAccess

New in version 2.9.0.

Load data model access partially.

GET role/all/(tenant_id)

Returns an array of roles, filtered by tenant_id if available.

Request

No payload

Response

An array of RoleDetail objects

Samples

GET /api/role/all HTTP/1.1
Sample response:
[
   {
      "users": [
         {
            "password": null,
            "verification": null,
            "isCheck": false,
            "name": "John Doe",
            "roles": [],
            "userRoles": null,
            "userSecurityQuestions": null,
            "status": 0,
            "issueDate": "0001-01-01T00:00:00.0000000+07:00",
            "autoLogin": false,
            "newPassword": null,
            "userName": "acme@system.com",
            "emailAddress": "acme@system.com",
            "firstName": "John",
            "lastName": "Doe",
            "passwordHash": null,
            "passwordSalt": null,
            "currentTokenHash": null,
            "tenantId": "a2787f8e-0b04-4d48-a5df-9ad9df32317d",
            "tenantDisplayId": null,
            "tenantName": null,
            "dataOffset": null,
            "timestampOffset": null,
            "initPassword": false,
            "active": true,
            "retryLoginTime": null,
            "lastTimeAccessed": null,
            "passwordLastChanged": null,
            "locked": null,
            "lockedDate": null,
            "cultureName": null,
            "securityQuestionLastChanged": null,
            "dateFormat": "MM/DD/YYYY",
            "systemAdmin": false,
            "notAllowSharing": false,
            "numberOfFailedSecurityQuestion": null,
            "fullName": "John Doe",
            "currentModules": null,
            "currentAccessToken": null,
            "id": "8f05e4b9-aa3d-48ec-869f-e6b2d8ecae14",
            "state": 0,
            "deleted": false,
            "inserted": true,
            "version": 2,
            "created": "2018-04-13T09:20:17.2900000+07:00",
            "createdBy": "$RootAdmin$",
            "modified": "2018-04-27T04:05:44.2730000+07:00",
            "modifiedBy": "$RootAdmin$"
         }
      ],
      "tenantUniqueName": null,
      "isChecked": false,
      "selected": false,
      "permission": null,
      "visibleQuerySources": null,
      "visibleQuerySourcesTree": [],
      "name": "Manager",
      "tenantId": "a2787f8e-0b04-4d48-a5df-9ad9df32317d",
      "active": true,
      "showCheckedQuerySource": false,
      "notAllowSharing": false,
      "permissionData": null,
      "querySources": "",
      "deserializedQuerySources": [],
      "id": "66159184-52e9-4ede-8951-c6118c7d5766",
      "state": 0,
      "deleted": false,
      "inserted": true,
      "version": 6,
      "created": "2018-05-03T07:24:42.9500000+07:00",
      "createdBy": "System Admin",
      "modified": "2018-05-09T09:49:52.5870000+07:00",
      "modifiedBy": "System Admin"
   }
]

POST role/active/{role_id}/(tenant_id)

Sets a role to be active.

Request

No payload

Response

An OperationResult object with success field true if the update is successful

Samples

POST api/role/active/0d030b1a-9568-4c98-8b1e-5dcc94dbd282 HTTP/1.1

Sample response:

{
  "success" : true,
  "messages" : null,
  "data" : null
}

POST role/deactive/{role_id}/(tenant_id)

Sets a role to be inactive.

Request

No payload

Response

An OperationResult object with success field true if the update is successful

Samples

POST api/role/deactive/0d030b1a-9568-4c98-8b1e-5dcc94dbd282 HTTP/1.1

Sample response:

{
  "success" : true,
  "messages" : null,
  "data" : null
}

DELETE role/{role_id}

Deletes a role.

Request

No payload

Response

An OperationResult object with success field true if the update is successful

Samples

DELETE api/role/0d030b1a-9568-4c98-8b1e-5dcc94dbd281 HTTP/1.1

Sample response:

{
  "success" : true,
  "messages" : null,
  "data" : null
}

GET role/{role_id}

Returns a role.

Request

No payload

Response

A RoleDetail object

Samples

GET /api/role/0d030b1a-9568-4c98-8b1e-5dcc94dbd281 HTTP/1.1

Sample response:

{
   "users": [],
   "permission": null,
   "visibleQuerySourceFields": null,
   "name": "Analyst",
   "tenantId": null,
   "active": true,
   "deleted": false,
   "permissionData": "",
   "querySourceFields": "",
   "id": "0d030b1a-9568-4c98-8b1e-5dcc94dbd281",
   "state": 0,
   "inserted": true,
   "version": 1,
   "created": null,
   "createdBy": null,
   "modified": null,
   "modifiedBy": null
}

GET role/availableRole/{type}/(tenant_id)

Returns a list of available roles for Access (type=0) or Scheduling (type=1), filtered by tenant_id if available.

Request

No payload

Response

An array of RoleDetail object

Samples

GET api/role/availableRole/0 HTTP/1.1
Sample response:
[{
   "users" : [],
   "permission" : null,
   "visibleQuerySourceFields" : null,
   "name" : "Anonymous",
   "tenantId" : null,
   "active" : false,
   "deleted" : false,
   "permissionData" : "",
   "querySourceFields" : "",
   "id" : "0d030b1a-9568-4c98-8b1e-5dcc94dbd284",
   "state" : 0,
   "inserted" : true,
   "version" : 1,
   "created" : null,
   "createdBy" : null,
   "modified" : null,
   "modifiedBy" : null
}, {
   "users" : [{
         "password" : null,
         "roles" : null,
         "userRoles" : null,
         "userSecurityQuestions" : null,
         "userName" : "User1",
         "emailAddress" : "katty@email.com",
         "firstName" : "Katty",
         "lastName" : "Doe",
         "passwordHash" : null,
         "passwordSalt" : null,
         "currentTokenHash" : null,
         "tenantId" : null,
         "deleted" : false,
         "dataOffset" : 0,
         "timestampOffset" : 0,
         "initPassword" : false,
         "active" : false,
         "fullName" : "Katty Doe",
         "id" : "9f58703e-0dff-4690-9dc6-c595a6fd84e1",
         "state" : 0,
         "inserted" : true,
         "version" : 1,
         "created" : null,
         "createdBy" : null,
         "modified" : null,
         "modifiedBy" : null
      }
   ],
   "permission" : null,
   "visibleQuerySourceFields" : null,
   "name" : "Analyst",
   "tenantId" : null,
   "active" : false,
   "deleted" : false,
   "permissionData" : "",
   "querySourceFields" : "",
   "id" : "0d030b1a-9568-4c98-8b1e-5dcc94dbd281",
   "state" : 0,
   "inserted" : true,
   "version" : 1,
   "created" : null,
   "createdBy" : null,
   "modified" : null,
   "modifiedBy" : null
}, {
   "users" : [],
   "permission" : null,
   "visibleQuerySourceFields" : null,
   "name" : "Reviewer",
   "tenantId" : null,
   "active" : true,
   "deleted" : false,
   "permissionData" : "",
   "querySourceFields" : "",
   "id" : "0d030b1a-9568-4c98-8b1e-5dcc94dbd282",
   "state" : 0,
   "inserted" : true,
   "version" : 1,
   "created" : null,
   "createdBy" : null,
   "modified" : null,
   "modifiedBy" : null
}
]

GET role/availableCategory/{type}/(tenant_id)

Deprecated since version 2.0.0: superseded by POST role/availableCategory

Returns a list of available categories for Report/Template (type=0) or Dashboard (type=1), filtered by tenant_id if available.

Request

No payload

Response

An array of Category objects

Samples

GET api/role/availableCategory/0 HTTP/1.1
Sample response:
[
{
   "name": "Sales",
   "type": 0,
   "parentId": null,
   "tenantId": null,
   "canDelete": false,
   "editable": false,
   "savable": false,
   "subCategories": [
   {
      "name": "InternetSales",
      "type": 0,
      "parentId": "93de93b9-d5d1-48f1-800d-1db1ffc02614",
      "tenantId": null,
      "canDelete": false,
      "editable": false,
      "savable": false,
      "subCategories": [],
      "checked": false,
      "reports": null,
      "dashboards": null,
      "status": 2,
      "id": "5d034fc7-0cc8-46b7-beb3-35b22c57827c",
      "state": 0,
      "deleted": false,
      "inserted": true,
      "version": null,
      "created": null,
      "createdBy": null,
      "modified": null,
      "modifiedBy": null
   }
   ],
   "checked": false,
   "reports": null,
   "dashboards": null,
   "status": 2,
   "id": "93de93b9-d5d1-48f1-800d-1db1ffc02614",
   "state": 0,
   "deleted": false,
   "inserted": true,
   "version": null,
   "created": null,
   "createdBy": null,
   "modified": null,
   "modifiedBy": null
},
{
   "name": "TestCategory",
   "type": 1,
   "parentId": null,
   "tenantId": null,
   "canDelete": false,
   "editable": false,
   "savable": false,
   "subCategories": [],
   "checked": false,
   "reports": null,
   "dashboards": null,
   "status": 2,
   "id": "0ecf1821-dc37-43dd-8b4c-654961b37038",
   "state": 0,
   "deleted": false,
   "inserted": true,
   "version": null,
   "created": null,
   "createdBy": null,
   "modified": null,
   "modifiedBy": null
},
{
   "name": "Uncategorized",
   "type": 0,
   "parentId": null,
   "tenantId": null,
   "canDelete": false,
   "editable": false,
   "savable": false,
   "subCategories": [],
   "checked": false,
   "reports": null,
   "dashboards": null,
   "status": 1,
   "id": "00000000-0000-0000-0000-000000000000",
   "state": 0,
   "deleted": false,
   "inserted": true,
   "version": null,
   "created": null,
   "createdBy": null,
   "modified": null,
   "modifiedBy": null
}
]

POST role/availableCategory

Returns a list of available categories, with total number of items.

Request

Payload: a CategoryPagedRequest object

Response

A PagedResult object, with result field containing an array of Category objects.

Samples

POST api/role/availableCategory HTTP/1.1

Request payload:

{
   "type": 0,
   "tenantId": null,
   "skipItems": 0,
   "pageSize": -1,
   "parentIds": [],
   "defaultChecked": false,
   "isUncategorized": false
}
Sample response:
{
   "result": [
      {
         "name": "Global Categories",
         "type": 0,
         "parentId": null,
         "tenantId": null,
         "isGlobal": true,
         "canDelete": false,
         "editable": false,
         "savable": false,
         "subCategories": [
            {
               "name": "Uncategorized",
               "type": 0,
               "parentId": null,
               "tenantId": null,
               "isGlobal": true,
               "canDelete": false,
               "editable": false,
               "savable": false,
               "subCategories": [],
               "checked": false,
               "reports": null,
               "dashboards": null,
               "numOfChilds": 0,
               "numOfCheckedChilds": 0,
               "indeterminate": false,
               "fullPath": null,
               "computeNameSettings": null,
               "id": null,
               "state": 0,
               "deleted": false,
               "inserted": true,
               "version": null,
               "created": null,
               "createdBy": "John Doe",
               "modified": null,
               "modifiedBy": null
            }
         ],
         "checked": false,
         "reports": null,
         "dashboards": null,
         "numOfChilds": 1,
         "numOfCheckedChilds": 0,
         "indeterminate": false,
         "fullPath": null,
         "computeNameSettings": null,
         "id": "2a83e3ce-f91b-4f14-910d-76cadf42d0fe",
         "state": 0,
         "deleted": false,
         "inserted": true,
         "version": null,
         "created": null,
         "createdBy": "John Doe",
         "modified": null,
         "modifiedBy": null
      },
      {
         "name": "Local Categories",
         "type": 0,
         "parentId": null,
         "tenantId": null,
         "isGlobal": false,
         "canDelete": false,
         "editable": false,
         "savable": false,
         "subCategories": [
            {
               "name": "A",
               "type": 1,
               "parentId": null,
               "tenantId": null,
               "isGlobal": false,
               "canDelete": false,
               "editable": false,
               "savable": false,
               "subCategories": [],
               "checked": false,
               "reports": null,
               "dashboards": null,
               "numOfChilds": 0,
               "numOfCheckedChilds": 0,
               "indeterminate": false,
               "fullPath": null,
               "computeNameSettings": null,
               "id": "680af264-a2a1-43da-9ab5-7bfaf2a42025",
               "state": 0,
               "deleted": false,
               "inserted": true,
               "version": null,
               "created": null,
               "createdBy": "John Doe",
               "modified": null,
               "modifiedBy": null
            },
            {
               "name": "Uncategorized",
               "type": 0,
               "parentId": null,
               "tenantId": null,
               "isGlobal": false,
               "canDelete": false,
               "editable": false,
               "savable": false,
               "subCategories": [],
               "checked": false,
               "reports": null,
               "dashboards": null,
               "numOfChilds": 0,
               "numOfCheckedChilds": 0,
               "indeterminate": false,
               "fullPath": null,
               "computeNameSettings": null,
               "id": null,
               "state": 0,
               "deleted": false,
               "inserted": true,
               "version": null,
               "created": null,
               "createdBy": "John Doe",
               "modified": null,
               "modifiedBy": null
            }
         ],
         "checked": false,
         "reports": null,
         "dashboards": null,
         "numOfChilds": 2,
         "numOfCheckedChilds": 0,
         "indeterminate": false,
         "fullPath": null,
         "computeNameSettings": null,
         "id": "09f8c4ab-0fe8-4e03-82d1-7949e3738f87",
         "state": 0,
         "deleted": false,
         "inserted": true,
         "version": null,
         "created": null,
         "createdBy": "John Doe",
         "modified": null,
         "modifiedBy": null
      }
   ],
   "pageIndex": 0,
   "pageSize": 0,
   "total": 8,
   "skipItems": 0,
   "isLastPage": true
}

POST role

Saves a role.

Request

Payload: a RoleDetail object

Response

Field Description Note
success
boolean
Should be true  
role
object
The saved RoleDetail object  

Note

The user password is not required in this API.

Samples

POST api/role HTTP/1.1
Request payload to add new role with permission and visible data sources:
{
   "users":[

   ],
   "permission":{
      "schedulingLimitsTree":[
         {
            "id":"c9952522-370e-4138-9185-2061b3fd5639",
            "name":"Administrator",
            "checked":true,
            "indeterminate":false,
            "numOfCheckedChilds":0,
            "isVirtual":true,
            "childNodes":[]
         },
         {
            "id":"0805d023-2801-463f-a93f-0f19245fc4f6",
            "name":"Manager",
            "checked":true,
            "indeterminate":false,
            "numOfCheckedChilds":0,
            "isVirtual":true,
            "childNodes":[]
         }
      ],
      "accessLimitsTree":[
         {
            "id":"0805d023-2801-463f-a93f-0f19245fc4f6",
            "name":"Manager",
            "checked":true,
            "indeterminate":false,
            "numOfCheckedChilds":0,
            "isVirtual":true,
            "childNodes":[]
         },
         {
            "id":"c9952522-370e-4138-9185-2061b3fd5639",
            "name":"Administrator",
            "checked":true,
            "indeterminate":false,
            "numOfCheckedChilds":0,
            "isVirtual":true,
            "childNodes":[]
         }
      ],
      "isClickedSection":false,
      "propsCloned":{
         "fullReportAndDashboardAccess":false,
         "systemConfiguration":{
            "scheduledInstances":{
               "value":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "tenantSetup":{
            "actions":{
               "create":false,
               "edit":false,
               "del":false,
               "tenantAccess":0
            },
            "permissions":{
               "value":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "dataSetup":{
            "dataModel":{
               "value":false,
               "tenantAccess":0,
               "customView":{
                  "create":false,
                  "edit":false,
                  "delete":false,
                  "tenantAccess":0
               }
            },
            "advancedSettings":{
               "category":false,
               "others":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "userSetup":{
            "userRoleAssociation":{
               "value":false,
               "tenantAccess":0
            },
            "actions":{
               "create":false,
               "edit":false,
               "del":false,
               "configureSecurityOptions":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "roleSetup":{
            "actions":{
               "create":false,
               "edit":false,
               "del":false,
               "tenantAccess":0
            },
            "dataModelAccess":{
               "value":false,
               "tenantAccess":0
            },
            "permissions":{
               "value":false,
               "tenantAccess":0
            },
            "grantRoleWithFullReportAndDashboardAccess":{
               "value":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "reports":{
            "canCreateNewReport":{
               "value":false,
               "tenantAccess":0
            },
            "dataSources":{
               "simpleDataSources":false,
               "advancedDataSources":false,
               "tenantAccess":0
            },
            "reportPartTypes":{
               "chart":false,
               "form":false,
               "gauge":false,
               "map":false,
               "tenantAccess":0
            },
            "reportCategoriesSubcategories":{
               "canCreateNewCategory":{
                  "value":false,
                  "tenantAccess":0
               },
               "categoryAccessibility":{
                  "categories":{
                     "value":[]
                  },
                  "tenantAccess":0
               }
            },
            "filterProperties":{
               "filterLogic":false,
               "crossFiltering":false,
               "tenantAccess":0
            },
            "fieldProperties":{
               "customURL":false,
               "embeddedJavaScript":false,
               "subreport":false,
               "tenantAccess":0
            },
            "actions":{
               "schedule":false,
               "email":false,
               "viewReportHistory":false,
               "del":false,
               "registerForAlerts":false,
               "print":false,
               "unarchiveReportVersions":false,
               "overwriteExistingReport":false,
               "subscribe":false,
               "exporting":false,
               "configureAccessRights":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "dashboards":{
            "canCreateNewDashboard":{
               "value":false,
               "tenantAccess":0
            },
            "dashboardCategoriesSubcategories":{
               "canCreateNewCategory":{
                  "value":false,
                  "tenantAccess":0
               },
               "categoryAccessibility":{
                  "categories":{
                     "value":[]
                  },
                  "tenantAccess":0
               }
            },
            "actions":{
               "schedule":false,
               "email":false,
               "del":false,
               "subscribe":false,
               "print":false,
               "overwriteExistingDashboard":false,
               "configureAccessRights":false,
               "exporting":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "access":{
            "accessLimits":{
               "value":{
                  "value":[]
               },
               "tenantAccess":0
            },
            "accessDefaults":{
               "value":{
                  "value":[]
               },
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "scheduling":{
            "schedulingLimits":{
               "value":{
                  "value":[]
               },
               "tenantAccess":0
            },
            "schedulingScope":{
               "systemUsers":false,
               "externalUsers":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "emailing":{
            "deliveryMethod":{
               "link":false,
               "embeddedHTML":false,
               "attachment":false,
               "tenantAccess":0
            },
            "attachmentType":{
               "word":false,
               "excel":false,
               "pdf":false,
               "csv":false,
               "xml":false,
               "json":false,
               "definition":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "exporting":{
            "exportingFormat":{
               "word":false,
               "excel":false,
               "pdf":false,
               "csv":false,
               "xml":false,
               "json":false,
               "queryExecution":false,
               "definition":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "systemwide":{
            "canSeeSystemMessages":{
               "value":false,
               "tenantAccess":0
            },
            "tenantAccess":0
         },
         "section":null,
         "isTenantSetup":false
      },
      "isDirty":true,
      "fullReportAndDashboardAccess":false,
      "systemConfiguration":{
         "scheduledInstances":{
            "value":false,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "tenantSetup":{
         "actions":{
            "create":false,
            "edit":false,
            "del":false,
            "tenantAccess":0
         },
         "permissions":{
            "value":false,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "dataSetup":{
         "dataModel":{
            "value":false,
            "tenantAccess":0,
            "customView":{
               "create":false,
               "edit":false,
               "delete":false,
               "tenantAccess":0
            }
         },
         "advancedSettings":{
            "category":false,
            "others":false,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "userSetup":{
         "userRoleAssociation":{
            "value":false,
            "tenantAccess":0
         },
         "actions":{
            "create":false,
            "edit":false,
            "del":false,
            "configureSecurityOptions":false,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "roleSetup":{
         "actions":{
            "create":false,
            "edit":false,
            "del":false,
            "tenantAccess":0
         },
         "dataModelAccess":{
            "value":false,
            "tenantAccess":0
         },
         "permissions":{
            "value":false,
            "tenantAccess":0
         },
         "grantRoleWithFullReportAndDashboardAccess":{
            "value":false,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "reports":{
         "canCreateNewReport":{
            "value":true,
            "tenantAccess":0
         },
         "dataSources":{
            "simpleDataSources":false,
            "advancedDataSources":false,
            "tenantAccess":0
         },
         "reportPartTypes":{
            "chart":true,
            "form":true,
            "gauge":true,
            "map":true,
            "tenantAccess":0
         },
         "reportCategoriesSubcategories":{
            "canCreateNewCategory":{
               "value":true,
               "tenantAccess":0
            },
            "categoryAccessibility":{
               "categories":[],
               "tenantAccess":0
            }
         },
         "filterProperties":{
            "filterLogic":true,
            "crossFiltering":true,
            "tenantAccess":0
         },
         "fieldProperties":{
            "customURL":true,
            "embeddedJavaScript":true,
            "subreport":true,
            "tenantAccess":0
         },
         "actions":{
            "schedule":true,
            "email":true,
            "viewReportHistory":true,
            "del":true,
            "registerForAlerts":true,
            "print":true,
            "unarchiveReportVersions":true,
            "overwriteExistingReport":true,
            "subscribe":true,
            "exporting":true,
            "configureAccessRights":true,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "dashboards":{
         "canCreateNewDashboard":{
            "value":true,
            "tenantAccess":0
         },
         "dashboardCategoriesSubcategories":{
            "canCreateNewCategory":{
               "value":true,
               "tenantAccess":0
            },
            "categoryAccessibility":{
               "categories":[],
               "tenantAccess":0
            }
         },
         "actions":{
            "schedule":true,
            "email":true,
            "del":true,
            "subscribe":true,
            "print":true,
            "overwriteExistingDashboard":true,
            "configureAccessRights":true,
            "exporting":true,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "access":{
         "accessLimits":{
            "value":[],
            "tenantAccess":0
         },
         "accessDefaults":{
            "value":[],
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "scheduling":{
         "schedulingLimits":{
            "value":[],
            "tenantAccess":0
         },
         "schedulingScope":{
            "systemUsers":false,
            "externalUsers":false,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "emailing":{
         "deliveryMethod":{
            "link":true,
            "embeddedHTML":true,
            "attachment":true,
            "tenantAccess":0
         },
         "attachmentType":{
            "word":true,
            "excel":true,
            "pdf":true,
            "csv":true,
            "xml":true,
            "json":true,
            "definition":true,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "exporting":{
         "exportingFormat":{
            "word":true,
            "excel":true,
            "pdf":true,
            "csv":true,
            "xml":true,
            "json":true,
            "queryExecution":true,
            "definition":true,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "systemwide":{
         "canSeeSystemMessages":{
            "value":false,
            "tenantAccess":0
         },
         "tenantAccess":0
      },
      "section":"systemConfiguration",
      "isTenantSetup":false
   },
   "name":"Employee",
   "tenantId":null,
   "active":true,
   "isDirty":true,
   "visibleQuerySourcesTree":[
      {
         "id":"8c148f1f-97a3-4f85-bdaf-e6e38c2e1962",
         "name":"[REDSH] Northwind",
         "checked":false,
         "interacted":false,
         "indeterminate":false,
         "numOfCheckedChilds":0,
         "childNodes":[
            {
               "id":"83371234-4fa1-48d1-855d-efb8434c6b2e",
               "name":"public",
               "checked":false,
               "interacted":false,
               "indeterminate":false,
               "numOfCheckedChilds":0,
               "childNodes":[
                  {
                     "id":"d258df08-cade-42c7-8461-41fdfc963fd8",
                     "name":"Table",
                     "checked":false,
                     "interacted":false,
                     "indeterminate":false,
                     "numOfCheckedChilds":0,
                     "childNodes":[
                        {
                           "id":"0e901d90-c66d-498b-b9e8-c9752853fb7c",
                           "name":"customers",
                           "checked":false,
                           "interacted":true,
                           "indeterminate":false,
                           "numOfCheckedChilds":0,
                           "childNodes":[]
                        }
                     ]
                  }
               ]
            }
         ]
      }
   ],
   "showCheckedQuerySource":false
}
Request payload to add an existing user to role:
{
  "users": [
    {
      "id": "493ec9c6-9cb1-4a02-a4bc-505f684b3b4d",
      "userName": "jdoe",
      "emailAddress": "jdoe@acme.com",
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "state": 0,
      "checkedAvailable": false,
      "checkedAssigned": false,
      "showInAvailable": false,
      "showInAssigned": true
    }
  ],
  "permission": {
    "fullReportAndDashboardAccess": false,
    "systemConfiguration": {
      "scheduledInstances": {
        "value": true,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "tenantSetup": {
      "actions": {
        "create": true,
        "edit": true,
        "del": true,
        "tenantAccess": 0
      },
      "permissions": {
        "value": true,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "dataSetup": {
      "dataModel": {
        "value": true,
        "tenantAccess": 0
      },
      "advancedSettings": {
        "category": true,
        "others": true,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "userSetup": {
      "userRoleAssociation": {
        "value": true,
        "tenantAccess": 0
      },
      "actions": {
        "create": true,
        "edit": true,
        "del": true,
        "configureSecurityOptions": true,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "roleSetup": {
      "actions": {
        "create": true,
        "edit": true,
        "del": false,
        "tenantAccess": 0
      },
      "dataModelAccess": {
        "value": true,
        "tenantAccess": 0
      },
      "permissions": {
        "value": true,
        "tenantAccess": 0
      },
      "grantRoleWithFullReportAndDashboardAccess": {
        "value": true,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "reports": {
      "canCreateNewReport": {
        "value": true,
        "tenantAccess": 0
      },
      "dataSources": {
        "simpleDataSources": true,
        "advancedDataSources": false,
        "tenantAccess": 0
      },
      "reportPartTypes": {
        "chart": true,
        "form": true,
        "gauge": true,
        "map": true,
        "tenantAccess": 0
      },
      "reportCategoriesSubcategories": {
        "canCreateNewCategory": {
          "value": false,
          "tenantAccess": 0
        },
        "categoryAccessibility": {
          "categories": [
            {
              "name": "Category 1",
              "type": 0,
              "parentId": null,
              "tenantId": null,
              "canDelete": false,
              "editable": false,
              "savable": true,
              "subCategories": [],
              "id": "81411428-0aad-4a6b-b292-a26f75b83938",
              "state": 0,
              "deleted": false,
              "inserted": true,
              "version": null,
              "created": null,
              "createdBy": "493ec9c6-9cb1-4a02-a4bc-505f684b3b4d",
              "modified": null,
              "modifiedBy": null
            }
          ],
          "tenantAccess": 0
        }
      },
      "filterProperties": {
        "filterLogic": true,
        "tenantAccess": 0
      },
      "fieldProperties": {
        "customURL": true,
        "embeddedJavaScript": true,
        "subreport": true,
        "tenantAccess": 0
      },
      "actions": {
        "schedule": true,
        "email": true,
        "viewReportHistory": true,
        "del": true,
        "registerForAlerts": true,
        "print": true,
        "unarchiveReportVersions": true,
        "overwriteExistingReport": true,
        "subscribe": true,
        "exporting": true,
        "configureAccessRights": true,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "dashboards": {
      "canCreateNewDashboard": {
        "value": true,
        "tenantAccess": 0
      },
      "dashboardCategoriesSubcategories": {
        "canCreateNewCategory": {
          "value": true,
          "tenantAccess": 0
        },
        "categoryAccessibility": {
          "categories": [],
          "tenantAccess": 0
        }
      },
      "actions": {
        "schedule": true,
        "email": true,
        "del": true,
        "subscribe": true,
        "print": true,
        "overwriteExistingDashboard": true,
        "configureAccessRights": true,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "access": {
      "accessLimits": {
        "value": [],
        "tenantAccess": 0
      },
      "accessDefaults": {
        "value": [],
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "scheduling": {
      "schedulingLimits": {
        "value": [],
        "tenantAccess": 0
      },
      "schedulingScope": {
        "systemUsers": false,
        "externalUsers": false,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "emailing": {
      "deliveryMethod": {
        "link": true,
        "embeddedHTML": true,
        "attachment": true,
        "tenantAccess": 0
      },
      "attachmentType": {
        "word": true,
        "excel": true,
        "pdf": true,
        "csv": true,
        "xml": true,
        "json": true,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "exporting": {
      "exportingFormat": {
        "word": true,
        "excel": true,
        "pdf": true,
        "csv": true,
        "xml": true,
        "json": true,
        "queryExecution": true,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    },
    "systemwide": {
      "canSeeSystemMessages": {
        "value": false,
        "tenantAccess": 0
      },
      "tenantAccess": 0
    }
  },
  "visibleQuerySources": [],
  "name": "role 1",
  "tenantId": null,
  "active": true,
  "deleted": false,
  "state": 0,
  "inserted": true,
  "version": 6,
  "created": "2016-11-05T10:08:12.513",
  "createdBy": "0fa44ace-abd7-4a8d-928e-c84ec2999dfe",
  "modified": "2016-11-15T09:09:55.18",
  "modifiedBy": "0fa44ace-abd7-4a8d-928e-c84ec2999dfe",
  "id": "7a119576-de72-4268-9685-f0676aeb428a"
}

GET role/summaries/(tenant_id)

Returns an array of roles filtered by tenant_id.

Request

No payload

Response

An array of RoleDetail objects

Samples

GET api/role/summaries HTTP/1.1

Sample response:

[{
     "users" : [],
     "permission" : null,
     "visibleQuerySourceFields" : null,
     "name" : "Anonymous",
     "tenantId" : null,
     "active" : false,
     "deleted" : false,
     "id" : "0d030b1a-9568-4c98-8b1e-5dcc94dbd285",
     "state" : 0,
     "inserted" : true,
     "version" : 1,
     "created" : null,
     "createdBy" : null,
     "modified" : null,
     "modifiedBy" : null
  }, {
     "users" : [],
     "permission" : null,
     "visibleQuerySourceFields" : null,
     "name" : "Reviewer",
     "tenantId" : null,
     "active" : false,
     "deleted" : false,
     "id" : "0d030b1a-9568-4c98-8b1e-5dcc94dbd282",
     "state" : 0,
     "inserted" : true,
     "version" : 1,
     "created" : null,
     "createdBy" : null,
     "modified" : null,
     "modifiedBy" : null
  }, {
     "users" : [],
     "permission" : null,
     "visibleQuerySourceFields" : null,
     "name" : "Designer",
     "tenantId" : null,
     "active" : false,
     "deleted" : false,
     "id" : "0d030b1a-9568-4c98-8b1e-5dcc94dbd283",
     "state" : 0,
     "inserted" : true,
     "version" : 1,
     "created" : null,
     "createdBy" : null,
     "modified" : null,
     "modifiedBy" : null
  }
]

POST role/allowedSharingRoles

Returns a list of roles allowed to be selected in report/dashboard access.

Request

Payload: a SharingRoleUserParameter object

Response

An array of RoleDetail objects

Samples

POST api/role/allowedSharingRoles HTTP/1.1

Request payload:

{
  "reportId": "63d50ed1-5323-47a1-bc11-3a03a070ec34",
  "tenantId": null
}
Sample response:
[
{
   "users": [
      {
      "password": null,
      "roles": [],
      "userRoles": null,
      "userSecurityQuestions": null,
      "status": 1,
      "issueDate": "0001-01-01T00:00:00",
      "autoLogin": false,
      "newPassword": null,
      "userName": "admintest",
      "emailAddress": null,
      "firstName": "admin",
      "lastName": "test",
      "tenantId": null,
      "tenantDisplayId": null,
      "tenantName": null,
      "dataOffset": 0,
      "timestampOffset": 0,
      "initPassword": true,
      "active": true,
      "retryLoginTime": 0,
      "lastTimeAccessed": "2016-12-19T10:00:38.54",
      "passwordLastChanged": "2016-11-04T09:54:22.417",
      "locked": false,
      "lockedDate": null,
      "cultureName": "en-US",
      "securityQuestionLastChanged": "2016-11-04T09:54:22.417",
      "dateFormat": "MM/DD/YYYY",
      "systemAdmin": true,
      "notAllowSharing": false,
      "numberOfFailedSecurityQuestion": 0,
      "fullName": "admin test",
      "currentModules": null,
      "id": "65a2e205-bbe3-4e75-8766-28aeaaf44f5d",
      "state": 0,
      "deleted": false,
      "inserted": true,
      "version": 2,
      "created": "2016-11-04T09:53:58.613",
      "createdBy": "9d2f1d51-0e3d-44db-bfc7-da94a7581bfe",
      "modified": "2016-12-19T10:00:38.54",
      "modifiedBy": "9d2f1d51-0e3d-44db-bfc7-da94a7581bfe"
      }
   ],
   "tenantUniqueName": null,
   "permission": null,
   "visibleQuerySources": null,
   "name": "new system role",
   "tenantId": null,
   "active": true,
   "notAllowSharing": false,
   "id": "1bbc0a0a-fb1b-444c-a355-63b32ef7aabb",
   "state": 0,
   "deleted": false,
   "inserted": true,
   "version": 9,
   "created": "2016-11-05T09:57:06.393",
   "createdBy": "0fa44ace-abd7-4a8d-928e-c84ec2999dfe",
   "modified": "2016-11-12T10:19:14.797",
   "modifiedBy": "0fa44ace-abd7-4a8d-928e-c84ec2999dfe"
},
{
   "users": [],
   "tenantUniqueName": null,
   "permission": null,
   "visibleQuerySources": null,
   "name": "No Permission Role",
   "tenantId": null,
   "active": true,
   "notAllowSharing": false,
   "id": "7faab1a0-8ca3-4dc2-af86-19e5396b76a9",
   "state": 0,
   "deleted": false,
   "inserted": true,
   "version": 1,
   "created": "2016-11-28T06:54:29.493",
   "createdBy": "9feea667-0bef-4dc7-bf6c-d7259f334fde",
   "modified": "2016-11-28T06:54:29.493",
   "modifiedBy": "9feea667-0bef-4dc7-bf6c-d7259f334fde"
},
{
   "users": [],
   "tenantUniqueName": null,
   "permission": null,
   "visibleQuerySources": null,
   "name": "role 1",
   "tenantId": null,
   "active": true,
   "notAllowSharing": false,
   "id": "7a119576-de72-4268-9685-f0676aeb428a",
   "state": 0,
   "deleted": false,
   "inserted": true,
   "version": 7,
   "created": "2016-11-05T10:08:12.513",
   "createdBy": "0fa44ace-abd7-4a8d-928e-c84ec2999dfe",
   "modified": "2016-12-14T08:51:37.32",
   "modifiedBy": "0fa44ace-abd7-4a8d-928e-c84ec2999dfe"
}
]

POST role/intergration/saveRole

Adds or updates an external role.

Request

Payload: a RoleDetail object

Response

  • true if the call is successful
  • false if not

Samples

POST api/role/intergration/saveRole HTTP/1.1
Request payload:
{
   "isDirty": true,
   "users": [],
   "permission": {
      "isClickedSection": false,
      "propsCloned": {
         "fullReportAndDashboardAccess": false,
         "systemConfiguration": {
            "scheduledInstances": {
               "value": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "tenantSetup": {
            "actions": {
               "create": false,
               "edit": false,
               "del": false,
               "tenantAccess": 0
            },
            "permissions": {
               "value": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "dataSetup": {
            "dataModel": {
               "value": false,
               "tenantAccess": 0,
               "customView": {
                  "create": false,
                  "edit": false,
                  "delete": false,
                  "tenantAccess": 0
               }
            },
            "advancedSettings": {
               "category": false,
               "others": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "userSetup": {
            "userRoleAssociation": {
               "value": false,
               "tenantAccess": 0
            },
            "actions": {
               "create": false,
               "edit": false,
               "del": false,
               "configureSecurityOptions": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "roleSetup": {
            "actions": {
               "create": false,
               "edit": false,
               "del": false,
               "tenantAccess": 0
            },
            "dataModelAccess": {
               "value": false,
               "tenantAccess": 0
            },
            "permissions": {
               "value": false,
               "tenantAccess": 0
            },
            "grantRoleWithFullReportAndDashboardAccess": {
               "value": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "reports": {
            "canCreateNewReport": {
               "value": false,
               "tenantAccess": 0
            },
            "dataSources": {
               "simpleDataSources": false,
               "advancedDataSources": false,
               "tenantAccess": 0
            },
            "reportPartTypes": {
               "chart": false,
               "form": false,
               "gauge": false,
               "map": false,
               "tenantAccess": 0
            },
            "reportCategoriesSubcategories": {
               "canCreateNewCategory": {
                  "value": false,
                  "tenantAccess": 0
               },
               "categoryAccessibility": {
                  "categories": [],
                  "tenantAccess": 0
               }
            },
            "filterProperties": {
               "filterLogic": false,
               "crossFiltering": false,
               "tenantAccess": 0
            },
            "fieldProperties": {
               "customURL": false,
               "embeddedJavaScript": false,
               "subreport": false,
               "tenantAccess": 0
            },
            "actions": {
               "schedule": false,
               "email": false,
               "viewReportHistory": false,
               "del": false,
               "registerForAlerts": false,
               "print": false,
               "unarchiveReportVersions": false,
               "overwriteExistingReport": false,
               "subscribe": false,
               "exporting": false,
               "configureAccessRights": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "dashboards": {
            "canCreateNewDashboard": {
               "value": false,
               "tenantAccess": 0
            },
            "dashboardCategoriesSubcategories": {
               "canCreateNewCategory": {
                  "value": false,
                  "tenantAccess": 0
               },
               "categoryAccessibility": {
                  "categories": [],
                  "tenantAccess": 0
               }
            },
            "actions": {
               "schedule": false,
               "email": false,
               "del": false,
               "subscribe": false,
               "print": false,
               "overwriteExistingDashboard": false,
               "configureAccessRights": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "access": {
            "accessLimits": {
               "value": [],
               "tenantAccess": 0
            },
            "accessDefaults": {
               "value": [],
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "scheduling": {
            "schedulingLimits": {
               "value": [],
               "tenantAccess": 0
            },
            "schedulingScope": {
               "systemUsers": false,
               "externalUsers": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "emailing": {
            "deliveryMethod": {
               "link": false,
               "embeddedHTML": false,
               "attachment": false,
               "tenantAccess": 0
            },
            "attachmentType": {
               "word": false,
               "excel": false,
               "pdf": false,
               "csv": false,
               "xml": false,
               "json": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "exporting": {
            "exportingFormat": {
               "word": false,
               "excel": false,
               "pdf": false,
               "csv": false,
               "xml": false,
               "json": false,
               "queryExecution": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "systemwide": {
            "canSeeSystemMessages": {
               "value": false,
               "tenantAccess": 0
            },
            "tenantAccess": 0
         },
         "section": null,
         "isTenantSetup": false
      },
      "isDirty": true,
      "fullReportAndDashboardAccess": false,
      "systemConfiguration": {
         "scheduledInstances": {
            "value": false,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "tenantSetup": {
         "actions": {
            "create": false,
            "edit": false,
            "del": false,
            "tenantAccess": 0
         },
         "permissions": {
            "value": false,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "dataSetup": {
         "dataModel": {
            "value": false,
            "tenantAccess": 0,
            "customView": {
               "create": false,
               "edit": false,
               "delete": false,
               "tenantAccess": 0
            }
         },
         "advancedSettings": {
            "category": false,
            "others": false,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "userSetup": {
         "userRoleAssociation": {
            "value": false,
            "tenantAccess": 0
         },
         "actions": {
            "create": false,
            "edit": false,
            "del": false,
            "configureSecurityOptions": false,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "roleSetup": {
         "actions": {
            "create": false,
            "edit": false,
            "del": false,
            "tenantAccess": 0
         },
         "dataModelAccess": {
            "value": false,
            "tenantAccess": 0
         },
         "permissions": {
            "value": false,
            "tenantAccess": 0
         },
         "grantRoleWithFullReportAndDashboardAccess": {
            "value": false,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "reports": {
         "canCreateNewReport": {
            "value": true,
            "tenantAccess": 0
         },
         "dataSources": {
            "simpleDataSources": false,
            "advancedDataSources": false,
            "tenantAccess": 0
         },
         "reportPartTypes": {
            "chart": true,
            "form": true,
            "gauge": true,
            "map": true,
            "tenantAccess": 0
         },
         "reportCategoriesSubcategories": {
            "canCreateNewCategory": {
               "value": true,
               "tenantAccess": 0
            },
            "categoryAccessibility": {
               "categories": [],
               "tenantAccess": 0
            }
         },
         "filterProperties": {
            "filterLogic": true,
            "crossFiltering": true,
            "tenantAccess": 0
         },
         "fieldProperties": {
            "customURL": true,
            "embeddedJavaScript": true,
            "subreport": true,
            "tenantAccess": 0
         },
         "actions": {
            "schedule": true,
            "email": true,
            "viewReportHistory": true,
            "del": true,
            "registerForAlerts": true,
            "print": true,
            "unarchiveReportVersions": true,
            "overwriteExistingReport": true,
            "subscribe": true,
            "exporting": true,
            "configureAccessRights": true,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "dashboards": {
         "canCreateNewDashboard": {
            "value": false,
            "tenantAccess": 0
         },
         "dashboardCategoriesSubcategories": {
            "canCreateNewCategory": {
               "value": false,
               "tenantAccess": 0
            },
            "categoryAccessibility": {
               "categories": [],
               "tenantAccess": 0
            }
         },
         "actions": {
            "schedule": false,
            "email": false,
            "del": false,
            "subscribe": false,
            "print": false,
            "overwriteExistingDashboard": false,
            "configureAccessRights": false,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "access": {
         "accessLimits": {
            "value": [],
            "tenantAccess": 0
         },
         "accessDefaults": {
            "value": [],
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "scheduling": {
         "schedulingLimits": {
            "value": [],
            "tenantAccess": 0
         },
         "schedulingScope": {
            "systemUsers": false,
            "externalUsers": false,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "emailing": {
         "deliveryMethod": {
            "link": false,
            "embeddedHTML": false,
            "attachment": false,
            "tenantAccess": 0
         },
         "attachmentType": {
            "word": false,
            "excel": false,
            "pdf": false,
            "csv": false,
            "xml": false,
            "json": false,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "exporting": {
         "exportingFormat": {
            "word": false,
            "excel": false,
            "pdf": false,
            "csv": false,
            "xml": false,
            "json": false,
            "queryExecution": false,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "systemwide": {
         "canSeeSystemMessages": {
            "value": false,
            "tenantAccess": 0
         },
         "tenantAccess": 0
      },
      "section": "systemConfiguration",
      "isTenantSetup": false
   },
   "visibleQuerySources": [],
   "name": "test",
   "tenantId": null,
   "active": true,
   "deleted": false,
   "state": 0,
   "inserted": false,
   "version": 0,
   "created": null,
   "createdBy": null,
   "modified": null,
   "modifiedBy": null
}

Response:

true

POST role/accessLimits

Lazy load access Limit data for each role.

Request

Response

A RoleVirtualNode objects

Samples

POST api/role/accessLimits HTTP/1.1

Request payload:

{
   "roleId": "db8693f7-3d5a-41d7-a888-8a1dfaad31b4",
   "tenantId": null,
   "skipItems": 0,
   "pageSize": 6,
   "parentIds": [],
   "criteria": [ { "key": "name", "value": "Anna" }]
}

Sample response:

{
   "isLastPage":true,
   "name":null,
   "childNodes":[
      {
         "isLastPage":true,
         "name":"Anna",
         "childNodes":[
            {
               "isLastPage":true,
               "name":"Anna Doe",
               "childNodes":[

               ],
               "numOfChilds":0,
               "checked":true,
               "indeterminate":false,
               "numOfCheckedChilds":0,
               "totalItems":1,
               "id":"c3085881-b972-42bb-9dcc-0a052aee38f9",
               "parentId":"101991da-d576-488b-a0aa-4df03512fbbb"
            }
         ],
         "numOfChilds":1,
         "checked":true,
         "indeterminate":false,
         "numOfCheckedChilds":1,
         "totalItems":2,
         "id":"db8693f7-3d5a-41d7-a888-8a1dfaad31b4",
         "parentId":"00000000-0000-0000-0000-000000000000"
      }
   ],
   "numOfChilds":1,
   "checked":true,
   "indeterminate":false,
   "numOfCheckedChilds":1,
   "totalItems":3,
   "id":"00000000-0000-0000-0000-000000000000",
   "parentId":null
}

POST role/scheduleLimits

Lazy load schedule limit data for each role.

Request

Response

A RoleVirtualNode objects

Samples

POST api/role/scheduleLimits HTTP/1.1

Request payload:

{
   "roleId": "db8693f7-3d5a-41d7-a888-8a1dfaad31b4",
   "tenantId": null,
   "skipItems": 0,
   "pageSize": 6,
   "parentIds": [],
   "criteria": [ { "key": "name", "value": "Anna" }]
}

Sample response:

{
   "isLastPage":true,
   "name":null,
   "childNodes":[
      {
         "isLastPage":true,
         "name":"Anna",
         "childNodes":[
            {
               "isLastPage":true,
               "name":"Anna Doe",
               "childNodes":[

               ],
               "numOfChilds":0,
               "checked":true,
               "indeterminate":false,
               "numOfCheckedChilds":0,
               "totalItems":1,
               "id":"c3085881-b972-42bb-9dcc-0a052aee38f9",
               "parentId":"101991da-d576-488b-a0aa-4df03512fbbb"
            }
         ],
         "numOfChilds":1,
         "checked":true,
         "indeterminate":false,
         "numOfCheckedChilds":1,
         "totalItems":2,
         "id":"db8693f7-3d5a-41d7-a888-8a1dfaad31b4",
         "parentId":"00000000-0000-0000-0000-000000000000"
      }
   ],
   "numOfChilds":1,
   "checked":true,
   "indeterminate":false,
   "numOfCheckedChilds":1,
   "totalItems":3,
   "id":"00000000-0000-0000-0000-000000000000",
   "parentId":null
}

POST role/loadPartialDataModelAccess

New in version 2.9.0.

Load data model access partially.

Request

Response

The following object:

Field Description Note
data
array of objects
An array of DataSourceItem objects  
totalItems
string
The number of all items  
numOfChilds
integer
The number of children  
numOfCheckedChilds
integer
The number of selected children  
indeterminate
boolean
  • true if 0 < numOfCheckedChilds < numOfChilds
  • false if not
 
isLastPage
boolean
Whether this is the last page  

Samples

POST api/role/loadPartialDataModelAccess HTTP/1.1
Request Payload:
{
   "tenantId":"c39a4500-b902-4e5b-ae86-901c09b71516",
   "roleId":"101991da-d576-488b-a0aa-4df03512fbbb",
   "skipItems":0,
   "pageSize":100,
   "parentIds":[],
   "visibleQuerySourcesTree":[],
   "criteria":[
      {
         "key":"DataSourceName",
         "value":""
      },
      {
         "key":"ShowCheckedQuerySource",
         "value":false
      }
   ]
}
Sample response:
{
   "data":[
      {
         "id":"299efcb5-39f8-4629-95c4-a88b1ca0073f",
         "name":"[MSSQL] MSSQL-Northwind",
         "childNodes":[
            {
               "id":"839470f3-f992-4d5f-8dff-21dfb4e67faa",
               "name":"dbo",
               "childNodes":[
                  {
                     "id":"d258df08-cade-42c7-8461-41fdfc963fd8",
                     "name":"Table",
                     "childNodes":[
                        {
                           "id":"bd42be43-9b18-4545-a599-b87becf8fc9a",
                           "name":"Customers",
                           "childNodes":[
                              {
                                 "id":"36ee3aca-4a09-4f4a-8ff7-5b04db8d3809",
                                 "name":"CustomerID",
                                 "childNodes":[

                                 ],
                                 "parentId":"bd42be43-9b18-4545-a599-b87becf8fc9a",
                                 "checked":true,
                                 "isLeafItem":true,
                                 "expand":true,
                                 "interacted":false,
                                 "isCheck":true,
                                 "indeterminate":false,
                                 "fullPath":null,
                                 "numOfChilds":0,
                                 "numOfCheckedChilds":0,
                                 "isLastPage":false
                              },
                              {
                                 "id":"78b5efd0-6c45-4cc6-b36b-b65c446b672b",
                                 "name":"ContactName",
                                 "childNodes":[

                                 ],
                                 "parentId":"bd42be43-9b18-4545-a599-b87becf8fc9a",
                                 "checked":true,
                                 "isLeafItem":true,
                                 "expand":true,
                                 "interacted":false,
                                 "isCheck":true,
                                 "indeterminate":false,
                                 "fullPath":null,
                                 "numOfChilds":0,
                                 "numOfCheckedChilds":0,
                                 "isLastPage":false
                              },
                              {
                                 "id":"d1d84171-cb96-49d4-95fc-61e70668713b",
                                 "name":"ContactTitle",
                                 "childNodes":[

                                 ],
                                 "parentId":"bd42be43-9b18-4545-a599-b87becf8fc9a",
                                 "checked":true,
                                 "isLeafItem":true,
                                 "expand":true,
                                 "interacted":false,
                                 "isCheck":true,
                                 "indeterminate":false,
                                 "fullPath":null,
                                 "numOfChilds":0,
                                 "numOfCheckedChilds":0,
                                 "isLastPage":false
                              },
                              {
                                 "id":"9a17c194-2cae-4019-b406-aae8d76b9a30",
                                 "name":"Phone",
                                 "childNodes":[

                                 ],
                                 "parentId":"bd42be43-9b18-4545-a599-b87becf8fc9a",
                                 "checked":true,
                                 "isLeafItem":true,
                                 "expand":true,
                                 "interacted":false,
                                 "isCheck":true,
                                 "indeterminate":false,
                                 "fullPath":null,
                                 "numOfChilds":0,
                                 "numOfCheckedChilds":0,
                                 "isLastPage":false
                              }
                           ],
                           "parentId":"d258df08-cade-42c7-8461-41fdfc963fd8",
                           "checked":true,
                           "isLeafItem":false,
                           "expand":true,
                           "interacted":false,
                           "isCheck":true,
                           "indeterminate":false,
                           "fullPath":null,
                           "numOfChilds":4,
                           "numOfCheckedChilds":4,
                           "isLastPage":true
                        }
                  ],
                     "parentId":"839470f3-f992-4d5f-8dff-21dfb4e67faa",
                     "checked":true,
                     "isLeafItem":false,
                     "expand":true,
                     "interacted":false,
                     "isCheck":true,
                     "indeterminate":false,
                     "fullPath":null,
                     "numOfChilds":1,
                     "numOfCheckedChilds":1,
                     "isLastPage":false
                  }
               ],
               "parentId":"299efcb5-39f8-4629-95c4-a88b1ca0073f",
               "checked":false,
               "isLeafItem":false,
               "expand":true,
               "interacted":false,
               "isCheck":false,
               "indeterminate":true,
               "fullPath":null,
               "numOfChilds":1,
               "numOfCheckedChilds":1,
               "isLastPage":false
            }
         ],
         "parentId":"00000000-0000-0000-0000-000000000000",
         "checked":false,
         "isLeafItem":false,
         "expand":true,
         "interacted":false,
         "isCheck":false,
         "indeterminate":true,
         "fullPath":null,
         "numOfChilds":1,
         "numOfCheckedChilds":0,
         "isLastPage":false
      }
   ],
   "totalItems":8,
   "numOfChilds":1,
   "numOfCheckedChilds":0,
   "indeterminate":false,
   "isLastPage":true
}