com.thingworx.resources.dashboards

Class DashboardFunctions

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.entities.ExtensibleRootEntity

com.thingworx.resources.Resource

com.thingworx.resources.dashboards.DashboardFunctions

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<java.lang.String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, java.io.Serializable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class DashboardFunctions
extends Resource

See Also:

Serialized Form

Field Summary

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTIES

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
DashboardFunctions()

Method Summary

Modifier and Type	Method and Description
java.lang.String	AddDashboardGroup(java.lang.String dashboardID, java.lang.String title, java.lang.Integer sequence) Service Category: Dashboards Service Description: Add a dashboard group.
java.lang.String	AddDashboardItem(java.lang.String dashboardID, java.lang.String groupID, java.lang.String title, java.lang.String mashupName, InfoTable parameters, java.lang.Integer sequence) Service Category: Dashboards Service Description: Add a dashboard item.
java.lang.String	CreateDashboard(java.lang.String title, TagCollection tags) Service Category: Dashboards Service Description: Create a new dashboard.
void	DeleteDashboard(java.lang.String dashboardID) Service Category: Dashboards Service Description: Delete an dashboard.
void	EditDashboardItemConfig(java.lang.String dashboardID, java.lang.String groupID, java.lang.String itemID, InfoTable parameters) Service Category: Dashboards Service Description: Replace all existing config parameters for a dashboard item with new parameters.
void	EditDashboardItemParameters(java.lang.String dashboardID, java.lang.String groupID, java.lang.String itemID, InfoTable parameters) Service Category: Dashboards Service Description: Updates or adds provided config parameters for a dashboard item.
InfoTable	GetDashboard(java.lang.String dashboardID) Service Category: Dashboards Service Description: Load a dashboard.
InfoTable	GetDashboardByTitle(java.lang.String title) Service Category: Dashboards Service Description: Load a dashboard by title.
InfoTable	GetDashboardGroup(java.lang.String dashboardID, java.lang.String groupID) Service Category: Dashboards Service Description: Load a dashboard group.
InfoTable	GetDashboardGroupByTitle(java.lang.String dashboardID, java.lang.String title) Service Category: Dashboards Service Description: Load a dashboard group by title.
InfoTable	GetDashboardGroupList(java.lang.String dashboardID) Service Category: Dashboards Service Description: Load a list of dashboard groups.
InfoTable	GetDashboardItem(java.lang.String dashboardID, java.lang.String groupID, java.lang.String itemID) Service Category: Dashboards Service Description: Load a dashboard item.
InfoTable	GetDashboardItemConfig(java.lang.String dashboardID, java.lang.String groupID, java.lang.String itemID) Service Category: Dashboards Service Description: Load a dashboard items configuration parameters.
InfoTable	GetDashboardItemList(java.lang.String dashboardID, java.lang.String groupID) Service Category: Dashboards Service Description: Load a list of dashboard items for a specific group.
InfoTable	GetDashboardItemParameters(java.lang.String dashboardID, java.lang.String groupID, java.lang.String itemID) Service Category: Dashboards Service Description: Load a dashboard items configuration parameters.
InfoTable	GetDashboardsForCurrentUser() Service Category: Dashboards Service Description: Return a list of dashboards for the current user.
InfoTable	GetSharedOrganizationUnits(java.lang.String dashboardID) Service Category: Dashboards Service Description: Return a list of the organization units that are sharing a dashboard.
void	MoveDashboardGroup(java.lang.String dashboardID, java.lang.String groupID, java.lang.Integer sequence) Service Category: Dashboards Service Description: Move a dashboard group.
void	MoveDashboardItems(java.lang.String dashboardID, InfoTable changes) Service Category: Dashboards Service Description: Move dashboard items.
void	RemoveDashboardGroup(java.lang.String dashboardID, java.lang.String groupID) Service Category: Dashboards Service Description: Remove a dashboard group.
void	RemoveDashboardItem(java.lang.String dashboardID, java.lang.String groupID, java.lang.String itemID) Service Category: Dashboards Service Description: Remove a dashboard item.
void	RemoveSharedOrganizationUnit(java.lang.String dashboardID, java.lang.String name, java.lang.String type) Service Category: Dashboards Service Description: Remove the organization unit shared to the dashboard.
void	RenameDashboard(java.lang.String dashboardID, java.lang.String title) Service Category: Dashboards Service Description: Rename a dashboard.
void	RenameDashboardGroup(java.lang.String dashboardID, java.lang.String groupID, java.lang.String title) Service Category: Dashboards Service Description: Rename a dashboard group.
void	RenameDashboardItem(java.lang.String dashboardID, java.lang.String groupID, java.lang.String itemID, java.lang.String title) Service Category: Dashboards Service Description: Rename a dashboard item.
InfoTable	SearchAllDashboards(TagCollection tags) Service Category: Dashboards Service Description: Return a list of dashboards.
InfoTable	SearchGadgets(TagCollection tags) Service Category: Dashboards Service Description: Return a list of gadgets.
void	ShareDashboard(java.lang.String dashboardID, java.lang.String name, java.lang.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, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, 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, 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, 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, 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.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

Constructor Detail

DashboardFunctions

public DashboardFunctions()

Method Detail

CreateDashboard

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String CreateDashboard(java.lang.String title,
                                                                                  TagCollection tags)
                                                                           throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Create a new dashboard.

Parameters:

title - Dashboard title - STRING

tags - Dashboard tags - TAGS

Returns:

id Dashboard id - STRING

Throws:

java.lang.Exception - If an error occurs

DeleteDashboard

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteDashboard(java.lang.String dashboardID)
                                                               throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Delete an dashboard.

Parameters:

dashboardID - Dashboard ID - DASHBOARDNAME

Throws:

java.lang.Exception - If an error occurs

GetDashboard

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDashboard(java.lang.String dashboardID)
                                                                 throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Load a dashboard.

Parameters:

dashboardID - Dashboard id - STRING

Returns:

result Dashboard definition - INFOTABLE - Aspects {dataShape:Dashboard}

Throws:

java.lang.Exception - If an error occurs

GetDashboardByTitle

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDashboardByTitle(java.lang.String title)
                                                                        throws java.lang.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:

java.lang.Exception - If an error occurs

GetDashboardGroupByTitle

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDashboardGroupByTitle(java.lang.String dashboardID,
                                                                                    java.lang.String title)
                                                                             throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Load a dashboard group by title.

Parameters:

dashboardID - Dashboard id - STRING

title - Dashboard title - STRING

Returns:

result Dashboard group - INFOTABLE - Aspects {dataShape:DashboardGroup}

Throws:

java.lang.Exception - If an error occurs

AddDashboardGroup

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String AddDashboardGroup(java.lang.String dashboardID,
                                                                                    java.lang.String title,
                                                                                    java.lang.Integer sequence)
                                                                             throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Add a dashboard group.

Parameters:

dashboardID - Dashboard ID - STRING

title - Dashboard group title - STRING

sequence - Dashboard group sequence - INTEGER

Returns:

id Dashboard group id - STRING

Throws:

java.lang.Exception - If an error occurs

GetDashboardGroup

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDashboardGroup(java.lang.String dashboardID,
                                                                             java.lang.String groupID)
                                                                      throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Load a dashboard group.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

Returns:

result Dashboard group definition - INFOTABLE - Aspects {dataShape:DashboardGroup}

Throws:

java.lang.Exception - If an error occurs

RenameDashboard

@ThingworxExtensionApiMethod(since={6,6})
public void RenameDashboard(java.lang.String dashboardID,
                                                                      java.lang.String title)
                                                               throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Rename a dashboard.

Parameters:

dashboardID - Dashboard ID - STRING

title - Dashboard title - STRING

Throws:

java.lang.Exception - If an error occurs

RenameDashboardGroup

@ThingworxExtensionApiMethod(since={6,6})
public void RenameDashboardGroup(java.lang.String dashboardID,
                                                                           java.lang.String groupID,
                                                                           java.lang.String title)
                                                                    throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Rename a dashboard group.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

title - Dashboard group title - STRING

Throws:

java.lang.Exception - If an error occurs

RenameDashboardItem

@ThingworxExtensionApiMethod(since={6,6})
public void RenameDashboardItem(java.lang.String dashboardID,
                                                                          java.lang.String groupID,
                                                                          java.lang.String itemID,
                                                                          java.lang.String title)
                                                                   throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Rename a dashboard item.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

itemID - Dashboard group ID - STRING

title - Dashboard group title - STRING

Throws:

java.lang.Exception - If an error occurs

EditDashboardItemConfig

@ThingworxExtensionApiMethod(since={6,6})
public void EditDashboardItemConfig(java.lang.String dashboardID,
                                                                              java.lang.String groupID,
                                                                              java.lang.String itemID,
                                                                              InfoTable parameters)
                                                                       throws java.lang.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 Dashboard

groupID - - the id of the dashboard group that contains the dashboard item

itemID - - the id of the dashboard item to update

parameters - - an InfoTable containing the dashboard item parameters

Throws:

java.lang.Exception - If an error occurs

This service replaces the existing parameter collection with the provided parameters.

EditDashboardItemParameters

@ThingworxExtensionApiMethod(since={6,6})
public void EditDashboardItemParameters(java.lang.String dashboardID,
                                                                                  java.lang.String groupID,
                                                                                  java.lang.String itemID,
                                                                                  InfoTable parameters)
                                                                           throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Updates or adds provided config parameters for a dashboard item.

Parameters:

dashboardID - - the guid that represents this Dashboard

groupID - - the id of the dashboard group that contains the dashboard item

itemID - - the id of the dashboard item to update

parameters - - an InfoTable containing the dashboard item parameters

Throws:

java.lang.Exception - If an error occurs

This service merges the provided parameters into the existing parameters.

GetDashboardGroupList

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDashboardGroupList(java.lang.String dashboardID)
                                                                          throws java.lang.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:

java.lang.Exception - If an error occurs

RemoveDashboardGroup

@ThingworxExtensionApiMethod(since={6,6})
public void RemoveDashboardGroup(java.lang.String dashboardID,
                                                                           java.lang.String groupID)
                                                                    throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Remove a dashboard group.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

Throws:

java.lang.Exception - If an error occurs

MoveDashboardGroup

@ThingworxExtensionApiMethod(since={6,6})
public void MoveDashboardGroup(java.lang.String dashboardID,
                                                                         java.lang.String groupID,
                                                                         java.lang.Integer sequence)
                                                                  throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Move a dashboard group.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

sequence - Dashboard item sequence - INTEGER

Throws:

java.lang.Exception - If an error occurs

AddDashboardItem

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String AddDashboardItem(java.lang.String dashboardID,
                                                                                   java.lang.String groupID,
                                                                                   java.lang.String title,
                                                                                   java.lang.String mashupName,
                                                                                   InfoTable parameters,
                                                                                   java.lang.Integer sequence)
                                                                            throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Add a dashboard item.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

title - Dashboard item title - STRING

mashupName - Dashboard item mashup name - MASHUPNAME

parameters - Dashboard item mashup parameters - INFOTABLE

sequence - Dashboard item sequence - INTEGER

Returns:

id Dashboard item id - STRING

Throws:

java.lang.Exception - If an error occurs

GetDashboardItem

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDashboardItem(java.lang.String dashboardID,
                                                                            java.lang.String groupID,
                                                                            java.lang.String itemID)
                                                                     throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Load a dashboard item.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

itemID - Dashboard item ID - STRING

Returns:

result Dashboard item definition - INFOTABLE - Aspects {dataShape:DashboardItem}

Throws:

java.lang.Exception - If an error occurs

GetDashboardItemConfig

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDashboardItemConfig(java.lang.String dashboardID,
                                                                                  java.lang.String groupID,
                                                                                  java.lang.String itemID)
                                                                           throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Load a dashboard items configuration parameters.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

itemID - Dashboard item ID - STRING

Returns:

result Dashboard item definition - INFOTABLE

Throws:

java.lang.Exception - If an error occurs

GetDashboardItemParameters

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDashboardItemParameters(java.lang.String dashboardID,
                                                                                      java.lang.String groupID,
                                                                                      java.lang.String itemID)
                                                                               throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Load a dashboard items configuration parameters.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

itemID - Dashboard item ID - STRING

Returns:

result Dashboard item definition - INFOTABLE - Aspects {dataShape:DashboardItemParameter}

Throws:

java.lang.Exception - If an error occurs

GetDashboardItemList

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDashboardItemList(java.lang.String dashboardID,
                                                                                java.lang.String groupID)
                                                                         throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Load a list of dashboard items for a specific group.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

Returns:

result Dashboard item list - INFOTABLE - Aspects {dataShape:DashboardItem}

Throws:

java.lang.Exception - If an error occurs

RemoveDashboardItem

@ThingworxExtensionApiMethod(since={6,6})
public void RemoveDashboardItem(java.lang.String dashboardID,
                                                                          java.lang.String groupID,
                                                                          java.lang.String itemID)
                                                                   throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Remove a dashboard item.

Parameters:

dashboardID - Dashboard ID - STRING

groupID - Dashboard group ID - STRING

itemID - Dashboard item ID - STRING

Throws:

java.lang.Exception - If an error occurs

MoveDashboardItems

@ThingworxExtensionApiMethod(since={6,6})
public void MoveDashboardItems(java.lang.String dashboardID,
                                                                         InfoTable changes)
                                                                  throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Move dashboard items.

Parameters:

dashboardID - Dashboard ID - STRING

changes - Dashboard item changes - INFOTABLE

Throws:

java.lang.Exception - If an error occurs

GetDashboardsForCurrentUser

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetDashboardsForCurrentUser()
                                                                                throws java.lang.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:

java.lang.Exception - If an error occurs

ShareDashboard

@ThingworxExtensionApiMethod(since={6,6})
public void ShareDashboard(java.lang.String dashboardID,
                                                                     java.lang.String name,
                                                                     java.lang.String type)
                                                              throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Shares an existing Dashboard with another organizational unit within that Organization.

Parameters:

dashboardID - - the guid that represents this Dashboard

name - - the name of the OrganizationalUnit to share the Dashboard with

type - - entity type to share the Dashboard with. Currently on OrganizationalUnit is supported

Throws:

java.lang.Exception - If an error occurs

Shares an existing Dashboard with another OrganizationalUnit. Sharing simply adds Visibility Permissions to the Dashboard for the OrganizationalUnit being shared to.

Only members of the Administrators Group and Owners of the provided Dashboard are allowed to share a Dashboard. Sharing is only permitted to other OrganizationalUnits within an Organization that the Owner is a part of, unless the caller is an Administrator.

GetSharedOrganizationUnits

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetSharedOrganizationUnits(java.lang.String dashboardID)
                                                                               throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Return a list of the organization units that are sharing a dashboard.

Parameters:

dashboardID - Dashboard ID - DASHBOARDNAME

Returns:

result List of organization units that are shared to the dashboard. If the user is a member of the organization it will contain a membership field value set to true. - INFOTABLE

Throws:

java.lang.Exception - If an error occurs

RemoveSharedOrganizationUnit

@ThingworxExtensionApiMethod(since={6,6})
public void RemoveSharedOrganizationUnit(java.lang.String dashboardID,
                                                                                   java.lang.String name,
                                                                                   java.lang.String type)
                                                                            throws java.lang.Exception

Service Category:

Dashboards

Service Description:

Remove the organization unit shared to the dashboard.

Parameters:

dashboardID - Dashboard ID - DASHBOARDNAME

name - Name of entity to organization to remove - STRING

type - Type of entity to organization to remove - STRING

Throws:

java.lang.Exception - If an error occurs

SearchAllDashboards

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchAllDashboards(TagCollection tags)
                                                                        throws java.lang.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:

java.lang.Exception - If an error occurs

SearchGadgets

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchGadgets(TagCollection tags)
                                                                  throws java.lang.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:

java.lang.Exception - If an error occurs