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<java.lang.String>
,IDesignTimeSecurable
,IDesignTimeSecurableEntity
,IInstanceDesignTimeSecurable
,IInstanceRunTimeSecurable
,IInstanceSecurable
,IInstanceVisibilitySecurable
,IRunTimeSecurable
,IRunTimeSecurableEntity
,ISecurable
,IVisibilitySecurable
,IVisibilitySecurableEntity
,IAspectContainer
,INamedObject
,java.io.Serializable
@ThingworxExtensionApiClass(since={6,6}, canInstantiate=true) public class ThingTemplate extends ServiceProviderEntity implements IRunTimeSecurable, IInstanceSecurable, IImplementableEntity, IEventMetadataProvider, IServiceMetadataProvider, IShapeProvider, IAlertProvider, IHierarchicalEntity, 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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
AddEventDefinition(java.lang.String name, java.lang.String description, java.lang.String category, java.lang.String dataShape, java.lang.Boolean remote, java.lang.String remoteEventName)
Service Category: Metadata Service Description: Add or update an event definition.void
addInstanceDesignTimePermission(PermissionTypes permissionType, Permission permission)
void
AddInstanceDesignTimePermission(java.lang.String type, java.lang.String principal, java.lang.String principalType, java.lang.Boolean allow)
Service Category: Permissions Service Description: Add an instance design time permission.void
addInstanceRunTimePermission(PermissionTypes permissionType, java.lang.String resourceName, Permission permission)
void
AddInstanceRunTimePermission(java.lang.String type, java.lang.String resource, java.lang.String principal, java.lang.String principalType, java.lang.Boolean allow)
Service Category: Permissions Service Description: Add an instance run time permission.void
addInstanceVisibilityPermission(PermissionTypes permissionType, Permission permission)
void
AddInstanceVisibilityPermission(java.lang.String principal, java.lang.String principalType)
Service Category: Permissions Service Description: Add a visibility permission.void
AddOrUpdateAlert(java.lang.String property, java.lang.String alertType, java.lang.String alertName, java.lang.String description, java.lang.Boolean enabled, java.lang.Integer priority, InfoTable attributes, java.lang.Boolean persistent)
Service Category: Alerts Service Description: Add or update an alert for a property.void
AddPropertyDefinition(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String category, java.lang.String dataShape, java.lang.Boolean readOnly, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.Boolean indexed, java.lang.String dataChangeType, java.lang.Double dataChangeThreshold, java.lang.Boolean remote, java.lang.String remotePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, java.lang.String defaultValue, org.json.JSONObject remoteBindingAspects)
Deprecated.void
AddPropertyDefinition(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String category, java.lang.String dataShape, java.lang.Boolean readOnly, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.Boolean indexed, java.lang.String dataChangeType, java.lang.Double dataChangeThreshold, java.lang.Boolean remote, java.lang.String remotePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, java.lang.String defaultValue, org.json.JSONObject remoteBindingAspects, org.json.JSONObject accessModifier)
Service Category: Metadata Service Description: Add a property definition.void
AddPropertyDefinition(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String category, java.lang.String dataShape, java.lang.Boolean readOnly, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.String dataChangeType, java.lang.Double dataChangeThreshold, java.lang.Boolean remote, java.lang.String remotePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, java.lang.String defaultValue)
Deprecated.As of release 8.0, replaced by AddPropertyDefinition(String, String, String, String, String, Boolean, Boolean, Boolean, String, Double, Boolean, String, Integer, String, Double, String, JSONObject)void
AddPropertyDefinition(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String category, java.lang.String dataShape, java.lang.Boolean readOnly, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.String dataChangeType, java.lang.Double dataChangeThreshold, java.lang.Boolean remote, java.lang.String remotePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, java.lang.String defaultValue, org.json.JSONObject remoteBindingAspects)
Deprecated.InfoTable
AddPropertyDefinitions(InfoTable values, java.lang.Boolean ignoreInvalidDefinitions)
Service Category: Metadata Service Description: Add multiple property definitions at once.void
AddPropertyTransformDefinition(java.lang.String name, java.lang.String description, java.lang.String category, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.Integer timeout, InfoTable propertyTransformConfig)
Service Category: Metadata Service Description: Add a property transform definition.void
AddServiceDefinition(java.lang.String name, java.lang.String description, java.lang.String category, InfoTable parameters, InfoTable resultType, java.lang.Boolean remote, java.lang.String remoteServiceName, java.lang.Integer timeout)
Deprecated.void
AddServiceDefinition(java.lang.String name, java.lang.String description, java.lang.String category, InfoTable parameters, InfoTable resultType, java.lang.Boolean remote, java.lang.String remoteServiceName, java.lang.Integer timeout, org.json.JSONObject accessModifier)
Service Category: Metadata Service Description: Add or update a service definition.void
DeleteAllSharedConfigurationTableRows(java.lang.String tableName, java.lang.Boolean persistent)
Service Category: Configuration Service Description: Delete all rows from a shared multi-row configuration table.void
deleteInstanceDesignTimePermission(PermissionTypes permissionType, Permission permission)
void
DeleteInstanceDesignTimePermission(java.lang.String type, java.lang.String principal, java.lang.String principalType)
Service Category: Permissions Service Description: Delete an instance design time permission.void
deleteInstanceRunTimePermission(PermissionTypes permissionType, java.lang.String resourceName, Permission permission)
void
DeleteInstanceRunTimePermission(java.lang.String type, java.lang.String resource, java.lang.String principal, java.lang.String principalType)
Service Category: Permissions Service Description: Delete an instance run time permission.void
deleteInstanceVisibilityPermission(PermissionTypes permissionType, Permission permission)
void
DeleteInstanceVisibilityPermission(java.lang.String principal, java.lang.String principalType)
Service Category: Permissions Service Description: Delete a visibility permission.void
DeleteSharedConfigurationTable(java.lang.String tableName, java.lang.Boolean persistent)
Service Category: Configuration Service Description: Delete an entire shared configuration table.void
DeleteSharedConfigurationTableRows(java.lang.String tableName, InfoTable values, java.lang.Boolean persistent)
Deprecated.void
DeleteSharedConfigurationTableRows(java.lang.String tableName, InfoTable values, java.lang.Boolean persistent, java.lang.Boolean removeAllMatchingRows)
Service Category: Configuration Service Description: Delete one or more rows from a shared multi-row configuration table.void
DisableSubscription(java.lang.String subscriptionName)
Service Category: Subscriptions Service Description: Disable Subscription.void
DisableSubscription(java.lang.String thingName, java.lang.String eventName, java.lang.String propertyName)
Deprecated.void
EnableSubscription(java.lang.String subscriptionName)
Service Category: Subscriptions Service Description: Enable Subscription.void
EnableSubscription(java.lang.String thingName, java.lang.String eventName, java.lang.String propertyName)
Deprecated.AlertConfigurationCollection
getAlertConfigurations()
InfoTable
GetAlertDefinition(java.lang.String property, java.lang.String alertName)
Service Category: Alerts Service Description: Get alert definition for a property.InfoTable
GetAlertDefinitions(java.lang.String property)
Service Category: Alerts Service Description: Get effective alert definitions for a property.EntityReferenceCollection
getAllImplementedThingTemplates()
ImagePrimitive
GetAvatar()
Service Category: Avatar Service Description: Get avatar image.ThingTemplate
getBaseThingTemplate()
java.lang.String
GetBaseThingTemplate()
Service Category: Template Service Description: Get base thing template name.java.lang.String
getBaseThingTemplateName()
java.lang.Boolean
GetBooleanAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)
Service Category: Alerts Service Description: Get a boolean alert parameter.org.joda.time.DateTime
GetDateTimeAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)
Service Category: Alerts Service Description: Get a date alert parameter.EntityReferenceTypeMap
getDependencies()
ThingTemplate
getDerivedBaseThingTemplate()
AlertConfigurationCollection
getEffectiveAlertConfiguration()
EventDefinition
getEffectiveEventDefinition(java.lang.String eventName)
InfoTable
GetEffectiveLocalPropertyBinding(java.lang.String propertyName)
Service Category: Bindings Service Description: Get the effective local property binding for a property.
Get the effective (inherited and local) property binding for a propertyInfoTable
GetEffectiveLocalPropertyBindings()
Service Category: Bindings Service Description: Get the effective local property bindings.
Get all effective (inherited and local) property bindings for this thingPropertyDefinition
getEffectivePropertyDefinition(java.lang.String propertyName)
ServiceDefinition
getEffectiveServiceDefinition(java.lang.String serviceName)
java.lang.String
GetEffectiveThingPackageName()
Service Category: Metadata Service Description: Get effective thing package.RelationshipTypes.ThingworxRelationshipTypes
getEntityType()
java.lang.String
GetHomeMashup()
Service Category: Mashups Service Description: Get home mashup.EntityReferenceTypeMap
getImplementations()
EntityReferenceCollection
getImplementedThingShapes()
InfoTable
GetImplementingThings()
Service Category: Queries Service Description: Return a list of all the things that implement this template.InfoTable
GetImplementingThingsWithData()
Service Category: Queries Service Description: Return a list of all the things that implement this template along with the thing properties and values.DesignTimePermissionCollection
getInstanceDesignTimePermissions()
InfoTable
GetInstanceDesignTimePermissions()
Service Category: Permissions Service Description: Get a list of assigned instance design time permissions.org.json.JSONObject
GetInstanceDesignTimePermissionsAsJSON()
Service Category: Permissions Service Description: Get a list of instance design time permissions.InfoTable
GetInstanceEventDefinitions()
Service Category: Metadata Service Description: Get the current event definitions for this thing.InfoTable
GetInstancePropertyDefinitions(java.lang.String type)
Service Category: Metadata Service Description: Get the current property definitions for this thing.RunTimePermissionCollection
getInstanceRunTimePermissions()
InfoTable
GetInstanceRunTimePermissions()
Service Category: Permissions Service Description: Get a list of assigned instance runtime permissions.org.json.JSONObject
GetInstanceRunTimePermissionsAsJSON()
Service Category: Permissions Service Description: Get a list of assigned runtime permissions.InfoTable
GetInstanceServiceDefinitions()
Service Category: Metadata Service Description: Get the current service definitions for this thing.ThingShapeInstance
getInstanceShape()
VisibilityPermissionCollection
getInstanceVisibilityPermissions()
InfoTable
GetInstanceVisibilityPermissions()
Service Category: Permissions Service Description: Get a list of assigned visibility permissions.org.json.JSONObject
GetInstanceVisibilityPermissionsAsJSON()
Service Category: Permissions Service Description: Get a list of instance visibility permissions.java.lang.Integer
GetIntegerAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)
Service Category: Alerts Service Description: Get a numeric alert parameter.InfoTable
GetLocalAlertDefinitions(java.lang.String property)
Service Category: Alerts Service Description: Get local alert definitions for a property.InfoTable
GetLocalPropertyBinding(java.lang.String propertyName)
Service Category: Bindings Service Description: Get the property binding for a property.Location
GetLocationAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)
Service Category: Alerts Service Description: Get a location alert parameter.InfoTable
GetLoggedProperties(java.lang.String type)
Service Category: Metadata Service Description: Get a list of logged properties for this thing.java.lang.Long
GetLongAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)
Service Category: Alerts Service Description: Get a numeric alert parameter.EntityReferenceCollection
getMashups()
InfoTable
GetMashups()
Service Category: Mashups Service Description: Get the mashups related to this thing template.java.lang.Double
GetNumberAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName)
Service Category: Alerts Service Description: Get a numeric alert parameter.InfoTable
GetNumericLoggedProperties()
Service Category: Metadata Service Description: Get a list of logged properties for this thing that are of a numeric data type.java.lang.Boolean
GetPropertyLogging(java.lang.String propertyName)
Service Category: DataLogging Service Description: Get property logging status for a specific property.InfoTable
GetRemoteEventBinding(java.lang.String eventName)
Service Category: Bindings Service Description: Get the remote event binding for a event.InfoTable
GetRemotePropertyBinding(java.lang.String propertyName)
Service Category: Bindings Service Description: Get the remote property binding for a property.InfoTable
GetRemoteServiceBinding(java.lang.String serviceName)
Service Category: Bindings Service Description: Get the remote service binding for a service.InfoTable
GetSharedConfigurationTable(java.lang.String tableName)
Service Category: Configuration Service Description: Get a specific shared configuration table as an InfoTable.InfoTable
GetSharedConfigurationTableRow(java.lang.String tableName, java.lang.String key)
Service Category: Configuration Service Description: Get a specific shared configuration table row as an InfoTable.java.lang.String
GetValueStream()
Service Category: DataLogging Service Description: Get the identifier for a thing.java.lang.Boolean
HasAlert(java.lang.String property, java.lang.String alertName)
Service Category: Alerts Service Description: Check to see if an alert is defined for a property.boolean
implementsShape(java.lang.String thingShape)
java.lang.Boolean
IsDerivedFromTemplate(java.lang.String thingTemplateName)
Service Category: Metadata Service Description: Check to see if a thing is derived from a particular thing template.java.lang.Boolean
IsSharedMultiRowTable(java.lang.String tableName)
Service Category: Configuration Service Description: Check if a shared configuration table is a multi-row table.void
persistInstanceDesignTimePermissions()
void
persistInstanceRunTimePermissions()
void
persistInstanceVisibilityPermissions()
InfoTable
QueryImplementingThings(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query)
Deprecated.InfoTable
QueryImplementingThings(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Boolean isSortFirst)
Service Category: Queries Service Description: Return a list of all the things that implement this template.InfoTable
QueryImplementingThingsOptimized(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Boolean withPermissions, InfoTable basicPropertyNames, InfoTable propertyNames, java.lang.String networkName, java.lang.String networkParentNode, java.lang.Integer networkMaxDepth, java.lang.Double offset)
Service Category: Queries Service Description: Return a list of all the things that implement this shape.InfoTable
QueryImplementingThingsOptimizedWithTotalCount(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Boolean withPermissions, InfoTable basicPropertyNames, InfoTable propertyNames, java.lang.String networkName, java.lang.String networkParentNode, java.lang.Integer networkMaxDepth, java.lang.Double offset)
Service Category: Queries Service Description: Return a list of all the things that implement this shape.InfoTable
QueryImplementingThingsV2(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Boolean isSortFirst)
Service Category: Queries Service Description: Return a list of all the things that implement this template.InfoTable
QueryImplementingThingsWithData(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query)
Service Category: Queries Service Description: Return a list of all the things that implement this template along with the thing properties and values.InfoTable
QueryImplementingThingsWithDataV2(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query)
Service Category: Queries Service Description: Return a list of all the things that implement this template along with the thing properties and values.InfoTable
QueryImplementingThingsWithNamedData(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, InfoTable basicPropertyNames, InfoTable propertyNames)
Service Category: Queries Service Description: Returns a list containing the specific properties and values of all the Things that Implement this Template.InfoTable
QueryImplementingThingsWithNamedDataV2(java.lang.Double maxItems, TagCollection tags, java.lang.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, java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Double maxDataItems, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, java.lang.Boolean oldestFirst, org.json.JSONObject dataQuery)
Service Category: Queries Service Description: Return a list of all the things that implement this template along with the thing property history.InfoTable
QueryImplementingThingsWithPropertyHistory(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Double maxDataItems, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, java.lang.Boolean oldestFirst, org.json.JSONObject dataQuery)
Service Category: Queries Service Description: Return a list of all the things that implement this template along with the thing property history.void
RemoveAlert(java.lang.String property, java.lang.String alertName, java.lang.Boolean persistent)
Service Category: Alerts Service Description: Remove an alert for a property.void
RemoveEventDefinition(java.lang.String name)
Service Category: Metadata Service Description: Remove a event definition.void
RemoveLocalPropertyBinding(java.lang.String propertyName)
Service Category: Bindings Service Description: Remove the local property binding for a property.void
RemovePropertyDefinition(java.lang.String name)
Service Category: Metadata Service Description: Remove a property definition.void
RemoveRemoteEventBinding(java.lang.String eventName)
Service Category: Bindings Service Description: Remove the remote event binding for a event.void
RemoveRemotePropertyBinding(java.lang.String propertyName)
Service Category: Bindings Service Description: Remove the remote property binding for a property.void
RemoveRemoteServiceBinding(java.lang.String serviceName)
Service Category: Bindings Service Description: Remove the remote service binding for a service.void
RemoveServiceDefinition(java.lang.String name)
Service Category: Metadata Service Description: Remove a service definition.void
setBaseThingTemplateName(java.lang.String value)
void
SetBooleanAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.Boolean value, java.lang.Boolean persistent)
Service Category: Alerts Service Description: Set a boolean alert parameter.void
SetDateTimeAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, org.joda.time.DateTime value, java.lang.Boolean persistent)
Service Category: Alerts Service Description: Set a date alert parameter.void
setImplementedThingShapes(EntityReferenceCollection value)
void
setInstanceDesignTimePermissions(DesignTimePermissionCollection value)
void
SetInstanceDesignTimePermissionsAsJSON(org.json.JSONObject permissions)
Service Category: Permissions Service Description: Set a list of instance design time permissions.void
setInstanceRunTimePermissions(RunTimePermissionCollection value)
void
SetInstanceRunTimePermissionsAsJSON(org.json.JSONObject permissions)
Service Category: Permissions Service Description: Set a list of assigned runtime permissions.void
setInstanceVisibilityPermissions(VisibilityPermissionCollection value)
void
SetInstanceVisibilityPermissionsAsJSON(org.json.JSONObject permissions)
Service Category: Permissions Service Description: Set a list of instance visibility permissions.void
SetIntegerAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.Integer value, java.lang.Boolean persistent)
Service Category: Alerts Service Description: Set a numeric alert parameter.void
SetLocalPropertyBinding(java.lang.String propertyName, java.lang.String sourceThingName, java.lang.String sourcePropertyName)
Deprecated.As of release 8.1.0, replaced bySetLocalPropertyBinding(String, String, String, JSONObject)
void
SetLocalPropertyBinding(java.lang.String propertyName, java.lang.String sourceThingName, java.lang.String sourcePropertyName, org.json.JSONObject aspects)
Service Category: Bindings Service Description: Set the property binding for a property.void
SetLocationAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, Location value, java.lang.Boolean persistent)
Service Category: Alerts Service Description: Set a location alert parameter.void
SetNumberAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.Double value, java.lang.Boolean persistent)
Service Category: Alerts Service Description: Set a numeric alert parameter.void
SetPropertyLogging(java.lang.String propertyName, java.lang.Boolean enabled)
Service Category: DataLogging Service Description: Set property logging status for a specific property.void
SetRemoteEventBinding(java.lang.String eventName, java.lang.String sourceEventName)
Service Category: Bindings Service Description: Set the remote event binding for a event.void
SetRemotePropertyBinding(java.lang.String propertyName, java.lang.String sourcePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold)
Deprecated.As of release 8.0.0, replaced bySetRemotePropertyBinding(String, String, Integer, String, Double, JSONObject, Integer, String)
void
SetRemotePropertyBinding(java.lang.String propertyName, java.lang.String sourcePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, org.json.JSONObject aspects, java.lang.Integer cacheTime, java.lang.String foldType)
Service Category: Bindings Service Description: Set the remote property binding for a property.void
SetRemoteServiceBinding(java.lang.String serviceName, java.lang.String sourceServiceName, java.lang.Integer timeout)
Service Category: Bindings Service Description: Set the remote service binding for a service.void
SetSharedConfigurationTable(java.lang.String tableName, InfoTable configurationTable, java.lang.Boolean persistent)
Service Category: Configuration Service Description: Set an entire shared configuration table.void
SetSharedConfigurationTableRows(java.lang.String tableName, InfoTable values, java.lang.Boolean persistent)
Service Category: Configuration Service Description: Update/add one or more rows in a shared multi-row configuration table.void
SetSharedMultiRowConfigurationTable(java.lang.String tableName, InfoTable configurationTable, java.lang.Boolean persistent)
Service Category: Configuration Service Description: Set an entire shared multi-row configuration table.void
SetStringAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.String value, java.lang.Boolean persistent)
Service Category: Alerts Service Description: Set a string alert parameter.void
SetUnitsForNumericPropertyDefinition(java.lang.String propertyName, java.lang.String units)
Service Category: Metadata Service Description: Set the additional information for units for a specific Long, Integer, or Number property.void
SetValueStream(java.lang.String name)
Service Category: DataLogging Service Description: Set the value stream for a thing.-
Methods inherited from class com.thingworx.entities.ServiceProviderEntity
getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest
-
Methods inherited from class com.thingworx.entities.RootEntity
AddConfigurationTableDefinition, 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
-
-
-
-
Method Detail
-
getAlertConfigurations
@ThingworxExtensionApiMethod(since={6,6}) public AlertConfigurationCollection getAlertConfigurations()
- Specified by:
getAlertConfigurations
in interfaceIAlertProvider
-
getEffectiveAlertConfiguration
@ThingworxExtensionApiMethod(since={6,6}) public AlertConfigurationCollection getEffectiveAlertConfiguration()
- Specified by:
getEffectiveAlertConfiguration
in interfaceIAlertProvider
-
GetBaseThingTemplate
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.String GetBaseThingTemplate()
- Service Category:
- Template
- Service Description:
- Get base thing template name.
- Returns:
- result Base thing template name - THINGTEMPLATENAME
-
getBaseThingTemplateName
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.String getBaseThingTemplateName()
-
setBaseThingTemplateName
@ThingworxExtensionApiMethod(since={6,6}) public void setBaseThingTemplateName(java.lang.String value)
-
getInstanceDesignTimePermissions
@ThingworxExtensionApiMethod(since={6,6}) public DesignTimePermissionCollection getInstanceDesignTimePermissions()
- Specified by:
getInstanceDesignTimePermissions
in interfaceIInstanceDesignTimeSecurable
-
setInstanceDesignTimePermissions
@ThingworxExtensionApiMethod(since={6,6}) public void setInstanceDesignTimePermissions(DesignTimePermissionCollection value)
- Specified by:
setInstanceDesignTimePermissions
in interfaceIInstanceDesignTimeSecurable
-
addInstanceDesignTimePermission
@ThingworxExtensionApiMethod(since={6,6}) public void addInstanceDesignTimePermission(PermissionTypes permissionType, Permission permission) throws java.lang.Exception
- Specified by:
addInstanceDesignTimePermission
in interfaceIInstanceDesignTimeSecurable
- Throws:
java.lang.Exception
- If an error occurs
-
deleteInstanceDesignTimePermission
@ThingworxExtensionApiMethod(since={6,6}) public void deleteInstanceDesignTimePermission(PermissionTypes permissionType, Permission permission) throws java.lang.Exception
- Specified by:
deleteInstanceDesignTimePermission
in interfaceIInstanceDesignTimeSecurable
- Throws:
java.lang.Exception
- If an error occurs
-
getInstanceVisibilityPermissions
@ThingworxExtensionApiMethod(since={6,6}) public VisibilityPermissionCollection getInstanceVisibilityPermissions()
- Specified by:
getInstanceVisibilityPermissions
in interfaceIInstanceVisibilitySecurable
-
setInstanceVisibilityPermissions
@ThingworxExtensionApiMethod(since={6,6}) public void setInstanceVisibilityPermissions(VisibilityPermissionCollection value)
- Specified by:
setInstanceVisibilityPermissions
in interfaceIInstanceVisibilitySecurable
-
addInstanceVisibilityPermission
@ThingworxExtensionApiMethod(since={6,6}) public void addInstanceVisibilityPermission(PermissionTypes permissionType, Permission permission) throws java.lang.Exception
- Specified by:
addInstanceVisibilityPermission
in interfaceIInstanceVisibilitySecurable
- Throws:
java.lang.Exception
- If an error occurs
-
deleteInstanceVisibilityPermission
@ThingworxExtensionApiMethod(since={6,6}) public void deleteInstanceVisibilityPermission(PermissionTypes permissionType, Permission permission) throws java.lang.Exception
- Specified by:
deleteInstanceVisibilityPermission
in interfaceIInstanceVisibilitySecurable
- Throws:
java.lang.Exception
- If an error occurs
-
getInstanceRunTimePermissions
@ThingworxExtensionApiMethod(since={6,6}) public RunTimePermissionCollection getInstanceRunTimePermissions()
- Specified by:
getInstanceRunTimePermissions
in interfaceIInstanceRunTimeSecurable
-
setInstanceRunTimePermissions
@ThingworxExtensionApiMethod(since={6,6}) public void setInstanceRunTimePermissions(RunTimePermissionCollection value)
- Specified by:
setInstanceRunTimePermissions
in interfaceIInstanceRunTimeSecurable
-
addInstanceRunTimePermission
@ThingworxExtensionApiMethod(since={6,6}) public void addInstanceRunTimePermission(PermissionTypes permissionType, java.lang.String resourceName, Permission permission) throws java.lang.Exception
- Specified by:
addInstanceRunTimePermission
in interfaceIInstanceRunTimeSecurable
- Throws:
java.lang.Exception
- If an error occurs
-
deleteInstanceRunTimePermission
@ThingworxExtensionApiMethod(since={6,6}) public void deleteInstanceRunTimePermission(PermissionTypes permissionType, java.lang.String resourceName, Permission permission) throws java.lang.Exception
- Specified by:
deleteInstanceRunTimePermission
in interfaceIInstanceRunTimeSecurable
- Throws:
java.lang.Exception
- If an error occurs
-
AddInstanceRunTimePermission
@ThingworxExtensionApiMethod(since={6,6}) public void AddInstanceRunTimePermission(java.lang.String type, java.lang.String resource, java.lang.String principal, java.lang.String principalType, java.lang.Boolean allow) throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Add an instance run time permission.
- Parameters:
type
- Permission type (PropertyRead PropertyWrite ServiceInvoke EventInvoke EventSubscribe) - STRINGresource
- Resource name (* = all or enter a specific resource to override) - STRINGprincipal
- Principal name (name of user or group) - STRINGprincipalType
- Principal type (User or Group) - STRINGallow
- Permission (true = allow, false = deny) - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
DeleteInstanceRunTimePermission
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteInstanceRunTimePermission(java.lang.String type, java.lang.String resource, java.lang.String principal, java.lang.String principalType) throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Delete an instance run time permission.
- Parameters:
type
- Permission type - STRINGresource
- Resource name - STRINGprincipal
- Principal name (name of user or group) - STRINGprincipalType
- Principal type (User or Group) - STRING- Throws:
java.lang.Exception
- If an error occurs
-
AddInstanceDesignTimePermission
@ThingworxExtensionApiMethod(since={6,6}) public void AddInstanceDesignTimePermission(java.lang.String type, java.lang.String principal, java.lang.String principalType, java.lang.Boolean allow) throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Add an instance design time permission.
- Parameters:
type
- Permission type (PropertyRead PropertyWrite ServiceInvoke EventInvoke EventSubscribe) - STRINGprincipal
- Principal name (name of user or group) - STRINGprincipalType
- Principal type (User or Group) - STRINGallow
- Permission (true = allow, false = deny) - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
DeleteInstanceDesignTimePermission
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteInstanceDesignTimePermission(java.lang.String type, java.lang.String principal, java.lang.String principalType) throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Delete an instance design time permission.
- Parameters:
type
- Permission type - STRINGprincipal
- Principal name (name of user or group) - STRINGprincipalType
- Principal type (User or Group) - STRING- Throws:
java.lang.Exception
- If an error occurs
-
AddInstanceVisibilityPermission
@ThingworxExtensionApiMethod(since={6,6}) public void AddInstanceVisibilityPermission(java.lang.String principal, java.lang.String principalType) throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Add a visibility permission.
- Parameters:
principal
- Principal name (name of organization or organization unit) - STRINGprincipalType
- Principal type (Organization or Organization Unit) - STRING- Throws:
java.lang.Exception
- If an error occurs
-
DeleteInstanceVisibilityPermission
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteInstanceVisibilityPermission(java.lang.String principal, java.lang.String principalType) throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Delete a visibility permission.
- Parameters:
principal
- Principal name (name of organization or organization unit) - STRINGprincipalType
- Principal type (Organization or Organization Unit) - STRING- Throws:
java.lang.Exception
- If an error occurs
-
GetInstanceVisibilityPermissions
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetInstanceVisibilityPermissions() throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Get a list of assigned visibility permissions.
- Returns:
- result Permission list - INFOTABLE - Aspects {dataShape:Permissions}
- Throws:
java.lang.Exception
- If an error occurs
-
GetInstanceVisibilityPermissionsAsJSON
@ThingworxExtensionApiMethod(since={6,6}) public org.json.JSONObject GetInstanceVisibilityPermissionsAsJSON() throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Get a list of instance visibility permissions.
- Returns:
- result Permission list - JSON
- Throws:
java.lang.Exception
- If an error occurs
-
SetInstanceVisibilityPermissionsAsJSON
@ThingworxExtensionApiMethod(since={6,6}) public void SetInstanceVisibilityPermissionsAsJSON(org.json.JSONObject permissions) throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Set a list of instance visibility permissions.
- Parameters:
permissions
- Permissions in JSON format - JSON- Throws:
java.lang.Exception
- If an error occurs
-
GetInstanceRunTimePermissions
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetInstanceRunTimePermissions() throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Get a list of assigned instance runtime permissions.
- Returns:
- result Permission list - INFOTABLE - Aspects {dataShape:Permissions}
- Throws:
java.lang.Exception
- If an error occurs
-
GetInstanceRunTimePermissionsAsJSON
@ThingworxExtensionApiMethod(since={6,6}) public org.json.JSONObject GetInstanceRunTimePermissionsAsJSON() throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Get a list of assigned runtime permissions.
- Returns:
- result Permission list - JSON
- Throws:
java.lang.Exception
- If an error occurs
-
SetInstanceRunTimePermissionsAsJSON
@ThingworxExtensionApiMethod(since={6,6}) public void SetInstanceRunTimePermissionsAsJSON(org.json.JSONObject permissions) throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Set a list of assigned runtime permissions.
- Parameters:
permissions
- Permissions in JSON format - JSON- Throws:
java.lang.Exception
- If an error occurs
-
GetInstanceDesignTimePermissions
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetInstanceDesignTimePermissions() throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Get a list of assigned instance design time permissions.
- Returns:
- result Permission list - INFOTABLE - Aspects {dataShape:Permissions}
- Throws:
java.lang.Exception
- If an error occurs
-
GetInstanceDesignTimePermissionsAsJSON
@ThingworxExtensionApiMethod(since={6,6}) public org.json.JSONObject GetInstanceDesignTimePermissionsAsJSON() throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Get a list of instance design time permissions.
- Returns:
- result Permission list - JSON
- Throws:
java.lang.Exception
- If an error occurs
-
SetInstanceDesignTimePermissionsAsJSON
@ThingworxExtensionApiMethod(since={6,6}) public void SetInstanceDesignTimePermissionsAsJSON(org.json.JSONObject permissions) throws java.lang.Exception
- Service Category:
- Permissions
- Service Description:
- Set a list of instance design time permissions.
- Parameters:
permissions
- Permissions in JSON format - JSON- Throws:
java.lang.Exception
- If an error occurs
-
persistInstanceRunTimePermissions
@ThingworxExtensionApiMethod(since={6,6}) public void persistInstanceRunTimePermissions() throws java.lang.Exception
- Specified by:
persistInstanceRunTimePermissions
in interfaceIInstanceRunTimeSecurable
- Throws:
java.lang.Exception
- If an error occurs
-
persistInstanceDesignTimePermissions
@ThingworxExtensionApiMethod(since={6,6}) public void persistInstanceDesignTimePermissions() throws java.lang.Exception
- Specified by:
persistInstanceDesignTimePermissions
in interfaceIInstanceDesignTimeSecurable
- Throws:
java.lang.Exception
- If an error occurs
-
persistInstanceVisibilityPermissions
@ThingworxExtensionApiMethod(since={6,6}) public void persistInstanceVisibilityPermissions() throws java.lang.Exception
- Specified by:
persistInstanceVisibilityPermissions
in interfaceIInstanceVisibilitySecurable
- Throws:
java.lang.Exception
- If an error occurs
-
IsDerivedFromTemplate
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.Boolean IsDerivedFromTemplate(java.lang.String thingTemplateName) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Check to see if a thing is derived from a particular thing template.
- Parameters:
thingTemplateName
- Thing template name - THINGTEMPLATENAME- Returns:
- result Is Derived From Template - BOOLEAN
- Throws:
java.lang.Exception
- If an error occurs
-
GetPropertyLogging
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.Boolean GetPropertyLogging(java.lang.String propertyName) throws java.lang.Exception
- Service Category:
- DataLogging
- Service Description:
- Get property logging status for a specific property.
- Parameters:
propertyName
- Property name - STRING- Returns:
- status Property logging status - BOOLEAN
- Throws:
java.lang.Exception
- If an error occurs
-
SetPropertyLogging
@ThingworxExtensionApiMethod(since={6,6}) public void SetPropertyLogging(java.lang.String propertyName, java.lang.Boolean enabled) throws java.lang.Exception
- Service Category:
- DataLogging
- Service Description:
- Set property logging status for a specific property.
- Parameters:
propertyName
- Property name - STRINGenabled
- Enable/disable logging - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
SetUnitsForNumericPropertyDefinition
@ThingworxExtensionApiMethod(since={8,5}) public void SetUnitsForNumericPropertyDefinition(java.lang.String propertyName, java.lang.String units) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Set the additional information for units for a specific Long, Integer, or Number property.
- Parameters:
propertyName
- Property name - STRINGunits
- Units (eg. lbs, F, inches, etc.) associated with input. For information only. - STRING- Throws:
java.lang.Exception
- If an error occurs
-
AddPropertyTransformDefinition
@ThingworxExtensionApiMethod(since={8,4}) public void AddPropertyTransformDefinition(java.lang.String name, java.lang.String description, java.lang.String category, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.Integer timeout, InfoTable propertyTransformConfig) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Add a property transform definition.
- Parameters:
name
- - The name of your new derived property.description
- - The description of the new property.category
- - Category for the new property.persistent
- - Should the value of this derived property be persisted between tomcat restarts?logged
- - Should the value of this derived property be logged over time?timeout
- - Timeout for creating the property.propertyTransformConfig
- - A configuration infotable consisting of key/value pairs. Refer to the help center for possible keys.- Throws:
java.lang.Exception
- If an error occurs
Creates a derived property on this ThingTemplate. A derived property receives data from a specified source property, and performs some requested calculation on the stream of data as the source property changes. The type of calculation will determine which configuration keys/values need to be set on the derivedPropertyConfig.
Note: In order to use the derived property functionality, you must have a RabbitMQ instance, Flink cluster, and "derived property configuration service" running on your machine, as well as the necessary configuration set inside your platform-settings.json file.
For more information on running derived properties, please refer to the help center docs on derived properties.
-
AddPropertyDefinition
@ThingworxExtensionApiMethod(since={6,6}) @Deprecated public void AddPropertyDefinition(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String category, java.lang.String dataShape, java.lang.Boolean readOnly, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.String dataChangeType, java.lang.Double dataChangeThreshold, java.lang.Boolean remote, java.lang.String remotePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, java.lang.String defaultValue) throws java.lang.Exception
Deprecated.As of release 8.0, replaced by AddPropertyDefinition(String, String, String, String, String, Boolean, Boolean, Boolean, String, Double, Boolean, String, Integer, String, Double, String, JSONObject)- Throws:
java.lang.Exception
- If an error occurs
-
AddPropertyDefinition
@ThingworxExtensionApiMethod(since={8,0}, deprecatedSince={9,3}) @Deprecated public void AddPropertyDefinition(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String category, java.lang.String dataShape, java.lang.Boolean readOnly, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.String dataChangeType, java.lang.Double dataChangeThreshold, java.lang.Boolean remote, java.lang.String remotePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, java.lang.String defaultValue, org.json.JSONObject remoteBindingAspects) throws java.lang.Exception
Deprecated.- Throws:
java.lang.Exception
- If an error occurs
-
AddPropertyDefinition
@ThingworxExtensionApiMethod(since={8,0}, deprecatedSince={9,4}) @Deprecated public void AddPropertyDefinition(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String category, java.lang.String dataShape, java.lang.Boolean readOnly, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.Boolean indexed, java.lang.String dataChangeType, java.lang.Double dataChangeThreshold, java.lang.Boolean remote, java.lang.String remotePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, java.lang.String defaultValue, org.json.JSONObject remoteBindingAspects) throws java.lang.Exception
Deprecated.- Throws:
java.lang.Exception
- If an error occurs
-
AddPropertyDefinition
@ThingworxExtensionApiMethod(since={9,3}) public void AddPropertyDefinition(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String category, java.lang.String dataShape, java.lang.Boolean readOnly, java.lang.Boolean persistent, java.lang.Boolean logged, java.lang.Boolean indexed, java.lang.String dataChangeType, java.lang.Double dataChangeThreshold, java.lang.Boolean remote, java.lang.String remotePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, java.lang.String defaultValue, org.json.JSONObject remoteBindingAspects, org.json.JSONObject accessModifier) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Add a property definition.
- Parameters:
name
- Property name - STRINGdescription
- Property description - STRINGtype
- Data type - BASETYPENAMEcategory
- Category - STRINGdataShape
- Data shape - DATASHAPENAMEreadOnly
- Read only - BOOLEANpersistent
- Persist property value - BOOLEANlogged
- Log property value - BOOLEANindexed
- Index property value - BOOLEANdataChangeType
- Data change type - STRINGdataChangeThreshold
- Data change threshold - NUMBERremote
- Is a remote property - BOOLEANremotePropertyName
- Remote property name - STRINGtimeout
- Request timeout - INTEGERpushType
- Push type - STRINGpushThreshold
- Push threshold - NUMBERdefaultValue
- Default value for property - STRINGremoteBindingAspects
- Aspects for the remote binding - JSONaccessModifier
- AccessModifier for propertyDefinition - JSON- Throws:
java.lang.Exception
- If an error occurs
-
AddPropertyDefinitions
@ThingworxExtensionApiMethod(since={7,3}) public InfoTable AddPropertyDefinitions(InfoTable values, java.lang.Boolean ignoreInvalidDefinitions) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Add multiple property definitions at once.
- Parameters:
values
- Infotable where each row defines a property, using the PropertyDefinitionWithDetailsV2 data shape - INFOTABLEignoreInvalidDefinitions
- True will skip over any invalid definitions provided, false indicates to fail the whole transaction when atleast one invalid definition is found - BOOLEAN- Returns:
- status Table of information about which properties caused errors while attempting to add - INFOTABLE - Aspects {dataShape:BulkProcessingReport}
- Throws:
java.lang.Exception
- If an error occurs
-
AddServiceDefinition
@ThingworxExtensionApiMethod(since={8,0}, deprecatedSince={9,4}) @Deprecated public void AddServiceDefinition(java.lang.String name, java.lang.String description, java.lang.String category, InfoTable parameters, InfoTable resultType, java.lang.Boolean remote, java.lang.String remoteServiceName, java.lang.Integer timeout) throws java.lang.Exception
Deprecated.- Throws:
java.lang.Exception
- If an error occurs
-
AddServiceDefinition
@ThingworxExtensionApiMethod(since={6,6}) public void AddServiceDefinition(java.lang.String name, java.lang.String description, java.lang.String category, InfoTable parameters, InfoTable resultType, java.lang.Boolean remote, java.lang.String remoteServiceName, java.lang.Integer timeout, org.json.JSONObject accessModifier) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Add or update a service definition.
- Parameters:
name
- Property name - STRINGdescription
- Property description - STRINGcategory
- Category - STRINGparameters
- Service parameters - INFOTABLEresultType
- Service result type - INFOTABLEremote
- Is a remote service - BOOLEANremoteServiceName
- Remote service name - STRINGtimeout
- Request timeout - INTEGERaccessModifier
- AccessModifier for serviceDefinition - JSON- Throws:
java.lang.Exception
- If an error occurs
-
AddEventDefinition
@ThingworxExtensionApiMethod(since={6,6}) public void AddEventDefinition(java.lang.String name, java.lang.String description, java.lang.String category, java.lang.String dataShape, java.lang.Boolean remote, java.lang.String remoteEventName) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Add or update an event definition.
- Parameters:
name
- Property name - STRINGdescription
- Property description - STRINGcategory
- Category - STRINGdataShape
- Data shape - DATASHAPENAMEremote
- Is a remote service - BOOLEANremoteEventName
- Remote event name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
DisableSubscription
@Deprecated @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,0}) public void DisableSubscription(java.lang.String thingName, java.lang.String eventName, java.lang.String propertyName) throws java.lang.Exception
Deprecated.- Throws:
java.lang.Exception
- If an error occurs
-
DisableSubscription
@ThingworxExtensionApiMethod(since={9,0}) public void DisableSubscription(java.lang.String subscriptionName) throws java.lang.Exception
- Service Category:
- Subscriptions
- Service Description:
- Disable Subscription.
- Parameters:
subscriptionName
- Subscription name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
EnableSubscription
@Deprecated @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,0}) public void EnableSubscription(java.lang.String thingName, java.lang.String eventName, java.lang.String propertyName) throws java.lang.Exception
Deprecated.- Throws:
java.lang.Exception
- If an error occurs
-
EnableSubscription
@ThingworxExtensionApiMethod(since={9,0}) public void EnableSubscription(java.lang.String subscriptionName) throws java.lang.Exception
- Service Category:
- Subscriptions
- Service Description:
- Enable Subscription.
- Parameters:
subscriptionName
- Subscription name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
RemovePropertyDefinition
@ThingworxExtensionApiMethod(since={6,6}) public void RemovePropertyDefinition(java.lang.String name) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Remove a property definition.
- Parameters:
name
- Property name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
RemoveServiceDefinition
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveServiceDefinition(java.lang.String name) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Remove a service definition.
- Parameters:
name
- Service name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
RemoveEventDefinition
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveEventDefinition(java.lang.String name) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Remove a event definition.
- Parameters:
name
- Event name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
getDerivedBaseThingTemplate
@ThingworxExtensionApiMethod(since={6,6}) public ThingTemplate getDerivedBaseThingTemplate()
-
getAllImplementedThingTemplates
@ThingworxExtensionApiMethod(since={6,6}) public EntityReferenceCollection getAllImplementedThingTemplates()
-
getImplementedThingShapes
@ThingworxExtensionApiMethod(since={6,6}) public EntityReferenceCollection getImplementedThingShapes()
-
setImplementedThingShapes
@ThingworxExtensionApiMethod(since={6,6}) public void setImplementedThingShapes(EntityReferenceCollection value)
-
getInstanceShape
@ThingworxExtensionApiMethod(since={6,6}) public ThingShapeInstance getInstanceShape()
- Specified by:
getInstanceShape
in interfaceIShapeProvider
-
QueryImplementingThingsOptimized
@ThingworxExtensionApiMethod(since={9,1}) public InfoTable QueryImplementingThingsOptimized(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Boolean withPermissions, InfoTable basicPropertyNames, InfoTable propertyNames, java.lang.String networkName, java.lang.String networkParentNode, java.lang.Integer networkMaxDepth, java.lang.Double offset) throws java.lang.Exception
- Service Category:
- Queries
- Service Description:
- Return a list of all the things that implement this shape.
- Specified by:
QueryImplementingThingsOptimized
in interfaceIImplementableEntity
- Parameters:
maxItems
- Maximum number of items to return - NUMBERtags
- Tags to search on - TAGSnameMask
- Name pattern - STRINGquery
- Query definition - QUERYwithPermissions
- whether or not to include read / update / delete permission information in the result - BOOLEANbasicPropertyNames
- Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLEpropertyNames
- Include propertyNames - INFOTABLEnetworkName
- Name of network - STRINGnetworkParentNode
- Name of the top network node - STRINGnetworkMaxDepth
- Max depth to search in the network - INTEGERoffset
- the number of rows to skip before starting to return rows from the query - NUMBER- Returns:
- result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
java.lang.Exception
- If an error occurs
-
QueryImplementingThingsOptimizedWithTotalCount
@ThingworxExtensionApiMethod(since={9,1}) public InfoTable QueryImplementingThingsOptimizedWithTotalCount(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Boolean withPermissions, InfoTable basicPropertyNames, InfoTable propertyNames, java.lang.String networkName, java.lang.String networkParentNode, java.lang.Integer networkMaxDepth, java.lang.Double offset) throws java.lang.Exception
- Service Category:
- Queries
- Service Description:
- Return a list of all the things that implement this shape.
- Specified by:
QueryImplementingThingsOptimizedWithTotalCount
in interfaceIImplementableEntity
- Parameters:
maxItems
- Maximum number of items to return - NUMBERtags
- Tags to search on - TAGSnameMask
- Name pattern - STRINGquery
- Query definition - QUERYwithPermissions
- whether or not to include read / update / delete permission information in the result - BOOLEANbasicPropertyNames
- Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLEpropertyNames
- Include propertyNames - INFOTABLEnetworkName
- Name of network - STRINGnetworkParentNode
- Name of the top network node - STRINGnetworkMaxDepth
- Max depth to search in the network - INTEGERoffset
- the number of rows to skip before starting to return rows from the query - NUMBER- Returns:
- result Implementing Things - INFOTABLE - Aspects {dataShape:ImplementedThingsWithTotalCount}
- Throws:
java.lang.Exception
- If an error occurs
-
implementsShape
@ThingworxExtensionApiMethod(since={6,6}) public boolean implementsShape(java.lang.String thingShape)
-
getBaseThingTemplate
@ThingworxExtensionApiMethod(since={6,6}) public ThingTemplate getBaseThingTemplate()
-
getDependencies
@ThingworxExtensionApiMethod(since={6,6}) public EntityReferenceTypeMap getDependencies()
-
getImplementations
@ThingworxExtensionApiMethod(since={6,6}) public EntityReferenceTypeMap getImplementations()
-
GetValueStream
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.String GetValueStream()
- Service Category:
- DataLogging
- Service Description:
- Get the identifier for a thing.
- Returns:
- name Value Stream Name - THINGNAME
-
SetValueStream
@ThingworxExtensionApiMethod(since={6,6}) public void SetValueStream(java.lang.String name) throws java.lang.Exception
- Service Category:
- DataLogging
- Service Description:
- Set the value stream for a thing.
- Parameters:
name
- Value stream name - THINGNAME- Throws:
java.lang.Exception
- If an error occurs
-
QueryImplementingThings
@Deprecated @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,4}) public InfoTable QueryImplementingThings(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query) throws java.lang.Exception
Deprecated.- Specified by:
QueryImplementingThings
in interfaceIImplementableEntity
- Throws:
java.lang.Exception
- If an error occurs
-
QueryImplementingThings
@ThingworxExtensionApiMethod(since={9,4}) public InfoTable QueryImplementingThings(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Boolean isSortFirst) throws java.lang.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 - NUMBERtags
- Tags to search on - TAGSnameMask
- Name pattern - STRINGquery
- Query definition - QUERYisSortFirst
- Sorts the things first if value is true - BOOLEAN- Returns:
- result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
java.lang.Exception
- If an error occurs
-
QueryImplementingThingsV2
@ThingworxExtensionApiMethod(since={9,4}) public InfoTable QueryImplementingThingsV2(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Boolean isSortFirst) throws java.lang.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 - NUMBERtags
- Tags to search on - TAGSnameMask
- Name pattern - STRINGquery
- Query definition - QUERYisSortFirst
- Sorts the things first if value is true - BOOLEAN- Returns:
- result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityListV2}
- Throws:
java.lang.Exception
- If an error occurs
-
QueryImplementingThingsWithData
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable QueryImplementingThingsWithData(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query) throws java.lang.Exception
- Service Category:
- Queries
- Service Description:
- Return a list of all the things that implement this template along with the thing properties and values.
- Specified by:
QueryImplementingThingsWithData
in interfaceIImplementableEntity
- Parameters:
maxItems
- Maximum number of items to return - NUMBERtags
- Tags to search on - TAGSnameMask
- Name pattern - STRINGquery
- Query definition - QUERY- Returns:
- result Implementing Things With Data - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
java.lang.Exception
- If an error occurs
-
QueryImplementingThingsWithDataV2
@ThingworxExtensionApiMethod(since={9,4}) public InfoTable QueryImplementingThingsWithDataV2(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query) throws java.lang.Exception
- Service Category:
- Queries
- Service Description:
- Return a list of all the things that implement this template along with the thing properties and values.
- Parameters:
maxItems
- Maximum number of items to return - NUMBERtags
- Tags to search on - TAGSnameMask
- Name pattern - STRINGquery
- Query definition - QUERY- Returns:
- result Implementing Things With Data - INFOTABLE - Aspects {dataShape:RootEntityListV2}
- Throws:
java.lang.Exception
- If an error occurs
-
QueryImplementingThingsWithNamedData
@ThingworxExtensionApiMethod(since={8,1}) public InfoTable QueryImplementingThingsWithNamedData(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, InfoTable basicPropertyNames, InfoTable propertyNames) throws java.lang.Exception
- Service Category:
- Queries
- Service Description:
- Returns a list containing the specific properties and values of all the Things that Implement this Template.
- Specified by:
QueryImplementingThingsWithNamedData
in interfaceIImplementableEntity
- Parameters:
maxItems
- Maximum number of items to return - NUMBERtags
- Tags to search on - TAGSnameMask
- Name pattern - STRINGquery
- Query definition - QUERYbasicPropertyNames
- Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLEpropertyNames
- Include Specific properties of this Template - INFOTABLE- Returns:
- result Implementing Things With Named Data - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
java.lang.Exception
- If an error occurs
-
QueryImplementingThingsWithNamedDataV2
@ThingworxExtensionApiMethod(since={9,4}) public InfoTable QueryImplementingThingsWithNamedDataV2(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, InfoTable basicPropertyNames, InfoTable propertyNames) throws java.lang.Exception
- Service Category:
- Queries
- Service Description:
- 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 - NUMBERtags
- Tags to search on - TAGSnameMask
- Name pattern - STRINGquery
- Query definition - QUERYbasicPropertyNames
- Include Basic Properties such as {isSystemObject, name, description, homeMashup, avatar, tags, projectName} - INFOTABLEpropertyNames
- Include Specific properties of this Template - INFOTABLE- Returns:
- result Implementing Things With Named Data - INFOTABLE - Aspects {dataShape:RootEntityListV2}
- Throws:
java.lang.Exception
- If an error occurs
-
GetLoggedProperties
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetLoggedProperties(java.lang.String type) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Get a list of logged properties for this thing.
- Parameters:
type
- Type to filter on - BASETYPENAME- Returns:
- result Property names - INFOTABLE - Aspects {dataShape:PropertyDefinition}
- Throws:
java.lang.Exception
- If an error occurs
-
GetNumericLoggedProperties
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetNumericLoggedProperties() throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Get a list of logged properties for this thing that are of a numeric data type.
- Returns:
- result Property names - INFOTABLE - Aspects {dataShape:PropertyDefinition}
- Throws:
java.lang.Exception
- If an error occurs
-
QueryImplementingThingsWithPropertyHistory
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable QueryImplementingThingsWithPropertyHistory(java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Double maxDataItems, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, java.lang.Boolean oldestFirst, org.json.JSONObject dataQuery) throws java.lang.Exception
- Service Category:
- Queries
- Service Description:
- Return a list of all the things that implement this template along with the thing property history.
- Parameters:
maxItems
- Maximum number of things - NUMBERtags
- Tags to search on - TAGSnameMask
- Name pattern - STRINGquery
- Thing query definition - QUERYmaxDataItems
- Maximum number of data rows per thing - NUMBERstartDate
- Start time - DATETIMEendDate
- End time - DATETIMEoldestFirst
- Search/sort from oldest to newest - BOOLEANdataQuery
- Data query definition - QUERY- Returns:
- result Implementing Things With Property History - INFOTABLE
- Throws:
java.lang.Exception
- If an error occurs
-
QueryImplementingThingsWithNamedPropertyHistory
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable QueryImplementingThingsWithNamedPropertyHistory(InfoTable propertyNames, java.lang.Double maxItems, TagCollection tags, java.lang.String nameMask, org.json.JSONObject query, java.lang.Double maxDataItems, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, java.lang.Boolean oldestFirst, org.json.JSONObject dataQuery) throws java.lang.Exception
- Service Category:
- Queries
- Service Description:
- Return a list of all the things that implement this template along with the thing property history.
- Parameters:
propertyNames
- Property names - INFOTABLEmaxItems
- Maximum number of things - NUMBERtags
- Tags to search on - TAGSnameMask
- Name pattern - STRINGquery
- Thing query definition - QUERYmaxDataItems
- Maximum number of data rows per thing - NUMBERstartDate
- Start time - DATETIMEendDate
- End time - DATETIMEoldestFirst
- Search/sort from oldest to newest - BOOLEANdataQuery
- Data query definition - QUERY- Returns:
- result Implementing Things With Named Property History - INFOTABLE
- Throws:
java.lang.Exception
- If an error occurs
-
GetImplementingThings
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetImplementingThings() throws java.lang.Exception
- Service Category:
- Queries
- Service Description:
- Return a list of all the things that implement this template.
- Specified by:
GetImplementingThings
in interfaceIImplementableEntity
- Returns:
- result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
java.lang.Exception
- If an error occurs
-
GetImplementingThingsWithData
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetImplementingThingsWithData() throws java.lang.Exception
- Service Category:
- Queries
- Service Description:
- Return a list of all the things that implement this template along with the thing properties and values.
- Specified by:
GetImplementingThingsWithData
in interfaceIImplementableEntity
- Returns:
- result Implementing Things - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
java.lang.Exception
- If an error occurs
-
GetMashups
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetMashups() throws java.lang.Exception
- Service Category:
- Mashups
- Service Description:
- Get the mashups related to this thing template.
- Returns:
- result Mashups - INFOTABLE - Aspects {dataShape:MashupList}
- Throws:
java.lang.Exception
- If an error occurs
-
getMashups
@ThingworxExtensionApiMethod(since={6,6}) public EntityReferenceCollection getMashups() throws java.lang.Exception
- Throws:
java.lang.Exception
- If an error occurs
-
GetHomeMashup
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.String GetHomeMashup()
- Service Category:
- Mashups
- Service Description:
- Get home mashup.
- Overrides:
GetHomeMashup
in classRootEntity
- Returns:
- HomeMashup Home mashup - MASHUPNAME
-
GetEffectiveThingPackageName
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.String GetEffectiveThingPackageName()
- Service Category:
- Metadata
- Service Description:
- Get effective thing package.
- Returns:
- name Effective thing package name - STRING
-
GetAvatar
@ThingworxExtensionApiMethod(since={6,6}) public ImagePrimitive GetAvatar() throws java.lang.Exception
- Service Category:
- Avatar
- Service Description:
- Get avatar image.
- Specified by:
GetAvatar
in interfaceIAvatar
- Overrides:
GetAvatar
in classRootEntity
- Returns:
- Avatar Entity avatar - IMAGE
- Throws:
java.lang.Exception
- If an error occurs
-
GetInstancePropertyDefinitions
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetInstancePropertyDefinitions(java.lang.String type) throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Get the current property definitions for this thing.
- Parameters:
type
- Type to filter on - STRING- Returns:
- result Property values - INFOTABLE - Aspects {dataShape:PropertyDefinition}
- Throws:
java.lang.Exception
- If an error occurs
-
GetInstanceEventDefinitions
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetInstanceEventDefinitions() throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Get the current event definitions for this thing.
- Returns:
- result Event definitions - INFOTABLE - Aspects {dataShape:EventDefinition}
- Throws:
java.lang.Exception
- If an error occurs
-
GetInstanceServiceDefinitions
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetInstanceServiceDefinitions() throws java.lang.Exception
- Service Category:
- Metadata
- Service Description:
- Get the current service definitions for this thing.
- Returns:
- result Service definitions - INFOTABLE - Aspects {dataShape:ServiceDefinition}
- Throws:
java.lang.Exception
- If an error occurs
-
GetSharedConfigurationTable
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetSharedConfigurationTable(java.lang.String tableName) throws java.lang.Exception
- Service Category:
- Configuration
- Service Description:
- Get a specific shared configuration table as an InfoTable.
- Parameters:
tableName
- Configuration table name - STRING- Returns:
- table table - INFOTABLE
- Throws:
java.lang.Exception
- If an error occurs
-
GetSharedConfigurationTableRow
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetSharedConfigurationTableRow(java.lang.String tableName, java.lang.String key) throws java.lang.Exception
- Service Category:
- Configuration
- Service Description:
- Get a specific shared configuration table row as an InfoTable.
- Parameters:
tableName
- Configuration table name - STRINGkey
- Row key value - STRING- Returns:
- table table - INFOTABLE
- Throws:
java.lang.Exception
- If an error occurs
-
IsSharedMultiRowTable
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.Boolean IsSharedMultiRowTable(java.lang.String tableName) throws java.lang.Exception
- Service Category:
- Configuration
- Service Description:
- Check if a shared configuration table is a multi-row table.
- Parameters:
tableName
- Configuration table name - STRING- Returns:
- result Flag if table is multi-row or not - BOOLEAN
- Throws:
java.lang.Exception
- If an error occurs
-
SetSharedConfigurationTable
@ThingworxExtensionApiMethod(since={6,6}) public void SetSharedConfigurationTable(java.lang.String tableName, InfoTable configurationTable, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Configuration
- Service Description:
- Set an entire shared configuration table.
- Parameters:
tableName
- Configuration table name - STRINGconfigurationTable
- Configuration table content - INFOTABLEpersistent
- Persist these changes - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
SetSharedMultiRowConfigurationTable
@ThingworxExtensionApiMethod(since={6,6}) public void SetSharedMultiRowConfigurationTable(java.lang.String tableName, InfoTable configurationTable, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Configuration
- Service Description:
- Set an entire shared multi-row configuration table.
- Parameters:
tableName
- Configuration table name - STRINGconfigurationTable
- Configuration table content - INFOTABLEpersistent
- Persist these changes - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
SetSharedConfigurationTableRows
@ThingworxExtensionApiMethod(since={6,6}) public void SetSharedConfigurationTableRows(java.lang.String tableName, InfoTable values, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Configuration
- Service Description:
- Update/add one or more rows in a shared multi-row configuration table.
- Parameters:
tableName
- Configuration table name - STRINGvalues
- Configuration table rows to modify - INFOTABLEpersistent
- Persist these changes - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
DeleteSharedConfigurationTable
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteSharedConfigurationTable(java.lang.String tableName, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Configuration
- Service Description:
- Delete an entire shared configuration table.
- Parameters:
tableName
- Configuration table name - STRINGpersistent
- Persist these changes - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
DeleteSharedConfigurationTableRows
@Deprecated @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,6}) public void DeleteSharedConfigurationTableRows(java.lang.String tableName, InfoTable values, java.lang.Boolean persistent) throws java.lang.Exception
Deprecated.- Throws:
java.lang.Exception
- If an error occurs
-
DeleteSharedConfigurationTableRows
@ThingworxExtensionApiMethod(since={9,6}) public void DeleteSharedConfigurationTableRows(java.lang.String tableName, InfoTable values, java.lang.Boolean persistent, java.lang.Boolean removeAllMatchingRows) throws java.lang.Exception
- Service Category:
- Configuration
- Service Description:
- Delete one or more rows from a shared multi-row configuration table.
- Parameters:
tableName
- Configuration table name - STRINGvalues
- Configuration table rows to modify - INFOTABLEpersistent
- Persist these changes - BOOLEANremoveAllMatchingRows
- It will remove all matching rows if value is true - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
DeleteAllSharedConfigurationTableRows
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteAllSharedConfigurationTableRows(java.lang.String tableName, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Configuration
- Service Description:
- Delete all rows from a shared multi-row configuration table.
- Parameters:
tableName
- Configuration table name - STRINGpersistent
- Persist these changes - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
getEntityType
@ThingworxExtensionApiMethod(since={6,6}) public RelationshipTypes.ThingworxRelationshipTypes getEntityType()
Description copied from class:RootEntity
Returns the type of this entity.
- Specified by:
getEntityType
in interfaceIShapeProvider
- Specified by:
getEntityType
in classRootEntity
- Returns:
- the entity type
-
getEffectiveServiceDefinition
@ThingworxExtensionApiMethod(since={6,6}) public ServiceDefinition getEffectiveServiceDefinition(java.lang.String serviceName)
- Specified by:
getEffectiveServiceDefinition
in interfaceIServiceMetadataProvider
-
getEffectiveEventDefinition
@ThingworxExtensionApiMethod(since={6,6}) public EventDefinition getEffectiveEventDefinition(java.lang.String eventName)
- Specified by:
getEffectiveEventDefinition
in interfaceIEventMetadataProvider
-
getEffectivePropertyDefinition
@ThingworxExtensionApiMethod(since={6,6}) public PropertyDefinition getEffectivePropertyDefinition(java.lang.String propertyName)
- Specified by:
getEffectivePropertyDefinition
in interfaceIAlertProvider
-
AddOrUpdateAlert
@ThingworxExtensionApiMethod(since={6,6}) public void AddOrUpdateAlert(java.lang.String property, java.lang.String alertType, java.lang.String alertName, java.lang.String description, java.lang.Boolean enabled, java.lang.Integer priority, InfoTable attributes, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Add or update an alert for a property.
- Parameters:
property
- Property name - STRINGalertType
- Alert type - STRINGalertName
- Alert name - STRINGdescription
- Alert description - STRINGenabled
- Alert enabled - BOOLEANpriority
- Alert priority - INTEGERattributes
- Alert attributes - INFOTABLEpersistent
- Persist this change - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
RemoveAlert
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveAlert(java.lang.String property, java.lang.String alertName, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Remove an alert for a property.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGpersistent
- Persist this change - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
GetLocalAlertDefinitions
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetLocalAlertDefinitions(java.lang.String property) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Get local alert definitions for a property.
- Parameters:
property
- Property name - STRING- Returns:
- AlertDefinitions Alert definition - INFOTABLE - Aspects {dataShape:AlertDefinition}
- Throws:
java.lang.Exception
- If an error occurs
-
GetAlertDefinitions
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetAlertDefinitions(java.lang.String property) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Get effective alert definitions for a property.
- Parameters:
property
- Property name - STRING- Returns:
- AlertDefinitions Alert definition - INFOTABLE - Aspects {dataShape:AlertDefinition}
- Throws:
java.lang.Exception
- If an error occurs
-
GetAlertDefinition
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetAlertDefinition(java.lang.String property, java.lang.String alertName) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Get alert definition for a property.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRING- Returns:
- AlertDefinitions Alert definition - INFOTABLE - Aspects {dataShape:AlertDefinition}
- Throws:
java.lang.Exception
- If an error occurs
-
HasAlert
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.Boolean HasAlert(java.lang.String property, java.lang.String alertName) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Check to see if an alert is defined for a property.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRING- Returns:
- result Has alert definition - BOOLEAN
- Throws:
java.lang.Exception
- If an error occurs
-
SetNumberAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public void SetNumberAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.Double value, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Set a numeric alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRINGvalue
- Parameter value - NUMBERpersistent
- Make it persistent - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
GetNumberAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.Double GetNumberAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Get a numeric alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRING- Returns:
- value Alert parameter value - NUMBER
- Throws:
java.lang.Exception
- If an error occurs
-
SetIntegerAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public void SetIntegerAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.Integer value, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Set a numeric alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRINGvalue
- Parameter value - INTEGERpersistent
- Make it persistent - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
GetIntegerAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.Integer GetIntegerAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Get a numeric alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRING- Returns:
- value Alert parameter value - INTEGER
- Throws:
java.lang.Exception
- If an error occurs
-
GetLongAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.Long GetLongAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Get a numeric alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRING- Returns:
- value Alert parameter value - LONG
- Throws:
java.lang.Exception
- If an error occurs
-
SetBooleanAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public void SetBooleanAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.Boolean value, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Set a boolean alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRINGvalue
- Parameter value - BOOLEANpersistent
- Make it persistent - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
GetBooleanAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public java.lang.Boolean GetBooleanAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Get a boolean alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRING- Returns:
- value Alert parameter value - BOOLEAN
- Throws:
java.lang.Exception
- If an error occurs
-
SetDateTimeAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public void SetDateTimeAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, org.joda.time.DateTime value, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Set a date alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRINGvalue
- Parameter value - DATETIMEpersistent
- Make it persistent - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
GetDateTimeAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public org.joda.time.DateTime GetDateTimeAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Get a date alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRING- Returns:
- value Alert parameter value - DATETIME
- Throws:
java.lang.Exception
- If an error occurs
-
SetLocationAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public void SetLocationAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, Location value, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Set a location alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRINGvalue
- Parameter value - LOCATIONpersistent
- Make it persistent - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
GetLocationAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public Location GetLocationAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Get a location alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRING- Returns:
- value Alert parameter value - LOCATION
- Throws:
java.lang.Exception
- If an error occurs
-
SetStringAlertParameter
@ThingworxExtensionApiMethod(since={6,6}) public void SetStringAlertParameter(java.lang.String property, java.lang.String alertName, java.lang.String parameterName, java.lang.String value, java.lang.Boolean persistent) throws java.lang.Exception
- Service Category:
- Alerts
- Service Description:
- Set a string alert parameter.
- Parameters:
property
- Property name - STRINGalertName
- Alert name - STRINGparameterName
- Parameter name - STRINGvalue
- Parameter value - STRINGpersistent
- Make it persistent - BOOLEAN- Throws:
java.lang.Exception
- If an error occurs
-
GetLocalPropertyBinding
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetLocalPropertyBinding(java.lang.String propertyName) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Get the property binding for a property.
- Parameters:
propertyName
- Property name - STRING- Returns:
- result Property binding - INFOTABLE - Aspects {dataShape:LocalPropertyBinding}
- Throws:
java.lang.Exception
- If an error occurs
-
GetEffectiveLocalPropertyBindings
@ThingworxExtensionApiMethod(since={7,3}) public InfoTable GetEffectiveLocalPropertyBindings() throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Get the effective local property bindings.
Get all effective (inherited and local) property bindings for this thing- Returns:
- InfoTable of local property bindings consists of property name, name of thing(sourceThingName) and name of property(sourceName) the property is locally bound to.
- Throws:
java.lang.Exception
- - any exception while execution
-
GetEffectiveLocalPropertyBinding
@ThingworxExtensionApiMethod(since={7,3}) public InfoTable GetEffectiveLocalPropertyBinding(java.lang.String propertyName) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Get the effective local property binding for a property.
Get the effective (inherited and local) property binding for a property- Parameters:
propertyName
- : name of property to get the local binding- Returns:
- InfoTable of local property bindings consists of property name, name of thing(sourceThingName) and name of property(sourceName) the property is locally bound to.
- Throws:
java.lang.Exception
- - any exception while execution
-
RemoveLocalPropertyBinding
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveLocalPropertyBinding(java.lang.String propertyName) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Remove the local property binding for a property.
- Parameters:
propertyName
- Property name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
SetLocalPropertyBinding
@ThingworxExtensionApiMethod(since={6,6}) @Deprecated public void SetLocalPropertyBinding(java.lang.String propertyName, java.lang.String sourceThingName, java.lang.String sourcePropertyName) throws java.lang.Exception
Deprecated.As of release 8.1.0, replaced bySetLocalPropertyBinding(String, String, String, JSONObject)
- Throws:
java.lang.Exception
- If an error occurs
-
SetLocalPropertyBinding
@ThingworxExtensionApiMethod(since={8,1,0}) public void SetLocalPropertyBinding(java.lang.String propertyName, java.lang.String sourceThingName, java.lang.String sourcePropertyName, org.json.JSONObject aspects) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Set the property binding for a property.
- Parameters:
propertyName
- Property name - STRINGsourceThingName
- Thing name to bind to - STRINGsourcePropertyName
- Source property name - STRINGaspects
- Aspects for the local binding - JSON- Throws:
java.lang.Exception
- If an error occurs
-
GetRemotePropertyBinding
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetRemotePropertyBinding(java.lang.String propertyName) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Get the remote property binding for a property.
- Parameters:
propertyName
- Property name - STRING- Returns:
- result Property binding - INFOTABLE - Aspects {dataShape:RemotePropertyBinding}
- Throws:
java.lang.Exception
- If an error occurs
-
RemoveRemotePropertyBinding
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveRemotePropertyBinding(java.lang.String propertyName) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Remove the remote property binding for a property.
- Parameters:
propertyName
- Property name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
SetRemotePropertyBinding
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={8,0}) @Deprecated public void SetRemotePropertyBinding(java.lang.String propertyName, java.lang.String sourcePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold) throws java.lang.Exception
Deprecated.As of release 8.0.0, replaced bySetRemotePropertyBinding(String, String, Integer, String, Double, JSONObject, Integer, String)
- Throws:
java.lang.Exception
- If an error occurs
-
SetRemotePropertyBinding
@ThingworxExtensionApiMethod(since={8,0}) public void SetRemotePropertyBinding(java.lang.String propertyName, java.lang.String sourcePropertyName, java.lang.Integer timeout, java.lang.String pushType, java.lang.Double pushThreshold, org.json.JSONObject aspects, java.lang.Integer cacheTime, java.lang.String foldType) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Set the remote property binding for a property.
- Parameters:
propertyName
- Property name - STRINGsourcePropertyName
- Source property name - STRINGtimeout
- Request timeout - INTEGERpushType
- Push type - STRINGpushThreshold
- Push threshold - NUMBERaspects
- Aspects for the remote binding - JSONcacheTime
- Property's cache time value at the server - INTEGERfoldType
- How a remote property's value should be handled by the server when a connection is lost - STRING- Throws:
java.lang.Exception
- If an error occurs
-
GetRemoteServiceBinding
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetRemoteServiceBinding(java.lang.String serviceName) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Get the remote service binding for a service.
- Parameters:
serviceName
- Service name - STRING- Returns:
- result Service binding - INFOTABLE - Aspects {dataShape:RemoteServiceBinding}
- Throws:
java.lang.Exception
- If an error occurs
-
RemoveRemoteServiceBinding
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveRemoteServiceBinding(java.lang.String serviceName) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Remove the remote service binding for a service.
- Parameters:
serviceName
- Service name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
SetRemoteServiceBinding
@ThingworxExtensionApiMethod(since={6,6}) public void SetRemoteServiceBinding(java.lang.String serviceName, java.lang.String sourceServiceName, java.lang.Integer timeout) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Set the remote service binding for a service.
- Parameters:
serviceName
- Service name - STRINGsourceServiceName
- Source service name - STRINGtimeout
- Request timeout - INTEGER- Throws:
java.lang.Exception
- If an error occurs
-
GetRemoteEventBinding
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetRemoteEventBinding(java.lang.String eventName) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Get the remote event binding for a event.
- Parameters:
eventName
- Event name - STRING- Returns:
- result Event binding - INFOTABLE - Aspects {dataShape:RemoteEventBinding}
- Throws:
java.lang.Exception
- If an error occurs
-
RemoveRemoteEventBinding
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveRemoteEventBinding(java.lang.String eventName) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Remove the remote event binding for a event.
- Parameters:
eventName
- Event name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
SetRemoteEventBinding
@ThingworxExtensionApiMethod(since={6,6}) public void SetRemoteEventBinding(java.lang.String eventName, java.lang.String sourceEventName) throws java.lang.Exception
- Service Category:
- Bindings
- Service Description:
- Set the remote event binding for a event.
- Parameters:
eventName
- Event name - STRINGsourceEventName
- Source event name - STRING- Throws:
java.lang.Exception
- If an error occurs
-
-