com.thingworx.resources.devices

Class DeviceFunctions

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.entities.ExtensibleRootEntity

com.thingworx.resources.Resource

com.thingworx.resources.devices.DeviceFunctions

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<java.lang.String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, java.io.Serializable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class DeviceFunctions
extends Resource

See Also:

Serialized Form

Field Summary

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTIES

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
DeviceFunctions()

Method Summary

Modifier and Type	Method and Description
InfoTable	GetBoundRemoteThings(java.lang.Double maxItems) Service Category: Bindings Service Description: Get bound remote things.
InfoTable	GetBoundThingsForFederatedServer(java.lang.String name, java.lang.Double maxItems) Service Category: Federation Service Description: Get bound federated things.
InfoTable	GetUnboundIdentifiers(java.lang.Double maxItems) Service Category: Bindings Service Description: Get unbound identifiers.
InfoTable	GetUnboundRemoteThings(java.lang.Double maxItems) Service Category: Bindings Service Description: Get unbound remote things.
InfoTable	GetUnboundThingsForFederatedServer(java.lang.String name, java.lang.Double maxItems) Service Category: Federation Service Description: Get unbound federated things.
InfoTable	SearchDevices(org.json.JSONObject query, java.lang.String nameMask, java.lang.String thingShape, java.lang.String thingTemplate, java.lang.Double maxItems) Service Category: Queries Service Description: Retrieve a list of Devices that match the options specified.

Methods inherited from class com.thingworx.resources.Resource

getEntityType

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, validateConfiguration

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

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getID, hasID

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

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

getID, getName

Constructor Detail

DeviceFunctions

public DeviceFunctions()

Method Detail

SearchDevices

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

Service Category:

Queries

Service Description:

Retrieve a list of Devices that match the options specified.

Parameters:

query - Query definition - QUERY

nameMask - Name pattern - STRING

thingShape - Filter only for devices that implement this shape - THINGSHAPENAME

thingTemplate - Filter only for devices that are derived from this template - THINGTEMPLATENAME

maxItems - Maximum number of items to return - NUMBER

Returns:

result Matching Devices - INFOTABLE - Aspects {dataShape:DeviceStatus}

Throws:

java.lang.Exception - If an error occurs

GetUnboundRemoteThings

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetUnboundRemoteThings(java.lang.Double maxItems)
                                                                           throws java.lang.Exception

Service Category:

Bindings

Service Description:

Get unbound remote things.

Parameters:

maxItems - Maximum number of items to return - NUMBER

Returns:

result Unbound remote things - INFOTABLE - Aspects {dataShape:BoundName}

Throws:

java.lang.Exception - If an error occurs

GetUnboundIdentifiers

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetUnboundIdentifiers(java.lang.Double maxItems)
                                                                          throws java.lang.Exception

Service Category:

Bindings

Service Description:

Get unbound identifiers.

Parameters:

maxItems - Maximum number of items to return - NUMBER

Returns:

result Unbound remote things with identifiers - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

java.lang.Exception - If an error occurs

GetBoundRemoteThings

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetBoundRemoteThings(java.lang.Double maxItems)
                                                                         throws java.lang.Exception

Service Category:

Bindings

Service Description:

Get bound remote things.

Parameters:

maxItems - Maximum number of items to return - NUMBER

Returns:

result Bound remote things - INFOTABLE - Aspects {dataShape:DeviceStatus}

Throws:

java.lang.Exception - If an error occurs

GetUnboundThingsForFederatedServer

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetUnboundThingsForFederatedServer(java.lang.String name,
                                                                                              java.lang.Double maxItems)
                                                                                       throws java.lang.Exception

Service Category:

Federation

Service Description:

Get unbound federated things.

Parameters:

name - Federated server name - THINGNAME

maxItems - Maximum number of items to return - NUMBER

Returns:

result Unbound federated things - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

java.lang.Exception - If an error occurs

GetBoundThingsForFederatedServer

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetBoundThingsForFederatedServer(java.lang.String name,
                                                                                            java.lang.Double maxItems)
                                                                                     throws java.lang.Exception

Service Category:

Federation

Service Description:

Get bound federated things.

Parameters:

name - Federated server name - THINGNAME

maxItems - Maximum number of items to return - NUMBER

Returns:

result Bound federated things - INFOTABLE - Aspects {dataShape:DeviceStatus}

Throws:

java.lang.Exception - If an error occurs