Category¶

Field	NULL	Description
name string		The name of the category
type string		The type of the category 0 = Report 1 = Template 2 = Dashboard 3 = Report/Template
parentId string (GUID)	Y	The id of the parent category
tenantId string (GUID)	Y	The id of the tenant
isGlobal boolean		Whether this is a global category
canDelete boolean		Can the category be deleted
editable boolean		Can the category be edited
savable boolean		Can the category be used to save reports or dashboards to
subCategories array of objects		An array of child Category objects
checked boolean		Is selected for copy in Copy Management
reports array of objects		An array of child Report objects
dashboards array of objects		An array of child Dashboard objects
numOfChilds integer		The number of children
numOfCheckedChilds integer		The number of selected children
indeterminate boolean		true if 0 < numOfCheckedChilds < numOfChilds false if not
status integer		The status 0 = Empty 1 = New 2 = Exist

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 0 = None 1 = Insert 2 = Delete 3 = Update
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

{
  "name": "Uncategorized",
  "type": 2,
  "parentId": null,
  "tenantId": null,
  "canDelete": false,
  "editable": false,
  "savable": false,
  "subCategories": [],
  "checked": false,
  "reports": null,
  "dashboards": null,
  "id": null,
  "state": 0,
  "deleted": false,
  "inserted": true,
  "version": null,
  "created": null,
  "createdBy": "John Doe",
  "modified": null,
  "modifiedBy": null
}