Class DashboardFunctions
- All Implemented Interfaces:
IConfigurableObject
,INotScriptFriendly
,ISupportsDeprecation
,IDiffableObject
,IAvatar
,IEntityLifeCycleEvent
,IPersistable
,IServiceProvider
,ITaggableObject
,IDependencyScannableObject
,IEntityDefinition
,IPersistableObject<String>
,IDesignTimeSecurable
,IDesignTimeSecurableEntity
,IRunTimeSecurable
,IRunTimeSecurableEntity
,ISecurable
,IVisibilitySecurable
,IVisibilitySecurableEntity
,IAspectContainer
,INamedObject
,Serializable
@ThingworxExtensionApiClass(since={6,6},
canInstantiate=true)
public class DashboardFunctions
extends Resource
- See Also:
-
Field Summary
Fields inherited from class com.thingworx.entities.RootEntity
BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT
Fields inherited from class com.thingworx.types.NamedObject
NAME_COMPARATOR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAddDashboardGroup
(String dashboardID, String title, Integer sequence) Service Category: Dashboards Service Description: Add a dashboard group.AddDashboardItem
(String dashboardID, String groupID, String title, String mashupName, InfoTable parameters, Integer sequence) Service Category: Dashboards Service Description: Add a dashboard item.CreateDashboard
(String title, TagCollection tags) Service Category: Dashboards Service Description: Create a new dashboard.void
DeleteDashboard
(String dashboardID) Service Category: Dashboards Service Description: Delete an dashboard.void
EditDashboardItemConfig
(String dashboardID, String groupID, String itemID, InfoTable parameters) Service Category: Dashboards Service Description: Replace all existing config parameters for a dashboard item with new parameters.void
EditDashboardItemParameters
(String dashboardID, String groupID, String itemID, InfoTable parameters) Service Category: Dashboards Service Description: Updates or adds provided config parameters for a dashboard item.GetDashboard
(String dashboardID) Service Category: Dashboards Service Description: Load a dashboard.GetDashboardByTitle
(String title) Service Category: Dashboards Service Description: Load a dashboard by title.GetDashboardGroup
(String dashboardID, String groupID) Service Category: Dashboards Service Description: Load a dashboard group.GetDashboardGroupByTitle
(String dashboardID, String title) Service Category: Dashboards Service Description: Load a dashboard group by title.GetDashboardGroupList
(String dashboardID) Service Category: Dashboards Service Description: Load a list of dashboard groups.GetDashboardItem
(String dashboardID, String groupID, String itemID) Service Category: Dashboards Service Description: Load a dashboard item.GetDashboardItemConfig
(String dashboardID, String groupID, String itemID) Service Category: Dashboards Service Description: Load a dashboard items configuration parameters.GetDashboardItemList
(String dashboardID, String groupID) Service Category: Dashboards Service Description: Load a list of dashboard items for a specific group.GetDashboardItemParameters
(String dashboardID, String groupID, String itemID) Service Category: Dashboards Service Description: Load a dashboard items configuration parameters.Service Category: Dashboards Service Description: Return a list of dashboards for the current user.GetSharedOrganizationUnits
(String dashboardID) Service Category: Dashboards Service Description: Return a list of the organization units that are sharing a dashboard.void
MoveDashboardGroup
(String dashboardID, String groupID, Integer sequence) Service Category: Dashboards Service Description: Move a dashboard group.void
MoveDashboardItems
(String dashboardID, InfoTable changes) Service Category: Dashboards Service Description: Move dashboard items.void
RemoveDashboardGroup
(String dashboardID, String groupID) Service Category: Dashboards Service Description: Remove a dashboard group.void
RemoveDashboardItem
(String dashboardID, String groupID, String itemID) Service Category: Dashboards Service Description: Remove a dashboard item.void
RemoveSharedOrganizationUnit
(String dashboardID, String name, String type) Service Category: Dashboards Service Description: Remove the organization unit shared to the dashboard.void
RenameDashboard
(String dashboardID, String title) Service Category: Dashboards Service Description: Rename a dashboard.void
RenameDashboardGroup
(String dashboardID, String groupID, String title) Service Category: Dashboards Service Description: Rename a dashboard group.void
RenameDashboardItem
(String dashboardID, String groupID, String itemID, String title) Service Category: Dashboards Service Description: Rename a dashboard item.Service Category: Dashboards Service Description: Return a list of dashboards.SearchGadgets
(TagCollection tags) Service Category: Dashboards Service Description: Return a list of gadgets.void
ShareDashboard
(String dashboardID, String name, String type) Service Category: Dashboards Service Description: Shares an existing Dashboard with another organizational unit within that Organization.Methods inherited from class com.thingworx.resources.Resource
getEntityType
Methods inherited from class com.thingworx.entities.ServiceProviderEntity
getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest
Methods inherited from class com.thingworx.entities.RootEntity
AddConfigurationTableDefinition, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, ListDeprecatedUsage, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, UpdateProjectDependencies, validateConfiguration
Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject
getID, hasID, isTransient
Methods inherited from class com.thingworx.types.NamedObject
getDescription, getName, setDescription, setName, toValueCollection
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.thingworx.types.INamedObject
getDescription, getName
Methods inherited from interface com.thingworx.entities.interfaces.IPersistable
getID, hasID
Methods inherited from interface com.thingworx.security.permissions.ISecurable
getID, getName
Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation
getDeprecated, isDeprecated, isDeprecatedBefore, since
-
Constructor Details
-
DashboardFunctions
public DashboardFunctions()
-
-
Method Details
-
CreateDashboard
@ThingworxExtensionApiMethod(since={6,6}) public String CreateDashboard(String title, TagCollection tags) throws Exception - Service Category:
- Dashboards
- Service Description:
- Create a new dashboard.
- Parameters:
title
- Dashboard title - STRINGtags
- Dashboard tags - TAGS- Returns:
- id Dashboard id - STRING
- Throws:
Exception
- If an error occurs
-
DeleteDashboard
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteDashboard(String dashboardID) throws Exception - Service Category:
- Dashboards
- Service Description:
- Delete an dashboard.
- Parameters:
dashboardID
- Dashboard ID - DASHBOARDNAME- Throws:
Exception
- If an error occurs
-
GetDashboard
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDashboard(String dashboardID) throws Exception - Service Category:
- Dashboards
- Service Description:
- Load a dashboard.
- Parameters:
dashboardID
- Dashboard id - STRING- Returns:
- result Dashboard definition - INFOTABLE - Aspects {dataShape:Dashboard}
- Throws:
Exception
- If an error occurs
-
GetDashboardByTitle
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDashboardByTitle(String title) throws Exception - Service Category:
- Dashboards
- Service Description:
- Load a dashboard by title.
- Parameters:
title
- Dashboard title - STRING- Returns:
- result Dashboard definition - INFOTABLE - Aspects {dataShape:Dashboard}
- Throws:
Exception
- If an error occurs
-
GetDashboardGroupByTitle
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDashboardGroupByTitle(String dashboardID, String title) throws Exception - Service Category:
- Dashboards
- Service Description:
- Load a dashboard group by title.
- Parameters:
dashboardID
- Dashboard id - STRINGtitle
- Dashboard title - STRING- Returns:
- result Dashboard group - INFOTABLE - Aspects {dataShape:DashboardGroup}
- Throws:
Exception
- If an error occurs
-
AddDashboardGroup
@ThingworxExtensionApiMethod(since={6,6}) public String AddDashboardGroup(String dashboardID, String title, Integer sequence) throws Exception - Service Category:
- Dashboards
- Service Description:
- Add a dashboard group.
- Parameters:
dashboardID
- Dashboard ID - STRINGtitle
- Dashboard group title - STRINGsequence
- Dashboard group sequence - INTEGER- Returns:
- id Dashboard group id - STRING
- Throws:
Exception
- If an error occurs
-
GetDashboardGroup
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDashboardGroup(String dashboardID, String groupID) throws Exception - Service Category:
- Dashboards
- Service Description:
- Load a dashboard group.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRING- Returns:
- result Dashboard group definition - INFOTABLE - Aspects {dataShape:DashboardGroup}
- Throws:
Exception
- If an error occurs
-
RenameDashboard
@ThingworxExtensionApiMethod(since={6,6}) public void RenameDashboard(String dashboardID, String title) throws Exception - Service Category:
- Dashboards
- Service Description:
- Rename a dashboard.
- Parameters:
dashboardID
- Dashboard ID - STRINGtitle
- Dashboard title - STRING- Throws:
Exception
- If an error occurs
-
RenameDashboardGroup
@ThingworxExtensionApiMethod(since={6,6}) public void RenameDashboardGroup(String dashboardID, String groupID, String title) throws Exception - Service Category:
- Dashboards
- Service Description:
- Rename a dashboard group.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRINGtitle
- Dashboard group title - STRING- Throws:
Exception
- If an error occurs
-
RenameDashboardItem
@ThingworxExtensionApiMethod(since={6,6}) public void RenameDashboardItem(String dashboardID, String groupID, String itemID, String title) throws Exception - Service Category:
- Dashboards
- Service Description:
- Rename a dashboard item.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRINGitemID
- Dashboard group ID - STRINGtitle
- Dashboard group title - STRING- Throws:
Exception
- If an error occurs
-
EditDashboardItemConfig
@ThingworxExtensionApiMethod(since={6,6}) public void EditDashboardItemConfig(String dashboardID, String groupID, String itemID, InfoTable parameters) throws Exception - Service Category:
- Dashboards
- Service Description:
- Replace all existing config parameters for a dashboard item with new parameters.
- Parameters:
dashboardID
- - the guid that represents this DashboardgroupID
- - the id of the dashboard group that contains the dashboard itemitemID
- - the id of the dashboard item to updateparameters
- - an InfoTable containing the dashboard item parameters- Throws:
Exception
- If an error occurs
This service replaces the existing parameter collection with the provided parameters.
-
EditDashboardItemParameters
@ThingworxExtensionApiMethod(since={6,6}) public void EditDashboardItemParameters(String dashboardID, String groupID, String itemID, InfoTable parameters) throws Exception - Service Category:
- Dashboards
- Service Description:
- Updates or adds provided config parameters for a dashboard item.
- Parameters:
dashboardID
- - the guid that represents this DashboardgroupID
- - the id of the dashboard group that contains the dashboard itemitemID
- - the id of the dashboard item to updateparameters
- - an InfoTable containing the dashboard item parameters- Throws:
Exception
- If an error occurs
This service merges the provided parameters into the existing parameters.
-
GetDashboardGroupList
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDashboardGroupList(String dashboardID) throws Exception - Service Category:
- Dashboards
- Service Description:
- Load a list of dashboard groups.
- Parameters:
dashboardID
- Dashboard ID - STRING- Returns:
- result Dashboard group list - INFOTABLE - Aspects {dataShape:DashboardGroup}
- Throws:
Exception
- If an error occurs
-
RemoveDashboardGroup
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveDashboardGroup(String dashboardID, String groupID) throws Exception - Service Category:
- Dashboards
- Service Description:
- Remove a dashboard group.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRING- Throws:
Exception
- If an error occurs
-
MoveDashboardGroup
@ThingworxExtensionApiMethod(since={6,6}) public void MoveDashboardGroup(String dashboardID, String groupID, Integer sequence) throws Exception - Service Category:
- Dashboards
- Service Description:
- Move a dashboard group.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRINGsequence
- Dashboard item sequence - INTEGER- Throws:
Exception
- If an error occurs
-
AddDashboardItem
@ThingworxExtensionApiMethod(since={6,6}) public String AddDashboardItem(String dashboardID, String groupID, String title, String mashupName, InfoTable parameters, Integer sequence) throws Exception - Service Category:
- Dashboards
- Service Description:
- Add a dashboard item.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRINGtitle
- Dashboard item title - STRINGmashupName
- Dashboard item mashup name - MASHUPNAMEparameters
- Dashboard item mashup parameters - INFOTABLEsequence
- Dashboard item sequence - INTEGER- Returns:
- id Dashboard item id - STRING
- Throws:
Exception
- If an error occurs
-
GetDashboardItem
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDashboardItem(String dashboardID, String groupID, String itemID) throws Exception - Service Category:
- Dashboards
- Service Description:
- Load a dashboard item.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRINGitemID
- Dashboard item ID - STRING- Returns:
- result Dashboard item definition - INFOTABLE - Aspects {dataShape:DashboardItem}
- Throws:
Exception
- If an error occurs
-
GetDashboardItemConfig
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDashboardItemConfig(String dashboardID, String groupID, String itemID) throws Exception - Service Category:
- Dashboards
- Service Description:
- Load a dashboard items configuration parameters.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRINGitemID
- Dashboard item ID - STRING- Returns:
- result Dashboard item definition - INFOTABLE
- Throws:
Exception
- If an error occurs
-
GetDashboardItemParameters
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDashboardItemParameters(String dashboardID, String groupID, String itemID) throws Exception - Service Category:
- Dashboards
- Service Description:
- Load a dashboard items configuration parameters.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRINGitemID
- Dashboard item ID - STRING- Returns:
- result Dashboard item definition - INFOTABLE - Aspects {dataShape:DashboardItemParameter}
- Throws:
Exception
- If an error occurs
-
GetDashboardItemList
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDashboardItemList(String dashboardID, String groupID) throws Exception - Service Category:
- Dashboards
- Service Description:
- Load a list of dashboard items for a specific group.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRING- Returns:
- result Dashboard item list - INFOTABLE - Aspects {dataShape:DashboardItem}
- Throws:
Exception
- If an error occurs
-
RemoveDashboardItem
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveDashboardItem(String dashboardID, String groupID, String itemID) throws Exception - Service Category:
- Dashboards
- Service Description:
- Remove a dashboard item.
- Parameters:
dashboardID
- Dashboard ID - STRINGgroupID
- Dashboard group ID - STRINGitemID
- Dashboard item ID - STRING- Throws:
Exception
- If an error occurs
-
MoveDashboardItems
@ThingworxExtensionApiMethod(since={6,6}) public void MoveDashboardItems(String dashboardID, InfoTable changes) throws Exception - Service Category:
- Dashboards
- Service Description:
- Move dashboard items.
- Parameters:
dashboardID
- Dashboard ID - STRINGchanges
- Dashboard item changes - INFOTABLE- Throws:
Exception
- If an error occurs
-
GetDashboardsForCurrentUser
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetDashboardsForCurrentUser() throws Exception- Service Category:
- Dashboards
- Service Description:
- Return a list of dashboards for the current user.
- Returns:
- result List of dashboards - INFOTABLE - Aspects {dataShape:DashboardList}
- Throws:
Exception
- If an error occurs
-
SearchAllDashboards
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable SearchAllDashboards(TagCollection tags) throws Exception - Service Category:
- Dashboards
- Service Description:
- Return a list of dashboards.
- Parameters:
tags
- Dashboard tags - TAGS- Returns:
- result List of dashboards - INFOTABLE - Aspects {dataShape:Dashboard}
- Throws:
Exception
- If an error occurs
-
SearchGadgets
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable SearchGadgets(TagCollection tags) throws Exception - Service Category:
- Dashboards
- Service Description:
- Return a list of gadgets.
- Parameters:
tags
- Tags - TAGS- Returns:
- result List of compatible mashups - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
Exception
- If an error occurs
-