REST – Config Settings

Settings JSON

Settings are represented as JSON objects with the following properties. Each corresponds with a setting in the Admin Console and base configuration file. Some settings appear both in the Settings JSON (Table A) and in General Settings JSON (Table B). When this happens, use the Table B setting.

General Settings JSON

Some settings appear both in the Settings JSON (Table A) and in General Settings JSON (Table B). When this happens, use the Table B setting.

Table B

Example:

{
  "General": {
    "ReportPath": "C:ExagoReports",
    "AllowHomeDirect": true,
    "AllowHtmlOutput": true,
    "AllowExcelOutput": true,
    "AllowPdfOutput": true,
    "AllowRtfOutput": true,
    "AllowCsvOutput": true,
    "DefaultOutputType": 2,
    "IsWriteLog": true,
    "CustomCode": "",
    "LicenseKey": "", 
    "DateFormat": "",
    "TimeFormat": "",
    "DateTimeFormat": "",
    "DateTimeTreatedAs": 0,
    "IsReadFilterValues": true,
    "DbTimeout": 600,
    "DbRowLimit": 0,
    "DbRowLimitStepSize": 1000,
    "VisualizationDbRowLimit": 0,
    "CallTypeParamName": "",
    "ColumnParamName": "",
    "FilterParamName": "",
    "FullFilterParamName": "",
    "SortParamName": "",
    "DataCategoryParamName": "",
    "ObjectIdParamName": "",
    "IsShowGrid": true,
    "ActiveRoleId": "",
    "IsDebugging": false,
    "IsShowPdfTemplate": true,
    "IsDashboardPromptAtExecution": false,
    "IsDashboardShowUrlItemButton": false,
    "IsVisualizationShowKeyword": false,
    "IsShowChartWizard": true,
    "IsShowMapWizard": false,
    "IsShowGoogleMapWizard": false,
    "IsShowGaugeWizard": true,
    "IsSaveOnExecute": true,
    "IsSaveOnFinish": true,
    "IsEnableRightClickMenus": true,
    "IsEnableReportsTreeDragAndDrop": true,
    "IsShowLinkReport": true,
    "IsShowLinkReportFields": true,
    "IsShowLinkReportFormula": false,
    "IsShowLinkAction": false,
    "IsShowInsertImage": true,
    "ExpirationDateStr": "",
    "IsHtmlPaging": true,
    "WindowHeight": 0,
    "WindowWidth": 0,
    "SeparatorSymbol": ",",
    "CurrencySymbol": "$",
    "DecimalSymbol": ".",
    "IsDataMapping": false,
    "IsShowJoinFields": true,
    "IsDetectJoinedObjects": true,
    "IsEnableSpecialCartesianProcessing": true,
    "IsIncludeNotFilterNullValues": false,
    "TempPath": "",
    "TempCloudService": "",
    "DataCloudService": "",
    "IsShowScheduleReports": false,
    "IsShowScheduleReportsManager": false,
    "ScheduleManagerViewLevel": 0,
    "IsShowScheduleReportsEmail": false,
    "ScheduleRemotingHost": "",
    "SynchronousRemotingHost": "",
    "SchedulerQueueService": "",
    "ReportScheduleEmailSubject": "",
    "ReportScheduleEmailBody": "",
    "IsRenewSession": true,
    "PasswordRequirement": "",
    "IsExecuteRemotely": false,
    "IsAccessDataSourcesRemotely": false,
    "MaxTempFileAge": 1440,
    "AllowExecuteNewFilters": true,
    "ExternalInterface": "",
    "DecimalPlaces": -1,
    "CurrencyDecimalPlaces": -1,
    "ApplyGeneralFormatDecimalPlaces": false,
    "ApplyGeneralCurrencyRightAlignment": true,
    "ChartColors": "#e85d61, #e5d08f, #00d995",
    "GeochartMapKey": "",
    "MapColors": "Lightblue,Navy",
    "GoogleMapKey": "",
    "GoogleMapColors": "Lightblue,Navy",
    "GaugeColors": "#e85d61, #e5d08f, #00d995",
    "IsShowGroupFilters": true,
    "IsShowJoinsWindow": true,
    "IsShowAdvancedJoins": true,
    "IsShowEventsWindow": false,
    "IsShowReportParametersWindow": true,
    "IsShowCrosstabReports": true,
    "IsShowDashboardReports": true,
    "IsShowChainedReports": true,
    "IsAllowExpressViewLiveEdit": false,
    "IsShowExpressViews": true,
    "IsShowDashboardNewVisualizationButton": true,
    "IsShowDashboardDataFieldsSearch": false,
    "IsShowExpressViewDataFieldsSearch": true,
    "IsUseSampleDataForDashboardVisualizationDesign": true,
    "IsShowDashboardExistingVisualizationReportButton": false,
    "IsDashboardPromptKeywordByDefault": false,
    "IsShowExpressReports": true,
    "IsShowExpressReportsGrouping": true,
    "IsShowExpressReportsFormulaButton": true,
    "IsShowExpressReportsStylingToolbar": true,
    "IsShowExpressReportsThemes": true,
    "IsShowAdvancedReports": true,
    "IsShowGroupHeadersFormulaButton": false,
    "IsOneCategoryLimit": false,
    "IsCacheServices": true,
    "SchedulerRecipientWindow": "",
    "FilterExecutionWindow": "",
    "IsShowIeDownloadButton": false,
    "IsDeleteSchedulesUponReportDeletion": false,
    "AllowMultipleSessions": true,
    "AllowMD5OnFIPS": false,
    "WriteBOMToCSV": false,
    "IsShowScheduleNoEndDate": true,
    "IsShowScheduleIntradayRecurrence": true,
    "TempUrl": "",
    "UserPreferenceStorage": 0,
    "UserStartupReportOverwriteGettingStarted": false,
    "UserStartupReportMaxNum": 1,
    "ExcelExportTarget": 1,
    "AllowDependantFilters": false,
    "LinkedReportsInNewTab": false,
    "LoadImageFuncParamPrefix": "",
    "LanguageFile": "en-us,en-us-getting-started,en-us-tooltips",
    "IsShowHelp": true,
    "CustomHelpSource": "",
    "IsEmailScheduledReports": true,
    "IsEnableBatchReports": false,
    "IsShowScheduleDeliveryTypeOptions": false,
    "IsUseSecureRemotingChannel": false,
    "IsShowTemplateUploadButton": false,
    "UseSVGForAppIcons": true,
    "CrossTabMaximumFields": 5,
    "IsShowExportsInTab": true,
    "IsShowHtmlToolbar": 0,
    "IsEnableScheduling": true,
    "IsShowFilterDescription": false,
    "DefaultFilterExecutionWindow": 0,
    "IsChangeableFilterExecutionWindow": true,
    "IgnoreInaccessibleReportFolders": false,
    "SchemaAccessType": 1,
    "ServerTimeZoneOffset": 0,
    "ClientTimeZoneName": "America/New_York",
    "IsShowEnhancedTooltips": true,
    "IsShowReportUploadDownloadOptions": false,
    "AllowInteractiveHtml": true,
    "AllowHtmlInScheduledEmails": false,
    "DefaultIsDockOpen": false,
    "DockPlacement": 0,
    "CssTheme": "Basic",
    "AllowExecuteSaveToDesign": true,
    "UserAllowUserReports": true,
    "MaxNumberOfChartPoints": 300,
    "DefaultFont": "Arial",
    "DefaultFontSize": 8,
    "DefaultChartFont": "Arial",
    "IsWebFarmSupport": false,
    "IsSilentDashboardRefresh": false,
    "MaxJobExecutionMinutes": 240,
    "IsAggregateAndGroupInDatabase": false,
    "IsEvaluateFormulasInDatabase": true,
    "IsShowBrowserOutOfDateWarning": true,
    "AreDateFunctionsLoaded": true,
    "VersionNumber": "2016.3.4.100"
  },
  "DateFormat": "",
  "TimeFormat": "",
  "DateTimeFormat": "",
  "SeparatorSymbol": ",",
  "CurrencySymbol": "$",
  "DecimalSymbol": ".",
  "ShowGrid": true,
  "ShowCrossTabReports": true,
  "ShowExpressReports": true,
  "ShowExpressReportsGrouping": true,
  "ShowExpressReportsFormulas": true,
  "ShowExpressReportsStyling": true,
  "ShowExpressReportsThemes": true,
  "ShowAdvancedReports": true,
  "ShowScheduleReports": false,
  "ShowScheduleReportsManager": false,
  "ShowScheduleReportsEmail": false,
  "ReadFilterValues": true,
  "ShowTabs": true,
  "WebReportsBaseUrl": null,
  "DefaultFolderName": "",
  "DefaultReportName": ""
}

Note

All requests require a Session ID URL parameter and basic request headers. In the following document, headers are omitted in the interest of brevity.

Show All Settings

GET /rest/Settings

Using curl

curl http://{webservice}/rest/Settings?sid={sid} -X GET

Example response

Status: 200 OK

{
  "General": {
    "ReportPath": "C:ExagoReports",
    ...
  }
  "DateFormat":                 "MM/dd/yyyy",
  "TimeFormat":                 "hh:mm:ss a",
  "DateTimeFormat":             "MM/dd/yyyy hh:mm:ss a",
  "SeparatorSymbol":            ",",
  "CurrencySymbol":             "$",
  "ShowGrid":                   true,
  "ShowCrossTabReports":        true,
  "ShowExpressReports":         true,
  ...
}

Edit Settings

PATCH /rest/Settings

Using curl

curl http://{webservice}/rest/settings?sid={sid} -X PATCH ^
	-d "{
             'General':
              {
                'ReportPath':'C:ExagoReports',
                'IsShowLinkReportFormula':false,
                ...
              }
             'ShowScheduleReports':false,
             'ShowExpressReports':false,
             ...
            }"

Example response

Status: 204 No Content