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:
  • 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 - STRING
      tags - 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 - STRING
      title - 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 - STRING
      title - Dashboard group title - STRING
      sequence - 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 - STRING
      groupID - 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 - STRING
      title - 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 - STRING
      groupID - Dashboard group ID - STRING
      title - 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 - STRING
      groupID - Dashboard group ID - STRING
      itemID - Dashboard group ID - STRING
      title - 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 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:
      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 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:
      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 - STRING
      groupID - 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 - STRING
      groupID - Dashboard group ID - STRING
      sequence - 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 - 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:
      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 - STRING
      groupID - Dashboard group ID - STRING
      itemID - 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 - STRING
      groupID - Dashboard group ID - STRING
      itemID - 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 - STRING
      groupID - Dashboard group ID - STRING
      itemID - 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 - STRING
      groupID - 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 - STRING
      groupID - Dashboard group ID - STRING
      itemID - 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 - STRING
      changes - 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
    • ShareDashboard

      @ThingworxExtensionApiMethod(since={6,6}) public void ShareDashboard(String dashboardID, String name, String type) throws 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:
      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(String dashboardID) throws 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:
      Exception - If an error occurs
    • RemoveSharedOrganizationUnit

      @ThingworxExtensionApiMethod(since={6,6}) public void RemoveSharedOrganizationUnit(String dashboardID, String name, String type) throws 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:
      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