REST API Documentation¶
A master list of REST API endpoints, their purpose, parameters and return types - together with cross-references to UI functions and sample API calls.
List of Request Headers¶
| Request header | Description |
|---|---|
access_token Required, except for POST user/login API |
The access token, which should be requested firstly using POST user/login API |
current_tenant Required if logged in user is a tenant user |
The id of the tenant of the logged in user |
selected_tenant |
The id of the selected tenant. This is used in case the logged in user is a system user, and selects setting level as a specific tenant. |
For an example on adding request headers, please see Code sample for calling REST API.
List of APIs¶
- System DB and License APIs
- Summary
- GET databaseSetup/supportedDatabaseType
- POST databaseSetup/testConnection
- GET databaseSetup/databaseInfo
- POST databaseSetup/databaseInfo
- POST databaseSetup/provisionStaticData
- GET databaseSetup/provisionStaticDataStatus
- POST databaseSetup/staticData/city
- POST databaseSetup/staticData/postalCode
- GET databaseSetup/staticData/countryCodes
- GET systemSetting/systemMode
- GET systemSetting/systemModeSettings
- POST systemSetting/systemModeSettings
- GET systemSetting/deploymentMode
- GET systemSetting/systemIndicator/(tenant_id)
- GET license/status
- GET license/currentToken
- POST license/validate
- POST license/requestToken
- Connection APIs
- Summary
- GET connection/(tenant_id)
- GET connection/basicInfo/(tenant_id)
- GET connection/detail/{connection_id}
- GET connection/detailInfo/(tenant_id)/{loadField}
- GET connection/preset/{server_type_id}
- GET connection/visible/(tenant_id)/count
- GET dataAdaptor
- GET systemSetting/databaseSetup
- POST connection
- POST connection/connectionStringData
- POST connection/databaseName
- POST connection/detailInfo
- POST connection/detailInfoByQuerySources
- POST connection/invisible/{connection_id}
- POST connection/loadDistinctConnections
- POST connection/loadRemoteSchema
- POST connection/reloadRemoteSchema
- POST connection/validateSchema
- POST connection/verify
- POST connection/visible/{connection_id}
- DELETE connection/{connection_id}
- Data Model APIs
- List of APIs
- POST dataModel/loadQuerySources
- POST dataModel/loadQuerySourceFields
- GET dataModel/basicConnectionsInfo/(tenant_id)
- POST dataModel/basicConnectionsInfo
- POST dataModel/connectionsInfo
- GET dataModel/basicQuerySourceCategoriesInfo/{connection_id}
- POST dataModel/basicQuerySourceCategoriesInfo/
- GET dataModel/basicQuerySourcesInfo/{connection_id}/(type)
- GET dataModel/querySourcesInfo/{connection_id}/(type)
- DELETE dataModel/querySourceField/{query_source_field_id}
- GET dataModel/basicQuerySourceFieldsInfo/{query_source_id}
- POST dataModel
- GET dataModel/indicator/(tenant_id)
- POST dataModel/reloadQuerySourceFields
- POST dataModel/validateCalculatedField
- POST dataModel/functionOperators/
- POST dataModel/loadRelationships
- POST dataModel/loadInvalidRelationships
- POST dataModel/relationships
- DELETE dataModel/relationship/{relationship_id}
- GET dataModel/schema/(tenant_id)
- POST dataModel/schema/updateConnectionColor
- GET dataModel/relationship/joinTypes
- GET dataModel/databaseMapping
- POST dataModel/databaseMapping
- POST dataModel/loadDatabaseNames
- POST dataModel/loadDatabaseObjects
- POST dataModel/customQuerySource
- POST dataModel/validateCustomQuerySource
- POST dataModel/deleteCustomQuerySource
- GET dataModel/querySource/{query_source_id}
- POST dataModel/validateRelationships
- Tenant APIs
- List of APIs
- GET tenant/{tenant_id}
- GET tenant/activeTenants
- GET tenant/allTenantGroups
- GET tenant/allTenants
- GET tenant/availableCategory/{type}
- GET tenant/basicInfos
- GET tenant/namesOnly
- GET tenant/tenantGroupsHierarchy
- POST tenant
- POST tenant/accessLimits
- POST tenant/active/{tenant_id}
- POST tenant/deactive/{tenant_id}
- POST tenant/intergration/saveTenant
- POST tenant/scheduleLimits
- DELETE tenant/{tenant_id}
- Role APIs
- List of APIs
- GET role/all/(tenant_id)
- POST role/active/{role_id}/(tenant_id)
- POST role/deactive/{role_id}/(tenant_id)
- DELETE role/{role_id}
- GET role/{role_id}
- GET role/availableRole/{type}/(tenant_id)
- GET role/availableCategory/{type}/(tenant_id)
- POST role/availableCategory
- POST role
- GET role/summaries/(tenant_id)
- POST role/allowedSharingRoles
- POST role/intergration/saveRole
- POST role/accessLimits
- POST role/scheduleLimits
- POST role/loadPartialDataModelAccess
- User APIs
- Summary
- GET user/all/(tenant_id)
- POST user/all
- POST user/load
- POST user/login
- POST user/logout
- POST user
- POST user/userProfile
- POST user/passwordProfile
- POST user/securityQuesitions
- POST user/password
- POST user/active
- POST user/deactive
- DELETE user/{user_id}
- POST user/passwordAndSecurityQuestion
- GET user/securityQuestion/{user_name}/(tenant_display_id)
- POST user/generatePasswordLink
- POST user/validatePasswordLink
- POST user/validateSecurityQuestion
- POST user/validateUserInfo
- POST user/validateExpirationPasswordLink
- POST user/sendPasswordLink
- POST user/integration/saveUser
- POST user/validateUserRoleAssociation
- POST user/allowedSharingUsers/(tenant_id)
- GET user/isLastSystemAdmin
- POST external/user
- Report Designer Details APIs
- Summary
- GET report/category/{type}/(tenant_id)
- POST report/allowedSavingCategories
- POST report/allowedSavingSubCategories
- GET report/subcategory/{parent_category_id}
- GET report/allCategories/{type}/(tenant_id)
- POST report/allCategories
- POST report/category
- DELETE report/category/{report_category_id}
- POST report/validateCategoryName
- GET report/reportByProperty/{report_id}/{property}
- POST report
- POST report/draft
- POST report/cancel
- POST report/loadForEdit
- GET report/(tenant_id)
- POST report/validateReportName
- POST report/validate
- POST report/search
- POST report/search2
- POST report/advancedSearch
- GET report/reportMode
- POST report/reportMode/{value}
- POST report/detectReportChange
- POST report/function/{function_mode}/{data_type}/(tenant_id)
- GET report/allReports/(tenant_id)
- POST report/detectSchemaChange
- POST report/updateResults
- POST report/loadAccesses
- POST report/loadSchedules
- GET report/reportPart/{report_part_id}/(report_id)?page=value
- POST report/validateExistingField
- GET report/reportId/(tenant_id)?reportName=value&categoryName=value
- POST report/validateExistingReport
- GET report/reportsByTenant/(tenant_id)
- POST report/updateRenderingTime
- GET report/isReportValid/(report_id)
- POST report/areReportsValid
- POST report/printDraft
- GET report/printDraft/{report_id}
- GET report/accessPriority/(report_dashboard_id)
- GET report/reportPart/crossfiltering/{report_part_id}
- GET report/validateEmbeddedReport/(tenant_id)?reportId=value&reportName=value&reportPartName=value
- POST report/findBySourceIds
- POST report/findReportPartsBySourceIds
- Report Designer Data Sources APIs
- Summary
- GET report/dataSourceCategory/(tenant_id)
- POST report/loadDataSourceCategory
- POST report/loadQuerySources
- POST report/loadRelatedQuerySources
- POST report/loadJoinQuerySourceByRelationship
- POST report/loadRelationships
- POST report/validateRelationshipSyntax
- POST report/validateCycleRelationships
- POST report/detectRelationshipsChange
- POST report/availableQuerySourceFields
- GET report/availableReportMappingFields/{report_id}
- GET report/fieldProperties/{query_source_field_id}
- POST report/loadDataSourceFields
- POST report/calculatedField
- GET report/calculatedField/{calculated_field_id}
- GET report/hasReportUseCalculatedField/{calculated_field_id}
- GET report/hasReportUseRelationship/{relationship_id}
- POST report/deleteReportCalculatedField
- POST report/loadDynamicDataSourceCategory
- POST report/loadPartialDataSourceCategory
- POST report/loadPartialDataSources
- POST report/loadRelatedDataSources
- Report Designer Filters APIs
- List of APIs
- GET report/filter/operators
- POST report/loadFilterDataSource
- POST report/loadFilterDataSourceByQuerySourceIds
- POST report/validateFilterSyntax
- POST report/loadFilter
- POST report/filter/loadFields
- GET report/filter/timePeriods
- GET report/filter/dataFormat/{dataType}
- GET report/field/dataFormat/{dataType}
- POST report/loadFilterFieldData
- POST report/loadFilterFieldDataAsTree
- POST report/loadPartialFilterFieldData
- POST report/loadPartialFilterFieldDataAsTree
- POST report/loadAllFilterFieldsData
- GET report/validateFilter/{report_id}
- POST report/validateFilterFieldsType
- POST report/validateFilterFields
- Report Designer Data and Expressions APIs
- Summary
- POST fusion/validateExpression
- POST fusion/validateGrandTotalExpression
- POST fusion/validateSubTotalExpression
- POST fusion/loadData
- POST fusion/reportPartPreview
- POST fusion/previewGrandTotal
- GET fusion/{report_id}/{report_part_id}/(pageIndex)/(pageSize)
- POST fusion/validateDataModelExpression
- POST fusion/previewCalculatedField
- POST fusion/previewSubTotal
- POST fusion/calculatedFieldValue
- POST fusion/retrieveRandomExpandedLevelData
- POST fusion/printQuery
- POST fusion/printQuery/reportPartPreview
- GET fusion/printQuery/{reportId}/{reportPartId}/(pageIndex)/(pageSize)
- Report List APIs
- List of APIs
- POST report/list
- POST report/list2(?includeHashCode=true)
- GET report/info/{report_id}/(version)
- POST report/copy
- POST report/move
- POST report/history
- GET report/history/{report_id}/(version)
- POST report/version/{report_id}/(version)
- DELETE report/history/{report_id}/(version)
- GET report/tenants/(tenant_id)/categories/(category_id)/reports
- POST report/rename
- POST report/delete
- POST report/loadSubscriptions
- POST report/emailTemplates/{isSubscription}
- POST report/subscription/validate
- POST report/subscriptions
- POST report/deleteAllArchiveVersions
- POST report/findByName
- Dashboard Designer APIs
- Summary
- POST dashboard
- POST dashboard/loadFilterFieldData
- POST dashboard/loadFilterFieldDataAsTree
- POST dashboard/loadPartialFilterFieldData
- POST dashboard/loadPartialFilterFieldDataAsTree
- POST dashboard/loadFilterComparisonFields
- POST dashboard/detectDashboardChange
- POST dashboard/loadDashboard
- POST dashboard/loadSubscriptions
- POST dashboard/subscription/validate
- POST dashboard/subscriptions
- POST dashboard/validateDashboardName
- POST dashboard/validate
- POST dashboard/validateGlobalDashboard
- POST dashboard/previewDashboardPartData
- POST dashboard/loadDashboardPartData
- POST dashboard/loadDashboardPartData2
- GET dashboard/dashboardPart/{dashboard_part_id}
- POST dashboard/accesses/validate
- GET dashboard/allowedSavingCategories
- POST dashboard/allowedSavingCategories
- POST dashboard/allowedSavingSubCategories
- POST dashboard/loadCommonFilters
- GET dashboard/commonFilters/{dashboard_id}
- POST dashboard/updateRenderingTime
- POST dashboard/draft
- GET dashboard/draft/{dashboard_id}
- POST dashboard/embeddedReports
- GET dashboard/loadRelatedDashboardParts/{dashboard_id}
- Dashboard List APIs
- Summary
- GET dashboard/categories/(tenant_id)
- POST dashboard/categories
- POST dashboard/category
- DELETE dashboard/category/{dashboard_category_id}
- POST dashboard/validateCategoryName
- GET dashboard/emailTemplates/{isSubscription}
- GET dashboard/emailTemplates/{templateType}
- POST dashboard/rename
- POST dashboard/move
- POST dashboard/copy
- DELETE dashboard/{dashboard_id}
- POST dashboard/loadFilterDescription
- POST dashboard/list
- POST dashboard/list2(?includeHashCode=true)
- POST dashboard/search
- POST dashboard/search2
- POST dashboard/loadAccesses
- POST dashboard/findByName
- Advanced Settings APIs
- Summary
- POST advancedSetting/category
- GET advancedSetting/category/(tenant_id)
- DELETE advancedSetting/category/{category_id}
- GET advancedSetting/performance/(tenant_id)
- POST advancedSetting/performance
- GET advancedSetting/security/(tenant_id)
- POST advancedSetting/security
- GET advancedSetting/miscSetting/(tenant_id)
- POST advancedSetting/miscSetting
- POST advancedSetting/defaultImageUrl
- GET advancedSetting/defaultImageUrl(?tenantId=tenant_id)
- GET api/advancedSetting/defaultTheme(?tenantId=tenant_id)
- POST api/advancedSetting/defaultTheme
- System Configuration APIs
- Summary
- POST systemSetting/reportSetting
- GET systemSetting/reportSetting
- GET systemSetting/securityPolicy
- POST systemSetting/securityPolicy
- POST systemSetting/loadSchedules
- GET systemSetting/schedules/reportDashboardName/{reportingType}/(tenant_id)
- GET systemSetting/schedules/recipients/(tenant_id)
- GET systemSetting/schedules/creators/(tenant_id)
- POST systemSetting/deleteSchedules
- GET systemSetting/categorySetting
- GET systemSetting/themes
- GET systemSetting/cacheConfiguration
- POST systemSetting/cacheConfiguration
- POST systemSetting/clearCache
- Misc System Settings APIs
- Summary
- GET accessRight/reportDashboard/{type}
- GET accessRight/authentication/{type}
- POST accessRight/load
- POST accessRight/validate
- POST authorization/checkPermissions
- GET authorization/permission/(section)
- GET accessRight/loadAccessDefaults/{reportingType}
- GET systemSetting/status
- GET systemSetting/reset
- GET systemSetting/systemVariables
- GET systemSetting/supportedDataSourceTypes
- POST systemSetting/loadEmailVariables
- POST systemSetting/securityQuestions
- GET systemSetting/email/(tenant_id)
- POST systemSetting/email
- GET systemSetting/email/status/(tenant_id)
- GET systemSetting/language
- GET systemSetting/dateFormat
- GET systemSetting/googleAPIKey/(tenantId)
- POST systemSetting/googleAPIKey
- Export APIs
- Copy Management APIs
- List of APIs
- GET copyManagement/workspace/{workspace_id}
- GET copyManagement/workspaces/{tenant_id}/{onlyMyWorkspace}
- POST copyManagement/workspace/validateName
- POST copyManagement
- DELETE copyManagement/workspace/{workspace_id}
- POST copyManagement/copy
- POST copyManagement/connectionsHasDataModel
- POST copyManagement/workspace/loadDestinationConnections
- POST copyManagement/workspace/validate
- POST copyManagement/workspace/validateWorkspaceTenant
- POST copyManagement/workspace/validateConcurrency
- POST copyManagement/workspace/detectConflictingTenantPermissions
- POST copyManagement/workspace/detectConflictingAdvancedSettings
- POST copyManagement/workspace/detectConflictingReport
- POST copyManagement/workspace/detectConflictingRolePermission
- POST copyManagement/workspace/detectConflictingTemplate
- POST copyManagement/workspace/detectConflictingDashboard
- POST copyManagement/exportDataModel
- POST copyManagement/importDataModel
- Copy Console APIs
- List of APIs
- API Workflow
- POST copyManagement/console/validate/sourcedata
- POST copyManagement/console/validate/dataconsistent
- POST copyManagement/console/validate/listusingfield
- POST copyManagement/console/validate/source
- POST copyManagement/console/validate/destination
- POST copyManagement/console/loadreport
- POST copyManagement/console/copyreport
- POST copyManagement/console/updatesubreport
- POST copyManagement/console/loaddashboard
- POST copyManagement/console/copydashboard
- POST copyManagement/console/listreport