Last updated on 13-May-2020 by Jakob Jakobsen Boysen

Jakob Jakobsen Boysen

Platform Lead
boysen@scifeon.com

Get dashboards

GET /api/dashboard

Get all dashboards the current user has access to.

Response

A simple JSON object with the following properties:

{
    "id":               // ID
    "name":             // dashboard name
    "description":      // longer description
    "userID":           // user ID of owner
    "widgets": [
        {
            "plugin":   // app and plugins information for widget
            "gridster": // size and position in dashboard
            "config":   // widget configuration
            "header":   // header for widget (optional)
        },
        ...
    ]
    "shares": {          // users, departments, projects and user roles this dashboard is shared with
        "userIDs":
        "departmentIDs":
        "projectIDs":   
        "userRoles":
    }
}

Create dashboard

POST /api/dashboard

Create a new dashboard.

Body

The body is a full dashboard entity, including the shares property.

Update dashboard

PUT /api/dashboard/{id}

Update an existing dashboard.

Query parameters

• id The ID of the dashboard to update.

Body

The body is a full dashboard entity, including the shares property.

Delete dashboard

DELETE /api/dashboard/{id}

Delete an existing dashboard, that the current user owns.

Query parameters

• id The ID of the dashboard to delete.