Package com.thingworx.thingshape

Class ThingShape

java.lang.Object
com.thingworx.types.NamedObject
com.thingworx.persistence.common.PersistableNamedObject
com.thingworx.entities.RootEntity
com.thingworx.entities.ServiceProviderEntity
com.thingworx.thingshape.ThingShape
All Implemented Interfaces:
ISupportsAccessModifier, IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAlertProvider, IAvatar, IEntityLifeCycleEvent, IEventMetadataProvider, IPersistable, IServiceMetadataProvider, IServiceProvider, IShapeProvider, ITaggableObject, IDependencyScannableObject, IHierarchicalEntity, IImplementableEntity, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IInstanceRunTimeSecurable, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable
@ThingworxExtensionApiClass(since={6,6}, canInstantiate=true) public class ThingShape extends ServiceProviderEntity implements IInstanceRunTimeSecurable, IImplementableEntity, IShapeProvider, IAlertProvider, IEventMetadataProvider, IServiceMetadataProvider, IHierarchicalEntity, ISupportsAccessModifier
See Also:

  • Constructor Details Link icon

    • ThingShape Link icon

      public ThingShape()

  • Method Details Link icon

    • getEffectivePropertyDefinition Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public PropertyDefinition getEffectivePropertyDefinition(String propertyName)
      Specified by:
      getEffectivePropertyDefinition in interface IAlertProvider

    • getEffectiveEventDefinition Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public EventDefinition getEffectiveEventDefinition(String eventName)
      Specified by:
      getEffectiveEventDefinition in interface IEventMetadataProvider

    • getEffectiveServiceDefinition Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public ServiceDefinition getEffectiveServiceDefinition(String eventName)
      Specified by:
      getEffectiveServiceDefinition in interface IServiceMetadataProvider

    • getInstanceShape Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public ThingShapeInstance getInstanceShape()
      Specified by:
      getInstanceShape in interface IShapeProvider

    • getEffectiveAlertConfiguration Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public AlertConfigurationCollection getEffectiveAlertConfiguration()
      Specified by:
      getEffectiveAlertConfiguration in interface IAlertProvider

    • getAlertConfigurations Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public AlertConfigurationCollection getAlertConfigurations()
      Specified by:
      getAlertConfigurations in interface IAlertProvider

    • QueryImplementingThings Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable QueryImplementingThings(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query) throws Exception
      Service Category:
      Queries
      Service Description:
      Return a list of all the things that implement this shape.
      Specified by:
      QueryImplementingThings in interface IImplementableEntity
      Parameters:
      maxItems - Maximum number of items to return - NUMBER
      tags - Tags to search on - TAGS
      nameMask - Name pattern - STRING
      query - Query definition - QUERY
      Returns:
      result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityList}
      Throws:
      Exception - If an error occurs

    • QueryImplementingThingsWithData Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable QueryImplementingThingsWithData(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query) throws Exception
      Service Category:
      Queries
      Service Description:
      Return a list of all the things that implement this shape along with the thing properties and values.
      Specified by:
      QueryImplementingThingsWithData in interface IImplementableEntity
      Parameters:
      maxItems - Maximum number of items to return - NUMBER
      tags - Tags to search on - TAGS
      nameMask - Name pattern - STRING
      query - Query definition - QUERY
      Returns:
      result Implementing Things With Data - INFOTABLE - Aspects {dataShape:RootEntityList}
      Throws:
      Exception - If an error occurs

    • QueryImplementingThingsWithNamedData Link icon

      @ThingworxExtensionApiMethod(since={8,1}) public InfoTable QueryImplementingThingsWithNamedData(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, InfoTable basicPropertyNames, InfoTable propertyNames) throws Exception
      Service Category:
      Queries
      Service Description:
      Returns a list containing the specific properties and values of all the Things that Implement this Shape.
      Specified by:
      QueryImplementingThingsWithNamedData in interface IImplementableEntity
      Parameters:
      maxItems - Maximum number of items to return - NUMBER
      tags - Tags to search on - TAGS
      nameMask - Name pattern - STRING
      query - Query definition - QUERY
      basicPropertyNames - Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLE
      propertyNames - Include Specific properties of this Shape - INFOTABLE
      Returns:
      result Implementing Things With Named Data - INFOTABLE - Aspects {dataShape:RootEntityList}
      Throws:
      Exception - If an error occurs

    • GetImplementingThings Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetImplementingThings() throws Exception
      Service Category:
      Queries
      Service Description:
      Return a list of all the things that implement this shape.
      Specified by:
      GetImplementingThings in interface IImplementableEntity
      Returns:
      result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityList}
      Throws:
      Exception - If an error occurs

    • GetImplementingThingsWithData Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetImplementingThingsWithData() throws Exception
      Service Category:
      Queries
      Service Description:
      Return a list of all the things that implement this shape along with the thing properties and values.
      Specified by:
      GetImplementingThingsWithData in interface IImplementableEntity
      Returns:
      result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityList}
      Throws:
      Exception - If an error occurs

    • GetInstancePropertyDefinitions Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetInstancePropertyDefinitions(String type) throws Exception
      Service Category:
      Metadata
      Service Description:
      Get the current property definitions for this thing.
      Parameters:
      type - Type to filter on - STRING
      Returns:
      result Property values - INFOTABLE - Aspects {dataShape:PropertyDefinition}
      Throws:
      Exception - If an error occurs

    • GetInstanceEventDefinitions Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetInstanceEventDefinitions() throws Exception
      Service Category:
      Metadata
      Service Description:
      Get the current event definitions for this thing.
      Returns:
      result Event definitions - INFOTABLE - Aspects {dataShape:EventDefinition}
      Throws:
      Exception - If an error occurs

    • GetInstanceServiceDefinitions Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetInstanceServiceDefinitions() throws Exception
      Service Category:
      Metadata
      Service Description:
      Get the current service definitions for this thing.
      Returns:
      result Service definitions - INFOTABLE - Aspects {dataShape:ServiceDefinition}
      Throws:
      Exception - If an error occurs

    • GetPropertyLogging Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public Boolean GetPropertyLogging(String propertyName) throws Exception
      Service Category:
      DataLogging
      Service Description:
      Get property logging status for a specific property.
      Parameters:
      propertyName - Property name - STRING
      Returns:
      status Property logging status - BOOLEAN
      Throws:
      Exception - If an error occurs

    • SetPropertyLogging Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void SetPropertyLogging(String propertyName, Boolean enabled) throws Exception
      Service Category:
      DataLogging
      Service Description:
      Set property logging status for a specific property.
      Parameters:
      propertyName - Property name - STRING
      enabled - Enable/disable logging - BOOLEAN
      Throws:
      Exception - If an error occurs

    • SetUnitsForNumericPropertyDefinition Link icon

      @ThingworxExtensionApiMethod(since={8,5}) public void SetUnitsForNumericPropertyDefinition(String propertyName, String units) throws Exception
      Service Category:
      Metadata
      Service Description:
      Set the additional information for units for a specific Long, Integer, or Number property.
      Parameters:
      propertyName - Property name - STRING
      units - Units (eg. lbs, F, inches, etc.) associated with input. For information only. - STRING
      Throws:
      Exception - If an error occurs

    • AddPropertyTransformDefinition Link icon

      @ThingworxExtensionApiMethod(since={8,4}) public void AddPropertyTransformDefinition(String name, String description, String category, Boolean persistent, Boolean logged, Integer timeout, InfoTable propertyTransformConfig) throws Exception
      Service Category:
      Metadata
      Service Description:
      Add a property transform definition.
      Parameters:
      name - - The name of your new derived property.
      description - - The description of the new property.
      category - - Category for the new property.
      persistent - - Should the value of this derived property be persisted between tomcat restarts?
      logged - - Should the value of this derived property be logged over time?
      timeout - - Timeout for creating the property.
      propertyTransformConfig - - A configuration infotable consisting of key/value pairs. Refer to the help center for possible keys.
      Throws:
      Exception - If an error occurs

      Creates a derived property on this ThingShape. A derived property receives data from a specified source property, and performs some requested calculation on the stream of data as the source property changes. The type of calculation will determine which configuration keys/values need to be set on the derivedPropertyConfig.

      Note: In order to use the derived property functionality, you must have a RabbitMQ instance, Flink cluster, and "derived property configuration service" running on your machine, as well as the necessary configuration set inside your platform-settings.json file.

      For more information on running derived properties, please refer to the help center docs on derived properties.

    • AddPropertyDefinition Link icon

      @ThingworxExtensionApiMethod(since={6,6}) @Deprecated public void AddPropertyDefinition(String name, String description, String type, String category, String dataShape, Boolean readOnly, Boolean persistent, Boolean logged, String dataChangeType, Double dataChangeThreshold, Boolean remote, String remotePropertyName, Integer timeout, String pushType, Double pushThreshold, String defaultValue) throws Exception
      Deprecated.
      As of release 8.0, replaced by AddPropertyDefinition(String, String, String, String, String, Boolean, Boolean, Boolean, String, Double, Boolean, String, Integer, String, Double, String, JSONObject)
      Throws:
      Exception - If an error occurs

    • AddPropertyDefinition Link icon

      @ThingworxExtensionApiMethod(since={8,0}, deprecatedSince={9,3}) @Deprecated public void AddPropertyDefinition(String name, String description, String type, String category, String dataShape, Boolean readOnly, Boolean persistent, Boolean logged, String dataChangeType, Double dataChangeThreshold, Boolean remote, String remotePropertyName, Integer timeout, String pushType, Double pushThreshold, String defaultValue, org.json.JSONObject remoteBindingAspects) throws Exception
      Deprecated.
      Throws:
      Exception - If an error occurs

    • AddPropertyDefinition Link icon

      @ThingworxExtensionApiMethod(since={8,0}, deprecatedSince={9,4}) @Deprecated public void AddPropertyDefinition(String name, String description, String type, String category, String dataShape, Boolean readOnly, Boolean persistent, Boolean logged, Boolean indexed, String dataChangeType, Double dataChangeThreshold, Boolean remote, String remotePropertyName, Integer timeout, String pushType, Double pushThreshold, String defaultValue, org.json.JSONObject remoteBindingAspects) throws Exception
      Deprecated.
      Throws:
      Exception - If an error occurs

    • AddPropertyDefinition Link icon

      @ThingworxExtensionApiMethod(since={9,3}) public void AddPropertyDefinition(String name, String description, String type, String category, String dataShape, Boolean readOnly, Boolean persistent, Boolean logged, Boolean indexed, String dataChangeType, Double dataChangeThreshold, Boolean remote, String remotePropertyName, Integer timeout, String pushType, Double pushThreshold, String defaultValue, org.json.JSONObject remoteBindingAspects, org.json.JSONObject accessModifier) throws Exception
      Service Category:
      Metadata
      Service Description:
      Add a property definition.
      Parameters:
      name - Property name - STRING
      description - Property description - STRING
      type - Data type - BASETYPENAME
      category - Category - STRING
      dataShape - Data shape - DATASHAPENAME
      readOnly - Read only - BOOLEAN
      persistent - Persist property value - BOOLEAN
      logged - Log property value - BOOLEAN
      indexed - Index property value - BOOLEAN
      dataChangeType - Data change type - STRING
      dataChangeThreshold - Data change threshold - NUMBER
      remote - Is a remote property - BOOLEAN
      remotePropertyName - Remote property name - STRING
      timeout - Request timeout - INTEGER
      pushType - Push type - STRING
      pushThreshold - Push threshold - NUMBER
      defaultValue - Default value for property - STRING
      remoteBindingAspects - Aspects for the remote binding - JSON
      accessModifier - AccessModifier for propertyDefinition - JSON
      Throws:
      Exception - If an error occurs

    • AddServiceDefinition Link icon

      @ThingworxExtensionApiMethod(since={8,0}, deprecatedSince={9,4}) @Deprecated public void AddServiceDefinition(String name, String description, String category, InfoTable parameters, InfoTable resultType, Boolean remote, String remoteServiceName, Integer timeout) throws Exception
      Deprecated.
      Throws:
      Exception - If an error occurs

    • AddServiceDefinition Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void AddServiceDefinition(String name, String description, String category, InfoTable parameters, InfoTable resultType, Boolean remote, String remoteServiceName, Integer timeout, org.json.JSONObject accessModifier) throws Exception
      Service Category:
      Metadata
      Service Description:
      Add or update a service definition.
      Parameters:
      name - Property name - STRING
      description - Property description - STRING
      category - Category - STRING
      parameters - Service parameters - INFOTABLE
      resultType - Service result type - INFOTABLE
      remote - Is a remote service - BOOLEAN
      remoteServiceName - Remote service name - STRING
      timeout - Request timeout - INTEGER
      accessModifier - AccessModifier for serviceDefinition - JSON
      Throws:
      Exception - If an error occurs

    • AddEventDefinition Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void AddEventDefinition(String name, String description, String category, String dataShape, Boolean remote, String remoteEventName) throws Exception
      Service Category:
      Metadata
      Service Description:
      Add or update an event definition.
      Parameters:
      name - Property name - STRING
      description - Property description - STRING
      category - Category - STRING
      dataShape - Data shape - DATASHAPENAME
      remote - Is a remote service - BOOLEAN
      remoteEventName - Remote event name - STRING
      Throws:
      Exception - If an error occurs

    • DisableSubscription Link icon

      @Deprecated @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,0}) public void DisableSubscription(String thingName, String eventName, String propertyName) throws Exception
      Deprecated.
      Throws:
      Exception - If an error occurs

    • DisableSubscription Link icon

      @ThingworxExtensionApiMethod(since={9,0}) public void DisableSubscription(String subscriptionName) throws Exception
      Service Category:
      Subscriptions
      Service Description:
      Disable Subscription.
      Parameters:
      subscriptionName - Subscription name - STRING
      Throws:
      Exception - If an error occurs

    • EnableSubscription Link icon

      @Deprecated @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,0}) public void EnableSubscription(String thingName, String eventName, String propertyName) throws Exception
      Deprecated.
      Throws:
      Exception - If an error occurs

    • EnableSubscription Link icon

      @ThingworxExtensionApiMethod(since={9,0}) public void EnableSubscription(String subscriptionName) throws Exception
      Service Category:
      Subscriptions
      Service Description:
      Enable Subscription.
      Parameters:
      subscriptionName - Subscription name - STRING
      Throws:
      Exception - If an error occurs

    • RemovePropertyDefinition Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void RemovePropertyDefinition(String name) throws Exception
      Service Category:
      Metadata
      Service Description:
      Remove a property definition.
      Parameters:
      name - Property name - STRING
      Throws:
      Exception - If an error occurs

    • RemoveServiceDefinition Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void RemoveServiceDefinition(String name) throws Exception
      Service Category:
      Metadata
      Service Description:
      Remove a service definition.
      Parameters:
      name - Service name - STRING
      Throws:
      Exception - If an error occurs

    • RemoveEventDefinition Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void RemoveEventDefinition(String name) throws Exception
      Service Category:
      Metadata
      Service Description:
      Remove a event definition.
      Parameters:
      name - Event name - STRING
      Throws:
      Exception - If an error occurs

    • GetLoggedProperties Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetLoggedProperties(String type) throws Exception
      Service Category:
      Metadata
      Service Description:
      Get a list of logged properties for this thing.
      Parameters:
      type - Type to filter on - BASETYPENAME
      Returns:
      result Property names - INFOTABLE - Aspects {dataShape:PropertyDefinition}
      Throws:
      Exception - If an error occurs

    • GetNumericLoggedProperties Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetNumericLoggedProperties() throws Exception
      Service Category:
      Metadata
      Service Description:
      Get a list of logged properties for this thing that are of a numeric data type.
      Returns:
      result Property names - INFOTABLE - Aspects {dataShape:PropertyDefinition}
      Throws:
      Exception - If an error occurs

    • getEntityType Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public RelationshipTypes.ThingworxRelationshipTypes getEntityType()
      Description copied from class: RootEntity


      Returns the type of this entity.

      Specified by:
      getEntityType in interface IShapeProvider
      Specified by:
      getEntityType in class RootEntity
      Returns:
      the entity type

    • AddOrUpdateAlert Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void AddOrUpdateAlert(String property, String alertType, String alertName, String description, Boolean enabled, Integer priority, InfoTable attributes, Boolean persistent) throws Exception
      Service Category:
      Alerts
      Service Description:
      Add or update an alert for a property.
      Parameters:
      property - Property name - STRING
      alertType - Alert type - STRING
      alertName - Alert name - STRING
      description - Alert description - STRING
      enabled - Alert enabled - BOOLEAN
      priority - Alert priority - INTEGER
      attributes - Alert attributes - INFOTABLE
      persistent - Persist this change - BOOLEAN
      Throws:
      Exception - If an error occurs

    • RemoveAlert Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void RemoveAlert(String property, String alertName, Boolean persistent) throws Exception
      Service Category:
      Alerts
      Service Description:
      Remove an alert for a property.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      persistent - Persist this change - BOOLEAN
      Throws:
      Exception - If an error occurs

    • GetLocalAlertDefinitions Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetLocalAlertDefinitions(String property) throws Exception
      Service Category:
      Alerts
      Service Description:
      Get local alert definitions for a property.
      Parameters:
      property - Property name - STRING
      Returns:
      AlertDefinitions Alert definition - INFOTABLE - Aspects {dataShape:AlertDefinition}
      Throws:
      Exception - If an error occurs

    • GetAlertDefinitions Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetAlertDefinitions(String property) throws Exception
      Service Category:
      Alerts
      Service Description:
      Get effective alert definitions for a property.
      Parameters:
      property - Property name - STRING
      Returns:
      AlertDefinitions Alert definition - INFOTABLE - Aspects {dataShape:AlertDefinition}
      Throws:
      Exception - If an error occurs

    • GetAlertDefinition Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetAlertDefinition(String property, String alertName) throws Exception
      Service Category:
      Alerts
      Service Description:
      Get alert definition for a property.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      Returns:
      AlertDefinitions Alert definition - INFOTABLE - Aspects {dataShape:AlertDefinition}
      Throws:
      Exception - If an error occurs

    • HasAlert Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public Boolean HasAlert(String property, String alertName) throws Exception
      Service Category:
      Alerts
      Service Description:
      Check to see if an alert is defined for a property.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      Returns:
      result Has alert definition - BOOLEAN
      Throws:
      Exception - If an error occurs

    • SetNumberAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void SetNumberAlertParameter(String property, String alertName, String parameterName, Double value, Boolean persistent) throws Exception
      Service Category:
      Alerts
      Service Description:
      Set a numeric alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      value - Parameter value - NUMBER
      persistent - Make it persistent - BOOLEAN
      Throws:
      Exception - If an error occurs

    • GetNumberAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public Double GetNumberAlertParameter(String property, String alertName, String parameterName) throws Exception
      Service Category:
      Alerts
      Service Description:
      Get a numeric alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      Returns:
      value Alert parameter value - NUMBER
      Throws:
      Exception - If an error occurs

    • SetIntegerAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void SetIntegerAlertParameter(String property, String alertName, String parameterName, Integer value, Boolean persistent) throws Exception
      Service Category:
      Alerts
      Service Description:
      Set a numeric alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      value - Parameter value - INTEGER
      persistent - Make it persistent - BOOLEAN
      Throws:
      Exception - If an error occurs

    • GetIntegerAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public Integer GetIntegerAlertParameter(String property, String alertName, String parameterName) throws Exception
      Service Category:
      Alerts
      Service Description:
      Get a numeric alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      Returns:
      value Alert parameter value - INTEGER
      Throws:
      Exception - If an error occurs

    • GetLongAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public Long GetLongAlertParameter(String property, String alertName, String parameterName) throws Exception
      Service Category:
      Alerts
      Service Description:
      Get a numeric alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      Returns:
      value Alert parameter value - LONG
      Throws:
      Exception - If an error occurs

    • SetBooleanAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void SetBooleanAlertParameter(String property, String alertName, String parameterName, Boolean value, Boolean persistent) throws Exception
      Service Category:
      Alerts
      Service Description:
      Set a boolean alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      value - Parameter value - BOOLEAN
      persistent - Make it persistent - BOOLEAN
      Throws:
      Exception - If an error occurs

    • GetBooleanAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public Boolean GetBooleanAlertParameter(String property, String alertName, String parameterName) throws Exception
      Service Category:
      Alerts
      Service Description:
      Get a boolean alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      Returns:
      value Alert parameter value - BOOLEAN
      Throws:
      Exception - If an error occurs

    • SetDateTimeAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void SetDateTimeAlertParameter(String property, String alertName, String parameterName, org.joda.time.DateTime value, Boolean persistent) throws Exception
      Service Category:
      Alerts
      Service Description:
      Set a date alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      value - Parameter value - DATETIME
      persistent - Make it persistent - BOOLEAN
      Throws:
      Exception - If an error occurs

    • GetDateTimeAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public org.joda.time.DateTime GetDateTimeAlertParameter(String property, String alertName, String parameterName) throws Exception
      Service Category:
      Alerts
      Service Description:
      Get a date alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      Returns:
      value Alert parameter value - DATETIME
      Throws:
      Exception - If an error occurs

    • SetLocationAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void SetLocationAlertParameter(String property, String alertName, String parameterName, Location value, Boolean persistent) throws Exception
      Service Category:
      Alerts
      Service Description:
      Set a location alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      value - Parameter value - LOCATION
      persistent - Make it persistent - BOOLEAN
      Throws:
      Exception - If an error occurs

    • GetLocationAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public Location GetLocationAlertParameter(String property, String alertName, String parameterName) throws Exception
      Service Category:
      Alerts
      Service Description:
      Get a location alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      Returns:
      value Alert parameter value - LOCATION
      Throws:
      Exception - If an error occurs

    • SetStringAlertParameter Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void SetStringAlertParameter(String property, String alertName, String parameterName, String value, Boolean persistent) throws Exception
      Service Category:
      Alerts
      Service Description:
      Set a string alert parameter.
      Parameters:
      property - Property name - STRING
      alertName - Alert name - STRING
      parameterName - Parameter name - STRING
      value - Parameter value - STRING
      persistent - Make it persistent - BOOLEAN
      Throws:
      Exception - If an error occurs

    • GetLocalPropertyBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetLocalPropertyBinding(String propertyName) throws Exception
      Service Category:
      Bindings
      Service Description:
      Get the property binding for a property.
      Parameters:
      propertyName - Property name - STRING
      Returns:
      result Property binding - INFOTABLE - Aspects {dataShape:LocalPropertyBinding}
      Throws:
      Exception - If an error occurs

    • GetEffectiveLocalPropertyBinding Link icon

      @ThingworxExtensionApiMethod(since={7,3}) public InfoTable GetEffectiveLocalPropertyBinding(String propertyName) throws Exception
      Service Category:
      Bindings
      Service Description:
      Get the effective local property binding for a property.


      Get the effective (inherited and local) property binding for a property
      Parameters:
      propertyName - : name of property to get the local binding
      Returns:
      InfoTable of local property bindings consists of property name, name of thing(sourceThingName) and name of property(sourceName) the property is locally bound to.
      Throws:
      Exception

    • GetEffectiveLocalPropertyBindings Link icon

      @ThingworxExtensionApiMethod(since={7,3}) public InfoTable GetEffectiveLocalPropertyBindings() throws Exception
      Service Category:
      Bindings
      Service Description:
      Get the effective local property bindings.


      Get all effective (inherited and local) property bindings for this thing
      Returns:
      InfoTable of local property bindings consists of property name, name of thing(sourceThingName) and name of property(sourceName) the property is locally bound to.
      Throws:
      Exception

    • RemoveLocalPropertyBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void RemoveLocalPropertyBinding(String propertyName) throws Exception
      Service Category:
      Bindings
      Service Description:
      Remove the local property binding for a property.
      Parameters:
      propertyName - Property name - STRING
      Throws:
      Exception - If an error occurs

    • SetLocalPropertyBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) @Deprecated public void SetLocalPropertyBinding(String propertyName, String sourceThingName, String sourcePropertyName) throws Exception
      Deprecated.
      As of release 8.1.0, replaced by SetLocalPropertyBinding(String, String, String, JSONObject)
      Throws:
      Exception - If an error occurs

    • SetLocalPropertyBinding Link icon

      @ThingworxExtensionApiMethod(since={8,1,0}) public void SetLocalPropertyBinding(String propertyName, String sourceThingName, String sourcePropertyName, org.json.JSONObject aspects) throws Exception
      Service Category:
      Bindings
      Service Description:
      Set the property binding for a property.
      Parameters:
      propertyName - Property name - STRING
      sourceThingName - Thing name to bind to - STRING
      sourcePropertyName - Source property name - STRING
      aspects - Aspects for the local binding - JSON
      Throws:
      Exception - If an error occurs

    • GetRemotePropertyBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetRemotePropertyBinding(String propertyName) throws Exception
      Service Category:
      Bindings
      Service Description:
      Get the remote property binding for a property.
      Parameters:
      propertyName - Property name - STRING
      Returns:
      result Property binding - INFOTABLE - Aspects {dataShape:RemotePropertyBinding}
      Throws:
      Exception - If an error occurs

    • RemoveRemotePropertyBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void RemoveRemotePropertyBinding(String propertyName) throws Exception
      Service Category:
      Bindings
      Service Description:
      Remove the remote property binding for a property.
      Parameters:
      propertyName - Property name - STRING
      Throws:
      Exception - If an error occurs

    • SetRemotePropertyBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) @Deprecated public void SetRemotePropertyBinding(String propertyName, String sourcePropertyName, Integer timeout, String pushType, Double pushThreshold) throws Exception
      Deprecated.
      As of release 8.0.0, replaced by SetRemotePropertyBinding(String, String, Integer, String, Double, JSONObject, Integer, String)
      Throws:
      Exception - If an error occurs

    • SetRemotePropertyBinding Link icon

      @ThingworxExtensionApiMethod(since={8,0}) public void SetRemotePropertyBinding(String propertyName, String sourcePropertyName, Integer timeout, String pushType, Double pushThreshold, org.json.JSONObject aspects, Integer cacheTime, String foldType) throws Exception
      Service Category:
      Bindings
      Service Description:
      Set the remote property binding for a property.
      Parameters:
      propertyName - Property name - STRING
      sourcePropertyName - Source property name - STRING
      timeout - Request timeout - INTEGER
      pushType - Push type - STRING
      pushThreshold - Push threshold - NUMBER
      aspects - Aspects for the remote binding - JSON
      cacheTime - Property's cache time value at the server - INTEGER
      foldType - How a remote property's value should be handled by the server when a connection is lost - STRING
      Throws:
      Exception - If an error occurs

    • GetRemoteServiceBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetRemoteServiceBinding(String serviceName) throws Exception
      Service Category:
      Bindings
      Service Description:
      Get the remote service binding for a service.
      Parameters:
      serviceName - Service name - STRING
      Returns:
      result Service binding - INFOTABLE - Aspects {dataShape:RemoteServiceBinding}
      Throws:
      Exception - If an error occurs

    • RemoveRemoteServiceBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void RemoveRemoteServiceBinding(String serviceName) throws Exception
      Service Category:
      Bindings
      Service Description:
      Remove the remote service binding for a service.
      Parameters:
      serviceName - Service name - STRING
      Throws:
      Exception - If an error occurs

    • SetRemoteServiceBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void SetRemoteServiceBinding(String serviceName, String sourceServiceName, Integer timeout) throws Exception
      Service Category:
      Bindings
      Service Description:
      Set the remote service binding for a service.
      Parameters:
      serviceName - Service name - STRING
      sourceServiceName - Source service name - STRING
      timeout - Request timeout - INTEGER
      Throws:
      Exception - If an error occurs

    • GetRemoteEventBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetRemoteEventBinding(String eventName) throws Exception
      Service Category:
      Bindings
      Service Description:
      Get the remote event binding for a event.
      Parameters:
      eventName - Event name - STRING
      Returns:
      result Event binding - INFOTABLE - Aspects {dataShape:RemoteEventBinding}
      Throws:
      Exception - If an error occurs

    • RemoveRemoteEventBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void RemoveRemoteEventBinding(String eventName) throws Exception
      Service Category:
      Bindings
      Service Description:
      Remove the remote event binding for a event.
      Parameters:
      eventName - Event name - STRING
      Throws:
      Exception - If an error occurs

    • SetRemoteEventBinding Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void SetRemoteEventBinding(String eventName, String sourceEventName) throws Exception
      Service Category:
      Bindings
      Service Description:
      Set the remote event binding for a event.
      Parameters:
      eventName - Event name - STRING
      sourceEventName - Source event name - STRING
      Throws:
      Exception - If an error occurs

    • getInstanceRunTimePermissions Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public RunTimePermissionCollection getInstanceRunTimePermissions()
      Specified by:
      getInstanceRunTimePermissions in interface IInstanceRunTimeSecurable

    • setInstanceRunTimePermissions Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void setInstanceRunTimePermissions(RunTimePermissionCollection value)
      Specified by:
      setInstanceRunTimePermissions in interface IInstanceRunTimeSecurable

    • AddInstanceRunTimePermission Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void AddInstanceRunTimePermission(String type, String resource, String principal, String principalType, Boolean allow) throws Exception
      Service Category:
      Permissions
      Service Description:
      Add an instance run time permission.
      Parameters:
      type - Permission type (PropertyRead PropertyWrite ServiceInvoke EventInvoke EventSubscribe) - STRING
      resource - Resource name (* = all or enter a specific resource to override) - STRING
      principal - Principal name (name of user or group) - STRING
      principalType - Principal type (User or Group) - STRING
      allow - Permission (true = allow, false = deny) - BOOLEAN
      Throws:
      Exception - If an error occurs

    • DeleteInstanceRunTimePermission Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void DeleteInstanceRunTimePermission(String type, String resource, String principal, String principalType) throws Exception
      Service Category:
      Permissions
      Service Description:
      Delete an instance run time permission.
      Parameters:
      type - Permission type - STRING
      resource - Resource name - STRING
      principal - Principal name (name of user or group) - STRING
      principalType - Principal type (User or Group) - STRING
      Throws:
      Exception - If an error occurs

    • GetInstanceRunTimePermissions Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetInstanceRunTimePermissions() throws Exception
      Service Category:
      Permissions
      Service Description:
      Get a list of assigned instance runtime permissions.
      Returns:
      result Permission list - INFOTABLE - Aspects {dataShape:Permissions}
      Throws:
      Exception - If an error occurs

    • GetInstanceRunTimePermissionsAsJSON Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public org.json.JSONObject GetInstanceRunTimePermissionsAsJSON() throws Exception
      Service Category:
      Permissions
      Service Description:
      Get a list of assigned runtime permissions.
      Returns:
      result Permission list - JSON
      Throws:
      Exception - If an error occurs

    • SetInstanceRunTimePermissionsAsJSON Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void SetInstanceRunTimePermissionsAsJSON(org.json.JSONObject permissions) throws Exception
      Service Category:
      Permissions
      Service Description:
      Set a list of assigned runtime permissions.
      Parameters:
      permissions - Permissions in JSON format - JSON
      Throws:
      Exception - If an error occurs

    • QueryImplementingThingsOptimized Link icon

      @ThingworxExtensionApiMethod(since={9,1}) public InfoTable QueryImplementingThingsOptimized(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, Boolean withPermissions, InfoTable basicPropertyNames, InfoTable propertyNames, String networkName, String networkParentNode, Integer networkMaxDepth, Double offset) throws Exception
      Service Category:
      Queries
      Service Description:
      Return a list of all the things that implement this shape.
      Specified by:
      QueryImplementingThingsOptimized in interface IImplementableEntity
      Parameters:
      maxItems - Maximum number of items to return - NUMBER
      tags - Tags to search on - TAGS
      nameMask - Name pattern - STRING
      query - Query definition - QUERY
      withPermissions - whether or not to include read / update / delete permission information in the result - BOOLEAN
      basicPropertyNames - Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLE
      propertyNames - Include propertyNames - INFOTABLE
      networkName - Name of network - STRING
      networkParentNode - Name of the top network node - STRING
      networkMaxDepth - Max depth to search in the network - INTEGER
      offset - the number of rows to skip before starting to return rows from the query - NUMBER
      Returns:
      result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityList}
      Throws:
      Exception - If an error occurs

    • QueryImplementingThingsOptimizedWithTotalCount Link icon

      @ThingworxExtensionApiMethod(since={9,1}) public InfoTable QueryImplementingThingsOptimizedWithTotalCount(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, Boolean withPermissions, InfoTable basicPropertyNames, InfoTable propertyNames, String networkName, String networkParentNode, Integer networkMaxDepth, Double offset) throws Exception
      Service Category:
      Queries
      Service Description:
      Return a list of all the things that implement this shape.
      Specified by:
      QueryImplementingThingsOptimizedWithTotalCount in interface IImplementableEntity
      Parameters:
      maxItems - Maximum number of items to return - NUMBER
      tags - Tags to search on - TAGS
      nameMask - Name pattern - STRING
      query - Query definition - QUERY
      withPermissions - whether or not to include read / update / delete permission information in the result - BOOLEAN
      basicPropertyNames - Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLE
      propertyNames - Include propertyNames - INFOTABLE
      networkName - Name of network - STRING
      networkParentNode - Name of the top network node - STRING
      networkMaxDepth - Max depth to search in the network - INTEGER
      offset - the number of rows to skip before starting to return rows from the query - NUMBER
      Returns:
      result Implementing Things - INFOTABLE - Aspects {dataShape:ImplementedThingsWithTotalCount}
      Throws:
      Exception - If an error occurs

    • persistInstanceRunTimePermissions Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void persistInstanceRunTimePermissions() throws Exception
      Specified by:
      persistInstanceRunTimePermissions in interface IInstanceRunTimeSecurable
      Throws:
      Exception - If an error occurs

    • addInstanceRunTimePermission Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void addInstanceRunTimePermission(PermissionTypes permissionType, String resourceName, Permission permission) throws Exception
      Specified by:
      addInstanceRunTimePermission in interface IInstanceRunTimeSecurable
      Throws:
      Exception - If an error occurs

    • deleteInstanceRunTimePermission Link icon

      @ThingworxExtensionApiMethod(since={6,6}) public void deleteInstanceRunTimePermission(PermissionTypes permissionType, String resourceName, Permission permission) throws Exception
      Specified by:
      deleteInstanceRunTimePermission in interface IInstanceRunTimeSecurable
      Throws:
      Exception - If an error occurs