BellaDati Technical Documentation : REST API Resources

This document lists all objects and methods available in the BellaDati REST API.

Data sets

Resource

URL

Method

Overview

GET Data Sets

/api/dataSets

GET

Lists all data sets available to the user.

GET Data Set Detail

/api/dataSets/:id

GET

Shows detailed information about the data set with the specified ID.

GET Data Sources

/api/dataSets/:id/dataSources

GET

Lists all data sources related to the data set with the specified ID.

GET Data Source Executions

/api/dataSets/dataSources/:id/executions

GET

Lists all data source executions specified by data source ID.

POST Schedule Execution

/api/dataSets/dataSources/:id/schedule

POST

Schedule execution for data source specified by ID.

Reports

Resource

URL

Method

Overview

GET Reports

/api/reports

GET

Lists all reports available to the user.

GET Report Detail

/api/reports/:id

GET

Shows detailed information about the report with the specified ID.

GET Report Thumbnail

/api/reports/:id/thumbnail

GET

Returns a report thumbnail image in PNG format.

GET Report Comments

/api/reports/:id/comments

GET

Returns all comments for the report with the specified ID.

POST Comments

/api/reports/:id/comments

POST

Posts a comment to the report with the specified ID.

GET Filter Attribute Values

/api/reports/:id/filter/attributeValues

GET

Returns attribute values for provided attribute code.

Views

Resource

URL

Method

Overview

GET KPI View

/api/reports/view/:id/kpi

GET

Returns data and metadata of the specified KPI view.

GET Chart

/api/reports/view/:id/chart

GET

This method returns chart metadata (for HTML5 renderer).

GET View as Image

/api/reports/view/:id/image

GET

This method returns view (chart or table) as image in PNG format.

GET Custom Content

/api/reports/view/:id/text

GET

This method returns custom content and its metadata.

GET Table Bounds

/api/reports/view/:id/table/bounds

GET

This method returns bounds of the table.

GET Table Left Header

/api/reports/view/:id/table/leftHeader

GET

This method returns left header in form of HTML.

GET Table Top Header

/api/reports/view/:id/table/topHeader

GET

This method returns top header in form of HTML.

GET Table Data

/api/reports/view/:id/table/data

GET

This method returns table data in JSON format.

Dashboards

Resource

URL

Method

Overview

GET Dashboards

/api/dashboards

GET

This method performs the listing of all dashboards available for user.

GET Dashboard Detail

/api/dashboards/:id

GET

This method performs loading of dashboard details specified by the id parameter.

GET Dashboard Thumbnail

/api/dashboards/:id/thumbnail

GET

This method returns dashboard thumbnail represented by the first view in PNG format.

Forms

Resource

URL

Method

Overview

GET Forms

/api/import/forms

GET

This method returns list of data collection forms for signed user.

POST Form Data

/api/import/forms/:id

POST

This method posts data to the form specified by ID.