Package com.thingworx.resources.devices

Class DeviceFunctions

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.devices.DeviceFunctions
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 DeviceFunctions extends Resource
See Also:

  • Constructor Details

    • DeviceFunctions

      public DeviceFunctions()

  • Method Details

    • SearchDevices

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable SearchDevices(org.json.JSONObject query, String nameMask, String thingShape, String thingTemplate, Double maxItems) throws Exception
      Service Category:
      Queries
      Service Description:
      Retrieve a list of Devices that match the options specified.
      Parameters:
      query - Query definition - QUERY
      nameMask - Name pattern - STRING
      thingShape - Filter only for devices that implement this shape - THINGSHAPENAME
      thingTemplate - Filter only for devices that are derived from this template - THINGTEMPLATENAME
      maxItems - Maximum number of items to return - NUMBER
      Returns:
      result Matching Devices - INFOTABLE - Aspects {dataShape:DeviceStatus}
      Throws:
      Exception - If an error occurs

    • SearchDevicesV2

      @ThingworxExtensionApiMethod(since={9,4}) public InfoTable SearchDevicesV2(org.json.JSONObject query, String nameMask, String thingShape, String thingTemplate, Double maxItems) throws Exception
      Service Category:
      Queries
      Service Description:
      Retrieve a list of Devices that match the options specified.
      Parameters:
      query - Query definition - QUERY
      nameMask - Name pattern - STRING
      thingShape - Filter only for devices that implement this shape - THINGSHAPENAME
      thingTemplate - Filter only for devices that are derived from this template - THINGTEMPLATENAME
      maxItems - Maximum number of items to return - NUMBER
      Returns:
      result Matching Devices - INFOTABLE - Aspects {dataShape:DeviceStatusV2}
      Throws:
      Exception - If an error occurs

    • SearchDevicesV3

      @ThingworxExtensionApiMethod(since={9,7}) public InfoTable SearchDevicesV3(org.json.JSONObject query, String nameMask, String thingShape, String thingTemplate, Double maxItems) throws Exception
      Service Category:
      Queries
      Service Description:
      Retrieve a list of Devices that match the options specified.
      Parameters:
      query - Query definition - QUERY
      nameMask - Name pattern - STRING
      thingShape - Filter only for devices that implement this shape - THINGSHAPENAME
      thingTemplate - Filter only for devices that are derived from this template - THINGTEMPLATENAME
      maxItems - Maximum number of items to return - NUMBER
      Returns:
      result Matching Devices - INFOTABLE - Aspects {dataShape:DeviceStatusV3}
      Throws:
      Exception - If an error occurs

    • GetUnboundRemoteThings

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetUnboundRemoteThings(Double maxItems) throws Exception
      Service Category:
      Bindings
      Service Description:
      Get unbound remote things.
      Parameters:
      maxItems - Maximum number of items to return - NUMBER
      Returns:
      result Unbound remote things - INFOTABLE - Aspects {dataShape:BoundName}
      Throws:
      Exception - If an error occurs

    • GetUnboundIdentifiers

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetUnboundIdentifiers(Double maxItems) throws Exception
      Service Category:
      Bindings
      Service Description:
      Get unbound identifiers.
      Parameters:
      maxItems - Maximum number of items to return - NUMBER
      Returns:
      result Unbound remote things with identifiers - INFOTABLE - Aspects {dataShape:EntityList}
      Throws:
      Exception - If an error occurs

    • GetBoundRemoteThings

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetBoundRemoteThings(Double maxItems) throws Exception
      Service Category:
      Bindings
      Service Description:
      Get bound remote things.
      Parameters:
      maxItems - Maximum number of items to return - NUMBER
      Returns:
      result Bound remote things - INFOTABLE - Aspects {dataShape:DeviceStatus}
      Throws:
      Exception - If an error occurs

    • GetUnboundThingsForFederatedServer

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetUnboundThingsForFederatedServer(String name, Double maxItems) throws Exception
      Service Category:
      Federation
      Service Description:
      Get unbound federated things.
      Parameters:
      name - Federated server name - THINGNAME
      maxItems - Maximum number of items to return - NUMBER
      Returns:
      result Unbound federated things - INFOTABLE - Aspects {dataShape:EntityList}
      Throws:
      Exception - If an error occurs

    • GetBoundThingsForFederatedServer

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetBoundThingsForFederatedServer(String name, Double maxItems) throws Exception
      Service Category:
      Federation
      Service Description:
      Get bound federated things.
      Parameters:
      name - Federated server name - THINGNAME
      maxItems - Maximum number of items to return - NUMBER
      Returns:
      result Bound federated things - INFOTABLE - Aspects {dataShape:DeviceStatus}
      Throws:
      Exception - If an error occurs