Package com.thingworx.thingtemplates

Class ThingTemplate

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:

ISupportsAccessModifier, IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAlertProvider, IAvatar, IEntityLifeCycleEvent, IEventMetadataProvider, IPersistable, IServiceMetadataProvider, IServiceProvider, IShapeProvider, ITaggableObject, IDependencyScannableObject, IHierarchicalEntity, IImplementableEntity, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IInstanceDesignTimeSecurable, IInstanceRunTimeSecurable, IInstanceSecurable, IInstanceVisibilitySecurable, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class ThingTemplate
extends ServiceProviderEntity
implements IRunTimeSecurable, IInstanceSecurable, IImplementableEntity, IEventMetadataProvider, IServiceMetadataProvider, IShapeProvider, IAlertProvider, IHierarchicalEntity, ISupportsAccessModifier

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
ThingTemplate()

Method Summary

Modifier and Type	Method	Description
void	AddEventDefinition(String name, String description, String category, String dataShape, Boolean remote, String remoteEventName)	Service Category: Metadata Service Description: Add or update an event definition.
void	addInstanceDesignTimePermission(PermissionTypes permissionType, Permission permission)
void	AddInstanceDesignTimePermission(String type, String principal, String principalType, Boolean allow)	Service Category: Permissions Service Description: Add an instance design time permission.
void	addInstanceRunTimePermission(PermissionTypes permissionType, String resourceName, Permission permission)
void	AddInstanceRunTimePermission(String type, String resource, String principal, String principalType, Boolean allow)	Service Category: Permissions Service Description: Add an instance run time permission.
void	addInstanceVisibilityPermission(PermissionTypes permissionType, Permission permission)
void	AddInstanceVisibilityPermission(String principal, String principalType)	Service Category: Permissions Service Description: Add a visibility permission.
void	AddOrUpdateAlert(String property, String alertType, String alertName, String description, Boolean enabled, Integer priority, InfoTable attributes, Boolean persistent)	Service Category: Alerts Service Description: Add or update an alert for a property.
void	AddPropertyDefinition(String name, String description, String type, String category, String dataShape, Boolean readOnly, Boolean persistent, Boolean logged, Boolean indexed, String dataChangeType, Double dataChangeThreshold, Boolean remote, String remotePropertyName, Integer timeout, String pushType, Double pushThreshold, String defaultValue, org.json.JSONObject remoteBindingAspects)	Deprecated.
void	AddPropertyDefinition(String name, String description, String type, String category, String dataShape, Boolean readOnly, Boolean persistent, Boolean logged, Boolean indexed, String dataChangeType, Double dataChangeThreshold, Boolean remote, String remotePropertyName, Integer timeout, String pushType, Double pushThreshold, String defaultValue, org.json.JSONObject remoteBindingAspects, org.json.JSONObject accessModifier)	Service Category: Metadata Service Description: Add a property definition.
void	AddPropertyDefinition(String name, String description, String type, String category, String dataShape, Boolean readOnly, Boolean persistent, Boolean logged, String dataChangeType, Double dataChangeThreshold, Boolean remote, String remotePropertyName, Integer timeout, String pushType, Double pushThreshold, String defaultValue)	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(String name, String description, String type, String category, String dataShape, Boolean readOnly, Boolean persistent, Boolean logged, String dataChangeType, Double dataChangeThreshold, Boolean remote, String remotePropertyName, Integer timeout, String pushType, Double pushThreshold, String defaultValue, org.json.JSONObject remoteBindingAspects)	Deprecated.
InfoTable	AddPropertyDefinitions(InfoTable values, Boolean ignoreInvalidDefinitions)	Service Category: Metadata Service Description: Add multiple property definitions at once.
void	AddPropertyTransformDefinition(String name, String description, String category, Boolean persistent, Boolean logged, Integer timeout, InfoTable propertyTransformConfig)	Service Category: Metadata Service Description: Add a property transform definition.
void	AddServiceDefinition(String name, String description, String category, InfoTable parameters, InfoTable resultType, Boolean remote, String remoteServiceName, Integer timeout)	Deprecated.
void	AddServiceDefinition(String name, String description, String category, InfoTable parameters, InfoTable resultType, Boolean remote, String remoteServiceName, Integer timeout, org.json.JSONObject accessModifier)	Service Category: Metadata Service Description: Add or update a service definition.
void	DeleteAllSharedConfigurationTableRows(String tableName, 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(String type, String principal, String principalType)	Service Category: Permissions Service Description: Delete an instance design time permission.
void	deleteInstanceRunTimePermission(PermissionTypes permissionType, String resourceName, Permission permission)
void	DeleteInstanceRunTimePermission(String type, String resource, String principal, String principalType)	Service Category: Permissions Service Description: Delete an instance run time permission.
void	deleteInstanceVisibilityPermission(PermissionTypes permissionType, Permission permission)
void	DeleteInstanceVisibilityPermission(String principal, String principalType)	Service Category: Permissions Service Description: Delete a visibility permission.
void	DeleteSharedConfigurationTable(String tableName, Boolean persistent)	Service Category: Configuration Service Description: Delete an entire shared configuration table.
void	DeleteSharedConfigurationTableRows(String tableName, InfoTable values, Boolean persistent)	Deprecated.
void	DeleteSharedConfigurationTableRows(String tableName, InfoTable values, Boolean persistent, Boolean removeAllMatchingRows)	Service Category: Configuration Service Description: Delete one or more rows from a shared multi-row configuration table.
void	DisableSubscription(String subscriptionName)	Service Category: Subscriptions Service Description: Disable Subscription.
void	DisableSubscription(String thingName, String eventName, String propertyName)	Deprecated.
void	EnableSubscription(String subscriptionName)	Service Category: Subscriptions Service Description: Enable Subscription.
void	EnableSubscription(String thingName, String eventName, String propertyName)	Deprecated.
AlertConfigurationCollection	getAlertConfigurations()
InfoTable	GetAlertDefinition(String property, String alertName)	Service Category: Alerts Service Description: Get alert definition for a property.
InfoTable	GetAlertDefinitions(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()
String	GetBaseThingTemplate()	Service Category: Template Service Description: Get base thing template name.
String	getBaseThingTemplateName()
Boolean	GetBooleanAlertParameter(String property, String alertName, String parameterName)	Service Category: Alerts Service Description: Get a boolean alert parameter.
org.joda.time.DateTime	GetDateTimeAlertParameter(String property, String alertName, String parameterName)	Service Category: Alerts Service Description: Get a date alert parameter.
EntityReferenceTypeMap	getDependencies()
ThingTemplate	getDerivedBaseThingTemplate()
AlertConfigurationCollection	getEffectiveAlertConfiguration()
EventDefinition	getEffectiveEventDefinition(String eventName)
InfoTable	GetEffectiveLocalPropertyBinding(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(String propertyName)
ServiceDefinition	getEffectiveServiceDefinition(String serviceName)
String	GetEffectiveThingPackageName()	Service Category: Metadata Service Description: Get effective thing package.
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()
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(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.
Integer	GetIntegerAlertParameter(String property, String alertName, String parameterName)	Service Category: Alerts Service Description: Get a numeric alert parameter.
InfoTable	GetLocalAlertDefinitions(String property)	Service Category: Alerts Service Description: Get local alert definitions for a property.
InfoTable	GetLocalPropertyBinding(String propertyName)	Service Category: Bindings Service Description: Get the property binding for a property.
Location	GetLocationAlertParameter(String property, String alertName, String parameterName)	Service Category: Alerts Service Description: Get a location alert parameter.
InfoTable	GetLoggedProperties(String type)	Service Category: Metadata Service Description: Get a list of logged properties for this thing.
Long	GetLongAlertParameter(String property, String alertName, 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.
Double	GetNumberAlertParameter(String property, String alertName, 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.
Boolean	GetPropertyLogging(String propertyName)	Service Category: DataLogging Service Description: Get property logging status for a specific property.
InfoTable	GetRemoteEventBinding(String eventName)	Service Category: Bindings Service Description: Get the remote event binding for a event.
InfoTable	GetRemotePropertyBinding(String propertyName)	Service Category: Bindings Service Description: Get the remote property binding for a property.
InfoTable	GetRemoteServiceBinding(String serviceName)	Service Category: Bindings Service Description: Get the remote service binding for a service.
InfoTable	GetSharedConfigurationTable(String tableName)	Service Category: Configuration Service Description: Get a specific shared configuration table as an InfoTable.
InfoTable	GetSharedConfigurationTableRow(String tableName, String key)	Service Category: Configuration Service Description: Get a specific shared configuration table row as an InfoTable.
String	GetValueStream()	Service Category: DataLogging Service Description: Get the identifier for a thing.
Boolean	HasAlert(String property, String alertName)	Service Category: Alerts Service Description: Check to see if an alert is defined for a property.
boolean	implementsShape(String thingShape)
Boolean	IsDerivedFromTemplate(String thingTemplateName)	Service Category: Metadata Service Description: Check to see if a thing is derived from a particular thing template.
Boolean	IsSharedMultiRowTable(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(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query)	Deprecated.
InfoTable	QueryImplementingThings(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, Boolean isSortFirst)	Service Category: Queries Service Description: Return a list of all the things that implement this template.
InfoTable	QueryImplementingThingsOptimized(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, Boolean withPermissions, InfoTable basicPropertyNames, InfoTable propertyNames, String networkName, String networkParentNode, Integer networkMaxDepth, Double offset)	Service Category: Queries Service Description: Return a list of all the things that implement this shape.
InfoTable	QueryImplementingThingsOptimizedWithTotalCount(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, Boolean withPermissions, InfoTable basicPropertyNames, InfoTable propertyNames, String networkName, String networkParentNode, Integer networkMaxDepth, Double offset)	Service Category: Queries Service Description: Return a list of all the things that implement this shape.
InfoTable	QueryImplementingThingsV2(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, Boolean isSortFirst)	Service Category: Queries Service Description: Return a list of all the things that implement this template.
InfoTable	QueryImplementingThingsWithData(Double maxItems, TagCollection tags, 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	QueryImplementingThingsWithDataV2(Double maxItems, TagCollection tags, 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(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, InfoTable basicPropertyNames, InfoTable propertyNames)	Service Category: Queries Service Description: Returns a list containing the specific properties and values of all the Things that Implement this Template.
InfoTable	QueryImplementingThingsWithNamedDataV2(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, InfoTable basicPropertyNames, InfoTable propertyNames)	Service Category: Queries Service Description: Returns a list containing the specific properties and values of all the Things that Implement this Template.
InfoTable	QueryImplementingThingsWithNamedPropertyHistory(InfoTable propertyNames, Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, Double maxDataItems, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, 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(Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query, Double maxDataItems, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, 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(String property, String alertName, Boolean persistent)	Service Category: Alerts Service Description: Remove an alert for a property.
void	RemoveEventDefinition(String name)	Service Category: Metadata Service Description: Remove a event definition.
void	RemoveLocalPropertyBinding(String propertyName)	Service Category: Bindings Service Description: Remove the local property binding for a property.
void	RemovePropertyDefinition(String name)	Service Category: Metadata Service Description: Remove a property definition.
void	RemoveRemoteEventBinding(String eventName)	Service Category: Bindings Service Description: Remove the remote event binding for a event.
void	RemoveRemotePropertyBinding(String propertyName)	Service Category: Bindings Service Description: Remove the remote property binding for a property.
void	RemoveRemoteServiceBinding(String serviceName)	Service Category: Bindings Service Description: Remove the remote service binding for a service.
void	RemoveServiceDefinition(String name)	Service Category: Metadata Service Description: Remove a service definition.
void	setBaseThingTemplateName(String value)
void	SetBooleanAlertParameter(String property, String alertName, String parameterName, Boolean value, Boolean persistent)	Service Category: Alerts Service Description: Set a boolean alert parameter.
void	SetDateTimeAlertParameter(String property, String alertName, String parameterName, org.joda.time.DateTime value, 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(String property, String alertName, String parameterName, Integer value, Boolean persistent)	Service Category: Alerts Service Description: Set a numeric alert parameter.
void	SetLocalPropertyBinding(String propertyName, String sourceThingName, String sourcePropertyName)	Deprecated. As of release 8.1.0, replaced by SetLocalPropertyBinding(String, String, String, JSONObject)
void	SetLocalPropertyBinding(String propertyName, String sourceThingName, String sourcePropertyName, org.json.JSONObject aspects)	Service Category: Bindings Service Description: Set the property binding for a property.
void	SetLocationAlertParameter(String property, String alertName, String parameterName, Location value, Boolean persistent)	Service Category: Alerts Service Description: Set a location alert parameter.
void	SetNumberAlertParameter(String property, String alertName, String parameterName, Double value, Boolean persistent)	Service Category: Alerts Service Description: Set a numeric alert parameter.
void	SetPropertyLogging(String propertyName, Boolean enabled)	Service Category: DataLogging Service Description: Set property logging status for a specific property.
void	SetRemoteEventBinding(String eventName, String sourceEventName)	Service Category: Bindings Service Description: Set the remote event binding for a event.
void	SetRemotePropertyBinding(String propertyName, String sourcePropertyName, Integer timeout, String pushType, Double pushThreshold)	Deprecated. As of release 8.0.0, replaced by SetRemotePropertyBinding(String, String, Integer, String, Double, JSONObject, Integer, String)
void	SetRemotePropertyBinding(String propertyName, String sourcePropertyName, Integer timeout, String pushType, Double pushThreshold, org.json.JSONObject aspects, Integer cacheTime, String foldType)	Service Category: Bindings Service Description: Set the remote property binding for a property.
void	SetRemoteServiceBinding(String serviceName, String sourceServiceName, Integer timeout)	Service Category: Bindings Service Description: Set the remote service binding for a service.
void	SetSharedConfigurationTable(String tableName, InfoTable configurationTable, Boolean persistent)	Service Category: Configuration Service Description: Set an entire shared configuration table.
void	SetSharedConfigurationTableRows(String tableName, InfoTable values, Boolean persistent)	Service Category: Configuration Service Description: Update/add one or more rows in a shared multi-row configuration table.
void	SetSharedMultiRowConfigurationTable(String tableName, InfoTable configurationTable, Boolean persistent)	Service Category: Configuration Service Description: Set an entire shared multi-row configuration table.
void	SetStringAlertParameter(String property, String alertName, String parameterName, String value, Boolean persistent)	Service Category: Alerts Service Description: Set a string alert parameter.
void	SetUnitsForNumericPropertyDefinition(String propertyName, String units)	Service Category: Metadata Service Description: Set the additional information for units for a specific Long, Integer, or Number property.
void	SetValueStream(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, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, 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, 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, ListDeprecatedUsage, 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, UpdateProjectDependencies, 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.types.INamedObject

getDescription

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

getID, hasID

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.accesscontrol.ISupportsAccessModifier

getAccessModifier, getAccessModifierScope, getExemptList, hasAccessModifier, isInternalAccess, isPrivateAccess, isRestrictedAccess

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Constructor Details

ThingTemplate

public ThingTemplate()

Method Details

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 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 String getBaseThingTemplateName()

setBaseThingTemplateName

@ThingworxExtensionApiMethod(since={6,6})
public void setBaseThingTemplateName(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 Exception

Specified by:

addInstanceDesignTimePermission in interface IInstanceDesignTimeSecurable

Throws:

Exception - If an error occurs

deleteInstanceDesignTimePermission

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

Specified by:

deleteInstanceDesignTimePermission in interface IInstanceDesignTimeSecurable

Throws:

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 Exception

Specified by:

addInstanceVisibilityPermission in interface IInstanceVisibilitySecurable

Throws:

Exception - If an error occurs

deleteInstanceVisibilityPermission

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

Specified by:

deleteInstanceVisibilityPermission in interface IInstanceVisibilitySecurable

Throws:

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,
 String resourceName,
 Permission permission)
                                  throws Exception

Specified by:

addInstanceRunTimePermission in interface IInstanceRunTimeSecurable

Throws:

Exception - If an error occurs

deleteInstanceRunTimePermission

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

Specified by:

deleteInstanceRunTimePermission in interface IInstanceRunTimeSecurable

Throws:

Exception - If an error occurs

AddInstanceRunTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void AddInstanceRunTimePermission(String type,
 String resource,
 String principal,
 String principalType,
 Boolean allow)
                                  throws Exception

Service Category:

Permissions

Service Description:

Add an instance run time permission.

Parameters:

type - Permission type (PropertyRead PropertyWrite ServiceInvoke EventInvoke EventSubscribe) - STRING

resource - Resource name (* = all or enter a specific resource to override) - STRING

principal - Principal name (name of user or group) - STRING

principalType - Principal type (User or Group) - STRING

allow - Permission (true = allow, false = deny) - BOOLEAN

Throws:

Exception - If an error occurs

DeleteInstanceRunTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteInstanceRunTimePermission(String type,
 String resource,
 String principal,
 String principalType)
                                     throws Exception

Service Category:

Permissions

Service Description:

Delete an instance run time permission.

Parameters:

type - Permission type - STRING

resource - Resource name - STRING

principal - Principal name (name of user or group) - STRING

principalType - Principal type (User or Group) - STRING

Throws:

Exception - If an error occurs

AddInstanceDesignTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void AddInstanceDesignTimePermission(String type,
 String principal,
 String principalType,
 Boolean allow)
                                     throws 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:

Exception - If an error occurs

DeleteInstanceDesignTimePermission

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

Exception - If an error occurs

AddInstanceVisibilityPermission

@ThingworxExtensionApiMethod(since={6,6})
public void AddInstanceVisibilityPermission(String principal,
 String principalType)
                                     throws 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:

Exception - If an error occurs

DeleteInstanceVisibilityPermission

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteInstanceVisibilityPermission(String principal,
 String principalType)
                                        throws 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:

Exception - If an error occurs

GetInstanceVisibilityPermissions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstanceVisibilityPermissions()
                                           throws Exception

Service Category:

Permissions

Service Description:

Get a list of assigned visibility permissions.

Returns:

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

Throws:

Exception - If an error occurs

GetInstanceVisibilityPermissionsAsJSON

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

Service Category:

Permissions

Service Description:

Get a list of instance visibility permissions.

Returns:

result Permission list - JSON

Throws:

Exception - If an error occurs

SetInstanceVisibilityPermissionsAsJSON

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

Service Category:

Permissions

Service Description:

Set a list of instance visibility permissions.

Parameters:

permissions - Permissions in JSON format - JSON

Throws:

Exception - If an error occurs

GetInstanceRunTimePermissions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstanceRunTimePermissions()
                                        throws Exception

Service Category:

Permissions

Service Description:

Get a list of assigned instance runtime permissions.

Returns:

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

Throws:

Exception - If an error occurs

GetInstanceRunTimePermissionsAsJSON

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

Service Category:

Permissions

Service Description:

Get a list of assigned runtime permissions.

Returns:

result Permission list - JSON

Throws:

Exception - If an error occurs

SetInstanceRunTimePermissionsAsJSON

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

Service Category:

Permissions

Service Description:

Set a list of assigned runtime permissions.

Parameters:

permissions - Permissions in JSON format - JSON

Throws:

Exception - If an error occurs

GetInstanceDesignTimePermissions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstanceDesignTimePermissions()
                                           throws Exception

Service Category:

Permissions

Service Description:

Get a list of assigned instance design time permissions.

Returns:

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

Throws:

Exception - If an error occurs

GetInstanceDesignTimePermissionsAsJSON

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

Service Category:

Permissions

Service Description:

Get a list of instance design time permissions.

Returns:

result Permission list - JSON

Throws:

Exception - If an error occurs

SetInstanceDesignTimePermissionsAsJSON

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

Service Category:

Permissions

Service Description:

Set a list of instance design time permissions.

Parameters:

permissions - Permissions in JSON format - JSON

Throws:

Exception - If an error occurs

persistInstanceRunTimePermissions

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

Specified by:

persistInstanceRunTimePermissions in interface IInstanceRunTimeSecurable

Throws:

Exception - If an error occurs

persistInstanceDesignTimePermissions

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

Specified by:

persistInstanceDesignTimePermissions in interface IInstanceDesignTimeSecurable

Throws:

Exception - If an error occurs

persistInstanceVisibilityPermissions

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

Specified by:

persistInstanceVisibilityPermissions in interface IInstanceVisibilitySecurable

Throws:

Exception - If an error occurs

IsDerivedFromTemplate

@ThingworxExtensionApiMethod(since={6,6})
public Boolean IsDerivedFromTemplate(String thingTemplateName)
                              throws 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:

Exception - If an error occurs

GetPropertyLogging

@ThingworxExtensionApiMethod(since={6,6})
public Boolean GetPropertyLogging(String propertyName)
                           throws Exception

Service Category:

DataLogging

Service Description:

Get property logging status for a specific property.

Parameters:

propertyName - Property name - STRING

Returns:

status Property logging status - BOOLEAN

Throws:

Exception - If an error occurs

SetPropertyLogging

@ThingworxExtensionApiMethod(since={6,6})
public void SetPropertyLogging(String propertyName,
 Boolean enabled)
                        throws Exception

Service Category:

DataLogging

Service Description:

Set property logging status for a specific property.

Parameters:

propertyName - Property name - STRING

enabled - Enable/disable logging - BOOLEAN

Throws:

Exception - If an error occurs

SetUnitsForNumericPropertyDefinition

@ThingworxExtensionApiMethod(since={8,5})
public void SetUnitsForNumericPropertyDefinition(String propertyName,
 String units)
                                          throws Exception

Service Category:

Metadata

Service Description:

Set the additional information for units for a specific Long, Integer, or Number property.

Parameters:

propertyName - Property name - STRING

units - Units (eg. lbs, F, inches, etc.) associated with input. For information only. - STRING

Throws:

Exception - If an error occurs

AddPropertyTransformDefinition

@ThingworxExtensionApiMethod(since={8,4})
public void AddPropertyTransformDefinition(String name,
 String description,
 String category,
 Boolean persistent,
 Boolean logged,
 Integer timeout,
 InfoTable propertyTransformConfig)
                                    throws Exception

Service Category:

Metadata

Service Description:

Add a property transform definition.

Parameters:

name - - The name of your new derived property.

description - - The description of the new property.

category - - Category for the new property.

persistent - - Should the value of this derived property be persisted between tomcat restarts?

logged - - Should the value of this derived property be logged over time?

timeout - - Timeout for creating the property.

propertyTransformConfig - - A configuration infotable consisting of key/value pairs. Refer to the help center for possible keys.

Throws:

Exception - If an error occurs

Creates a derived property on this 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(String name,
 String description,
 String type,
 String category,
 String dataShape,
 Boolean readOnly,
 Boolean persistent,
 Boolean logged,
 String dataChangeType,
 Double dataChangeThreshold,
 Boolean remote,
 String remotePropertyName,
 Integer timeout,
 String pushType,
 Double pushThreshold,
 String defaultValue)
                           throws Exception

Deprecated.

As of release 8.0, replaced by AddPropertyDefinition(String, String, String, String, String, Boolean, Boolean, Boolean, String, Double, Boolean, String, Integer, String, Double, String, JSONObject)

Throws:

Exception - If an error occurs

AddPropertyDefinition

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

Deprecated.

Throws:

Exception - If an error occurs

AddPropertyDefinition

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

Deprecated.

Throws:

Exception - If an error occurs

AddPropertyDefinition

@ThingworxExtensionApiMethod(since={9,3})
public void AddPropertyDefinition(String name,
 String description,
 String type,
 String category,
 String dataShape,
 Boolean readOnly,
 Boolean persistent,
 Boolean logged,
 Boolean indexed,
 String dataChangeType,
 Double dataChangeThreshold,
 Boolean remote,
 String remotePropertyName,
 Integer timeout,
 String pushType,
 Double pushThreshold,
 String defaultValue,
 org.json.JSONObject remoteBindingAspects,
 org.json.JSONObject accessModifier)
                           throws Exception

Service Category:

Metadata

Service Description:

Add a property definition.

Parameters:

name - Property name - STRING

description - Property description - STRING

type - Data type - BASETYPENAME

category - Category - STRING

dataShape - Data shape - DATASHAPENAME

readOnly - Read only - BOOLEAN

persistent - Persist property value - BOOLEAN

logged - Log property value - BOOLEAN

indexed - Index property value - BOOLEAN

dataChangeType - Data change type - STRING

dataChangeThreshold - Data change threshold - NUMBER

remote - Is a remote property - BOOLEAN

remotePropertyName - Remote property name - STRING

timeout - Request timeout - INTEGER

pushType - Push type - STRING

pushThreshold - Push threshold - NUMBER

defaultValue - Default value for property - STRING

remoteBindingAspects - Aspects for the remote binding - JSON

accessModifier - AccessModifier for propertyDefinition - JSON

Throws:

Exception - If an error occurs

AddPropertyDefinitions

@ThingworxExtensionApiMethod(since={7,3})
public InfoTable AddPropertyDefinitions(InfoTable values,
 Boolean ignoreInvalidDefinitions)
                                 throws Exception

Service Category:

Metadata

Service Description:

Add multiple property definitions at once.

Parameters:

values - Infotable where each row defines a property, using the PropertyDefinitionWithDetailsV2 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:

Exception - If an error occurs

AddServiceDefinition

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

Deprecated.

Throws:

Exception - If an error occurs

AddServiceDefinition

@ThingworxExtensionApiMethod(since={6,6})
public void AddServiceDefinition(String name,
 String description,
 String category,
 InfoTable parameters,
 InfoTable resultType,
 Boolean remote,
 String remoteServiceName,
 Integer timeout,
 org.json.JSONObject accessModifier)
                          throws Exception

Service Category:

Metadata

Service Description:

Add or update a service definition.

Parameters:

name - Property name - STRING

description - Property description - STRING

category - Category - STRING

parameters - Service parameters - INFOTABLE

resultType - Service result type - INFOTABLE

remote - Is a remote service - BOOLEAN

remoteServiceName - Remote service name - STRING

timeout - Request timeout - INTEGER

accessModifier - AccessModifier for serviceDefinition - JSON

Throws:

Exception - If an error occurs

AddEventDefinition

@ThingworxExtensionApiMethod(since={6,6})
public void AddEventDefinition(String name,
 String description,
 String category,
 String dataShape,
 Boolean remote,
 String remoteEventName)
                        throws Exception

Service Category:

Metadata

Service Description:

Add or update an event definition.

Parameters:

name - Property name - STRING

description - Property description - STRING

category - Category - STRING

dataShape - Data shape - DATASHAPENAME

remote - Is a remote service - BOOLEAN

remoteEventName - Remote event name - STRING

Throws:

Exception - If an error occurs

DisableSubscription

@Deprecated
@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={9,0})
public void DisableSubscription(String thingName,
 String eventName,
 String propertyName)
                         throws Exception

Deprecated.

Throws:

Exception - If an error occurs

DisableSubscription

@ThingworxExtensionApiMethod(since={9,0})
public void DisableSubscription(String subscriptionName)
                         throws Exception

Service Category:

Subscriptions

Service Description:

Disable Subscription.

Parameters:

subscriptionName - Subscription name - STRING

Throws:

Exception - If an error occurs

EnableSubscription

@Deprecated
@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={9,0})
public void EnableSubscription(String thingName,
 String eventName,
 String propertyName)
                        throws Exception

Deprecated.

Throws:

Exception - If an error occurs

EnableSubscription

@ThingworxExtensionApiMethod(since={9,0})
public void EnableSubscription(String subscriptionName)
                        throws Exception

Service Category:

Subscriptions

Service Description:

Enable Subscription.

Parameters:

subscriptionName - Subscription name - STRING

Throws:

Exception - If an error occurs

RemovePropertyDefinition

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

Service Category:

Metadata

Service Description:

Remove a property definition.

Parameters:

name - Property name - STRING

Throws:

Exception - If an error occurs

RemoveServiceDefinition

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

Service Category:

Metadata

Service Description:

Remove a service definition.

Parameters:

name - Service name - STRING

Throws:

Exception - If an error occurs

RemoveEventDefinition

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

Service Category:

Metadata

Service Description:

Remove a event definition.

Parameters:

name - Event name - STRING

Throws:

Exception - If an error occurs

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

QueryImplementingThingsOptimized

@ThingworxExtensionApiMethod(since={9,1})
public InfoTable QueryImplementingThingsOptimized(Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query,
 Boolean withPermissions,
 InfoTable basicPropertyNames,
 InfoTable propertyNames,
 String networkName,
 String networkParentNode,
 Integer networkMaxDepth,
 Double offset)
                                           throws Exception

Service Category:

Queries

Service Description:

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

Specified by:

QueryImplementingThingsOptimized in interface IImplementableEntity

Parameters:

maxItems - Maximum number of items to return - NUMBER

tags - Tags to search on - TAGS

nameMask - Name pattern - STRING

query - Query definition - QUERY

withPermissions - whether or not to include read / update / delete permission information in the result - BOOLEAN

basicPropertyNames - Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLE

propertyNames - Include propertyNames - INFOTABLE

networkName - Name of network - STRING

networkParentNode - Name of the top network node - STRING

networkMaxDepth - Max depth to search in the network - INTEGER

offset - the number of rows to skip before starting to return rows from the query - NUMBER

Returns:

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

Throws:

Exception - If an error occurs

QueryImplementingThingsOptimizedWithTotalCount

@ThingworxExtensionApiMethod(since={9,1})
public InfoTable QueryImplementingThingsOptimizedWithTotalCount(Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query,
 Boolean withPermissions,
 InfoTable basicPropertyNames,
 InfoTable propertyNames,
 String networkName,
 String networkParentNode,
 Integer networkMaxDepth,
 Double offset)
                                                         throws Exception

Service Category:

Queries

Service Description:

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

Specified by:

QueryImplementingThingsOptimizedWithTotalCount in interface IImplementableEntity

Parameters:

maxItems - Maximum number of items to return - NUMBER

tags - Tags to search on - TAGS

nameMask - Name pattern - STRING

query - Query definition - QUERY

withPermissions - whether or not to include read / update / delete permission information in the result - BOOLEAN

basicPropertyNames - Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLE

propertyNames - Include propertyNames - INFOTABLE

networkName - Name of network - STRING

networkParentNode - Name of the top network node - STRING

networkMaxDepth - Max depth to search in the network - INTEGER

offset - the number of rows to skip before starting to return rows from the query - NUMBER

Returns:

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

Throws:

Exception - If an error occurs

implementsShape

@ThingworxExtensionApiMethod(since={6,6})
public boolean implementsShape(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 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(String name)
                    throws Exception

Service Category:

DataLogging

Service Description:

Set the value stream for a thing.

Parameters:

name - Value stream name - THINGNAME

Throws:

Exception - If an error occurs

QueryImplementingThings

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

Deprecated.

Specified by:

QueryImplementingThings in interface IImplementableEntity

Throws:

Exception - If an error occurs

QueryImplementingThings

@ThingworxExtensionApiMethod(since={9,4})
public InfoTable QueryImplementingThings(Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query,
 Boolean isSortFirst)
                                  throws Exception

Service Category:

Queries

Service Description:

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

Parameters:

maxItems - Maximum number of items to return - NUMBER

tags - Tags to search on - TAGS

nameMask - Name pattern - STRING

query - Query definition - QUERY

isSortFirst - Sorts the things first if value is true - BOOLEAN

Returns:

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

Throws:

Exception - If an error occurs

QueryImplementingThingsV2

@ThingworxExtensionApiMethod(since={9,4})
public InfoTable QueryImplementingThingsV2(Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query,
 Boolean isSortFirst)
                                    throws Exception

Service Category:

Queries

Service Description:

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

Parameters:

maxItems - Maximum number of items to return - NUMBER

tags - Tags to search on - TAGS

nameMask - Name pattern - STRING

query - Query definition - QUERY

isSortFirst - Sorts the things first if value is true - BOOLEAN

Returns:

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

Throws:

Exception - If an error occurs

QueryImplementingThingsWithData

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

Service Category:

Queries

Service Description:

Return a list of all the things that implement this 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:

Exception - If an error occurs

QueryImplementingThingsWithDataV2

@ThingworxExtensionApiMethod(since={9,4})
public InfoTable QueryImplementingThingsWithDataV2(Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query)
                                            throws Exception

Service Category:

Queries

Service Description:

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

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:RootEntityListV2}

Throws:

Exception - If an error occurs

QueryImplementingThingsWithNamedData

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

Service Category:

Queries

Service Description:

Returns a list containing the specific properties and values of all the Things that Implement this Template.

Specified by:

QueryImplementingThingsWithNamedData in interface IImplementableEntity

Parameters:

maxItems - Maximum number of items to return - NUMBER

tags - Tags to search on - TAGS

nameMask - Name pattern - STRING

query - Query definition - QUERY

basicPropertyNames - Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLE

propertyNames - Include Specific properties of this Template - INFOTABLE

Returns:

result Implementing Things With Named Data - INFOTABLE - Aspects {dataShape:RootEntityList}

Throws:

Exception - If an error occurs

QueryImplementingThingsWithNamedDataV2

@ThingworxExtensionApiMethod(since={9,4})
public InfoTable QueryImplementingThingsWithNamedDataV2(Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query,
 InfoTable basicPropertyNames,
 InfoTable propertyNames)
                                                 throws Exception

Service Category:

Queries

Service Description:

Returns a list containing the specific properties and values of all the Things that Implement this Template.

Parameters:

maxItems - Maximum number of items to return - NUMBER

tags - Tags to search on - TAGS

nameMask - Name pattern - STRING

query - Query definition - QUERY

basicPropertyNames - Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLE

propertyNames - Include Specific properties of this Template - INFOTABLE

Returns:

result Implementing Things With Named Data - INFOTABLE - Aspects {dataShape:RootEntityListV2}

Throws:

Exception - If an error occurs

GetLoggedProperties

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetLoggedProperties(String type)
                              throws Exception

Service Category:

Metadata

Service Description:

Get a list of logged properties for this thing.

Parameters:

type - Type to filter on - BASETYPENAME

Returns:

result Property names - INFOTABLE - Aspects {dataShape:PropertyDefinition}

Throws:

Exception - If an error occurs

GetNumericLoggedProperties

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetNumericLoggedProperties()
                                     throws Exception

Service Category:

Metadata

Service Description:

Get a list of logged properties for this thing that are of a numeric data type.

Returns:

result Property names - INFOTABLE - Aspects {dataShape:PropertyDefinition}

Throws:

Exception - If an error occurs

QueryImplementingThingsWithPropertyHistory

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryImplementingThingsWithPropertyHistory(Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query,
 Double maxDataItems,
 org.joda.time.DateTime startDate,
 org.joda.time.DateTime endDate,
 Boolean oldestFirst,
 org.json.JSONObject dataQuery)
                                                     throws 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:

Exception - If an error occurs

QueryImplementingThingsWithNamedPropertyHistory

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryImplementingThingsWithNamedPropertyHistory(InfoTable propertyNames,
 Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query,
 Double maxDataItems,
 org.joda.time.DateTime startDate,
 org.joda.time.DateTime endDate,
 Boolean oldestFirst,
 org.json.JSONObject dataQuery)
                                                          throws 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:

Exception - If an error occurs

GetImplementingThings

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

Exception - If an error occurs

GetImplementingThingsWithData

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

Exception - If an error occurs

GetMashups

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetMashups()
                     throws Exception

Service Category:

Mashups

Service Description:

Get the mashups related to this thing template.

Returns:

result Mashups - INFOTABLE - Aspects {dataShape:MashupList}

Throws:

Exception - If an error occurs

getMashups

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

Throws:

Exception - If an error occurs

GetHomeMashup

@ThingworxExtensionApiMethod(since={6,6})
public 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 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 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:

Exception - If an error occurs

GetInstancePropertyDefinitions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstancePropertyDefinitions(String type)
                                         throws Exception

Service Category:

Metadata

Service Description:

Get the current property definitions for this thing.

Parameters:

type - Type to filter on - STRING

Returns:

result Property values - INFOTABLE - Aspects {dataShape:PropertyDefinition}

Throws:

Exception - If an error occurs

GetInstanceEventDefinitions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstanceEventDefinitions()
                                      throws Exception

Service Category:

Metadata

Service Description:

Get the current event definitions for this thing.

Returns:

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

Throws:

Exception - If an error occurs

GetInstanceServiceDefinitions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetInstanceServiceDefinitions()
                                        throws Exception

Service Category:

Metadata

Service Description:

Get the current service definitions for this thing.

Returns:

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

Throws:

Exception - If an error occurs

GetSharedConfigurationTable

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetSharedConfigurationTable(String tableName)
                                      throws 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:

Exception - If an error occurs

GetSharedConfigurationTableRow

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetSharedConfigurationTableRow(String tableName,
 String key)
                                         throws 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:

Exception - If an error occurs

IsSharedMultiRowTable

@ThingworxExtensionApiMethod(since={6,6})
public Boolean IsSharedMultiRowTable(String tableName)
                              throws 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:

Exception - If an error occurs

SetSharedConfigurationTable

@ThingworxExtensionApiMethod(since={6,6})
public void SetSharedConfigurationTable(String tableName,
 InfoTable configurationTable,
 Boolean persistent)
                                 throws 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:

Exception - If an error occurs

SetSharedMultiRowConfigurationTable

@ThingworxExtensionApiMethod(since={6,6})
public void SetSharedMultiRowConfigurationTable(String tableName,
 InfoTable configurationTable,
 Boolean persistent)
                                         throws 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:

Exception - If an error occurs

SetSharedConfigurationTableRows

@ThingworxExtensionApiMethod(since={6,6})
public void SetSharedConfigurationTableRows(String tableName,
 InfoTable values,
 Boolean persistent)
                                     throws 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:

Exception - If an error occurs

DeleteSharedConfigurationTable

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

Service Category:

Configuration

Service Description:

Delete an entire shared configuration table.

Parameters:

tableName - Configuration table name - STRING

persistent - Persist these changes - BOOLEAN

Throws:

Exception - If an error occurs

DeleteSharedConfigurationTableRows

@Deprecated
@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={9,6})
public void DeleteSharedConfigurationTableRows(String tableName,
 InfoTable values,
 Boolean persistent)
                                        throws Exception

Deprecated.

Throws:

Exception - If an error occurs

DeleteSharedConfigurationTableRows

@ThingworxExtensionApiMethod(since={9,6})
public void DeleteSharedConfigurationTableRows(String tableName,
 InfoTable values,
 Boolean persistent,
 Boolean removeAllMatchingRows)
                                        throws 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

removeAllMatchingRows - It will remove all matching rows if value is true - BOOLEAN

Throws:

Exception - If an error occurs

DeleteAllSharedConfigurationTableRows

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteAllSharedConfigurationTableRows(String tableName,
 Boolean persistent)
                                           throws 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:

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(String serviceName)

Specified by:

getEffectiveServiceDefinition in interface IServiceMetadataProvider

getEffectiveEventDefinition

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

Specified by:

getEffectiveEventDefinition in interface IEventMetadataProvider

getEffectivePropertyDefinition

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

Specified by:

getEffectivePropertyDefinition in interface IAlertProvider

AddOrUpdateAlert

@ThingworxExtensionApiMethod(since={6,6})
public void AddOrUpdateAlert(String property,
 String alertType,
 String alertName,
 String description,
 Boolean enabled,
 Integer priority,
 InfoTable attributes,
 Boolean persistent)
                      throws Exception

Service Category:

Alerts

Service Description:

Add or update an alert for a property.

Parameters:

property - Property name - STRING

alertType - Alert type - STRING

alertName - Alert name - STRING

description - Alert description - STRING

enabled - Alert enabled - BOOLEAN

priority - Alert priority - INTEGER

attributes - Alert attributes - INFOTABLE

persistent - Persist this change - BOOLEAN

Throws:

Exception - If an error occurs

RemoveAlert

@ThingworxExtensionApiMethod(since={6,6})
public void RemoveAlert(String property,
 String alertName,
 Boolean persistent)
                 throws Exception

Service Category:

Alerts

Service Description:

Remove an alert for a property.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

persistent - Persist this change - BOOLEAN

Throws:

Exception - If an error occurs

GetLocalAlertDefinitions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetLocalAlertDefinitions(String property)
                                   throws Exception

Service Category:

Alerts

Service Description:

Get local alert definitions for a property.

Parameters:

property - Property name - STRING

Returns:

AlertDefinitions Alert definition - INFOTABLE - Aspects {dataShape:AlertDefinition}

Throws:

Exception - If an error occurs

GetAlertDefinitions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetAlertDefinitions(String property)
                              throws Exception

Service Category:

Alerts

Service Description:

Get effective alert definitions for a property.

Parameters:

property - Property name - STRING

Returns:

AlertDefinitions Alert definition - INFOTABLE - Aspects {dataShape:AlertDefinition}

Throws:

Exception - If an error occurs

GetAlertDefinition

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetAlertDefinition(String property,
 String alertName)
                             throws Exception

Service Category:

Alerts

Service Description:

Get alert definition for a property.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

Returns:

AlertDefinitions Alert definition - INFOTABLE - Aspects {dataShape:AlertDefinition}

Throws:

Exception - If an error occurs

HasAlert

@ThingworxExtensionApiMethod(since={6,6})
public Boolean HasAlert(String property,
 String alertName)
                 throws Exception

Service Category:

Alerts

Service Description:

Check to see if an alert is defined for a property.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

Returns:

result Has alert definition - BOOLEAN

Throws:

Exception - If an error occurs

SetNumberAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetNumberAlertParameter(String property,
 String alertName,
 String parameterName,
 Double value,
 Boolean persistent)
                             throws Exception

Service Category:

Alerts

Service Description:

Set a numeric alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

value - Parameter value - NUMBER

persistent - Make it persistent - BOOLEAN

Throws:

Exception - If an error occurs

GetNumberAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public Double GetNumberAlertParameter(String property,
 String alertName,
 String parameterName)
                               throws Exception

Service Category:

Alerts

Service Description:

Get a numeric alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

Returns:

value Alert parameter value - NUMBER

Throws:

Exception - If an error occurs

SetIntegerAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetIntegerAlertParameter(String property,
 String alertName,
 String parameterName,
 Integer value,
 Boolean persistent)
                              throws Exception

Service Category:

Alerts

Service Description:

Set a numeric alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

value - Parameter value - INTEGER

persistent - Make it persistent - BOOLEAN

Throws:

Exception - If an error occurs

GetIntegerAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public Integer GetIntegerAlertParameter(String property,
 String alertName,
 String parameterName)
                                 throws Exception

Service Category:

Alerts

Service Description:

Get a numeric alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

Returns:

value Alert parameter value - INTEGER

Throws:

Exception - If an error occurs

GetLongAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public Long GetLongAlertParameter(String property,
 String alertName,
 String parameterName)
                           throws Exception

Service Category:

Alerts

Service Description:

Get a numeric alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

Returns:

value Alert parameter value - LONG

Throws:

Exception - If an error occurs

SetBooleanAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetBooleanAlertParameter(String property,
 String alertName,
 String parameterName,
 Boolean value,
 Boolean persistent)
                              throws Exception

Service Category:

Alerts

Service Description:

Set a boolean alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

value - Parameter value - BOOLEAN

persistent - Make it persistent - BOOLEAN

Throws:

Exception - If an error occurs

GetBooleanAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public Boolean GetBooleanAlertParameter(String property,
 String alertName,
 String parameterName)
                                 throws Exception

Service Category:

Alerts

Service Description:

Get a boolean alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

Returns:

value Alert parameter value - BOOLEAN

Throws:

Exception - If an error occurs

SetDateTimeAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetDateTimeAlertParameter(String property,
 String alertName,
 String parameterName,
 org.joda.time.DateTime value,
 Boolean persistent)
                               throws Exception

Service Category:

Alerts

Service Description:

Set a date alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

value - Parameter value - DATETIME

persistent - Make it persistent - BOOLEAN

Throws:

Exception - If an error occurs

GetDateTimeAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public org.joda.time.DateTime GetDateTimeAlertParameter(String property,
 String alertName,
 String parameterName)
                                                 throws Exception

Service Category:

Alerts

Service Description:

Get a date alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

Returns:

value Alert parameter value - DATETIME

Throws:

Exception - If an error occurs

SetLocationAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetLocationAlertParameter(String property,
 String alertName,
 String parameterName,
 Location value,
 Boolean persistent)
                               throws Exception

Service Category:

Alerts

Service Description:

Set a location alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

value - Parameter value - LOCATION

persistent - Make it persistent - BOOLEAN

Throws:

Exception - If an error occurs

GetLocationAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public Location GetLocationAlertParameter(String property,
 String alertName,
 String parameterName)
                                   throws Exception

Service Category:

Alerts

Service Description:

Get a location alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

Returns:

value Alert parameter value - LOCATION

Throws:

Exception - If an error occurs

SetStringAlertParameter

@ThingworxExtensionApiMethod(since={6,6})
public void SetStringAlertParameter(String property,
 String alertName,
 String parameterName,
 String value,
 Boolean persistent)
                             throws Exception

Service Category:

Alerts

Service Description:

Set a string alert parameter.

Parameters:

property - Property name - STRING

alertName - Alert name - STRING

parameterName - Parameter name - STRING

value - Parameter value - STRING

persistent - Make it persistent - BOOLEAN

Throws:

Exception - If an error occurs

GetLocalPropertyBinding

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetLocalPropertyBinding(String propertyName)
                                  throws Exception

Service Category:

Bindings

Service Description:

Get the property binding for a property.

Parameters:

propertyName - Property name - STRING

Returns:

result Property binding - INFOTABLE - Aspects {dataShape:LocalPropertyBinding}

Throws:

Exception - If an error occurs

GetEffectiveLocalPropertyBindings

@ThingworxExtensionApiMethod(since={7,3})
public InfoTable GetEffectiveLocalPropertyBindings()
                                            throws Exception

Service Category:

Bindings

Service Description:

Get the effective local property bindings.

Get all effective (inherited and local) property bindings for this thing

Returns:

InfoTable of local property bindings consists of property name, name of thing(sourceThingName) and name of property(sourceName) the property is locally bound to.

Throws:

Exception - - any exception while execution

GetEffectiveLocalPropertyBinding

@ThingworxExtensionApiMethod(since={7,3})
public InfoTable GetEffectiveLocalPropertyBinding(String propertyName)
                                           throws Exception

Service Category:

Bindings

Service Description:

Get the effective local property binding for a property.

Get the effective (inherited and local) property binding for a property

Parameters:

propertyName - : name of property to get the local binding

Returns:

InfoTable of local property bindings consists of property name, name of thing(sourceThingName) and name of property(sourceName) the property is locally bound to.

Throws:

Exception - - any exception while execution

RemoveLocalPropertyBinding

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

Service Category:

Bindings

Service Description:

Remove the local property binding for a property.

Parameters:

propertyName - Property name - STRING

Throws:

Exception - If an error occurs

SetLocalPropertyBinding

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

Deprecated.

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

Throws:

Exception - If an error occurs

SetLocalPropertyBinding

@ThingworxExtensionApiMethod(since={8,1,0})
public void SetLocalPropertyBinding(String propertyName,
 String sourceThingName,
 String sourcePropertyName,
 org.json.JSONObject aspects)
                             throws Exception

Service Category:

Bindings

Service Description:

Set the property binding for a property.

Parameters:

propertyName - Property name - STRING

sourceThingName - Thing name to bind to - STRING

sourcePropertyName - Source property name - STRING

aspects - Aspects for the local binding - JSON

Throws:

Exception - If an error occurs

GetRemotePropertyBinding

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetRemotePropertyBinding(String propertyName)
                                   throws Exception

Service Category:

Bindings

Service Description:

Get the remote property binding for a property.

Parameters:

propertyName - Property name - STRING

Returns:

result Property binding - INFOTABLE - Aspects {dataShape:RemotePropertyBinding}

Throws:

Exception - If an error occurs

RemoveRemotePropertyBinding

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

Service Category:

Bindings

Service Description:

Remove the remote property binding for a property.

Parameters:

propertyName - Property name - STRING

Throws:

Exception - If an error occurs

SetRemotePropertyBinding

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

Deprecated.

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

Throws:

Exception - If an error occurs

SetRemotePropertyBinding

@ThingworxExtensionApiMethod(since={8,0})
public void SetRemotePropertyBinding(String propertyName,
 String sourcePropertyName,
 Integer timeout,
 String pushType,
 Double pushThreshold,
 org.json.JSONObject aspects,
 Integer cacheTime,
 String foldType)
                              throws Exception

Service Category:

Bindings

Service Description:

Set the remote property binding for a property.

Parameters:

propertyName - Property name - STRING

sourcePropertyName - Source property name - STRING

timeout - Request timeout - INTEGER

pushType - Push type - STRING

pushThreshold - Push threshold - NUMBER

aspects - Aspects for the remote binding - JSON

cacheTime - Property's cache time value at the server - INTEGER

foldType - How a remote property's value should be handled by the server when a connection is lost - STRING

Throws:

Exception - If an error occurs

GetRemoteServiceBinding

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetRemoteServiceBinding(String serviceName)
                                  throws Exception

Service Category:

Bindings

Service Description:

Get the remote service binding for a service.

Parameters:

serviceName - Service name - STRING

Returns:

result Service binding - INFOTABLE - Aspects {dataShape:RemoteServiceBinding}

Throws:

Exception - If an error occurs

RemoveRemoteServiceBinding

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

Service Category:

Bindings

Service Description:

Remove the remote service binding for a service.

Parameters:

serviceName - Service name - STRING

Throws:

Exception - If an error occurs

SetRemoteServiceBinding

@ThingworxExtensionApiMethod(since={6,6})
public void SetRemoteServiceBinding(String serviceName,
 String sourceServiceName,
 Integer timeout)
                             throws Exception

Service Category:

Bindings

Service Description:

Set the remote service binding for a service.

Parameters:

serviceName - Service name - STRING

sourceServiceName - Source service name - STRING

timeout - Request timeout - INTEGER

Throws:

Exception - If an error occurs

GetRemoteEventBinding

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetRemoteEventBinding(String eventName)
                                throws Exception

Service Category:

Bindings

Service Description:

Get the remote event binding for a event.

Parameters:

eventName - Event name - STRING

Returns:

result Event binding - INFOTABLE - Aspects {dataShape:RemoteEventBinding}

Throws:

Exception - If an error occurs

RemoveRemoteEventBinding

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

Service Category:

Bindings

Service Description:

Remove the remote event binding for a event.

Parameters:

eventName - Event name - STRING

Throws:

Exception - If an error occurs

SetRemoteEventBinding

@ThingworxExtensionApiMethod(since={6,6})
public void SetRemoteEventBinding(String eventName,
 String sourceEventName)
                           throws Exception

Service Category:

Bindings

Service Description:

Set the remote event binding for a event.

Parameters:

eventName - Event name - STRING

sourceEventName - Source event name - STRING

Throws:

Exception - If an error occurs