Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetUserDashboards

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetUserDashboards

 

Loads an user specific dashboard configuration

 

 

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetUserDashboards

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ LoadDashboardData

xs:boolean

nillable

Defines if also the full dashboard configuration should be loaded

â–¡ UserNo

xs:int

nillable

The user number to load the dashboard information for

 

 

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetUserDashboardsResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ UserDashboards

 

mandatory nillable

The dashboards and their order for the user

≡ WSUserDashboard

 

list nillable


â–¡ Dashboard

 

nillable

The dashboard no for this position

â–  DashboardNo

xs:int

mandatory

Number of the dashboard

â–¡ Name

xs:string

mandatory nillable

Name of the dashboard

â–  CreatedByUserNo

xs:int

mandatory

User that created the dashboard

â–  Created

xs:dateTime

mandatory

DateTime when the dashboard was last modified

â–  Shared

xs:boolean

mandatory

Informs if the dashboard is shared

â–  Guid

xs:string

 

GUID string template:

[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

Gets the GUID of the dashboard

â–  FolderNo

xs:int

 

Folder number which contains the dashboard

â–¡ DashboardData

xs:string

mandatory nillable

JSON definition of the dashboard

â–  Position

xs:int

 

The position of the user dashboard in the list of dashboards

â–  IsHidden

xs:boolean

 

Defines if the dashboard is hidden in UI

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.