RoleDetail¶
| Field | NULL | Description | Note |
|---|---|---|---|
| users array of objects |
An array of UserDetail objects | ||
| tenantUniqueName string |
Used for integration only | ||
| permission object |
A Permission object | ||
| visibleQuerySources array of objects |
An array of QuerySource objects | ||
| showCheckedQuerySource boolean |
Whether to show checked query sources or not |
Inherited fields:
Role¶
| Field | NULL | Description | Note |
|---|---|---|---|
| name string |
The role name | ||
| tenantId string (GUID) |
Y | The id of the tenant | |
| active boolean |
Is the role active | ||
| notAllowSharing boolean |
Is the role not allowed for sharing |
Inherited fields:
Entity¶
| Field | NULL | Description | Note |
|---|---|---|---|
| id string (GUID) |
The id of this object Example: 572bd576-8c92-4901-ab2a-b16e38144813 |
Allow null incase insert a new entity | |
| state integer |
The entity state of this object
|
||
| deleted boolean |
Is this object deleted | ||
| inserted boolean |
Is this object inserted | ||
| version string |
Y | The version | |
| created datetime in ISO 8601 format |
Y | The created datetime | |
| createdBy string |
The creator | ||
| modified datetime in ISO 8601 format |
Y | The modification datetime | |
| modifiedBy string |
The user who last modified this object |
Sample:
{
"users": [],
"permission": null,
"visibleQuerySources": null,
"name": "Analyst",
"tenantId": null,
"active": true,
"deleted": false,
"id": "0d030b1a-9568-4c98-8b1e-5dcc94dbd281",
"state": 0,
"inserted": true,
"version": 1,
"created": null,
"createdBy": null,
"modified": null,
"modifiedBy": null
}