System Configuration APIs

System Configuration APIs allow user to:

  • view and edit report settings
  • view and edit security policies
  • search for schedule instances
  • view, edit and delete schedule instances

Summary

API Purpose Usage in Izenda Front-end
POST systemSetting/reportSetting Saves report setting. Settings > System Configuration > Report > Save
GET systemSetting/reportSetting Gets report setting. Settings > System Configuration > Report
GET systemSetting/securityPolicy Returns the security policies. Settings > System Configuration > Sercurity Policies
POST systemSetting/securityPolicy Updates the security policies. Settings > System Configuration > Sercurity Policies > Save
POST systemSetting/loadSchedules Searches for schedule instances. Settings > System Configuration > Scheduling > Search
GET systemSetting/schedules/reportDashboardName/{reportingType}/(tenant_id) Returns an array of possible report names (reportingType=1), dashboard names (reportingType=2), or both (reportingType=0) for schedule search screen. -Settings > System Configuration > Scheduling
-Settings > System Configuration > Scheduling > Choose Dashboard report type > Search
GET systemSetting/schedules/recipients/(tenant_id) Returns an array of possible recipients for schedule search screen. Settings > System Configuration > Scheduling
GET systemSetting/schedules/creators/(tenant_id) Returns an array of possible owners for schedule search screen. Settings > System Configuration > Scheduling
POST systemSetting/deleteSchedules Deletes schedules from an array of ids. Settings > System Configuration > Scheduling > Pick reports > Delete > OK
GET systemSetting/categorySetting Returns the global category and local category. Not used, replaced by GET systemSetting/reportSetting

GET systemSetting/themes

New in version 2.9.0.

Returns the available color themes for Chart, Gauge, and Map. System Configuration > Report > Default Color Theme for Chart, Gauge, and Map > geer icon
OR Report Designer > Design tab

POST systemSetting/reportSetting

Saves report setting.

Request

Payload: a ReportSetting object

Response

Field Description Note
success
boolean
Is the save successful  
reportSetting
object
The saved ReportSetting object  

Samples

POST /api/systemSetting/reportSetting HTTP/1.1

Request payload:

{
 "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
}

Sample Response:

{
   "success": true,
   "reportSetting": {
      "numOfArchivedVersionToKeepDefault": 5,
      "enforceVersionHistory": true,
      "numOfArchivedVersionToKeep": 5,
      "removeArchivedVersions": true,
      "isScheduled": false,
      "localCategoryName": "Local Categories",
      "globalCategoryName": "Global Categories",
      "recurrentReportSetting": {
         "once": false,
         "recurrence": true,
         "startDate": "2017-10-17T00:00:00",
         "startTime": "2017-06-16T17:00:00",
         "recurrenceType": 0,
         "occurValue": null
      },
      "id": "9af62d45-df46-4db3-83b6-b943da5f7a87",
      "state": 3,
      "deleted": false,
      "inserted": false,
      "version": null,
      "created": "2017-10-17T09:19:13.9683186",
      "createdBy": "System5 Admin5",
      "modified": "2017-10-17T09:19:13.9839496",
      "modifiedBy": "System5 Admin5"
   }
}

GET systemSetting/reportSetting

Gets report setting.

Request

No payload

Response

A ReportSetting object

Samples

GET /api/systemSetting/reportSetting HTTP/1.1

Sample response:

{
 "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
}

GET systemSetting/securityPolicy

Returns the security policies.

Request

No payload

Response

Samples

GET /api/systemSetting/securityPolicy HTTP/1.1

Sample response:

{
  "minNumberOfPasswordLenght" : null,
  "maxNumberOfPasswordLenght" : null,
  "minNumberOfSpecialCharacter" : null,
  "maxNumberOfSpecialCharacter" : null,
  "minNumberOfUppercaseCharacter" : null,
  "maxNumberOfUppercaseCharacter" : null,
  "minNumberOfLowercaseCharacter" : null,
  "maxNumberOfLowercaseCharacter" : null,
  "minNumberOfNumericCharacter" : null,
  "maxNumberOfNumericCharacter" : null,
  "maxNumberOfRepeatSequentialCharacter" : null,
  "minNumberOfPasswordAge" : null,
  "maxNumberOfPasswordAge" : null,
  "notifyUseDuring" : null,
  "numberOfPasswordToKeep" : null,
  "passwordLinkValidity" : 1,
  "numberOfSecurityQuestionProfile" : null,
  "numberOfSecurityQuestionToResetPassword" : null,
  "numberOfFailedLogonAttemptsAllowed" : null,
  "numberOfFailedSecurityQuestionAlllowed" : null,
  "tenantId" : null,
  "lockoutPeriod" : null,
  "id" : "95aa269c-0d8c-4f68-8155-06429774d0f0",
  "state" : 0,
  "inserted" : true,
  "version" : null,
  "created" : null,
  "createdBy" : null,
  "modified" : null,
  "modifiedBy" : null
}

POST systemSetting/securityPolicy

Updates the security policies.

Request

Payload: a SecurityPolicy object

Response

The updated SecurityPolicy object

Samples

POST /api/systemSetting/securityPolicy HTTP/1.1

Request payload:

{
   "id": "1700ffc4-597e-48c2-8220-f17167cb69d2",
   "state": 0,
   "inserted": true,
   "version": 2,
   "created": "2017-07-14T07:28:14.1500000+07:00",
   "createdBy": "System5 Admin5",
   "modified": "2017-09-28T07:03:57.6770000+07:00",
   "minNumberOfPasswordLenght": 4,
   "maxNumberOfPasswordLenght": 10,
   "minNumberOfSpecialCharacter": null,
   "maxNumberOfSpecialCharacter": null,
   "minNumberOfUppercaseCharacter": null,
   "maxNumberOfUppercaseCharacter": null,
   "minNumberOfLowercaseCharacter": null,
   "maxNumberOfLowercaseCharacter": null,
   "minNumberOfNumericCharacter": null,
   "maxNumberOfNumericCharacter": null,
   "maxNumberOfRepeatSequential": null,
   "minNumberOfPasswordAge": null,
   "maxNumberOfPasswordAge": null,
   "notifyUseDuring": null,
   "numberOfPasswordToKeep": null,
   "passwordLinkValidity": null,
   "numberOfQuestionProfile": null,
   "numberOfQuestionResetPassword": null,
   "numberOfFailedLogonAllowed": null,
   "numberOfFailedAnswerAllowed": null,
   "lockoutPeriod": null
}

Sample response:

{
   "minNumberOfPasswordLenght": 4,
   "maxNumberOfPasswordLenght": 10,
   "minNumberOfSpecialCharacter": null,
   "maxNumberOfSpecialCharacter": null,
   "minNumberOfUppercaseCharacter": null,
   "maxNumberOfUppercaseCharacter": null,
   "minNumberOfLowercaseCharacter": null,
   "maxNumberOfLowercaseCharacter": null,
   "minNumberOfNumericCharacter": null,
   "maxNumberOfNumericCharacter": null,
   "maxNumberOfRepeatSequential": null,
   "minNumberOfPasswordAge": null,
   "maxNumberOfPasswordAge": null,
   "notifyUseDuring": null,
   "numberOfPasswordToKeep": null,
   "passwordLinkValidity": null,
   "numberOfQuestionProfile": null,
   "numberOfQuestionResetPassword": null,
   "numberOfFailedLogonAllowed": null,
   "numberOfFailedAnswerAllowed": null,
   "tenantId": null,
   "lockoutPeriod": null,
   "id": "1700ffc4-597e-48c2-8220-f17167cb69d2",
   "state": 0,
   "deleted": false,
   "inserted": true,
   "version": 2,
   "created": "2017-07-14T07:28:14.1500000+07:00",
   "createdBy": "System5 Admin5",
   "modified": "2017-10-17T09:30:53.7169802Z",
   "modifiedBy": null
}

POST systemSetting/loadSchedules

Searches for schedule instances.

Request

Payload: a SystemSchedulingPagedRequest object

Note

The keys for SearchCriteria that this API support:
- All
- Name
- Schedule
- FilterValueSelection
- DeliveryType
- DeliveryMethod
- Recipients
- LastSuccessfulRun
- LastSuccessfulRunFrom
- LastSuccessfulRunTo
- NextScheduledRun
- NextScheduledRunFrom
- NextScheduledRunTo
- Keyword
- ReportingType
- ReportDashboardName
- Type
- RecurrenceType
- ExportFileType
- CreatedBy

Response

A PagedResult object with result field containing an array of SystemSchedulingPagedResult

Samples

POST /api/systemSetting/loadSchedules HTTP/1.1

Request payload:

{
  "systemLevel" : true,
  "tenantId" : null,
  "pageIndex" : 1,
  "pageSize" : 10,
  "sortOrders" : [{
        "key" : "name",
        "descending" : true
     }
  ],
  "criteria" : [{
        "key" : "ReportingType",
        "value" : ""
     }, {
        "key" : "ReportDashboardName",
        "value" : ""
     }, {
        "key" : "DeliveryType",
        "value" : ""
     }, {
        "key" : "DeliveryMethod",
        "value" : ""
     }, {
        "key" : "Recipients",
        "value" : ""
     }, {
        "key" : "Type",
        "value" : ""
     }, {
        "key" : "LastSuccessfulRun",
        "value" : ""
     }, {
        "key" : "NextScheduledRun",
        "value" : ""
     }, {
        "key" : "NextScheduledRunFrom",
        "value" : ""
     }, {
        "key" : "NextScheduledRunTo",
        "value" : ""
     }, {
        "key" : "LastSuccessfulRunFrom",
        "value" : ""
     }, {
        "key" : "LastSuccessfulRunTo",
        "value" : ""
     }, {
        "key" : "RecurrenceType",
        "value" : ""
     }, {
        "key" : "ExportFileType",
        "value" : ""
     }, {
        "key" : "CreatedBy",
        "value" : ""
     }
  ]
}

Sample response:

{
  "result" : [{
        "tenantId" : null,
        "tenantName" : null,
        "result" : [{
              "name" : "Weekly Email",
              "schedule" : "Occurs every Thursday effective 10/06/2016 at 05:00 PM (UTC-06:00) Central Time (US & Canada)",
              "type" : "Subscribed Reporting Item",
              "timeZoneName" : "(UTC-06:00) Central Time (US & Canada)",
              "timeZoneValue" : "Central Standard Time",
              "startDate" : "2016-10-06T00:00:00",
              "startDateUtc" : "0001-01-01T00:00:00",
              "startTime" : "2016-10-06T17:00:00",
              "recurrenceType" : 8,
              "recurrencePattern" : 1,
              "recurrencePatternSetting" : {
                 "recurrenceWeek" : 1,
                 "selectedDayValue" : "5"
              },
              "isEndless" : true,
              "isScheduled" : false,
              "occurrence" : 0,
              "endDate" : null,
              "endDateUtc" : null,
              "deliveryType" : "Email",
              "deliveryMethod" : "Link",
              "exportFileType" : null,
              "exportAttachmentType" : null,
              "emailSubject" : "{reportName}",
              "emailBody" : "Dear {currentUserName},    <br/>    <br/>        Please see dashboard in the following link.    <br/>    <br/>        {dashboardLink}    <br/>    <br/>        Regards,",
              "reportId" : null,
              "dashboardId" : "5a21db3b-82c6-4791-8380-41affe1f0dcd",
              "filterValueSelection" : "",
              "recipients" : null,
              "lastSuccessfulRun" : "The schedule has not started.",
              "lastSuccessfulRunDate" : null,
              "nextScheduledRun" : "10/06/2016 05:00 PM (UTC-06:00) Central Time (US & Canada)",
              "nextScheduledRunDate" : null,
              "isSubscription" : true,
              "createdById" : null,
              "isStartDateAdjusted" : false,
              "subscriptionFilterFields" : [],
              "subscriptionCommonFilterFields" : [],
              "tempId" : null,
              "reportingType" : "Dashboard",
              "additionalRecipients" : null,
              "reportDashboardName" : "001*",
              "id" : "17b78ebb-aece-41d1-a73d-6ffc965b00d6",
              "state" : 0,
              "deleted" : false,
              "inserted" : true,
              "version" : 1,
              "created" : null,
              "createdBy" : null,
              "modified" : "2016-10-06T04:31:13.34",
              "modifiedBy" : null
           }, {
              "name" : "Daily Email",
              "schedule" : "Occurs every day effective 10/06/2016 at 05:00 PM (UTC-06:00) Central Time (US & Canada)",
              "type" : "Subscribed Reporting Item",
              "timeZoneName" : "(UTC-06:00) Central Time (US & Canada)",
              "timeZoneValue" : "Central Standard Time",
              "startDate" : "2016-10-06T00:00:00",
              "startDateUtc" : "0001-01-01T00:00:00",
              "startTime" : "2016-10-06T17:00:00",
              "recurrenceType" : 1,
              "recurrencePattern" : 1,
              "recurrencePatternSetting" : {
                 "recurrenceWeek" : 1,
                 "selectedDayValue" : "5"
              },
              "isEndless" : true,
              "isScheduled" : false,
              "occurrence" : 0,
              "endDate" : null,
              "endDateUtc" : null,
              "deliveryType" : "Email",
              "deliveryMethod" : "Link",
              "exportFileType" : null,
              "exportAttachmentType" : null,
              "emailSubject" : "{reportName}",
              "emailBody" : "Dear {currentUserName},    <br/>    <br/>        Please see report in the following link.    <br/>    <br/>        {reportLink}    <br/>    <br/>        Regards,",
              "reportId" : "aeb4258e-7e30-4018-af48-9d73c6a41dee",
              "dashboardId" : null,
              "filterValueSelection" : "",
              "recipients" : null,
              "lastSuccessfulRun" : "The schedule has not started.",
              "lastSuccessfulRunDate" : null,
              "nextScheduledRun" : "10/06/2016 05:00 PM (UTC-06:00) Central Time (US & Canada)",
              "nextScheduledRunDate" : null,
              "isSubscription" : true,
              "createdById" : null,
              "isStartDateAdjusted" : false,
              "subscriptionFilterFields" : [],
              "subscriptionCommonFilterFields" : [],
              "tempId" : null,
              "reportingType" : "Report",
              "additionalRecipients" : null,
              "reportDashboardName" : "grid1",
              "id" : "4ff7a37f-b381-4869-bf9d-16b6a8e5349e",
              "state" : 0,
              "deleted" : false,
              "inserted" : true,
              "version" : 1,
              "created" : null,
              "createdBy" : null,
              "modified" : "2016-10-06T04:31:49.153",
              "modifiedBy" : null
           }
        ],
        "pageIndex" : 1,
        "pageSize" : 10,
        "total" : 2
     }, {
        "tenantId" : "a246229f-d190-4445-9fe9-1cdb22a03461",
        "tenantName" : "001",
        "result" : [],
        "pageIndex" : 1,
        "pageSize" : 10,
        "total" : 0
     }
  ],
  "pageIndex" : 0,
  "pageSize" : 0,
  "total" : 0
}

GET systemSetting/schedules/reportDashboardName/{reportingType}/(tenant_id)

Returns an array of possible report names (reportingType=1), dashboard names (reportingType=2), or both (reportingType=0) for schedule search screen.

Request

No payload

Response

An array of strings

Samples

GET /api/systemSetting/schedules/reportDashboardName/0 HTTP/1.1

Sample response:

["Orders Report", "Products Report", "Sales Dashboard"]

GET systemSetting/schedules/recipients/(tenant_id)

Returns an array of possible recipients for schedule search screen.

Request

No payload

Response

An array of strings

Samples

GET /api/systemSetting/schedules/recipients HTTP/1.1

Sample response:

["jdoe@acme.com","jbourne@treadstone.com","Admin","jdoe","jbourne","HR_Role","Reviewer_Role"]

GET systemSetting/schedules/creators/(tenant_id)

Returns an array of possible owners for schedule search screen.

Request

No payload

Response

An array of strings

Samples

GET /api/systemSetting/schedules/creators HTTP/1.1

Sample response:

["Admin","jdoe"]

POST systemSetting/deleteSchedules

Deletes schedules from an array of ids.

Request

Payload: an array of strings (GUIDs)

Response

  • true if the deletion was successful
  • false if not

Samples

POST /api/systemSetting/deleteSchedules HTTP/1.1

Request payload:

["083ad7a3-f0ec-427d-ba3e-7f5327720eb2","22072491-1714-43dd-ae82-a07397390fab","d7c75b0f-bd05-4d82-ae1d-dd8904429115"]

Sample response:

true

GET systemSetting/categorySetting

Returns the global category and local category.

Request

No payload

Response

An array of exactly two objects with the following fields:

Field Description Note
id
string (GUI)
The id of the setting  
name
string
Either “Global Category” or “Local Category”  
isGlobal
boolean
  • true if Global
  • false if Local
 

Samples

GET /api/systemSetting/categorySetting HTTP/1.1

Sample response:

[
   {
      "id": "2a83e3ce-f91b-4f14-910d-76cadf42d0fe",
      "name": "Global Category",
      "isGlobal": true
   },
   {
      "id": "09f8c4ab-0fe8-4e03-82d1-7949e3738f87",
      "name": "Local Category",
      "isGlobal": false
   }
]

GET systemSetting/themes

New in version 2.9.0.

Returns the available color themes for Chart, Gauge, and Map.

Request

No payload

Response

An array of available the color themes. Each theme has the following structure:

Field Description Note
name
string
The name of the theme  
colors
an array of string
An array of HEX color codes  

Samples

GET /api/systemSetting/themes HTTP/1.1

Sample response:

[
   {
      "name": "Boston Blue",
      "colors": [
            "#3182bd",
            "#6baed6",
            "#9ecae1",
            "#c6dbef",
            "#e6550d",
            "#fd8d3c",
            "#fdae6b",
            "#fdd0a2",
            "#31a354",
            "#74c476",
            "#a1d99b",
            "#c7e9c0"
      ]
   },
   {
      "name": "Classic",
      "colors": [
            "#F9EA15",
            "#B4D335",
            "#35B24D",
            "#128076",
            "#2C5AA8",
            "#2C3185",
            "#332A7B",
            "#981E5B",
            "#EE1D26",
            "#F04323",
            "#F5841E",
            "#FDCC05"
      ]
   }
]