Package com.thingworx.resources.entities
Class EntityServices
- All Implemented Interfaces:
IConfigurableObject
,INotScriptFriendly
,ISupportsDeprecation
,IDiffableObject
,IAvatar
,IEntityLifeCycleEvent
,IPersistable
,IServiceProvider
,ITaggableObject
,IDependencyScannableObject
,IEntityDefinition
,IPersistableObject<String>
,IDesignTimeSecurable
,IDesignTimeSecurableEntity
,IRunTimeSecurable
,IRunTimeSecurableEntity
,ISecurable
,IVisibilitySecurable
,IVisibilitySecurableEntity
,IAspectContainer
,INamedObject
,Serializable
@ThingworxExtensionApiClass(since={6,6},
canInstantiate=true)
public class EntityServices
extends Resource
- See Also:
-
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
AddEntityVisibilities
(InfoTable organizationReferences, TagCollection tags, String projectName, Boolean includeDependents) Service Category: Permissions Service Description: Add visibility on a set of entities for multiple Organizations/OrganizationalUnits.void
AddEntityVisibility
(String organizationName, TagCollection tags, String projectName, Boolean includeDependents) Service Category: Permissions Service Description: Add visibility to a set of entities.void
AddResourceEntityPermission
(TagCollection tags, String projectName, Boolean includeDependents, InfoTable permissions) Service Category: Permissions Service Description: Add run time permissions for a resource to a set of entities.void
AddShapeToThing
(String name, String thingShapeName) Service Category: Things Service Description: Add a thing shape to an existing thing.void
AddShapeToThingTemplate
(String name, String thingShapeName) Service Category: ThingTemplates Service Description: Add a thing shape to an existing thing template.void
AddThingPermission
(String entityName, String entityType, org.json.JSONObject query, InfoTable permissions) Service Category: Permissions Service Description: Add run time permissions to a set of Things.void
AddThingVisibility
(InfoTable organizationReferences, String entityName, String entityType, org.json.JSONObject query) Service Category: Permissions Service Description: Add visibility on a set of entities.void
CloneNotificationContent
(String sourceNotificationContentName, String name, String description, TagCollection tags) Service Category: NotificationContents Service Description: Clone a notification content.void
CloneNotificationDefinition
(String sourceNotificationDefinitionName, String name, String description, TagCollection tags) Service Category: NotificationDefinitions Service Description: Clone a notification definition.void
CloneThing
(String sourceThingName, String name, String description, TagCollection tags) Service Category: Things Service Description: Clone an existing thing with a new name.void
CloneThingShape
(String sourceThingShapeName, String name, String description, TagCollection tags) Service Category: ThingShapes Service Description: Clone an existing thing shape with a new name.void
CloneThingShapeWithOwner
(String sourceThingShapeName, String name, String description, TagCollection tags, String ownerUserName) Service Category: ThingShapes Service Description: Clone an existing thing shape with a new name and set owner if provided.void
CloneThingTemplate
(String sourceThingTemplateName, String name, String description, TagCollection tags) Service Category: ThingTemplates Service Description: Clone an existing thing template with a new name.void
CloneThingTemplateWithOwner
(String sourceThingTemplateName, String name, String description, TagCollection tags, String ownerUserName) Service Category: ThingTemplates Service Description: Clone an existing thing template with a new name and ownerName.void
CloneThingWithOwner
(String sourceThingName, String name, String description, TagCollection tags, String ownerUserName) Service Category: Things Service Description: Clone thing and set owner if provided.void
CloneUser
(String sourceUserName, String name, String description, TagCollection tags, String password) Service Category: Users Service Description: Clone an existing user.void
CloneUserWithGroups
(String sourceUserName, String name, String description, TagCollection tags, String password) Service Category: Users Service Description: Clone an existing user and clone group memberships.void
CreateApplicationKey
(String name, String description, String user, TagCollection tags, String projectName, String whitelist, String clientName, org.joda.time.DateTime expirationDate) Service Category: ApplicationKeys Service Description: Create a new application key.void
CreateApplicationKey
(String name, String description, String user, TagCollection tags, String whitelist, String clientName, org.joda.time.DateTime expirationDate) Deprecated.void
CreateDataShape
(String name, String description, TagCollection tags, InfoTable fields) Deprecated.in 9.1 to be replaced byCreateDataShape(String, String, TagCollection, String, InfoTable)
which allows specification of a projectName via a parameter.void
CreateDataShape
(String name, String description, TagCollection tags, String projectName, InfoTable fields) Service Category: DataShapes Service Description: Create a new data shape.void
CreateDataTagVocabulary
(String name, String description, TagCollection tags, Boolean dynamic) Deprecated.in 9.1 to be replaced byCreateDataTagVocabulary(String, String, TagCollection, Boolean)
which allows specification of a projectName via a parameter.void
CreateDataTagVocabulary
(String name, String description, TagCollection tags, String projectName, Boolean dynamic) Service Category: DataTags Service Description: Create a new data tag vocabulary.void
CreateGroup
(String name, String description, TagCollection tags) Deprecated.in 9.1 to be replaced byCreateGroup(String, String, TagCollection, String)
which allows specification of a projectName via a parameter.void
CreateGroup
(String name, String description, TagCollection tags, String projectName) Service Category: Groups Service Description: Create a new group.void
CreateLocalizationTable
(String name, String description, TagCollection tags) Deprecated.in 9.1 to be replaced byCreateLocalizationTable(String, String, TagCollection, String)
which allows specification of a projectName via a parameter.void
CreateLocalizationTable
(String name, String description, TagCollection tags, String projectName) Service Category: LocalizationTables Service Description: Create a new localization table.void
CreateMediaEntity
(String name, String description, TagCollection tags, byte[] content) Deprecated.in 9.1 to be replaced byCreateMediaEntity(String, String, TagCollection, String, byte[])
which allows specification of a projectName via a parameter.void
CreateMediaEntity
(String name, String description, TagCollection tags, String projectName, byte[] content) Service Category: Media Service Description: Create a new media entity.void
CreateModelTagVocabulary
(String name, String description, TagCollection tags, Boolean dynamic) Deprecated.in 9.1 to be replaced byCreateModelTagVocabulary(String, String, TagCollection, String, Boolean)
which allows specification of a projectName via a parameter.void
CreateModelTagVocabulary
(String name, String description, TagCollection tags, String projectName, Boolean dynamic) Service Category: ModelTags Service Description: Create a new model tag vocabulary.void
CreateNetwork
(String name, String description, TagCollection tags, InfoTable connections) Deprecated.in 9.1 to be replaced byCreateNetwork(String, String, TagCollection, String, InfoTable)
which allows specification of a projectName via a parameter.void
CreateNetwork
(String name, String description, TagCollection tags, String projectName, InfoTable connections) Service Category: Networks Service Description: Create a new network.void
CreateNotificationContent
(String name, String description, TagCollection tags, String handlerID, String handlerEntity) Deprecated.in 9.1 to be replaced byCreateNotificationContent(String, String, TagCollection, String, String, String)
which allows specification of a projectName via a parameter.void
CreateNotificationContent
(String name, String description, TagCollection tags, String projectName, String handlerID, String handlerEntity) Service Category: NotificationContents Service Description: Create a new notification content.void
CreateNotificationDefinition
(String name, String description, TagCollection tags, InfoTable notificationContents) Deprecated.in 9.1 to be replaced byCreateNotificationDefinition(String, String, TagCollection, String, InfoTable)
which allows specification of a projectName via a parameter.void
CreateNotificationDefinition
(String name, String description, TagCollection tags, String projectName, InfoTable notificationContents) Service Category: Notifications Service Description: Create a new notification definition.void
CreateOrganization
(String name, String description, TagCollection tags, String topOUName, String topOUDescription) Deprecated.in 9.1 to be replaced byCreateOrganization(String, String, TagCollection, String, String, String)
which allows specification of a projectName via a parameter.void
CreateOrganization
(String name, String description, TagCollection tags, String projectName, String topOUName, String topOUDescription) Service Category: Organizations Service Description: Create a new organization.void
CreateProject
(String name, String description, String dependsOn, TagCollection tags) Deprecated.void
CreateProject
(String name, String projectType, String description, String dependsOn, TagCollection tags) Service Category: Projects Service Description: Create a new project.
This method creates a new Project Entity.void
CreateStyleDefinition
(String name, String description, TagCollection tags, String projectName, org.json.JSONObject content) Service Category: StyleDefinitions Service Description: Create a new style definition.void
CreateStyleDefinition
(String name, String description, TagCollection tags, org.json.JSONObject content) Deprecated.in 9.1 to be replaced byCreateStyleDefinition(String, String, TagCollection, String, JSONObject)
which allows specification of a projectName via a parameter.void
CreateThing
(String name, String description, TagCollection tags, String thingTemplateName) Deprecated.in 9.1 to be replaced byCreateThing(String, String, TagCollection, String, String)
which allows specification of a projectName via a parameter.void
CreateThing
(String name, String description, TagCollection tags, String projectName, String thingTemplateName) Service Category: Things Service Description: Create a new thing.void
CreateThingShape
(String name, String description, TagCollection tags) Deprecated.in 9.1 to be replaced byCreateThingShape(String, String, TagCollection, String)
which allows specification of a projectName via a parameter.void
CreateThingShape
(String name, String description, TagCollection tags, String projectName) Service Category: ThingShape Service Description: Create a new thing shape.void
CreateThingShapeWithOwner
(String name, String description, TagCollection tags, String projectName, String ownerUserName) Service Category: ThingShape Service Description: Create a new thingShape and set owner if provided.void
CreateThingTemplate
(String name, String description, TagCollection tags, String thingTemplateName) Deprecated.in 9.1 to be replaced byCreateThingTemplate(String, String, TagCollection, String, String)
which allows specification of a projectName via a parameter.void
CreateThingTemplate
(String name, String description, TagCollection tags, String projectName, String thingTemplateName) Service Category: ThingTemplates Service Description: Create a new thing template from a base template.void
CreateThingTemplateWithOwner
(String name, String description, TagCollection tags, String projectName, String thingTemplateName, String ownerUserName) Service Category: ThingTemplates Service Description: Create a new thing template from a base template with Owner.void
CreateThingWithOwner
(String name, String description, TagCollection tags, String thingTemplateName, String ownerUserName) Deprecated.in 9.1 to be replaced byCreateThingWithOwner(String, String, TagCollection, String, String, String)
which allows specification of a projectName via a parameter.void
CreateThingWithOwner
(String name, String description, TagCollection tags, String projectName, String thingTemplateName, String ownerUserName) Service Category: Things Service Description: Create a new thing and set owner if provided.void
CreateUser
(String name, String description, TagCollection tags, String password) Deprecated.in 9.1 to be replaced byCreateUser(String, String, TagCollection, String, String)
which allows specification of a projectName via a parameter.void
CreateUser
(String name, String description, TagCollection tags, String projectName, String password) Service Category: Users Service Description: Create a new user.void
CreateUserWithOptions
(InfoTable userOptions) Service Category: Users Service Description: Creates a user.void
DeleteApplicationKey
(String name) Service Category: ApplicationKeys Service Description: Delete an application key.void
Service Category: DataTags Service Description: Delete a data tag vocabulary.void
DeleteEntityPermission
(String name, String type, TagCollection tags, String projectName, Boolean includeDependents) Service Category: Permissions Service Description: Delete run time permissions on a set of entities.void
DeleteEntityVisibilities
(InfoTable organizationReferences, TagCollection tags, String projectName, Boolean includeDependents) Service Category: Permissions Service Description: Delete visibility on a set of entities for multiple Organizations/OrganizationalUnits.void
DeleteEntityVisibility
(String organizationName, TagCollection tags, String projectName, Boolean includeDependents) Service Category: Permissions Service Description: Delete visibility on a set of entities.void
DeleteGroup
(String name) Service Category: Groups Service Description: Delete a group.void
DeleteMediaEntity
(String name) Service Category: Media Service Description: Delete a media entity.void
Service Category: ModelTags Service Description: Delete a model tag vocabulary.void
DeleteNetwork
(String name) Service Category: Networks Service Description: Delete a network.void
Service Category: NotificationContents Service Description: Delete a notification content.void
Service Category: NotificationDefinitions Service Description: Delete a notification definition.void
DeleteOrganization
(String name) Service Category: Organizations Service Description: Delete an organization.void
DeleteProject
(String name) Service Category: Projects Service Description: Delete a Project.void
DeleteResourceEntityPermission
(TagCollection tags, String projectName, Boolean includeDependents, InfoTable permissions) Service Category: Permissions Service Description: Delete run time permissions for a resource on a set of entities.void
DeleteStyleDefinition
(String name) Service Category: StyleDefinitions Service Description: Delete a style definition.void
DeleteThing
(String name) Service Category: Things Service Description: Delete a thing.void
DeleteThingPermission
(String entityName, String entityType, org.json.JSONObject query, InfoTable permissions) Service Category: Permissions Service Description: Delete run time permissions on a set of entities.void
DeleteThingShape
(String name) Service Category: ThingShapes Service Description: Delete a thing shape.void
DeleteThingTemplate
(String name) Service Category: ThingTemplates Service Description: Delete a thing template.void
DeleteThingVisibility
(InfoTable organizationReferences, String entityName, String entityType, org.json.JSONObject query) Service Category: Permissions Service Description: Delete visibility on a set of entities.void
DeleteUser
(String name) Service Category: Users Service Description: Delete a user.void
DeleteUserWithOptions
(InfoTable userOptions) Service Category: Users Service Description: Delete a user.GetAspects
(String aspectName, InfoTable entityRefs) Service Category: Aspects Service Description: Returns list of entities and members with aspects filtered on the aspectName.GetEntityList
(String type, String nameMask, TagCollection tags, Double maxItems) Service Category: Service Description: Retrieve a list of all model entities.GetEntityListByRegEx
(String type, String nameMask, TagCollection tags, Double maxItems) Service Category: Service Description: Retrieve a list of all model entities using the nameMask regex expression.GetEntityListWithPermissionMask
(String type, String nameMask, String permissionType, String permissionTarget, TagCollection tags, Double maxItems) Service Category: Service Description: Retrieve a list of all model entities for which the current user has a specific permission.GetEntityListWithPermissionMaskByRegEx
(String type, String nameMask, String permissionType, String permissionTarget, TagCollection tags, Double maxItems) Service Category: Service Description: Retrieve a list of all model entities for which the current user has a specific permission.Service Category: Security Service Description: Return list of locked users.GetThingNameForIdentifier
(String identifier) Service Category: Service Description: Get the thing name associated with an identifier.IsRemoteThingBound
(String name) Service Category: Service Description: Check to see if a remote thing is bound.org.json.JSONObject
ReadEntityAsJSON
(String type, String name, String key) Service Category: Service Description: Read an entity as JSON.org.json.JSONObject
ReadEntityDefinitionAsJSON
(String type, String name) Service Category: Service Description: Read the definition for an entity as JSON.void
RemoveShapeFromThing
(String name, String thingShapeName) Service Category: Things Service Description: Remove a thing shape from an existing thing.void
RemoveShapeFromThingTemplate
(String name, String thingShapeName) Service Category: ThingTemplates Service Description: Remove a thing shape from an existing thing template.void
Service Category: ThingShapes Service Description: Restart dependencies for an existing thing template.void
Service Category: ThingTemplates Service Description: Restart dependencies for an existing thing template.void
SetAccessModifier
(InfoTable accessModifierList) Service Category: Aspects Service Description: Sets accessModifier on entity and its members which support access modifier.
Sets accessModifier on entity and its members which support access modifiervoid
SetDeprecated
(InfoTable deprecatedList) Service Category: Aspects Service Description: Sets the deprecation on entity and members, which supports the deprecation.
Set deprecated on entity and its members which support deprecatedvoid
SetEntityPermission
(String name, String type, Boolean allow, TagCollection tags, String projectName, Boolean includeDependents) Service Category: Permissions Service Description: Set run time permissions on a set of entities.void
SetEntityVisibilities
(InfoTable organizationReferences, TagCollection tags, String projectName, Boolean includeDependents) Service Category: Permissions Service Description: Set visibility on a set of entities for multiple Organizations/OrganizationalUnits.void
SetEntityVisibility
(String organizationName, TagCollection tags, String projectName, Boolean includeDependents) Service Category: Permissions Service Description: Set visibility on a set of entities.void
SetLocalizationTableNames
(String locale, String nativeName, String commonName, String description, TagCollection tags) Service Category: LocalizationTables Service Description: Update or create a localization table with native and common name.void
SetResourceEntityPermission
(TagCollection tags, String projectName, Boolean includeDependents, InfoTable permissions) Service Category: Permissions Service Description: Set run time permissions for a resource on a set of entities.void
SetThingPermission
(String entityName, String entityType, org.json.JSONObject query, InfoTable permissions) Service Category: Permissions Service Description: Set run time permissions on a set of Things.void
SetThingVisibility
(InfoTable organizationReferences, String entityName, String entityType, org.json.JSONObject query) Service Category: Permissions Service Description: Set visibility on a set of entities.void
UpdateMediaEntity
(String name, byte[] content) Service Category: Media Service Description: Update a media entity.void
UpdateStyleDefinition
(String name, org.json.JSONObject content) Service Category: StyleDefinitions Service Description: Update a style definition entity.void
UpdateUserWithOptions
(InfoTable userOptions) Service Category: Users Service Description: Updates a user.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, 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, 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, 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, getName
Methods inherited from interface com.thingworx.entities.interfaces.IPersistable
getID, hasID
Methods inherited from interface com.thingworx.security.permissions.ISecurable
getID, getName
Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation
getDeprecated, isDeprecated, isDeprecatedBefore, since
-
Field Details
-
CONFIGURATIONTABLE
- See Also:
-
PROPERTY
- See Also:
-
SERVICE
- See Also:
-
-
Constructor Details
-
EntityServices
public EntityServices()
-
-
Method Details
-
DeleteApplicationKey
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteApplicationKey(String name) throws Exception - Service Category:
- ApplicationKeys
- Service Description:
- Delete an application key.
- Parameters:
name
- ApplicationKey name - APPLICATIONKEYNAME- Throws:
Exception
- If an error occurs
-
CreateApplicationKey
@Deprecated @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) public void CreateApplicationKey(String name, String description, String user, TagCollection tags, String whitelist, String clientName, org.joda.time.DateTime expirationDate) throws Exception Deprecated.in 9.1 to be replaced byCreateApplicationKey(String, String, String, TagCollection, String, String, String, DateTime)
which allows specification of a projectName via a parameter.- Throws:
Exception
- If an error occurs
-
CreateApplicationKey
@ThingworxExtensionApiMethod(since={9,1}) public void CreateApplicationKey(String name, String description, String user, TagCollection tags, String projectName, String whitelist, String clientName, org.joda.time.DateTime expirationDate) throws Exception - Service Category:
- ApplicationKeys
- Service Description:
- Create a new application key.
- Parameters:
name
- Application key name - STRINGdescription
- Application key description - STRINGuser
- Associated user name - USERNAMEtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEwhitelist
- IP whitelist - STRINGclientName
- clientName - STRINGexpirationDate
- Expiration date - DATETIME- Throws:
Exception
- If an error occurs
-
DeleteUser
- Service Category:
- Users
- Service Description:
- Delete a user.
- Parameters:
name
- User name - USERNAME- Throws:
Exception
- If an error occurs
-
DeleteNetwork
- Service Category:
- Networks
- Service Description:
- Delete a network.
- Parameters:
name
- Network name - NETWORKNAME- Throws:
Exception
- If an error occurs
-
DeleteMediaEntity
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteMediaEntity(String name) throws Exception - Service Category:
- Media
- Service Description:
- Delete a media entity.
- Parameters:
name
- Media entity name - MEDIAENTITYNAME- Throws:
Exception
- If an error occurs
-
DeleteOrganization
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteOrganization(String name) throws Exception - Service Category:
- Organizations
- Service Description:
- Delete an organization.
- Parameters:
name
- Organization name - ORGANIZATIONNAME- Throws:
Exception
- If an error occurs
-
DeleteGroup
- Service Category:
- Groups
- Service Description:
- Delete a group.
- Parameters:
name
- Group name - GROUPNAME- Throws:
Exception
- If an error occurs
-
DeleteThing
- Service Category:
- Things
- Service Description:
- Delete a thing.
- Parameters:
name
- Thing name - THINGNAME- Throws:
Exception
- If an error occurs
-
DeleteThingTemplate
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteThingTemplate(String name) throws Exception - Service Category:
- ThingTemplates
- Service Description:
- Delete a thing template.
- Parameters:
name
- Thing template name - THINGTEMPLATENAME- Throws:
Exception
- If an error occurs
-
DeleteThingShape
@ThingworxExtensionApiMethod(since={6,6}) public void DeleteThingShape(String name) throws Exception - Service Category:
- ThingShapes
- Service Description:
- Delete a thing shape.
- Parameters:
name
- Thing shape name - THINGSHAPENAME- Throws:
Exception
- If an error occurs
-
DeleteProject
- Service Category:
- Projects
- Service Description:
- Delete a Project.
- Parameters:
name
- Project name - PROJECTNAME- Throws:
Exception
- If an error occurs
-
CreateUser
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateUser(String name, String description, TagCollection tags, String password) throws Exception Deprecated.in 9.1 to be replaced byCreateUser(String, String, TagCollection, String, String)
which allows specification of a projectName via a parameter.- Throws:
Exception
- If an error occurs
-
CreateUser
@ThingworxExtensionApiMethod(since={9,1}) public void CreateUser(String name, String description, TagCollection tags, String projectName, String password) throws Exception - Service Category:
- Users
- Service Description:
- Create a new user.
- Parameters:
name
- New user name - STRINGdescription
- New user description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEpassword
- New user password - STRING- Throws:
Exception
- If an error occurs
-
CloneUser
@ThingworxExtensionApiMethod(since={6,6}) public void CloneUser(String sourceUserName, String name, String description, TagCollection tags, String password) throws Exception - Service Category:
- Users
- Service Description:
- Clone an existing user.
- Parameters:
sourceUserName
- Existing user name - USERNAMEname
- New user name - STRINGdescription
- New user description - STRINGtags
- Tags - TAGSpassword
- New user password - STRING- Throws:
Exception
- If an error occurs
-
CloneUserWithGroups
@ThingworxExtensionApiMethod(since={6,6}) public void CloneUserWithGroups(String sourceUserName, String name, String description, TagCollection tags, String password) throws Exception - Service Category:
- Users
- Service Description:
- Clone an existing user and clone group memberships.
- Parameters:
sourceUserName
- Existing user name - USERNAMEname
- New user name - STRINGdescription
- New user description - STRINGtags
- Tags - TAGSpassword
- New user password - STRING- Throws:
Exception
- If an error occurs
-
CreateUserWithOptions
@ThingworxExtensionApiMethod(since={7,4}) public void CreateUserWithOptions(InfoTable userOptions) throws Exception - Service Category:
- Users
- Service Description:
- Creates a user.
- Parameters:
userOptions
- Create a user according to the given user options. The userName in the UserOptions is required. - INFOTABLE- Throws:
Exception
- If an error occurs
-
UpdateUserWithOptions
@ThingworxExtensionApiMethod(since={7,4}) public void UpdateUserWithOptions(InfoTable userOptions) throws Exception - Service Category:
- Users
- Service Description:
- Updates a user.
- Parameters:
userOptions
- Update the user for the given user options. The userName in the UserOptions is required. - INFOTABLE- Throws:
Exception
- If an error occurs
-
DeleteUserWithOptions
@ThingworxExtensionApiMethod(since={7,4}) public void DeleteUserWithOptions(InfoTable userOptions) throws Exception - Service Category:
- Users
- Service Description:
- Delete a user.
- Parameters:
userOptions
- Delete the user for the given user options. The userName in the UserOptions is required. - INFOTABLE- Throws:
Exception
- If an error occurs
-
CreateGroup
@Deprecated @ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) public void CreateGroup(String name, String description, TagCollection tags) throws Exception Deprecated.in 9.1 to be replaced byCreateGroup(String, String, TagCollection, String)
which allows specification of a projectName via a parameter.- Throws:
Exception
- If an error occurs
-
CreateGroup
@ThingworxExtensionApiMethod(since={9,1}) public void CreateGroup(String name, String description, TagCollection tags, String projectName) throws Exception - Service Category:
- Groups
- Service Description:
- Create a new group.
- Parameters:
name
- New group name - STRINGdescription
- New group description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAME- Throws:
Exception
- If an error occurs
-
CreateDataShape
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateDataShape(String name, String description, TagCollection tags, InfoTable fields) throws Exception Deprecated.in 9.1 to be replaced byCreateDataShape(String, String, TagCollection, String, InfoTable)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateDataShape
@ThingworxExtensionApiMethod(since={9,1}) public void CreateDataShape(String name, String description, TagCollection tags, String projectName, InfoTable fields) throws Exception - Service Category:
- DataShapes
- Service Description:
- Create a new data shape.
- Parameters:
name
- New data shape name - STRINGdescription
- New data shape description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEfields
- Info table with field definitions - INFOTABLE- Throws:
Exception
- If an error occurs
-
CreateDataTagVocabulary
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateDataTagVocabulary(String name, String description, TagCollection tags, Boolean dynamic) throws Exception Deprecated.in 9.1 to be replaced byCreateDataTagVocabulary(String, String, TagCollection, Boolean)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateDataTagVocabulary
@ThingworxExtensionApiMethod(since={9,1}) public void CreateDataTagVocabulary(String name, String description, TagCollection tags, String projectName, Boolean dynamic) throws Exception - Service Category:
- DataTags
- Service Description:
- Create a new data tag vocabulary.
- Parameters:
name
- New vocabulary name - STRINGdescription
- New vocabulary description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEdynamic
- Make the vocabulary dynamic - BOOLEAN- Throws:
Exception
- If an error occurs
-
CreateModelTagVocabulary
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateModelTagVocabulary(String name, String description, TagCollection tags, Boolean dynamic) throws Exception Deprecated.in 9.1 to be replaced byCreateModelTagVocabulary(String, String, TagCollection, String, Boolean)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateModelTagVocabulary
@ThingworxExtensionApiMethod(since={9,1}) public void CreateModelTagVocabulary(String name, String description, TagCollection tags, String projectName, Boolean dynamic) throws Exception - Service Category:
- ModelTags
- Service Description:
- Create a new model tag vocabulary.
- Parameters:
name
- New vocabulary name - STRINGdescription
- New vocabulary description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEdynamic
- Make the vocabulary dynamic - BOOLEAN- Throws:
Exception
- If an error occurs
-
CreateNetwork
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateNetwork(String name, String description, TagCollection tags, InfoTable connections) throws Exception Deprecated.in 9.1 to be replaced byCreateNetwork(String, String, TagCollection, String, InfoTable)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateNetwork
@ThingworxExtensionApiMethod(since={9,1}) public void CreateNetwork(String name, String description, TagCollection tags, String projectName, InfoTable connections) throws Exception - Service Category:
- Networks
- Service Description:
- Create a new network.
- Parameters:
name
- New network name - STRINGdescription
- New network description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEconnections
- Connections - INFOTABLE- Throws:
Exception
- If an error occurs
-
CreateOrganization
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateOrganization(String name, String description, TagCollection tags, String topOUName, String topOUDescription) throws Exception Deprecated.in 9.1 to be replaced byCreateOrganization(String, String, TagCollection, String, String, String)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateOrganization
@ThingworxExtensionApiMethod(since={9,1}) public void CreateOrganization(String name, String description, TagCollection tags, String projectName, String topOUName, String topOUDescription) throws Exception - Service Category:
- Organizations
- Service Description:
- Create a new organization.
- Parameters:
name
- New organization name - STRINGdescription
- New organization description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEtopOUName
- Top level organizational unit in the Organization - STRINGtopOUDescription
- Description for the top level organizational unit - STRING- Throws:
Exception
- If an error occurs
-
CreateLocalizationTable
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateLocalizationTable(String name, String description, TagCollection tags) throws Exception Deprecated.in 9.1 to be replaced byCreateLocalizationTable(String, String, TagCollection, String)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateLocalizationTable
@ThingworxExtensionApiMethod(since={9,1}) public void CreateLocalizationTable(String name, String description, TagCollection tags, String projectName) throws Exception - Service Category:
- LocalizationTables
- Service Description:
- Create a new localization table.
- Parameters:
name
- New localization table name, i.e. language - STRINGdescription
- New localization table description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAME- Throws:
Exception
- If an error occurs
-
SetLocalizationTableNames
@ThingworxExtensionApiMethod(since={7,4}) public void SetLocalizationTableNames(String locale, String nativeName, String commonName, String description, TagCollection tags) throws Exception - Service Category:
- LocalizationTables
- Service Description:
- Update or create a localization table with native and common name.
- Parameters:
locale
- Localization table name or language - STRINGnativeName
- Localization table native name or native language - STRINGcommonName
- Localization table common name or common language - STRINGdescription
- Localization table description - STRINGtags
- Tags - TAGS- Throws:
Exception
- If an error occurs
-
CreateMediaEntity
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateMediaEntity(String name, String description, TagCollection tags, byte[] content) throws Exception Deprecated.in 9.1 to be replaced byCreateMediaEntity(String, String, TagCollection, String, byte[])
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateMediaEntity
@ThingworxExtensionApiMethod(since={9,1}) public void CreateMediaEntity(String name, String description, TagCollection tags, String projectName, byte[] content) throws Exception - Service Category:
- Media
- Service Description:
- Create a new media entity.
- Parameters:
name
- New media name - STRINGdescription
- New media description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEcontent
- Media content - IMAGE- Throws:
Exception
- If an error occurs
-
UpdateMediaEntity
@ThingworxExtensionApiMethod(since={6,6}) public void UpdateMediaEntity(String name, byte[] content) throws Exception - Service Category:
- Media
- Service Description:
- Update a media entity.
- Parameters:
name
- Existing media name - STRINGcontent
- Media content - IMAGE- Throws:
Exception
- If an error occurs
-
CreateThing
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateThing(String name, String description, TagCollection tags, String thingTemplateName) throws Exception Deprecated.in 9.1 to be replaced byCreateThing(String, String, TagCollection, String, String)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateThing
@ThingworxExtensionApiMethod(since={9,1}) public void CreateThing(String name, String description, TagCollection tags, String projectName, String thingTemplateName) throws Exception - Service Category:
- Things
- Service Description:
- Create a new thing.
- Parameters:
name
- New thing name - STRINGdescription
- New thing description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEthingTemplateName
- Thing template name - THINGTEMPLATENAME- Throws:
Exception
- If an error occurs
-
CreateThingWithOwner
@ThingworxExtensionApiMethod(since={8,4,13}, deprecatedSince={9,1}) @Deprecated public void CreateThingWithOwner(String name, String description, TagCollection tags, String thingTemplateName, String ownerUserName) throws Exception Deprecated.in 9.1 to be replaced byCreateThingWithOwner(String, String, TagCollection, String, String, String)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateThingWithOwner
@ThingworxExtensionApiMethod(since={9,1}) public void CreateThingWithOwner(String name, String description, TagCollection tags, String projectName, String thingTemplateName, String ownerUserName) throws Exception - Service Category:
- Things
- Service Description:
- Create a new thing and set owner if provided.
- Parameters:
name
- New thing name - STRINGdescription
- New thing description - STRINGtags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEthingTemplateName
- Thing template name - THINGTEMPLATENAMEownerUserName
- the user name to set as owner of newly thing - USERNAME- Throws:
Exception
- If an error occurs
-
CreateThingTemplate
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateThingTemplate(String name, String description, TagCollection tags, String thingTemplateName) throws Exception Deprecated.in 9.1 to be replaced byCreateThingTemplate(String, String, TagCollection, String, String)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
-
CreateThingTemplate
@ThingworxExtensionApiMethod(since={9,1}) public void CreateThingTemplate(String name, String description, TagCollection tags, String projectName, String thingTemplateName) throws Exception - Service Category:
- ThingTemplates
- Service Description:
- Create a new thing template from a base template.
- Parameters:
name
- New thing template name - STRINGdescription
- New thing template description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEthingTemplateName
- Base thing template name - THINGTEMPLATENAME- Throws:
Exception
- If an error occurs
-
CreateThingTemplateWithOwner
@ThingworxExtensionApiMethod(since={8,5,14}) public void CreateThingTemplateWithOwner(String name, String description, TagCollection tags, String projectName, String thingTemplateName, String ownerUserName) throws Exception - Service Category:
- ThingTemplates
- Service Description:
- Create a new thing template from a base template with Owner.
- Parameters:
name
- New thing template name - STRINGdescription
- New thing template description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEthingTemplateName
- Base thing template name - THINGTEMPLATENAMEownerUserName
- the User Name to set as owner of this ThingTemplate - USERNAME- Throws:
Exception
- If an error occurs
-
CreateThingShape
@ThingworxExtensionApiMethod(since={6,6}, deprecatedSince={9,1}) @Deprecated public void CreateThingShape(String name, String description, TagCollection tags) throws Exception Deprecated.in 9.1 to be replaced byCreateThingShape(String, String, TagCollection, String)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateThingShape
@ThingworxExtensionApiMethod(since={9,1}) public void CreateThingShape(String name, String description, TagCollection tags, String projectName) throws Exception - Service Category:
- ThingShape
- Service Description:
- Create a new thing shape.
- Parameters:
name
- New thing shape name - STRINGdescription
- New thing shape description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAME- Throws:
Exception
- If an error occurs
-
CreateThingShapeWithOwner
@ThingworxExtensionApiMethod(since={8,5,14}) public void CreateThingShapeWithOwner(String name, String description, TagCollection tags, String projectName, String ownerUserName) throws Exception - Service Category:
- ThingShape
- Service Description:
- Create a new thingShape and set owner if provided.
- Parameters:
name
- New thingShape name - STRINGdescription
- New thingShape description - STRINGtags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEownerUserName
- the user name to set as owner of newly thingShape - USERNAME- Throws:
Exception
- If an error occurs
-
CreateProject
@ThingworxExtensionApiMethod(since={7,1}, deprecatedSince={9,1}) @Deprecated public void CreateProject(String name, String description, String dependsOn, TagCollection tags) throws Exception Deprecated.
This is deprecated because the new API accepts the type for a project. This method will always create project of Component type.- Parameters:
name
- - Name of the projectdescription
- - Description of the projectdependsOn
- - Extensions that this project depends ontags
- - Tags for this project- Throws:
Exception
-
CreateProject
@ThingworxExtensionApiMethod(since={9,1}) public void CreateProject(String name, String projectType, String description, String dependsOn, TagCollection tags) throws Exception - Service Category:
- Projects
- Service Description:
- Create a new project.
This method creates a new Project Entity. If the type is not specified the project type will be set to Component.- Parameters:
name
- - Name of the projectprojectType
- - Type of the project.Ex - Component, Solutiondescription
- - Description of the projectdependsOn
- - Extensions that this project depends ontags
- - Tags for this project- Throws:
Exception
-
CloneThing
@ThingworxExtensionApiMethod(since={6,6}) public void CloneThing(String sourceThingName, String name, String description, TagCollection tags) throws Exception - Service Category:
- Things
- Service Description:
- Clone an existing thing with a new name.
- Parameters:
sourceThingName
- Existing thing name - THINGNAMEname
- New thing name - STRINGdescription
- New thing description - STRINGtags
- Tags - TAGS- Throws:
Exception
- If an error occurs
Additional Information: Clones a Thing. The cloned Thing inherits all the characteristics of the Thing from which it was cloned, including visibility, permissions, and persisted property values. Similarly, enabled subscriptions from the Thing being cloned will be enabled on the cloned Thing. The description and tags of the cloned Thing are set to the arguments provided for description and tags. The user invoking CloneThing() must have Read permissions for the Thing being cloned (sourceThingName). Likewise, the Thing being cloned must exist. The name of the cloned Thing must contain valid characters and be unique. After cloning a Thing, the cloned Thing must be enabled (Thing.EnableThing()) and restarted (Thing.RestartThing()) to be live.
-
CloneThingTemplate
@ThingworxExtensionApiMethod(since={6,6}) public void CloneThingTemplate(String sourceThingTemplateName, String name, String description, TagCollection tags) throws Exception - Service Category:
- ThingTemplates
- Service Description:
- Clone an existing thing template with a new name.
- Parameters:
sourceThingTemplateName
- Existing thing template name - THINGTEMPLATENAMEname
- New thing name - STRINGdescription
- New thing description - STRINGtags
- Tags - TAGS- Throws:
Exception
- If an error occurs
-
CloneThingTemplateWithOwner
@ThingworxExtensionApiMethod(since={8,5,14}) public void CloneThingTemplateWithOwner(String sourceThingTemplateName, String name, String description, TagCollection tags, String ownerUserName) throws Exception - Service Category:
- ThingTemplates
- Service Description:
- Clone an existing thing template with a new name and ownerName.
- Parameters:
sourceThingTemplateName
- Thing template name - THINGTEMPLATENAMEname
- New thing name - STRINGdescription
- New thing description - STRINGtags
- Tags - TAGSownerUserName
- the user name to set as owner of newly thing - USERNAME- Throws:
Exception
- If an error occurs
-
CloneThingShape
@ThingworxExtensionApiMethod(since={6,6}) public void CloneThingShape(String sourceThingShapeName, String name, String description, TagCollection tags) throws Exception - Service Category:
- ThingShapes
- Service Description:
- Clone an existing thing shape with a new name.
- Parameters:
sourceThingShapeName
- Existing thing shape name - THINGSHAPENAMEname
- New thing name - STRINGdescription
- New thing description - STRINGtags
- Tags - TAGS- Throws:
Exception
- If an error occurs
Additional Information: Clones a Thing Shape. The cloned Thing Shape inherits all the characteristics of the Thing Shape from which it was cloned, including visibility and permissions. Similarly, subscriptions from the Thing Shape being cloned will be enabled on the cloned Thing Shape. The description and tags of the cloned Thing Shape are set to the arguments for description and tags. The user invoking CloneThingShape() must have Read permissions for the Thing Shape being cloned (sourceThingShapeName). Likewise, the Thing Shape being cloned must exist. The name of the cloned Thing Shape must contain valid characters and be unique.
-
CloneThingShapeWithOwner
@ThingworxExtensionApiMethod(since={8,5,14}) public void CloneThingShapeWithOwner(String sourceThingShapeName, String name, String description, TagCollection tags, String ownerUserName) throws Exception - Service Category:
- ThingShapes
- Service Description:
- Clone an existing thing shape with a new name and set owner if provided.
- Parameters:
sourceThingShapeName
- Existing thing shape name - THINGSHAPENAMEname
- New thing name - STRINGdescription
- New thing description - STRINGtags
- Tags - TAGSownerUserName
- the user name to set as owner of newly cloned thingShape - USERNAME- Throws:
Exception
- If an error occurs
-
AddShapeToThing
@ThingworxExtensionApiMethod(since={6,6}) public void AddShapeToThing(String name, String thingShapeName) throws Exception - Service Category:
- Things
- Service Description:
- Add a thing shape to an existing thing.
- Parameters:
name
- Thing name - THINGNAMEthingShapeName
- Thing shape name - THINGSHAPENAME- Throws:
Exception
- If an error occurs
-
AddShapeToThingTemplate
@ThingworxExtensionApiMethod(since={6,6}) public void AddShapeToThingTemplate(String name, String thingShapeName) throws Exception - Service Category:
- ThingTemplates
- Service Description:
- Add a thing shape to an existing thing template.
- Parameters:
name
- Thing template name - THINGTEMPLATENAMEthingShapeName
- Thing shape name - THINGSHAPENAME- Throws:
Exception
- If an error occurs
-
RemoveShapeFromThing
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveShapeFromThing(String name, String thingShapeName) throws Exception - Service Category:
- Things
- Service Description:
- Remove a thing shape from an existing thing.
- Parameters:
name
- Thing name - THINGNAMEthingShapeName
- Thing shape name - THINGSHAPENAME- Throws:
Exception
- If an error occurs
-
RemoveShapeFromThingTemplate
@ThingworxExtensionApiMethod(since={6,6}) public void RemoveShapeFromThingTemplate(String name, String thingShapeName) throws Exception - Service Category:
- ThingTemplates
- Service Description:
- Remove a thing shape from an existing thing template.
- Parameters:
name
- Thing template name - THINGTEMPLATENAMEthingShapeName
- Thing shape name - THINGSHAPENAME- Throws:
Exception
- If an error occurs
-
RestartDependenciesForThingTemplate
@ThingworxExtensionApiMethod(since={6,6}) public void RestartDependenciesForThingTemplate(String name) throws Exception - Service Category:
- ThingTemplates
- Service Description:
- Restart dependencies for an existing thing template.
- Parameters:
name
- Thing template name - THINGTEMPLATENAME- Throws:
Exception
- If an error occurs
-
RestartDependenciesForThingShape
@ThingworxExtensionApiMethod(since={6,6}) public void RestartDependenciesForThingShape(String name) throws Exception - Service Category:
- ThingShapes
- Service Description:
- Restart dependencies for an existing thing template.
- Parameters:
name
- Thing shape name - THINGSHAPENAME- Throws:
Exception
- If an error occurs
-
ReadEntityAsJSON
@ThingworxExtensionApiMethod(since={6,6}) public org.json.JSONObject ReadEntityAsJSON(String type, String name, String key) throws Exception - Service Category:
- Service Description:
- Read an entity as JSON.
- Parameters:
type
- Entity Collection Type (Things, Mashups, Users, etc) - STRINGname
- Entity Name - STRINGkey
- Encryption-Decryption key name - STRING- Returns:
- result Entity definition - JSON
- Throws:
Exception
- If an error occurs
-
ReadEntityDefinitionAsJSON
@ThingworxExtensionApiMethod(since={6,6}) public org.json.JSONObject ReadEntityDefinitionAsJSON(String type, String name) throws Exception - Service Category:
- Service Description:
- Read the definition for an entity as JSON.
- Parameters:
type
- Entity Collection Type (Things, Mashups, Users, etc) - STRINGname
- Entity Name - STRING- Returns:
- result Entity definition - JSON
- Throws:
Exception
- If an error occurs
-
GetEntityList
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetEntityList(String type, String nameMask, TagCollection tags, Double maxItems) throws Exception - Service Category:
- Service Description:
- Retrieve a list of all model entities.
- Parameters:
type
- Entity Type (Thing, Mashup, User, etc) - STRINGnameMask
- Entity name pattern to match - STRINGtags
- Tags - TAGSmaxItems
- Maximum number of items to return - NUMBER- Returns:
- result Matching entries - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
Exception
- If an error occurs
-
GetEntityListByRegEx
@ThingworxExtensionApiMethod(since={9,0}) public InfoTable GetEntityListByRegEx(String type, String nameMask, TagCollection tags, Double maxItems) throws Exception - Service Category:
- Service Description:
- Retrieve a list of all model entities using the nameMask regex expression.
- Parameters:
type
- Entity Type (Thing, Mashup, User, etc) - STRINGnameMask
- Entity name pattern to match - STRINGtags
- Tags - TAGSmaxItems
- Maximum number of items to return - NUMBER- Returns:
- result Matching entries - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
Exception
- If an error occurs
-
GetEntityListWithPermissionMask
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable GetEntityListWithPermissionMask(String type, String nameMask, String permissionType, String permissionTarget, TagCollection tags, Double maxItems) throws Exception - Service Category:
- Service Description:
- Retrieve a list of all model entities for which the current user has a specific permission.
- Parameters:
type
- Entity Type (Thing, Mashup, User, etc) - STRINGnameMask
- Entity name pattern to match - STRINGpermissionType
- Permission Type (ServiceInvoke, PropertyRead, PropertyWrite, etc.) - STRINGpermissionTarget
- Permission target - STRINGtags
- Tags - TAGSmaxItems
- Maximum number of items to return - NUMBER- Returns:
- result Matching entries - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
Exception
- If an error occurs
-
GetEntityListWithPermissionMaskByRegEx
@ThingworxExtensionApiMethod(since={9,0}) public InfoTable GetEntityListWithPermissionMaskByRegEx(String type, String nameMask, String permissionType, String permissionTarget, TagCollection tags, Double maxItems) throws Exception - Service Category:
- Service Description:
- Retrieve a list of all model entities for which the current user has a specific permission.
- Parameters:
type
- Entity Type (Thing, Mashup, User, etc) - STRINGnameMask
- Entity name pattern to match - STRINGpermissionType
- Permission Type (ServiceInvoke, PropertyRead, PropertyWrite, etc.) - STRINGpermissionTarget
- Permission target - STRINGtags
- Tags - TAGSmaxItems
- Maximum number of items to return - NUMBER- Returns:
- result Matching entries - INFOTABLE - Aspects {dataShape:RootEntityList}
- Throws:
Exception
- If an error occurs
-
IsRemoteThingBound
@ThingworxExtensionApiMethod(since={6,6}) public Boolean IsRemoteThingBound(String name) throws Exception - Service Category:
- Service Description:
- Check to see if a remote thing is bound.
- Parameters:
name
- Thing Name or Identifier - STRING- Returns:
- result Binding status - BOOLEAN
- Throws:
Exception
- If an error occurs
-
GetThingNameForIdentifier
@ThingworxExtensionApiMethod(since={6,6}) public String GetThingNameForIdentifier(String identifier) throws Exception - Service Category:
- Service Description:
- Get the thing name associated with an identifier.
- Parameters:
identifier
- Identifier - STRING- Returns:
- result Thing name - THINGNAME
- Throws:
Exception
- If an error occurs
-
SetEntityVisibility
@ThingworxExtensionApiMethod(since={7,1}) public void SetEntityVisibility(String organizationName, TagCollection tags, String projectName, Boolean includeDependents) throws Exception - Service Category:
- Permissions
- Service Description:
- Set visibility on a set of entities.
- Parameters:
organizationName
- Name of the Organization to use for visibility permissions - STRINGtags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEAN- Throws:
Exception
- If an error occurs
-
AddEntityVisibility
@ThingworxExtensionApiMethod(since={7,2}) public void AddEntityVisibility(String organizationName, TagCollection tags, String projectName, Boolean includeDependents) throws Exception - Service Category:
- Permissions
- Service Description:
- Add visibility to a set of entities.
- Parameters:
organizationName
- Name of the Organization to use for visibility permissions - STRINGtags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEAN- Throws:
Exception
- If an error occurs
-
DeleteEntityVisibility
@ThingworxExtensionApiMethod(since={7,1}) public void DeleteEntityVisibility(String organizationName, TagCollection tags, String projectName, Boolean includeDependents) throws Exception - Service Category:
- Permissions
- Service Description:
- Delete visibility on a set of entities.
- Parameters:
organizationName
- Name of the Organization to use for visibility permissions - STRINGtags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEAN- Throws:
Exception
- If an error occurs
-
SetEntityVisibilities
@ThingworxExtensionApiMethod(since={7,2}) public void SetEntityVisibilities(InfoTable organizationReferences, TagCollection tags, String projectName, Boolean includeDependents) throws Exception - Service Category:
- Permissions
- Service Description:
- Set visibility on a set of entities for multiple Organizations/OrganizationalUnits. This replaces all existing visibility for the Entities.
- Parameters:
organizationReferences
- List of Organizations/OrganizationalUnits to use for visibility permissions - INFOTABLEtags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEAN- Throws:
Exception
- If an error occurs
-
AddEntityVisibilities
@ThingworxExtensionApiMethod(since={7,2}) public void AddEntityVisibilities(InfoTable organizationReferences, TagCollection tags, String projectName, Boolean includeDependents) throws Exception - Service Category:
- Permissions
- Service Description:
- Add visibility on a set of entities for multiple Organizations/OrganizationalUnits.
- Parameters:
organizationReferences
- List of Organizations/OrganizationalUnits to use for visibility permissions - INFOTABLEtags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEAN- Throws:
Exception
- If an error occurs
-
DeleteEntityVisibilities
@ThingworxExtensionApiMethod(since={7,2}) public void DeleteEntityVisibilities(InfoTable organizationReferences, TagCollection tags, String projectName, Boolean includeDependents) throws Exception - Service Category:
- Permissions
- Service Description:
- Delete visibility on a set of entities for multiple Organizations/OrganizationalUnits.
- Parameters:
organizationReferences
- List of Organizations/OrganizationalUnits to use for visibility permissions - INFOTABLEtags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEAN- Throws:
Exception
- If an error occurs
-
SetThingVisibility
@ThingworxExtensionApiMethod(since={7,2}) public void SetThingVisibility(InfoTable organizationReferences, String entityName, String entityType, org.json.JSONObject query) throws Exception - Service Category:
- Permissions
- Service Description:
- Set visibility on a set of entities. This replaces all existing visibility for the Things.
- Parameters:
organizationReferences
- List of Organizations/OrganizationalUnits to use for visibility permissions - INFOTABLEentityName
- Thing shape or template name - STRINGentityType
- ThingShape or ThingTemplate - STRINGquery
- Query definition - QUERY- Throws:
Exception
- If an error occurs
-
AddThingVisibility
@ThingworxExtensionApiMethod(since={7,2}) public void AddThingVisibility(InfoTable organizationReferences, String entityName, String entityType, org.json.JSONObject query) throws Exception - Service Category:
- Permissions
- Service Description:
- Add visibility on a set of entities.
- Parameters:
organizationReferences
- List of Organizations/OrganizationalUnits to use for visibility permissions - INFOTABLEentityName
- Thing shape or template name - STRINGentityType
- ThingShape or ThingTemplate - STRINGquery
- Query definition - QUERY- Throws:
Exception
- If an error occurs
-
DeleteThingVisibility
@ThingworxExtensionApiMethod(since={7,2}) public void DeleteThingVisibility(InfoTable organizationReferences, String entityName, String entityType, org.json.JSONObject query) throws Exception - Service Category:
- Permissions
- Service Description:
- Delete visibility on a set of entities.
- Parameters:
organizationReferences
- List of Organizations/OrganizationalUnits to use for visibility permissions - INFOTABLEentityName
- Thing shape or template name - STRINGentityType
- ThingShape or ThingTemplate - STRINGquery
- Query definition - QUERY- Throws:
Exception
- If an error occurs
-
SetEntityPermission
@ThingworxExtensionApiMethod(since={7,1}) public void SetEntityPermission(String name, String type, Boolean allow, TagCollection tags, String projectName, Boolean includeDependents) throws Exception - Service Category:
- Permissions
- Service Description:
- Set run time permissions on a set of entities.
- Parameters:
name
- Name of the User or Group for run time permissions - STRINGtype
- User or Group - STRINGallow
- Is the User or Group allowed run time permission - BOOLEANtags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEAN- Throws:
Exception
- If an error occurs
-
SetResourceEntityPermission
@ThingworxExtensionApiMethod(since={7,2}) public void SetResourceEntityPermission(TagCollection tags, String projectName, Boolean includeDependents, InfoTable permissions) throws Exception - Service Category:
- Permissions
- Service Description:
- Set run time permissions for a resource on a set of entities. This replaces all existing permissions for the entities.
- Parameters:
tags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEANpermissions
- Resource permissions - INFOTABLE- Throws:
Exception
- If an error occurs
Additional Information If multiple parameters are set (for example, tags and projectName), all entities that have these exact parameters defined will be granted run time permission. Entities that only have one parameter defined will not be granted the run time permission. When the service runs, it overrides and deletes existing run time permissions. Only the permission defined by the SetEntityPermission service will be granted.
-
AddResourceEntityPermission
@ThingworxExtensionApiMethod(since={7,2}) public void AddResourceEntityPermission(TagCollection tags, String projectName, Boolean includeDependents, InfoTable permissions) throws Exception - Service Category:
- Permissions
- Service Description:
- Add run time permissions for a resource to a set of entities.
- Parameters:
tags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEANpermissions
- Resource permissions - INFOTABLE- Throws:
Exception
- If an error occurs
-
DeleteEntityPermission
@ThingworxExtensionApiMethod(since={7,1}) public void DeleteEntityPermission(String name, String type, TagCollection tags, String projectName, Boolean includeDependents) throws Exception - Service Category:
- Permissions
- Service Description:
- Delete run time permissions on a set of entities.
- Parameters:
name
- Name of the User or Group for run time permissions - STRINGtype
- User or Group - STRINGtags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEAN- Throws:
Exception
- If an error occurs
-
DeleteResourceEntityPermission
@ThingworxExtensionApiMethod(since={7,2}) public void DeleteResourceEntityPermission(TagCollection tags, String projectName, Boolean includeDependents, InfoTable permissions) throws Exception - Service Category:
- Permissions
- Service Description:
- Delete run time permissions for a resource on a set of entities.
- Parameters:
tags
- Tags - TAGSprojectName
- Project name - PROJECTNAMEincludeDependents
- Include dependent projects - BOOLEANpermissions
- Resource permissions - INFOTABLE- Throws:
Exception
- If an error occurs
-
SetThingPermission
@ThingworxExtensionApiMethod(since={7,2}) public void SetThingPermission(String entityName, String entityType, org.json.JSONObject query, InfoTable permissions) throws Exception - Service Category:
- Permissions
- Service Description:
- Set run time permissions on a set of Things. This replaces all existing permissions for the Things.
- Parameters:
entityName
- Thing shape or template name - STRINGentityType
- ThingShape or ThingTemplate - STRINGquery
- Query definition - QUERYpermissions
- Resource permissions - INFOTABLE- Throws:
Exception
- If an error occurs
-
AddThingPermission
@ThingworxExtensionApiMethod(since={7,2}) public void AddThingPermission(String entityName, String entityType, org.json.JSONObject query, InfoTable permissions) throws Exception - Service Category:
- Permissions
- Service Description:
- Add run time permissions to a set of Things.
- Parameters:
entityName
- Thing shape or template name - STRINGentityType
- ThingShape or ThingTemplate - STRINGquery
- Query definition - QUERYpermissions
- Resource permissions - INFOTABLE- Throws:
Exception
- If an error occurs
-
DeleteThingPermission
@ThingworxExtensionApiMethod(since={7,2}) public void DeleteThingPermission(String entityName, String entityType, org.json.JSONObject query, InfoTable permissions) throws Exception - Service Category:
- Permissions
- Service Description:
- Delete run time permissions on a set of entities.
- Parameters:
entityName
- Thing shape or template name - STRINGentityType
- ThingShape or ThingTemplate - STRINGquery
- Query definition - QUERYpermissions
- Resource permissions - INFOTABLE- Throws:
Exception
- If an error occurs
-
GetLockedUsers
- Service Category:
- Security
- Service Description:
- Return list of locked users.
- Returns:
- result List of locked users - INFOTABLE - Aspects {dataShape:LockedUsers}
- Throws:
Exception
- If an error occurs
-
DeleteModelTagVocabulary
@ThingworxExtensionApiMethod(since={7,2}) public void DeleteModelTagVocabulary(String name) throws Exception - Service Category:
- ModelTags
- Service Description:
- Delete a model tag vocabulary.
- Parameters:
name
- New vocabulary name - STRING- Throws:
Exception
- If an error occurs
-
DeleteDataTagVocabulary
@ThingworxExtensionApiMethod(since={7,2}) public void DeleteDataTagVocabulary(String name) throws Exception - Service Category:
- DataTags
- Service Description:
- Delete a data tag vocabulary.
- Parameters:
name
- New vocabulary name - STRING- Throws:
Exception
- If an error occurs
-
CreateNotificationDefinition
@ThingworxExtensionApiMethod(since={7,4}, deprecatedSince={9,1}) @Deprecated public void CreateNotificationDefinition(String name, String description, TagCollection tags, InfoTable notificationContents) throws Exception Deprecated.in 9.1 to be replaced byCreateNotificationDefinition(String, String, TagCollection, String, InfoTable)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateNotificationDefinition
@ThingworxExtensionApiMethod(since={9,1}) public void CreateNotificationDefinition(String name, String description, TagCollection tags, String projectName, InfoTable notificationContents) throws Exception - Service Category:
- Notifications
- Service Description:
- Create a new notification definition.
- Parameters:
name
- New notification definition name - STRINGdescription
- New notification definition description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEnotificationContents
- List of NotificationContents for the new notification definition - INFOTABLE- Throws:
Exception
- If an error occurs
-
DeleteNotificationDefinition
@ThingworxExtensionApiMethod(since={7,4}) public void DeleteNotificationDefinition(String name) throws Exception - Service Category:
- NotificationDefinitions
- Service Description:
- Delete a notification definition.
- Parameters:
name
- New notification definition name - STRING- Throws:
Exception
- If an error occurs
-
CloneNotificationDefinition
@ThingworxExtensionApiMethod(since={7,4}) public void CloneNotificationDefinition(String sourceNotificationDefinitionName, String name, String description, TagCollection tags) throws Exception - Service Category:
- NotificationDefinitions
- Service Description:
- Clone a notification definition.
- Parameters:
sourceNotificationDefinitionName
- Existing notification definition name - STRINGname
- New notification definition name - STRINGdescription
- New notification definition description - STRINGtags
- Tags - TAGS- Throws:
Exception
- If an error occurs
-
CreateNotificationContent
@ThingworxExtensionApiMethod(since={7,4}, deprecatedSince={9,1}) @Deprecated public void CreateNotificationContent(String name, String description, TagCollection tags, String handlerID, String handlerEntity) throws Exception Deprecated.in 9.1 to be replaced byCreateNotificationContent(String, String, TagCollection, String, String, String)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateNotificationContent
@ThingworxExtensionApiMethod(since={9,1}) public void CreateNotificationContent(String name, String description, TagCollection tags, String projectName, String handlerID, String handlerEntity) throws Exception - Service Category:
- NotificationContents
- Service Description:
- Create a new notification content.
- Parameters:
name
- New notification content name - STRINGdescription
- New notification content description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEhandlerID
- New notification content handler ID - STRINGhandlerEntity
- New notification content handler name - STRING- Throws:
Exception
- If an error occurs
-
DeleteNotificationContent
@ThingworxExtensionApiMethod(since={7,4}) public void DeleteNotificationContent(String name) throws Exception - Service Category:
- NotificationContents
- Service Description:
- Delete a notification content.
- Parameters:
name
- Notification content name - STRING- Throws:
Exception
- If an error occurs
-
CloneNotificationContent
@ThingworxExtensionApiMethod(since={7,4}) public void CloneNotificationContent(String sourceNotificationContentName, String name, String description, TagCollection tags) throws Exception - Service Category:
- NotificationContents
- Service Description:
- Clone a notification content.
- Parameters:
sourceNotificationContentName
- Existing notification content name - STRINGname
- New notification content name - STRINGdescription
- New notification content description - STRINGtags
- Tags - TAGS- Throws:
Exception
- If an error occurs
-
CreateStyleDefinition
@ThingworxExtensionApiMethod(since={7,4}, deprecatedSince={9,1}) @Deprecated public void CreateStyleDefinition(String name, String description, TagCollection tags, org.json.JSONObject content) throws Exception Deprecated.in 9.1 to be replaced byCreateStyleDefinition(String, String, TagCollection, String, JSONObject)
which allows specification of a projectName via a parameter. Calling this method will set the project to the default project.- Throws:
Exception
- If an error occurs
-
CreateStyleDefinition
@ThingworxExtensionApiMethod(since={9,1}) public void CreateStyleDefinition(String name, String description, TagCollection tags, String projectName, org.json.JSONObject content) throws Exception - Service Category:
- StyleDefinitions
- Service Description:
- Create a new style definition.
- Parameters:
name
- New style definition name - STRINGdescription
- New style definition description - STRINGtags
- Tags - TAGSprojectName
- Name of the Project to add this entity to - PROJECTNAMEcontent
- Style definition content in JSON format: { "content": {} } - JSON- Throws:
Exception
- If an error occurs
-
DeleteStyleDefinition
@ThingworxExtensionApiMethod(since={7,4}) public void DeleteStyleDefinition(String name) throws Exception - Service Category:
- StyleDefinitions
- Service Description:
- Delete a style definition.
- Parameters:
name
- Style definition name - STYLEDEFINITIONNAME- Throws:
Exception
- If an error occurs
-
UpdateStyleDefinition
@ThingworxExtensionApiMethod(since={7,4}) public void UpdateStyleDefinition(String name, org.json.JSONObject content) throws Exception - Service Category:
- StyleDefinitions
- Service Description:
- Update a style definition entity.
- Parameters:
name
- Existing style definition name - STYLEDEFINITIONNAMEcontent
- Style definition content in JSON format - JSON- Throws:
Exception
- If an error occurs
-
CloneThingWithOwner
@ThingworxExtensionApiMethod(since={8,5,14}) public void CloneThingWithOwner(String sourceThingName, String name, String description, TagCollection tags, String ownerUserName) throws Exception - Service Category:
- Things
- Service Description:
- Clone thing and set owner if provided.
- Parameters:
sourceThingName
- Existing thing name - THINGNAMEname
- New thing name - STRINGdescription
- New thing description - STRINGtags
- Tags - TAGSownerUserName
- the user name to set as owner of newly thing - USERNAME- Throws:
Exception
- If an error occurs
-
GetAspects
@ThingworxExtensionApiMethod(since={9,4}) public InfoTable GetAspects(String aspectName, InfoTable entityRefs) throws Exception - Service Category:
- Aspects
- Service Description:
- Returns list of entities and members with aspects filtered on the aspectName.
- Parameters:
aspectName
- Aspect name - STRINGentityRefs
- Entity list - INFOTABLE- Returns:
- result Result - INFOTABLE - Aspects {dataShape:EntityListWithAspects}
- Throws:
Exception
- If an error occurs
-
SetAccessModifier
@ThingworxExtensionApiMethod(since={9,4}) public void SetAccessModifier(InfoTable accessModifierList) throws Exception - Service Category:
- Aspects
- Service Description:
- Sets accessModifier on entity and its members which support access modifier.
Sets accessModifier on entity and its members which support access modifier- Parameters:
accessModifierList
- - InfoTable of entity and its members- Throws:
Exception
-
SetDeprecated
@ThingworxExtensionApiMethod(since={9,4}) public void SetDeprecated(InfoTable deprecatedList) throws Exception - Service Category:
- Aspects
- Service Description:
- Sets the deprecation on entity and members, which supports the deprecation.
Set deprecated on entity and its members which support deprecated- Parameters:
deprecatedList
- - InfoTable of entity and its members- Throws:
Exception
-
CreateApplicationKey(String, String, String, TagCollection, String, String, String, DateTime)
which allows specification of a projectName via a parameter.