ReportSetting

Field NULL Description Note
numOfArchivedVersionToKeepDefault
integer		   The default value for number of archived versions to keep Default value 5
enforceVersionHistory
boolean		   Whether to keep report version history  
numOfArchivedVersionToKeep
integer		   The number of archived versions to keep  
removeArchivedVersions
boolean		   Whether to remove achived versions  
isScheduled
boolean		   Whether to use the schedule to remove archived versions  
localCategoryName
string		   The local category name  
globalCategoryName
string		   The global category name  
recurrentReportSetting
object		   The Remove Archived Versions options  
once
boolean
   True to run one time, opposite of recurrence  
recurrence
boolean
   True to run multiple times, opposite of once  
startDate
datetime
 Y The start date  
startTime
datetime
 Y The start time  
recurrenceType
integer
  
  • 0 = Day 1 = Week 2 = Month 3 = Year
  
occurValue
integer
 Y The numer of times it has run  

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  
Sample:
 {
  "numOfArchivedVersionToKeepDefault": 5,
  "enforceVersionHistory": true,
  "numOfArchivedVersionToKeep": 5,
  "removeArchivedVersions": true,
  "recurrentReportSetting": {
    "once": false,
    "recurrence": true,
    "startDate": "2017-01-06T06:53:44.5249129",
    "startTime": "2017-01-06T06:53:44.5249129",
    "recurrenceType": 0,
    "occurValue": 0
  },
  "id": null,
  "state": 0,
  "deleted": false,
  "inserted": true,
  "version": null,
  "created": null,
  "createdBy": "John Doe",
  "modified": null,
  "modifiedBy": null
}