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

    Users

    Resource

    URL

    Method

    Required roles

    Overview

    GET User Detail by Username/api/users/username/:usernameGET

    Global admin, Domain admin, User himself

    Loads details about user specified by username.

    GET User Detail

    /api/users/:id

    GET

    Global admin, Domain admin, User himself

    Loads details about user specified by ID.

    GET User Status

    /api/users/:id/status

    GET

    Global admin, Domain admin, User himself

    Returns the active status for the user specified by ID.

    GET User Photo

    /api/users/:id/image

    GET

    Global admin, Domain admin, User himself

    Returns the image for the user specified by ID.

    POST Create User

    /api/users/create

    POST

    Global admin, Domain admin

    Creates new user.

    POST Edit User

    /api/users/:id

    POST

    Global admin, Domain admin

    Modifies the user specified by ID.

    POST Set User Status/api/users/:id/statusPOSTGlobal admin, Domain adminActivates/Deactivates user specified by ID.
    POST Create User Group/api/users/groups/createPOSTGlobal admin, Domain adminCreates new user group.
    POST Create User Request/api/users/:username/requestsPOSTGlobal admin, Domain admin, User himselfCreates new user request for user specified by username.
    POST Create Access Token/api/users/:username/accessTokenPOSTGlobal admin, Domain adminCreates new access token for user specified by username.
    DELETE User/api/users/:idDELETEGlobal admin, Domain adminDeletes the user

    Domains

    Resource

    URL

    Method

    Required roles

    Overview

    GET Domains

    /api/domains

    GET

    Global admin

    List domains.

    GET Domain Detail/api/domains/:idGETGlobal admin, Domain adminReturns details about domain specified by ID.
    GET Users/api/domains/:domain_id/usersGETGlobal admin, Domain adminList users for domain specified by domain ID.
    GET User Groups/api/domains/:domain_id/userGroupsGETGlobal admin, Domain adminList user groups for domain specified by domain ID.

    POST Create Domain

    /api/domains/create

    POST

    Global admin

    Creates new domain.

    POST Edit Domain

    /api/domains/:id

    POST

    Global admin, Domain admin

    Modifies the domain specified by ID.

    POST Sign Parameters/api/domains/:domain_id/signParametersPOSTGlobal admin, Domain adminRetrieves the signature of the passed parameters.
    POST Sign Resource/api/domains/:domain_id/signResourcePOSTGlobal admin, Domain adminRetrieves the signature of desired resource.

    Data sets

    Resource

    URL

    Method

    Required roles

    Overview

    GET Data Sets

    /api/dataSets

    GET

    Active user

    Lists all data sets available to the user.

    GET Data Set Detail

    /api/dataSets/:id

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

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

    GET Attribute Values

    /api/dataSets/:id/attributes/:code/values

    GETGlobal admin, Domain admin, Owner, Editor, ViewerLists attribute values by given data set ID and attribute code.
    POST Attribute Value Image

    /api/dataSets/:id/attributes/:code/:value/image

    POSTGlobal admin, Domain admin, Owner, EditorEdits image in appearance settings for given data set ID, attribute code and attribute value.
    GET Data Sources

    /api/dataSets/:id/dataSources

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

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

    GET Data Source Executions

    /api/dataSets/dataSources/:id/executions

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    Lists all data source executions specified by data source ID.

    POST Schedule Execution

    /api/dataSets/dataSources/:id/schedule

    POST

    Global admin, Domain admin, Owner, Editor

    Schedule execution for data source specified by ID.

    GET Data Set Data/api/dataSets/:id/dataGETGlobal admin, Domain admin, Owner, Editor, ViewerRetrieves data set data for desired data set specified by ID.
    POST Data Set Data/api/dataSets/:id/dataPOSTGlobal admin, Domain admin, Owner, EditorUpdates existing row or inserts new row in data set specified by ID.

    Reports

    Resource

    URL

    Method

    Required roles

    Overview

    GET Reports

    /api/reports

    GET

    Active user

    Lists all reports available to the user.

    GET Reports by Username/api/reports/username/:usernameGETGlobal admin, Domain Admin, User himselfLists all reports available to the specified user.

    GET Report Detail

    /api/reports/:id

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    Shows detailed information about the report with the specified ID.

    GET Report Thumbnail

    /api/reports/:id/thumbnail

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    Returns a report thumbnail image in PNG format.

    GET Report Comments

    /api/reports/:id/comments

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    Returns all comments for the report with the specified ID.

    POST Comments

    /api/reports/:id/comments

    POST

    Global admin, Domain admin, Owner, Editor, Viewer

    Posts a comment to the report with the specified ID.

    DELETE Comments/api/reports/comments/:idDELETEGlobal admin, Domain admin, Owner, EditorDeletes a comment specified by ID.

    GET Filter Attribute Values

    /api/reports/:id/filter/attributeValues

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    Returns attribute values for provided attribute code.

    POST Images

    /api/reports/:id/imagesPOSTGlobal admin, Domain admin, Owner, EditorPosts an image to the report with the specified ID.

    Views

    Resource

    URL

    Method

    Required roles

    Overview

    GET Chart

    /api/reports/views/:id/chart

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    This method returns chart metadata (for HTML5 renderer).

    GET KPI View

    /api/reports/views/:id/kpi

    GET

    Global admin, Domain admin, Owner, Editor, Viewer This method returns data and metadata of specified KPI view.

    GET Custom Content

    /api/reports/views/:id/text

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    This method returns custom content and its metadata.

    GET Table Bounds

    /api/reports/views/:id/table/bounds

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    This method returns bounds of the table.

    GET Table Left Header

    /api/reports/views/:id/table/leftHeader

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    This method returns left header in form of HTML.

    GET Table Top Header

    /api/reports/views/:id/table/topHeader

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    This method returns top header in form of HTML.

    GET Table Data

    /api/reports/views/:id/table/data

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    This method returns table data in HTML format.

    GET Table JSON

    /api/reports/views/:id/table/json

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

    This method returns entire table in JSON format.

    GET Map/api/reports/views/:id/mapGETGlobal admin, Domain admin, Owner, Editor, ViewerThis method returns data for rendering a map in JSON format.

    GET View as Image

    /api/reports/views/:id/imageGETGlobal admin, Domain admin, Owner, Editor, ViewerThis method returns view (chart or table) as image in PNG format.
    GET View as PDF/api/reports/views/:id/export/pdfGETGlobal admin, Domain admin, Owner, Editor, ViewerThis method returns view (chart, table or map) as PDF file.
    POST Edit Image View/api/reports/views/:id/imagePOSTGlobal admin, Domain admin, Owner, EditorThis method edits image in the view with the specified ID.

    Dashboards

    Resource

    URL

    Method

     

    Overview

    GET Dashboards

    /api/dashboards

    GET

    Active user

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

    GET Dashboards by Username/api/dashboards/username/:usernameGETGlobal admin, Domain admin, User himselfLists all dashboards available to the specified user.

    GET Dashboard Detail

    /api/dashboards/:id

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

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

    GET Dashboard Thumbnail

    /api/dashboards/:id/thumbnail

    GET

    Global admin, Domain admin, Owner, Editor, Viewer

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

    Import

    Resource

    URL

    Method

    Required roles

    Overview

    GET Forms

    /api/import/forms

    GET

    Active user

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

    GET Form

    /api/import/forms/:id

    GET

    Active user

    This method returns desired collection form specified by ID

    POST Form Data

    /api/import/forms/:id

    POST

    Active user

    This method posts data to the form specified by ID.

    POST JSON Data/api/import/:idPOSTGlobal admin, Domain admin, Owner, EditorThis method posts data to BellaDati in JSON format.
    POST Image to Media Gallery

    /api/import/media/image

    POSTActive userPosts image to BellaDati Media Gallery.
     

    Utilities

     

    Resource

    URL

    Method

    Required roles

    Overview

    GET File

    /api/utils/file/{path}

    GET

    Active user (must be allowed in domain settings)

    Returns file from given absolute path.

    GET Merge PDF files/api/utils/mergePdfFiles/{paths}GETActive user (must be allowed in domain settings)Merges PDF files (specified by given absolute paths separated by ";") into one PDF file.
    GET Images from Media Gallery/api/media/imageGETGlobal admin, Domain admin, Active user from same domainReturns a list of all images available to the user
    GET Image from Media gallery/api/media/image/:idGETGlobal admin, Domain admin, Active user from same domainReturns image from image gallery

     


    • No labels