ThingTemplate (ThingWorx Platform API 8.5.0)

java.lang.Object
- com.thingworx.types.NamedObject
- - com.thingworx.persistence.common.PersistableNamedObject
  - - com.thingworx.entities.RootEntity
    - - com.thingworx.entities.ServiceProviderEntity
      - com.thingworx.thingtemplates.ThingTemplate

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, IDiffableObject, IAlertProvider, IAvatar, IEntityLifeCycleEvent, IEventMetadataProvider, IPersistable, IServiceMetadataProvider, IServiceProvider, IShapeProvider, ITaggableObject, IDependencyScannableObject, IHierarchicalEntity, IImplementableEntity, IEntityDefinition, IPersistableObject<java.lang.String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IInstanceDesignTimeSecurable, IInstanceRunTimeSecurable, IInstanceSecurable, IInstanceVisibilitySecurable, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, java.io.Serializable
```
@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class ThingTemplate
extends ServiceProviderEntity
implements IRunTimeSecurable, IInstanceSecurable, IImplementableEntity, IEventMetadataProvider, IServiceMetadataProvider, IShapeProvider, IAlertProvider, IHierarchicalEntity
```
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

ThingTemplate()

Constructors
Constructor and Description
`ThingTemplate()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`AddEventDefinition(java.lang.String name, java.lang.String description, java.lang.String category, java.lang.String dataShape, java.lang.Boolean remote, java.lang.String remoteEventName)` Service Category: Metadata Service Description: Add or update an event definition.
`void`	`addInstanceDesignTimePermission(PermissionTypes permissionType, Permission permission)`
`void`	`AddInstanceDesignTimePermission(java.lang.String type, java.lang.String principal, java.lang.String principalType, java.lang.Boolean allow)` Service Category: Permissions Service Description: Add an instance design time permission.
`void`	`addInstanceRunTimePermission(PermissionTypes permissionType, java.lang.String resourceName, Permission permission)`
`void`	`AddInstanceRunTimePermission(java.lang.String type, java.lang.String resource, java.lang.String principal, java.lang.String principalType, java.lang.Boolean allow)` Service Category: Permissions Service Description: Add an instance run time permission.
`void`	`addInstanceVisibilityPermission(PermissionTypes permissionType, Permission permission)`
`void`	`AddInstanceVisibilityPermission(java.lang.String principal, java.lang.String principalType)` Service Category: Permissions Service Description: Add a visibility permission.
`void`	`AddOrUpdateAlert(java.lang.String property, java.lang.String alertType, java.lang.String alertName, java.lang.String description, java.lang.Boolean enabled, java.lang.Integer priority, InfoTable attributes, java.lang.Boolean persistent)` Service Category: Alerts Service Description: Add or update an alert for a property.
`void`	AddPropertyDefinition(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String category, java.lang.String dataShape, java.lang.Boolean readOnly, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.String dataChangeType, java.lang.Double dataChangeThreshold, java.lang.Boolean remote, java.lang.String remotePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, java.lang.String defaultValue) 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)
`void`	AddPropertyDefinition(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String category, java.lang.String dataShape, java.lang.Boolean readOnly, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.String dataChangeType, java.lang.Double dataChangeThreshold, java.lang.Boolean remote, java.lang.String remotePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, java.lang.String defaultValue, org.json.JSONObject remoteBindingAspects) Service Category: Metadata Service Description: Add a property definition.
`InfoTable`	`AddPropertyDefinitions(InfoTable values, java.lang.Boolean ignoreInvalidDefinitions)` Service Category: Metadata Service Description: Add multiple property definitions at once.
`void`	`AddPropertyTransformDefinition(java.lang.String name, java.lang.String description, java.lang.String category, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.Integer timeout, InfoTable propertyTransformConfig)` Service Category: Metadata Service Description: Add a property transform definition.
`void`	`AddServiceDefinition(java.lang.String name, java.lang.String description, java.lang.String category, InfoTable parameters, InfoTable resultType, java.lang.Boolean remote, java.lang.String remoteServiceName, java.lang.Integer timeout)` Service Category: Metadata Service Description: Add or update a service definition.
`void`	`DeleteAllSharedConfigurationTableRows(java.lang.String tableName, java.lang.Boolean persistent)` Service Category: Configuration Service Description: Delete all rows from a shared multi-row configuration table.
`void`	`deleteInstanceDesignTimePermission(PermissionTypes permissionType, Permission permission)`
`void`	`DeleteInstanceDesignTimePermission(java.lang.String type, java.lang.String principal, java.lang.String principalType)` Service Category: Permissions Service Description: Delete an instance design time permission.
`void`	`deleteInstanceRunTimePermission(PermissionTypes permissionType, java.lang.String resourceName, Permission permission)`
`void`	`DeleteInstanceRunTimePermission(java.lang.String type, java.lang.String resource, java.lang.String principal, java.lang.String principalType)` Service Category: Permissions Service Description: Delete an instance run time permission.
`void`	`deleteInstanceVisibilityPermission(PermissionTypes permissionType, Permission permission)`
`void`	`DeleteInstanceVisibilityPermission(java.lang.String principal, java.lang.String principalType)` Service Category: Permissions Service Description: Delete a visibility permission.
`void`	`DeleteSharedConfigurationTable(java.lang.String tableName, java.lang.Boolean persistent)` Service Category: Configuration Service Description: Delete an entire shared configuration table.
`void`	`DeleteSharedConfigurationTableRows(java.lang.String tableName, InfoTable values, java.lang.Boolean persistent)` Service Category: Configuration Service Description: Delete one or more rows from a shared multi-row configuration table.
`void`	`DisableSubscription(java.lang.String thingName, java.lang.String eventName, java.lang.String propertyName)` Service Category: Subscriptions Service Description: Disable Subscription.
`void`	`EnableSubscription(java.lang.String thingName, java.lang.String eventName, java.lang.String propertyName)` Service Category: Subscriptions Service Description: Enable Subscription.
`AlertConfigurationCollection`	`getAlertConfigurations()`
`InfoTable`	`GetAlertDefinition(java.lang.String property, java.lang.String alertName)` Service Category: Alerts Service Description: Get alert definition for a property.
`InfoTable`	`GetAlertDefinitions(java.lang.String property)` Service Category: Alerts Service Description: Get effective alert definitions for a property.
`EntityReferenceCollection`	`getAllImplementedThingTemplates()`
`ImagePrimitive`	`GetAvatar()` Service Category: Avatar Service Description: Get avatar image.
`ThingTemplate`	`getBaseThingTemplate()`
`java.lang.String`	`GetBaseThingTemplate()` Service Category: Template Service Description: Get base thing template name.
`java.lang.String`	`getBaseThingTemplateName()`
`java.lang.Boolean`	`GetBooleanAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)` Service Category: Alerts Service Description: Get a boolean alert parameter.
`org.joda.time.DateTime`	`GetDateTimeAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)` Service Category: Alerts Service Description: Get a date alert parameter.
`EntityReferenceTypeMap`	`getDependencies()`
`ThingTemplate`	`getDerivedBaseThingTemplate()`
`AlertConfigurationCollection`	`getEffectiveAlertConfiguration()`
`EventDefinition`	`getEffectiveEventDefinition(java.lang.String eventName)`
`InfoTable`	`GetEffectiveLocalPropertyBinding(java.lang.String propertyName)` 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
`InfoTable`	`GetEffectiveLocalPropertyBindings()` Service Category: Bindings Service Description: Get the effective local property bindings. Get all effective (inherited and local) property bindings for this thing
`PropertyDefinition`	`getEffectivePropertyDefinition(java.lang.String propertyName)`
`ServiceDefinition`	`getEffectiveServiceDefinition(java.lang.String serviceName)`
`java.lang.String`	`GetEffectiveThingPackageName()` Service Category: Metadata Service Description: Get effective thing package.
`RelationshipTypes.ThingworxRelationshipTypes`	`getEntityType()`
`java.lang.String`	`GetHomeMashup()` Service Category: Mashups Service Description: Get home mashup.
`EntityReferenceTypeMap`	`getImplementations()`
`EntityReferenceCollection`	`getImplementedThingShapes()`
`InfoTable`	`GetImplementingThings()` Service Category: Queries Service Description: Return a list of all the things that implement this template.
`InfoTable`	`GetImplementingThingsWithData()` Service Category: Queries Service Description: Return a list of all the things that implement this template along with the thing properties and values.
`DesignTimePermissionCollection`	`getInstanceDesignTimePermissions()`
`InfoTable`	`GetInstanceDesignTimePermissions()` Service Category: Permissions Service Description: Get a list of assigned instance design time permissions.
`org.json.JSONObject`	`GetInstanceDesignTimePermissionsAsJSON()` Service Category: Permissions Service Description: Get a list of instance design time permissions.
`InfoTable`	`GetInstanceEventDefinitions()` Service Category: Metadata Service Description: Get the current event definitions for this thing.
`InfoTable`	`GetInstancePropertyDefinitions(java.lang.String type)` Service Category: Metadata Service Description: Get the current property definitions for this thing.
`RunTimePermissionCollection`	`getInstanceRunTimePermissions()`
`InfoTable`	`GetInstanceRunTimePermissions()` Service Category: Permissions Service Description: Get a list of assigned instance runtime permissions.
`org.json.JSONObject`	`GetInstanceRunTimePermissionsAsJSON()` Service Category: Permissions Service Description: Get a list of assigned runtime permissions.
`InfoTable`	`GetInstanceServiceDefinitions()` Service Category: Metadata Service Description: Get the current service definitions for this thing.
`ThingShapeInstance`	`getInstanceShape()`
`VisibilityPermissionCollection`	`getInstanceVisibilityPermissions()`
`InfoTable`	`GetInstanceVisibilityPermissions()` Service Category: Permissions Service Description: Get a list of assigned visibility permissions.
`org.json.JSONObject`	`GetInstanceVisibilityPermissionsAsJSON()` Service Category: Permissions Service Description: Get a list of instance visibility permissions.
`java.lang.Integer`	`GetIntegerAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)` Service Category: Alerts Service Description: Get a numeric alert parameter.
`InfoTable`	`GetLocalAlertDefinitions(java.lang.String property)` Service Category: Alerts Service Description: Get local alert definitions for a property.
`InfoTable`	`GetLocalPropertyBinding(java.lang.String propertyName)` Service Category: Bindings Service Description: Get the property binding for a property.
`Location`	`GetLocationAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)` Service Category: Alerts Service Description: Get a location alert parameter.
`InfoTable`	`GetLoggedProperties(java.lang.String type)` Service Category: Metadata Service Description: Get a list of logged properties for this thing.
`java.lang.Long`	`GetLongAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)` Service Category: Alerts Service Description: Get a numeric alert parameter.
`EntityReferenceCollection`	`getMashups()`
`InfoTable`	`GetMashups()` Service Category: Mashups Service Description: Get the mashups related to this thing template.
`java.lang.Double`	`GetNumberAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)` Service Category: Alerts Service Description: Get a numeric alert parameter.
`InfoTable`	`GetNumericLoggedProperties()` Service Category: Metadata Service Description: Get a list of logged properties for this thing that are of a numeric data type.
`java.lang.Boolean`	`GetPropertyLogging(java.lang.String propertyName)` Service Category: DataLogging Service Description: Get property logging status for a specific property.
`InfoTable`	`GetRemoteEventBinding(java.lang.String eventName)` Service Category: Bindings Service Description: Get the remote event binding for a event.
`InfoTable`	`GetRemotePropertyBinding(java.lang.String propertyName)` Service Category: Bindings Service Description: Get the remote property binding for a property.
`InfoTable`	`GetRemoteServiceBinding(java.lang.String serviceName)` Service Category: Bindings Service Description: Get the remote service binding for a service.
`InfoTable`	`GetSharedConfigurationTable(java.lang.String tableName)` Service Category: Configuration Service Description: Get a specific shared configuration table as an InfoTable.
`InfoTable`	`GetSharedConfigurationTableRow(java.lang.String tableName, java.lang.String key)` Service Category: Configuration Service Description: Get a specific shared configuration table row as an InfoTable.
`java.lang.String`	`GetValueStream()` Service Category: DataLogging Service Description: Get the identifier for a thing.
`java.lang.Boolean`	`HasAlert(java.lang.String property, java.lang.String alertName)` Service Category: Alerts Service Description: Check to see if an alert is defined for a property.
`boolean`	`implementsShape(java.lang.String thingShape)`
`java.lang.Boolean`	`IsDerivedFromTemplate(java.lang.String thingTemplateName)` Service Category: Metadata Service Description: Check to see if a thing is derived from a particular thing template.
`java.lang.Boolean`	`IsSharedMultiRowTable(java.lang.String tableName)` Service Category: Configuration Service Description: Check if a shared configuration table is a multi-row table.
`void`	`persistInstanceDesignTimePermissions()`
`void`	`persistInstanceRunTimePermissions()`
`void`	`persistInstanceVisibilityPermissions()`
`InfoTable`	`QueryImplementingThings(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query)` Service Category: Queries Service Description: Return a list of all the things that implement this template.
`InfoTable`	`QueryImplementingThingsWithData(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query)` Service Category: Queries Service Description: Return a list of all the things that implement this template along with the thing properties and values.
`InfoTable`	`QueryImplementingThingsWithNamedData(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, InfoTable basicPropertyNames, InfoTable propertyNames)` Service Category: Queries Service Description: Return a list of all the things that implement this template along with the specified thing properties and values.
`InfoTable`	`QueryImplementingThingsWithNamedPropertyHistory(InfoTable propertyNames, java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Double maxDataItems, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, java.lang.Boolean oldestFirst, org.json.JSONObject dataQuery)` Service Category: Queries Service Description: Return a list of all the things that implement this template along with the thing property history.
`InfoTable`	`QueryImplementingThingsWithPropertyHistory(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Double maxDataItems, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, java.lang.Boolean oldestFirst, org.json.JSONObject dataQuery)` Service Category: Queries Service Description: Return a list of all the things that implement this template along with the thing property history.
`void`	`RemoveAlert(java.lang.String property, java.lang.String alertName, java.lang.Boolean persistent)` Service Category: Alerts Service Description: Remove an alert for a property.
`void`	`RemoveEventDefinition(java.lang.String name)` Service Category: Metadata Service Description: Remove a event definition.
`void`	`RemoveLocalPropertyBinding(java.lang.String propertyName)` Service Category: Bindings Service Description: Remove the local property binding for a property.
`void`	`RemovePropertyDefinition(java.lang.String name)` Service Category: Metadata Service Description: Remove a property definition.
`void`	`RemoveRemoteEventBinding(java.lang.String eventName)` Service Category: Bindings Service Description: Remove the remote event binding for a event.
`void`	`RemoveRemotePropertyBinding(java.lang.String propertyName)` Service Category: Bindings Service Description: Remove the remote property binding for a property.
`void`	`RemoveRemoteServiceBinding(java.lang.String serviceName)` Service Category: Bindings Service Description: Remove the remote service binding for a service.
`void`	`RemoveServiceDefinition(java.lang.String name)` Service Category: Metadata Service Description: Remove a service definition.
`void`	`setBaseThingTemplateName(java.lang.String value)`
`void`	`SetBooleanAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.Boolean value, java.lang.Boolean persistent)` Service Category: Alerts Service Description: Set a boolean alert parameter.
`void`	`SetDateTimeAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, org.joda.time.DateTime value, java.lang.Boolean persistent)` Service Category: Alerts Service Description: Set a date alert parameter.
`void`	`setImplementedThingShapes(EntityReferenceCollection value)`
`void`	`setInstanceDesignTimePermissions(DesignTimePermissionCollection value)`
`void`	`SetInstanceDesignTimePermissionsAsJSON(org.json.JSONObject permissions)` Service Category: Permissions Service Description: Set a list of instance design time permissions.
`void`	`setInstanceRunTimePermissions(RunTimePermissionCollection value)`
`void`	`SetInstanceRunTimePermissionsAsJSON(org.json.JSONObject permissions)` Service Category: Permissions Service Description: Set a list of assigned runtime permissions.
`void`	`setInstanceVisibilityPermissions(VisibilityPermissionCollection value)`
`void`	`SetInstanceVisibilityPermissionsAsJSON(org.json.JSONObject permissions)` Service Category: Permissions Service Description: Set a list of instance visibility permissions.
`void`	`SetIntegerAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.Integer value, java.lang.Boolean persistent)` Service Category: Alerts Service Description: Set a numeric alert parameter.
`void`	`SetLocalPropertyBinding(java.lang.String propertyName, java.lang.String sourceThingName, java.lang.String sourcePropertyName)` Deprecated. As of release 8.1.0, replaced by `SetLocalPropertyBinding(String, String, String, JSONObject)`
`void`	`SetLocalPropertyBinding(java.lang.String propertyName, java.lang.String sourceThingName, java.lang.String sourcePropertyName, org.json.JSONObject aspects)` Service Category: Bindings Service Description: Set the property binding for a property.
`void`	`SetLocationAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, Location value, java.lang.Boolean persistent)` Service Category: Alerts Service Description: Set a location alert parameter.
`void`	`SetNumberAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.Double value, java.lang.Boolean persistent)` Service Category: Alerts Service Description: Set a numeric alert parameter.
`void`	`SetPropertyLogging(java.lang.String propertyName, java.lang.Boolean enabled)` Service Category: DataLogging Service Description: Set property logging status for a specific property.
`void`	`SetRemoteEventBinding(java.lang.String eventName, java.lang.String sourceEventName)` Service Category: Bindings Service Description: Set the remote event binding for a event.
`void`	`SetRemotePropertyBinding(java.lang.String propertyName, java.lang.String sourcePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold)` Deprecated. As of release 8.0.0, replaced by `SetRemotePropertyBinding(String, String, Integer, String, Double, JSONObject, Integer, String)`
`void`	`SetRemotePropertyBinding(java.lang.String propertyName, java.lang.String sourcePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, org.json.JSONObject aspects, java.lang.Integer cacheTime, java.lang.String foldType)` Service Category: Bindings Service Description: Set the remote property binding for a property.
`void`	`SetRemoteServiceBinding(java.lang.String serviceName, java.lang.String sourceServiceName, java.lang.Integer timeout)` Service Category: Bindings Service Description: Set the remote service binding for a service.
`void`	`SetSharedConfigurationTable(java.lang.String tableName, InfoTable configurationTable, java.lang.Boolean persistent)` Service Category: Configuration Service Description: Set an entire shared configuration table.
`void`	`SetSharedConfigurationTableRows(java.lang.String tableName, InfoTable values, java.lang.Boolean persistent)` Service Category: Configuration Service Description: Update/add one or more rows in a shared multi-row configuration table.
`void`	`SetSharedMultiRowConfigurationTable(java.lang.String tableName, InfoTable configurationTable, java.lang.Boolean persistent)` Service Category: Configuration Service Description: Set an entire shared multi-row configuration table.
`void`	`SetStringAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.String value, java.lang.Boolean persistent)` Service Category: Alerts Service Description: Set a string alert parameter.
`void`	`SetUnitsForNumericPropertyDefinition(java.lang.String propertyName, java.lang.String units)` Service Category: Metadata Service Description: Set the additional information for units for a specific Long, Integer, or Number property.
`void`	`SetValueStream(java.lang.String name)` Service Category: DataLogging Service Description: Set the value stream for a thing.

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, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, 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.security.permissions.IRunTimeSecurable
addRunTimePermission, deleteRunTimePermission, getRunTimePermissions, persistRunTimePermissions, setRunTimePermissions

Methods inherited from interface com.thingworx.security.permissions.ISecurable
getID, getName, getOwner, isOwner

Methods inherited from interface com.thingworx.entities.interfaces.IShapeProvider
getName

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable
getID, hasID

Methods inherited from interface com.thingworx.types.INamedObject
getDescription

Constructor Detail
- ThingTemplate
```
public ThingTemplate()
```

Method Detail

getAlertConfigurations

@ThingworxExtensionApiMethod(since={6,6})
public AlertConfigurationCollection getAlertConfigurations()

Specified by:: getAlertConfigurations in interface IAlertProvider

getEffectiveAlertConfiguration

@ThingworxExtensionApiMethod(since={6,6})
public AlertConfigurationCollection getEffectiveAlertConfiguration()

Specified by:: getEffectiveAlertConfiguration in interface IAlertProvider

GetBaseThingTemplate
```
@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String GetBaseThingTemplate()
```
Service Category:

Template

Service Description:

Get base thing template name.

Returns:

result Base thing template name - THINGTEMPLATENAME

getBaseThingTemplateName

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String getBaseThingTemplateName()

setBaseThingTemplateName

@ThingworxExtensionApiMethod(since={6,6})
public void setBaseThingTemplateName(java.lang.String value)

getInstanceDesignTimePermissions

@ThingworxExtensionApiMethod(since={6,6})
public DesignTimePermissionCollection getInstanceDesignTimePermissions()

Specified by:: getInstanceDesignTimePermissions in interface IInstanceDesignTimeSecurable

setInstanceDesignTimePermissions

@ThingworxExtensionApiMethod(since={6,6})
public void setInstanceDesignTimePermissions(DesignTimePermissionCollection value)

Specified by:: setInstanceDesignTimePermissions in interface IInstanceDesignTimeSecurable

addInstanceDesignTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void addInstanceDesignTimePermission(PermissionTypes permissionType,
                                                                                      Permission permission)
                                                                               throws java.lang.Exception

Specified by:: addInstanceDesignTimePermission in interface IInstanceDesignTimeSecurable
Throws:: java.lang.Exception - If an error occurs

deleteInstanceDesignTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void deleteInstanceDesignTimePermission(PermissionTypes permissionType,
                                                                                         Permission permission)
                                                                                  throws java.lang.Exception

Specified by:: deleteInstanceDesignTimePermission in interface IInstanceDesignTimeSecurable
Throws:: java.lang.Exception - If an error occurs

getInstanceVisibilityPermissions

@ThingworxExtensionApiMethod(since={6,6})
public VisibilityPermissionCollection getInstanceVisibilityPermissions()

Specified by:: getInstanceVisibilityPermissions in interface IInstanceVisibilitySecurable

setInstanceVisibilityPermissions

@ThingworxExtensionApiMethod(since={6,6})
public void setInstanceVisibilityPermissions(VisibilityPermissionCollection value)

Specified by:: setInstanceVisibilityPermissions in interface IInstanceVisibilitySecurable

addInstanceVisibilityPermission

@ThingworxExtensionApiMethod(since={6,6})
public void addInstanceVisibilityPermission(PermissionTypes permissionType,
                                                                                      Permission permission)
                                                                               throws java.lang.Exception

Specified by:: addInstanceVisibilityPermission in interface IInstanceVisibilitySecurable
Throws:: java.lang.Exception - If an error occurs

deleteInstanceVisibilityPermission

@ThingworxExtensionApiMethod(since={6,6})
public void deleteInstanceVisibilityPermission(PermissionTypes permissionType,
                                                                                         Permission permission)
                                                                                  throws java.lang.Exception

Specified by:: deleteInstanceVisibilityPermission in interface IInstanceVisibilitySecurable
Throws:: java.lang.Exception - If an error occurs

getInstanceRunTimePermissions

@ThingworxExtensionApiMethod(since={6,6})
public RunTimePermissionCollection getInstanceRunTimePermissions()

Specified by:: getInstanceRunTimePermissions in interface IInstanceRunTimeSecurable

setInstanceRunTimePermissions

@ThingworxExtensionApiMethod(since={6,6})
public void setInstanceRunTimePermissions(RunTimePermissionCollection value)

Specified by:: setInstanceRunTimePermissions in interface IInstanceRunTimeSecurable

addInstanceRunTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void addInstanceRunTimePermission(PermissionTypes permissionType,
                                                                                   java.lang.String resourceName,
                                                                                   Permission permission)
                                                                            throws java.lang.Exception

Specified by:: addInstanceRunTimePermission in interface IInstanceRunTimeSecurable
Throws:: java.lang.Exception - If an error occurs

deleteInstanceRunTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void deleteInstanceRunTimePermission(PermissionTypes permissionType,
                                                                                      java.lang.String resourceName,
                                                                                      Permission permission)
                                                                               throws java.lang.Exception

Specified by:: deleteInstanceRunTimePermission in interface IInstanceRunTimeSecurable
Throws:: java.lang.Exception - If an error occurs

AddInstanceRunTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void AddInstanceRunTimePermission(java.lang.String type,
                                                                                   java.lang.String resource,
                                                                                   java.lang.String principal,
                                                                                   java.lang.String principalType,
                                                                                   java.lang.Boolean allow)
                                                                            throws java.lang.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:: java.lang.Exception - If an error occurs

DeleteInstanceRunTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteInstanceRunTimePermission(java.lang.String type,
                                                                                      java.lang.String resource,
                                                                                      java.lang.String principal,
                                                                                      java.lang.String principalType)
                                                                               throws java.lang.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:: java.lang.Exception - If an error occurs

AddInstanceDesignTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void AddInstanceDesignTimePermission(java.lang.String type,
                                                                                      java.lang.String principal,
                                                                                      java.lang.String principalType,
                                                                                      java.lang.Boolean allow)
                                                                               throws java.lang.Exception

Service Category:: Permissions

Service Description:: Add an instance design time permission.

Parameters:: type - Permission type (PropertyRead PropertyWrite ServiceInvoke EventInvoke EventSubscribe) - 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:: java.lang.Exception - If an error occurs

DeleteInstanceDesignTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteInstanceDesignTimePermission(java.lang.String type,
                                                                                         java.lang.String principal,
                                                                                         java.lang.String principalType)
                                                                                  throws java.lang.Exception

Service Category:: Permissions

Service Description:: Delete an instance design time permission.

Parameters:: type - Permission type - STRING; principal - Principal name (name of user or group) - STRING; principalType - Principal type (User or Group) - STRING
Throws:: java.lang.Exception - If an error occurs

AddInstanceVisibilityPermission

@ThingworxExtensionApiMethod(since={6,6})
public void AddInstanceVisibilityPermission(java.lang.String principal,
                                                                                      java.lang.String principalType)
                                                                               throws java.lang.Exception

Service Category:: Permissions

Service Description:: Add a visibility permission.

Parameters:: principal - Principal name (name of organization or organization unit) - STRING; principalType - Principal type (Organization or Organization Unit) - STRING
Throws:: java.lang.Exception - If an error occurs

DeleteInstanceVisibilityPermission

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteInstanceVisibilityPermission(java.lang.String principal,
                                                                                         java.lang.String principalType)
                                                                                  throws java.lang.Exception

Service Category:: Permissions

Service Description:: Delete a visibility permission.

Parameters:: principal - Principal name (name of organization or organization unit) - STRING; principalType - Principal type (Organization or Organization Unit) - STRING
Throws:: java.lang.Exception - If an error occurs

GetInstanceVisibilityPermissions
```
@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstanceVisibilityPermissions()
                                                                                     throws java.lang.Exception
```
Service Category:

Permissions

Service Description:

Get a list of assigned visibility permissions.

Returns:

result Permission list - INFOTABLE - Aspects {dataShape:Permissions}

Throws:

java.lang.Exception - If an error occurs

GetInstanceVisibilityPermissionsAsJSON

@ThingworxExtensionApiMethod(since={6,6})
public org.json.JSONObject GetInstanceVisibilityPermissionsAsJSON()
                                                                                                     throws java.lang.Exception

Service Category:: Permissions

Service Description:: Get a list of instance visibility permissions.

Returns:: result Permission list - JSON
Throws:: java.lang.Exception - If an error occurs

SetInstanceVisibilityPermissionsAsJSON

@ThingworxExtensionApiMethod(since={6,6})
public void SetInstanceVisibilityPermissionsAsJSON(org.json.JSONObject permissions)
                                                                                      throws java.lang.Exception

Service Category:: Permissions

Service Description:: Set a list of instance visibility permissions.

Parameters:: permissions - Permissions in JSON format - JSON
Throws:: java.lang.Exception - If an error occurs

GetInstanceRunTimePermissions
```
@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstanceRunTimePermissions()
                                                                                  throws java.lang.Exception
```
Service Category:

Permissions

Service Description:

Get a list of assigned instance runtime permissions.

Returns:

result Permission list - INFOTABLE - Aspects {dataShape:Permissions}

Throws:

java.lang.Exception - If an error occurs

GetInstanceRunTimePermissionsAsJSON

@ThingworxExtensionApiMethod(since={6,6})
public org.json.JSONObject GetInstanceRunTimePermissionsAsJSON()
                                                                                                  throws java.lang.Exception

Service Category:: Permissions

Service Description:: Get a list of assigned runtime permissions.

Returns:: result Permission list - JSON
Throws:: java.lang.Exception - If an error occurs

SetInstanceRunTimePermissionsAsJSON

@ThingworxExtensionApiMethod(since={6,6})
public void SetInstanceRunTimePermissionsAsJSON(org.json.JSONObject permissions)
                                                                                   throws java.lang.Exception

Service Category:: Permissions

Service Description:: Set a list of assigned runtime permissions.

Parameters:: permissions - Permissions in JSON format - JSON
Throws:: java.lang.Exception - If an error occurs

GetInstanceDesignTimePermissions
```
@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstanceDesignTimePermissions()
                                                                                     throws java.lang.Exception
```
Service Category:

Permissions

Service Description:

Get a list of assigned instance design time permissions.

Returns:

result Permission list - INFOTABLE - Aspects {dataShape:Permissions}

Throws:

java.lang.Exception - If an error occurs

GetInstanceDesignTimePermissionsAsJSON

@ThingworxExtensionApiMethod(since={6,6})
public org.json.JSONObject GetInstanceDesignTimePermissionsAsJSON()
                                                                                                     throws java.lang.Exception

Service Category:: Permissions

Service Description:: Get a list of instance design time permissions.

Returns:: result Permission list - JSON
Throws:: java.lang.Exception - If an error occurs

SetInstanceDesignTimePermissionsAsJSON

@ThingworxExtensionApiMethod(since={6,6})
public void SetInstanceDesignTimePermissionsAsJSON(org.json.JSONObject permissions)
                                                                                      throws java.lang.Exception

Service Category:: Permissions

Service Description:: Set a list of instance design time permissions.

Parameters:: permissions - Permissions in JSON format - JSON
Throws:: java.lang.Exception - If an error occurs

persistInstanceRunTimePermissions

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

Specified by:: persistInstanceRunTimePermissions in interface IInstanceRunTimeSecurable
Throws:: java.lang.Exception - If an error occurs

persistInstanceDesignTimePermissions

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

Specified by:: persistInstanceDesignTimePermissions in interface IInstanceDesignTimeSecurable
Throws:: java.lang.Exception - If an error occurs

persistInstanceVisibilityPermissions

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

Specified by:: persistInstanceVisibilityPermissions in interface IInstanceVisibilitySecurable
Throws:: java.lang.Exception - If an error occurs

IsDerivedFromTemplate
```
@ThingworxExtensionApiMethod(since={6,6})
public java.lang.Boolean IsDerivedFromTemplate(java.lang.String thingTemplateName)
                                                                                  throws java.lang.Exception
```
Service Category:

Metadata

Service Description:

Check to see if a thing is derived from a particular thing template.

Parameters:

thingTemplateName - Thing template name - THINGTEMPLATENAME

Returns:

result Is Derived From Template - BOOLEAN

Throws:

java.lang.Exception - If an error occurs

GetPropertyLogging
```
@ThingworxExtensionApiMethod(since={6,6})
public java.lang.Boolean GetPropertyLogging(java.lang.String propertyName)
                                                                               throws java.lang.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:

java.lang.Exception - If an error occurs

SetPropertyLogging

@ThingworxExtensionApiMethod(since={6,6})
public void SetPropertyLogging(java.lang.String propertyName,
                                                                         java.lang.Boolean enabled)
                                                                  throws java.lang.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:: java.lang.Exception - If an error occurs

SetUnitsForNumericPropertyDefinition
```
@ThingworxExtensionApiMethod(since={8,5})
public void SetUnitsForNumericPropertyDefinition(java.lang.String propertyName,
                                                                                           java.lang.String units)
                                                                                    throws java.lang.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:

java.lang.Exception - If an error occurs

AddPropertyTransformDefinition
```
@ThingworxExtensionApiMethod(since={8,4})
public void AddPropertyTransformDefinition(java.lang.String name,
                                                                                     java.lang.String description,
                                                                                     java.lang.String category,
                                                                                     java.lang.Boolean persistent,
                                                                                     java.lang.Boolean logged,
                                                                                     java.lang.Integer timeout,
                                                                                     InfoTable propertyTransformConfig)
                                                                              throws java.lang.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:

java.lang.Exception - If an error occurs

Creates a derived property on this ThingTemplate. 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

@ThingworxExtensionApiMethod(since={6,6})
 @Deprecated
public void AddPropertyDefinition(java.lang.String name,
                                                                                         java.lang.String description,
                                                                                         java.lang.String type,
                                                                                         java.lang.String category,
                                                                                         java.lang.String dataShape,
                                                                                         java.lang.Boolean readOnly,
                                                                                         java.lang.Boolean persistent,
                                                                                         java.lang.Boolean logged,
                                                                                         java.lang.String dataChangeType,
                                                                                         java.lang.Double dataChangeThreshold,
                                                                                         java.lang.Boolean remote,
                                                                                         java.lang.String remotePropertyName,
                                                                                         java.lang.Integer timeout,
                                                                                         java.lang.String pushType,
                                                                                         java.lang.Double pushThreshold,
                                                                                         java.lang.String defaultValue)
                                                                                  throws java.lang.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:: java.lang.Exception - If an error occurs

AddPropertyDefinition

@ThingworxExtensionApiMethod(since={8,0})
public void AddPropertyDefinition(java.lang.String name,
                                                                            java.lang.String description,
                                                                            java.lang.String type,
                                                                            java.lang.String category,
                                                                            java.lang.String dataShape,
                                                                            java.lang.Boolean readOnly,
                                                                            java.lang.Boolean persistent,
                                                                            java.lang.Boolean logged,
                                                                            java.lang.String dataChangeType,
                                                                            java.lang.Double dataChangeThreshold,
                                                                            java.lang.Boolean remote,
                                                                            java.lang.String remotePropertyName,
                                                                            java.lang.Integer timeout,
                                                                            java.lang.String pushType,
                                                                            java.lang.Double pushThreshold,
                                                                            java.lang.String defaultValue,
                                                                            org.json.JSONObject remoteBindingAspects)
                                                                     throws java.lang.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; 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
Throws:: java.lang.Exception - If an error occurs

AddPropertyDefinitions
```
@ThingworxExtensionApiMethod(since={7,3})
public InfoTable AddPropertyDefinitions(InfoTable values,
                                                                                  java.lang.Boolean ignoreInvalidDefinitions)
                                                                           throws java.lang.Exception
```
Service Category:

Metadata

Service Description:

Add multiple property definitions at once.

Parameters:

values - Infotable where each row defines a property, using the PropertyDefinitionWithDetails data shape - INFOTABLE

ignoreInvalidDefinitions - True will skip over any invalid definitions provided, false indicates to fail the whole transaction when atleast one invalid definition is found - BOOLEAN

Returns:

status Table of information about which properties caused errors while attempting to add - INFOTABLE - Aspects {dataShape:BulkProcessingReport}

Throws:

java.lang.Exception - If an error occurs

AddServiceDefinition

@ThingworxExtensionApiMethod(since={6,6})
public void AddServiceDefinition(java.lang.String name,
                                                                           java.lang.String description,
                                                                           java.lang.String category,
                                                                           InfoTable parameters,
                                                                           InfoTable resultType,
                                                                           java.lang.Boolean remote,
                                                                           java.lang.String remoteServiceName,
                                                                           java.lang.Integer timeout)
                                                                    throws java.lang.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
Throws:: java.lang.Exception - If an error occurs

AddEventDefinition

@ThingworxExtensionApiMethod(since={6,6})
public void AddEventDefinition(java.lang.String name,
                                                                         java.lang.String description,
                                                                         java.lang.String category,
                                                                         java.lang.String dataShape,
                                                                         java.lang.Boolean remote,
                                                                         java.lang.String remoteEventName)
                                                                  throws java.lang.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:: java.lang.Exception - If an error occurs

DisableSubscription

@ThingworxExtensionApiMethod(since={6,6})
public void DisableSubscription(java.lang.String thingName,
                                                                          java.lang.String eventName,
                                                                          java.lang.String propertyName)
                                                                   throws java.lang.Exception

Service Category:: Subscriptions

Service Description:: Disable Subscription.

Parameters:: thingName - Thing name - THINGNAME; eventName - Event name - STRING; propertyName - Property name - STRING
Throws:: java.lang.Exception - If an error occurs

EnableSubscription

@ThingworxExtensionApiMethod(since={6,6})
public void EnableSubscription(java.lang.String thingName,
                                                                         java.lang.String eventName,
                                                                         java.lang.String propertyName)
                                                                  throws java.lang.Exception

Service Category:: Subscriptions

Service Description:: Enable Subscription.

Parameters:: thingName - Thing name - THINGNAME; eventName - Event name - STRING; propertyName - Property name - STRING
Throws:: java.lang.Exception - If an error occurs

RemovePropertyDefinition

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

Service Category:: Metadata

Service Description:: Remove a property definition.

Parameters:: name - Property name - STRING
Throws:: java.lang.Exception - If an error occurs

RemoveServiceDefinition

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

Service Category:: Metadata

Service Description:: Remove a service definition.

Parameters:: name - Service name - STRING
Throws:: java.lang.Exception - If an error occurs

RemoveEventDefinition

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

Service Category:: Metadata

Service Description:: Remove a event definition.

Parameters:: name - Event name - STRING
Throws:: java.lang.Exception - If an error occurs

getDerivedBaseThingTemplate

@ThingworxExtensionApiMethod(since={6,6})
public ThingTemplate getDerivedBaseThingTemplate()

getAllImplementedThingTemplates

@ThingworxExtensionApiMethod(since={6,6})
public EntityReferenceCollection getAllImplementedThingTemplates()

getImplementedThingShapes

@ThingworxExtensionApiMethod(since={6,6})
public EntityReferenceCollection getImplementedThingShapes()

setImplementedThingShapes

@ThingworxExtensionApiMethod(since={6,6})
public void setImplementedThingShapes(EntityReferenceCollection value)

getInstanceShape

@ThingworxExtensionApiMethod(since={6,6})
public ThingShapeInstance getInstanceShape()

Specified by:: getInstanceShape in interface IShapeProvider

implementsShape

@ThingworxExtensionApiMethod(since={6,6})
public boolean implementsShape(java.lang.String thingShape)

getBaseThingTemplate

@ThingworxExtensionApiMethod(since={6,6})
public ThingTemplate getBaseThingTemplate()

getDependencies

@ThingworxExtensionApiMethod(since={6,6})
public EntityReferenceTypeMap getDependencies()

getImplementations

@ThingworxExtensionApiMethod(since={6,6})
public EntityReferenceTypeMap getImplementations()

GetValueStream
```
@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String GetValueStream()
```
Service Category:

DataLogging

Service Description:

Get the identifier for a thing.

Returns:

name Value Stream Name - THINGNAME

SetValueStream
```
@ThingworxExtensionApiMethod(since={6,6})
public void SetValueStream(java.lang.String name)
                                                              throws java.lang.Exception
```
Service Category:

DataLogging

Service Description:

Set the value stream for a thing.

Parameters:

name - Value stream name - THINGNAME

Throws:

java.lang.Exception - If an error occurs

QueryImplementingThings

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryImplementingThings(java.lang.Double maxItems,
                                                                                   TagCollection tags,
                                                                                   java.lang.String nameMask,
                                                                                   org.json.JSONObject query)
                                                                            throws java.lang.Exception

Service Category:: Queries

Service Description:: Return a list of all the things that implement this template.

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:: java.lang.Exception - If an error occurs

QueryImplementingThingsWithData

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryImplementingThingsWithData(java.lang.Double maxItems,
                                                                                           TagCollection tags,
                                                                                           java.lang.String nameMask,
                                                                                           org.json.JSONObject query)
                                                                                    throws java.lang.Exception

Service Category:: Queries

Service Description:: Return a list of all the things that implement this template 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:: java.lang.Exception - If an error occurs

QueryImplementingThingsWithNamedData

@ThingworxExtensionApiMethod(since={8,1})
public InfoTable QueryImplementingThingsWithNamedData(java.lang.Double maxItems,
                                                                                                TagCollection tags,
                                                                                                java.lang.String nameMask,
                                                                                                org.json.JSONObject query,
                                                                                                InfoTable basicPropertyNames,
                                                                                                InfoTable propertyNames)
                                                                                         throws java.lang.Exception

Service Category:: Queries

Service Description:: Return a list of all the things that implement this template along with the specified thing properties and values.

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 - Basic Property names - INFOTABLE; propertyNames - Property names - INFOTABLE
Returns:: result Implementing Things With Data - INFOTABLE - Aspects {dataShape:RootEntityList}
Throws:: java.lang.Exception - If an error occurs

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

java.lang.Exception - If an error occurs

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

java.lang.Exception - If an error occurs

QueryImplementingThingsWithPropertyHistory

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryImplementingThingsWithPropertyHistory(java.lang.Double maxItems,
                                                                                                      TagCollection tags,
                                                                                                      java.lang.String nameMask,
                                                                                                      org.json.JSONObject query,
                                                                                                      java.lang.Double maxDataItems,
                                                                                                      org.joda.time.DateTime startDate,
                                                                                                      org.joda.time.DateTime endDate,
                                                                                                      java.lang.Boolean oldestFirst,
                                                                                                      org.json.JSONObject dataQuery)
                                                                                               throws java.lang.Exception

Service Category:: Queries

Service Description:: Return a list of all the things that implement this template along with the thing property history.

Parameters:: maxItems - Maximum number of things - NUMBER; tags - Tags to search on - TAGS; nameMask - Name pattern - STRING; query - Thing query definition - QUERY; maxDataItems - Maximum number of data rows per thing - NUMBER; startDate - Start time - DATETIME; endDate - End time - DATETIME; oldestFirst - Search/sort from oldest to newest - BOOLEAN; dataQuery - Data query definition - QUERY
Returns:: result Implementing Things With Property History - INFOTABLE
Throws:: java.lang.Exception - If an error occurs

QueryImplementingThingsWithNamedPropertyHistory

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryImplementingThingsWithNamedPropertyHistory(InfoTable propertyNames,
                                                                                                           java.lang.Double maxItems,
                                                                                                           TagCollection tags,
                                                                                                           java.lang.String nameMask,
                                                                                                           org.json.JSONObject query,
                                                                                                           java.lang.Double maxDataItems,
                                                                                                           org.joda.time.DateTime startDate,
                                                                                                           org.joda.time.DateTime endDate,
                                                                                                           java.lang.Boolean oldestFirst,
                                                                                                           org.json.JSONObject dataQuery)
                                                                                                    throws java.lang.Exception

Service Category:: Queries

Service Description:: Return a list of all the things that implement this template along with the thing property history.

Parameters:: propertyNames - Property names - INFOTABLE; maxItems - Maximum number of things - NUMBER; tags - Tags to search on - TAGS; nameMask - Name pattern - STRING; query - Thing query definition - QUERY; maxDataItems - Maximum number of data rows per thing - NUMBER; startDate - Start time - DATETIME; endDate - End time - DATETIME; oldestFirst - Search/sort from oldest to newest - BOOLEAN; dataQuery - Data query definition - QUERY
Returns:: result Implementing Things With Named Property History - INFOTABLE
Throws:: java.lang.Exception - If an error occurs

GetImplementingThings
```
@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetImplementingThings()
                                                                          throws java.lang.Exception
```
Service Category:

Queries

Service Description:

Return a list of all the things that implement this template.

Specified by:

GetImplementingThings in interface IImplementableEntity

Returns:

result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityList}

Throws:

java.lang.Exception - If an error occurs

GetImplementingThingsWithData
```
@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetImplementingThingsWithData()
                                                                                  throws java.lang.Exception
```
Service Category:

Queries

Service Description:

Return a list of all the things that implement this template along with the thing properties and values.

Specified by:

GetImplementingThingsWithData in interface IImplementableEntity

Returns:

result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityList}

Throws:

java.lang.Exception - If an error occurs

GetMashups
```
@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetMashups()
                                                               throws java.lang.Exception
```
Service Category:

Mashups

Service Description:

Get the mashups related to this thing template.

Returns:

result Mashups - INFOTABLE - Aspects {dataShape:MashupList}

Throws:

java.lang.Exception - If an error occurs

getMashups

@ThingworxExtensionApiMethod(since={6,6})
public EntityReferenceCollection getMashups()
                                                                               throws java.lang.Exception

Throws:: java.lang.Exception - If an error occurs

GetHomeMashup
```
@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String GetHomeMashup()
```
Service Category:

Mashups

Service Description:

Get home mashup.

Overrides:

GetHomeMashup in class RootEntity

Returns:

HomeMashup Home mashup - MASHUPNAME

GetEffectiveThingPackageName
```
@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String GetEffectiveThingPackageName()
```
Service Category:

Metadata

Service Description:

Get effective thing package.

Returns:

name Effective thing package name - STRING

GetAvatar
```
@ThingworxExtensionApiMethod(since={6,6})
public ImagePrimitive GetAvatar()
                                                                   throws java.lang.Exception
```
Service Category:

Avatar

Service Description:

Get avatar image.

Specified by:

GetAvatar in interface IAvatar

Overrides:

GetAvatar in class RootEntity

Returns:

Avatar Entity avatar - IMAGE

Throws:

java.lang.Exception - If an error occurs

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

java.lang.Exception - If an error occurs

GetInstanceEventDefinitions
```
@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstanceEventDefinitions()
                                                                                throws java.lang.Exception
```
Service Category:

Metadata

Service Description:

Get the current event definitions for this thing.

Returns:

result Event definitions - INFOTABLE - Aspects {dataShape:EventDefinition}

Throws:

java.lang.Exception - If an error occurs

GetInstanceServiceDefinitions
```
@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstanceServiceDefinitions()
                                                                                  throws java.lang.Exception
```
Service Category:

Metadata

Service Description:

Get the current service definitions for this thing.

Returns:

result Service definitions - INFOTABLE - Aspects {dataShape:ServiceDefinition}

Throws:

java.lang.Exception - If an error occurs

GetSharedConfigurationTable
```
@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetSharedConfigurationTable(java.lang.String tableName)
                                                                                throws java.lang.Exception
```
Service Category:

Configuration

Service Description:

Get a specific shared configuration table as an InfoTable.

Parameters:

tableName - Configuration table name - STRING

Returns:

table table - INFOTABLE

Throws:

java.lang.Exception - If an error occurs

GetSharedConfigurationTableRow

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetSharedConfigurationTableRow(java.lang.String tableName,
                                                                                          java.lang.String key)
                                                                                   throws java.lang.Exception

Service Category:: Configuration

Service Description:: Get a specific shared configuration table row as an InfoTable.

Parameters:: tableName - Configuration table name - STRING; key - Row key value - STRING
Returns:: table table - INFOTABLE
Throws:: java.lang.Exception - If an error occurs

IsSharedMultiRowTable
```
@ThingworxExtensionApiMethod(since={6,6})
public java.lang.Boolean IsSharedMultiRowTable(java.lang.String tableName)
                                                                                  throws java.lang.Exception
```
Service Category:

Configuration

Service Description:

Check if a shared configuration table is a multi-row table.

Parameters:

tableName - Configuration table name - STRING

Returns:

result Flag if table is multi-row or not - BOOLEAN

Throws:

java.lang.Exception - If an error occurs

SetSharedConfigurationTable

@ThingworxExtensionApiMethod(since={6,6})
public void SetSharedConfigurationTable(java.lang.String tableName,
                                                                                  InfoTable configurationTable,
                                                                                  java.lang.Boolean persistent)
                                                                           throws java.lang.Exception

Service Category:: Configuration

Service Description:: Set an entire shared configuration table.

Parameters:: tableName - Configuration table name - STRING; configurationTable - Configuration table content - INFOTABLE; persistent - Persist these changes - BOOLEAN
Throws:: java.lang.Exception - If an error occurs

SetSharedMultiRowConfigurationTable

@ThingworxExtensionApiMethod(since={6,6})
public void SetSharedMultiRowConfigurationTable(java.lang.String tableName,
                                                                                          InfoTable configurationTable,
                                                                                          java.lang.Boolean persistent)
                                                                                   throws java.lang.Exception

Service Category:: Configuration

Service Description:: Set an entire shared multi-row configuration table.

Parameters:: tableName - Configuration table name - STRING; configurationTable - Configuration table content - INFOTABLE; persistent - Persist these changes - BOOLEAN
Throws:: java.lang.Exception - If an error occurs

SetSharedConfigurationTableRows

@ThingworxExtensionApiMethod(since={6,6})
public void SetSharedConfigurationTableRows(java.lang.String tableName,
                                                                                      InfoTable values,
                                                                                      java.lang.Boolean persistent)
                                                                               throws java.lang.Exception

Service Category:: Configuration

Service Description:: Update/add one or more rows in a shared multi-row configuration table.

Parameters:: tableName - Configuration table name - STRING; values - Configuration table rows to modify - INFOTABLE; persistent - Persist these changes - BOOLEAN
Throws:: java.lang.Exception - If an error occurs

DeleteSharedConfigurationTable

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteSharedConfigurationTable(java.lang.String tableName,
                                                                                     java.lang.Boolean persistent)
                                                                              throws java.lang.Exception

Service Category:: Configuration

Service Description:: Delete an entire shared configuration table.

Parameters:: tableName - Configuration table name - STRING; persistent - Persist these changes - BOOLEAN
Throws:: java.lang.Exception - If an error occurs

DeleteSharedConfigurationTableRows

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteSharedConfigurationTableRows(java.lang.String tableName,
                                                                                         InfoTable values,
                                                                                         java.lang.Boolean persistent)
                                                                                  throws java.lang.Exception

Service Category:: Configuration

Service Description:: Delete one or more rows from a shared multi-row configuration table.

Parameters:: tableName - Configuration table name - STRING; values - Configuration table rows to modify - INFOTABLE; persistent - Persist these changes - BOOLEAN
Throws:: java.lang.Exception - If an error occurs

DeleteAllSharedConfigurationTableRows

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteAllSharedConfigurationTableRows(java.lang.String tableName,
                                                                                            java.lang.Boolean persistent)
                                                                                     throws java.lang.Exception

Service Category:: Configuration

Service Description:: Delete all rows from a shared multi-row configuration table.

Parameters:: tableName - Configuration table name - STRING; persistent - Persist these changes - BOOLEAN
Throws:: java.lang.Exception - If an error occurs

getEntityType
```
@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

getEffectiveServiceDefinition

@ThingworxExtensionApiMethod(since={6,6})
public ServiceDefinition getEffectiveServiceDefinition(java.lang.String serviceName)

Specified by:: getEffectiveServiceDefinition in interface IServiceMetadataProvider

getEffectiveEventDefinition

@ThingworxExtensionApiMethod(since={6,6})
public EventDefinition getEffectiveEventDefinition(java.lang.String eventName)

Specified by:: getEffectiveEventDefinition in interface IEventMetadataProvider

getEffectivePropertyDefinition

@ThingworxExtensionApiMethod(since={6,6})
public PropertyDefinition getEffectivePropertyDefinition(java.lang.String propertyName)

Specified by:: getEffectivePropertyDefinition in interface IAlertProvider

AddOrUpdateAlert

@ThingworxExtensionApiMethod(since={6,6})
public void AddOrUpdateAlert(java.lang.String property,
                                                                       java.lang.String alertType,
                                                                       java.lang.String alertName,
                                                                       java.lang.String description,
                                                                       java.lang.Boolean enabled,
                                                                       java.lang.Integer priority,
                                                                       InfoTable attributes,
                                                                       java.lang.Boolean persistent)
                                                                throws java.lang.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:: java.lang.Exception - If an error occurs

RemoveAlert

@ThingworxExtensionApiMethod(since={6,6})
public void RemoveAlert(java.lang.String property,
                                                                  java.lang.String alertName,
                                                                  java.lang.Boolean persistent)
                                                           throws java.lang.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:: java.lang.Exception - If an error occurs

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

java.lang.Exception - If an error occurs

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

java.lang.Exception - If an error occurs

GetAlertDefinition

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetAlertDefinition(java.lang.String property,
                                                                              java.lang.String alertName)
                                                                       throws java.lang.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:: java.lang.Exception - If an error occurs

HasAlert

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.Boolean HasAlert(java.lang.String property,
                                                                            java.lang.String alertName)
                                                                     throws java.lang.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:: java.lang.Exception - If an error occurs

SetNumberAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetNumberAlertParameter(java.lang.String property,
                                                                              java.lang.String alertName,
                                                                              java.lang.String parameterName,
                                                                              java.lang.Double value,
                                                                              java.lang.Boolean persistent)
                                                                       throws java.lang.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:: java.lang.Exception - If an error occurs

GetNumberAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.Double GetNumberAlertParameter(java.lang.String property,
                                                                                          java.lang.String alertName,
                                                                                          java.lang.String parameterName)
                                                                                   throws java.lang.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:: java.lang.Exception - If an error occurs

SetIntegerAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetIntegerAlertParameter(java.lang.String property,
                                                                               java.lang.String alertName,
                                                                               java.lang.String parameterName,
                                                                               java.lang.Integer value,
                                                                               java.lang.Boolean persistent)
                                                                        throws java.lang.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:: java.lang.Exception - If an error occurs

GetIntegerAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.Integer GetIntegerAlertParameter(java.lang.String property,
                                                                                            java.lang.String alertName,
                                                                                            java.lang.String parameterName)
                                                                                     throws java.lang.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:: java.lang.Exception - If an error occurs

GetLongAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.Long GetLongAlertParameter(java.lang.String property,
                                                                                      java.lang.String alertName,
                                                                                      java.lang.String parameterName)
                                                                               throws java.lang.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:: java.lang.Exception - If an error occurs

SetBooleanAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetBooleanAlertParameter(java.lang.String property,
                                                                               java.lang.String alertName,
                                                                               java.lang.String parameterName,
                                                                               java.lang.Boolean value,
                                                                               java.lang.Boolean persistent)
                                                                        throws java.lang.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:: java.lang.Exception - If an error occurs

GetBooleanAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.Boolean GetBooleanAlertParameter(java.lang.String property,
                                                                                            java.lang.String alertName,
                                                                                            java.lang.String parameterName)
                                                                                     throws java.lang.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:: java.lang.Exception - If an error occurs

SetDateTimeAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetDateTimeAlertParameter(java.lang.String property,
                                                                                java.lang.String alertName,
                                                                                java.lang.String parameterName,
                                                                                org.joda.time.DateTime value,
                                                                                java.lang.Boolean persistent)
                                                                         throws java.lang.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:: java.lang.Exception - If an error occurs

GetDateTimeAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public org.joda.time.DateTime GetDateTimeAlertParameter(java.lang.String property,
                                                                                                  java.lang.String alertName,
                                                                                                  java.lang.String parameterName)
                                                                                           throws java.lang.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:: java.lang.Exception - If an error occurs

SetLocationAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetLocationAlertParameter(java.lang.String property,
                                                                                java.lang.String alertName,
                                                                                java.lang.String parameterName,
                                                                                Location value,
                                                                                java.lang.Boolean persistent)
                                                                         throws java.lang.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:: java.lang.Exception - If an error occurs

GetLocationAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public Location GetLocationAlertParameter(java.lang.String property,
                                                                                    java.lang.String alertName,
                                                                                    java.lang.String parameterName)
                                                                             throws java.lang.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:: java.lang.Exception - If an error occurs

SetStringAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetStringAlertParameter(java.lang.String property,
                                                                              java.lang.String alertName,
                                                                              java.lang.String parameterName,
                                                                              java.lang.String value,
                                                                              java.lang.Boolean persistent)
                                                                       throws java.lang.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:: java.lang.Exception - If an error occurs

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

java.lang.Exception - If an error occurs

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

java.lang.Exception - - any exception while execution

GetEffectiveLocalPropertyBinding
```
@ThingworxExtensionApiMethod(since={7,3})
public InfoTable GetEffectiveLocalPropertyBinding(java.lang.String propertyName)
                                                                                     throws java.lang.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:

java.lang.Exception - - any exception while execution

RemoveLocalPropertyBinding

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

Service Category:: Bindings

Service Description:: Remove the local property binding for a property.

Parameters:: propertyName - Property name - STRING
Throws:: java.lang.Exception - If an error occurs

SetLocalPropertyBinding

@ThingworxExtensionApiMethod(since={6,6})
 @Deprecated
public void SetLocalPropertyBinding(java.lang.String propertyName,
                                                                                           java.lang.String sourceThingName,
                                                                                           java.lang.String sourcePropertyName)
                                                                                    throws java.lang.Exception

Deprecated. As of release 8.1.0, replaced by SetLocalPropertyBinding(String, String, String, JSONObject)

Throws:: java.lang.Exception - If an error occurs

SetLocalPropertyBinding

@ThingworxExtensionApiMethod(since={8,1,0})
public void SetLocalPropertyBinding(java.lang.String propertyName,
                                                                                java.lang.String sourceThingName,
                                                                                java.lang.String sourcePropertyName,
                                                                                org.json.JSONObject aspects)
                                                                         throws java.lang.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:: java.lang.Exception - If an error occurs

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

java.lang.Exception - If an error occurs

RemoveRemotePropertyBinding

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

Service Category:: Bindings

Service Description:: Remove the remote property binding for a property.

Parameters:: propertyName - Property name - STRING
Throws:: java.lang.Exception - If an error occurs

SetRemotePropertyBinding

@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={8,0})
 @Deprecated
public void SetRemotePropertyBinding(java.lang.String propertyName,
                                                                                                                                                java.lang.String sourcePropertyName,
                                                                                                                                                java.lang.Integer timeout,
                                                                                                                                                java.lang.String pushType,
                                                                                                                                                java.lang.Double pushThreshold)
                                                                                                                                         throws java.lang.Exception

Deprecated. As of release 8.0.0, replaced by SetRemotePropertyBinding(String, String, Integer, String, Double, JSONObject, Integer, String)

Throws:: java.lang.Exception - If an error occurs

SetRemotePropertyBinding

@ThingworxExtensionApiMethod(since={8,0})
public void SetRemotePropertyBinding(java.lang.String propertyName,
                                                                               java.lang.String sourcePropertyName,
                                                                               java.lang.Integer timeout,
                                                                               java.lang.String pushType,
                                                                               java.lang.Double pushThreshold,
                                                                               org.json.JSONObject aspects,
                                                                               java.lang.Integer cacheTime,
                                                                               java.lang.String foldType)
                                                                        throws java.lang.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:: java.lang.Exception - If an error occurs

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

java.lang.Exception - If an error occurs

RemoveRemoteServiceBinding

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

Service Category:: Bindings

Service Description:: Remove the remote service binding for a service.

Parameters:: serviceName - Service name - STRING
Throws:: java.lang.Exception - If an error occurs

SetRemoteServiceBinding

@ThingworxExtensionApiMethod(since={6,6})
public void SetRemoteServiceBinding(java.lang.String serviceName,
                                                                              java.lang.String sourceServiceName,
                                                                              java.lang.Integer timeout)
                                                                       throws java.lang.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:: java.lang.Exception - If an error occurs

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

java.lang.Exception - If an error occurs

RemoveRemoteEventBinding

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

Service Category:: Bindings

Service Description:: Remove the remote event binding for a event.

Parameters:: eventName - Event name - STRING
Throws:: java.lang.Exception - If an error occurs

SetRemoteEventBinding

@ThingworxExtensionApiMethod(since={6,6})
public void SetRemoteEventBinding(java.lang.String eventName,
                                                                            java.lang.String sourceEventName)
                                                                     throws java.lang.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:: java.lang.Exception - If an error occurs

Class ThingTemplate

Field Summary

Fields inherited from class com.thingworx.entities.RootEntity

Fields inherited from class com.thingworx.types.NamedObject

Constructor Summary

Method Summary

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

Methods inherited from class com.thingworx.entities.RootEntity

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

Methods inherited from class com.thingworx.types.NamedObject

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface com.thingworx.entities.interfaces.IShapeProvider

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

Methods inherited from interface com.thingworx.types.INamedObject

Constructor Detail

ThingTemplate

Method Detail

getAlertConfigurations

getEffectiveAlertConfiguration

GetBaseThingTemplate

getBaseThingTemplateName

setBaseThingTemplateName

getInstanceDesignTimePermissions

setInstanceDesignTimePermissions

addInstanceDesignTimePermission

deleteInstanceDesignTimePermission

getInstanceVisibilityPermissions

setInstanceVisibilityPermissions

addInstanceVisibilityPermission

deleteInstanceVisibilityPermission

getInstanceRunTimePermissions

setInstanceRunTimePermissions

addInstanceRunTimePermission

deleteInstanceRunTimePermission

AddInstanceRunTimePermission

DeleteInstanceRunTimePermission

AddInstanceDesignTimePermission

DeleteInstanceDesignTimePermission

AddInstanceVisibilityPermission

DeleteInstanceVisibilityPermission

GetInstanceVisibilityPermissions

GetInstanceVisibilityPermissionsAsJSON

SetInstanceVisibilityPermissionsAsJSON

GetInstanceRunTimePermissions

GetInstanceRunTimePermissionsAsJSON

SetInstanceRunTimePermissionsAsJSON

GetInstanceDesignTimePermissions

GetInstanceDesignTimePermissionsAsJSON

SetInstanceDesignTimePermissionsAsJSON

persistInstanceRunTimePermissions

persistInstanceDesignTimePermissions

persistInstanceVisibilityPermissions

IsDerivedFromTemplate

GetPropertyLogging

SetPropertyLogging

SetUnitsForNumericPropertyDefinition

AddPropertyTransformDefinition

AddPropertyDefinition

AddPropertyDefinition

AddPropertyDefinitions

AddServiceDefinition

AddEventDefinition

DisableSubscription

EnableSubscription

RemovePropertyDefinition

RemoveServiceDefinition

RemoveEventDefinition

getDerivedBaseThingTemplate

getAllImplementedThingTemplates

getImplementedThingShapes

setImplementedThingShapes

getInstanceShape

implementsShape

getBaseThingTemplate

getDependencies

getImplementations

GetValueStream

SetValueStream