Package com.thingworx.resources.entities

Class EntityServices

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.entities.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 Details

  • Constructor Details

    • EntityServices

      public EntityServices()
      Initializes this instace with default values.

  • 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 by CreateApplicationKey(String, String, String, TagCollection, String, String, String, DateTime) which allows specification of a projectName via a parameter.
      Throws:
      Exception

    • 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 - STRING
      description - Application key description - STRING
      user - Associated user name - USERNAME
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      whitelist - IP whitelist - STRING
      clientName - clientName - STRING
      expirationDate - Expiration date - DATETIME
      Throws:
      Exception - if an error occurs

    • DeleteUser

      @ThingworxExtensionApiMethod(since={6,6}) public void DeleteUser(String name) throws Exception
      Service Category:
      Users
      Service Description:
      Delete a user.
      Parameters:
      name - User name - USERNAME
      Throws:
      Exception - if an error occurs

    • DeleteNetwork

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

      @ThingworxExtensionApiMethod(since={6,6}) public void DeleteGroup(String name) throws Exception
      Service Category:
      Groups
      Service Description:
      Delete a group.
      Parameters:
      name - Group name - GROUPNAME
      Throws:
      Exception - if an error occurs

    • DeleteThing

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

      @ThingworxExtensionApiMethod(since={7,1}) public void DeleteProject(String name) throws Exception
      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 by CreateUser(String, String, TagCollection, String, String) which allows specification of a projectName via a parameter.
      Throws:
      Exception

    • 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 - STRING
      description - New user description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      password - 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 - USERNAME
      name - New user name - STRING
      description - New user description - STRING
      tags - Tags - TAGS
      password - 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 - USERNAME
      name - New user name - STRING
      description - New user description - STRING
      tags - Tags - TAGS
      password - 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 by CreateGroup(String, String, TagCollection, String) which allows specification of a projectName via a parameter.
      Throws:
      Exception

    • 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 - STRING
      description - New group description - STRING
      tags - Tags - TAGS
      projectName - 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 by CreateDataShape(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

    • 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 - STRING
      description - New data shape description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      fields - 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 by CreateDataTagVocabulary(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

    • 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 - STRING
      description - New vocabulary description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      dynamic - 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 by CreateModelTagVocabulary(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

    • 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 - STRING
      description - New vocabulary description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      dynamic - 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 by CreateNetwork(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

    • 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 - STRING
      description - New network description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      connections - 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 by CreateOrganization(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

    • 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 - STRING
      description - New organization description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      topOUName - Top level organizational unit in the Organization - STRING
      topOUDescription - 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 by CreateLocalizationTable(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

    • 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 - STRING
      description - New localization table description - STRING
      tags - Tags - TAGS
      projectName - 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 - STRING
      nativeName - Localization table native name or native language - STRING
      commonName - Localization table common name or common language - STRING
      description - Localization table description - STRING
      tags - 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 by CreateMediaEntity(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

    • 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 - STRING
      description - New media description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      content - 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 - STRING
      content - 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 by CreateThing(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

    • 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 - STRING
      description - New thing description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      thingTemplateName - 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 by CreateThingWithOwner(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

    • 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 - STRING
      description - New thing description - STRING
      tags - Tags - TAGS
      projectName - Project name - PROJECTNAME
      thingTemplateName - Thing template name - THINGTEMPLATENAME
      ownerUserName - 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 by CreateThingTemplate(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 - STRING
      description - New thing template description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      thingTemplateName - 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 - STRING
      description - New thing template description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      thingTemplateName - Base thing template name - THINGTEMPLATENAME
      ownerUserName - 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 by CreateThingShape(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

    • 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 - STRING
      description - New thing shape description - STRING
      tags - Tags - TAGS
      projectName - 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 - STRING
      description - New thingShape description - STRING
      tags - Tags - TAGS
      projectName - Project name - PROJECTNAME
      ownerUserName - 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 project
      description - - Description of the project
      dependsOn - - Extensions that this project depends on
      tags - - 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 project
      projectType - - Type of the project.Ex - Component, Solution
      description - - Description of the project
      dependsOn - - Extensions that this project depends on
      tags - - 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 - THINGNAME
      name - New thing name - STRING
      description - New thing description - STRING
      tags - 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 - THINGTEMPLATENAME
      name - New thing name - STRING
      description - New thing description - STRING
      tags - 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 - THINGTEMPLATENAME
      name - New thing name - STRING
      description - New thing description - STRING
      tags - Tags - TAGS
      ownerUserName - 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 - THINGSHAPENAME
      name - New thing name - STRING
      description - New thing description - STRING
      tags - 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 - THINGSHAPENAME
      name - New thing name - STRING
      description - New thing description - STRING
      tags - Tags - TAGS
      ownerUserName - 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 - THINGNAME
      thingShapeName - 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 - THINGTEMPLATENAME
      thingShapeName - 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 - THINGNAME
      thingShapeName - 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 - THINGTEMPLATENAME
      thingShapeName - 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) - STRING
      name - Entity Name - STRING
      key - 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) - STRING
      name - 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) - STRING
      nameMask - Entity name pattern to match - STRING
      tags - Tags - TAGS
      maxItems - 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) - STRING
      nameMask - Entity name pattern to match - STRING
      tags - Tags - TAGS
      maxItems - 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) - STRING
      nameMask - Entity name pattern to match - STRING
      permissionType - Permission Type (ServiceInvoke, PropertyRead, PropertyWrite, etc.) - STRING
      permissionTarget - Permission target - STRING
      tags - Tags - TAGS
      maxItems - 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) - STRING
      nameMask - Entity name pattern to match - STRING
      permissionType - Permission Type (ServiceInvoke, PropertyRead, PropertyWrite, etc.) - STRING
      permissionTarget - Permission target - STRING
      tags - Tags - TAGS
      maxItems - 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 - STRING
      tags - Tags - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - 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 - STRING
      tags - Tags - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - 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 - STRING
      tags - Tags - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - 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 - INFOTABLE
      tags - Tags - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - 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 - INFOTABLE
      tags - Tags - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - 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 - INFOTABLE
      tags - Tags - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - 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 - INFOTABLE
      entityName - Thing shape or template name - STRING
      entityType - ThingShape or ThingTemplate - STRING
      query - 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 - INFOTABLE
      entityName - Thing shape or template name - STRING
      entityType - ThingShape or ThingTemplate - STRING
      query - 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 - INFOTABLE
      entityName - Thing shape or template name - STRING
      entityType - ThingShape or ThingTemplate - STRING
      query - 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 - STRING
      type - User or Group - STRING
      allow - Is the User or Group allowed run time permission - BOOLEAN
      tags - Tags - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - 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 - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - Include dependent projects - BOOLEAN
      permissions - 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 - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - Include dependent projects - BOOLEAN
      permissions - 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 - STRING
      type - User or Group - STRING
      tags - Tags - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - 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 - TAGS
      projectName - Project name - PROJECTNAME
      includeDependents - Include dependent projects - BOOLEAN
      permissions - 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 - STRING
      entityType - ThingShape or ThingTemplate - STRING
      query - Query definition - QUERY
      permissions - 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 - STRING
      entityType - ThingShape or ThingTemplate - STRING
      query - Query definition - QUERY
      permissions - 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 - STRING
      entityType - ThingShape or ThingTemplate - STRING
      query - Query definition - QUERY
      permissions - Resource permissions - INFOTABLE
      Throws:
      Exception - if an error occurs

    • GetLockedUsers

      @ThingworxExtensionApiMethod(since={7,2}) public InfoTable GetLockedUsers() throws Exception
      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 by CreateNotificationDefinition(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

    • 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 - STRING
      description - New notification definition description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      notificationContents - 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 - STRING
      name - New notification definition name - STRING
      description - New notification definition description - STRING
      tags - 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 by CreateNotificationContent(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

    • 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 - STRING
      description - New notification content description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      handlerID - New notification content handler ID - STRING
      handlerEntity - 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 - STRING
      name - New notification content name - STRING
      description - New notification content description - STRING
      tags - 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 by CreateStyleDefinition(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

    • 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 - STRING
      description - New style definition description - STRING
      tags - Tags - TAGS
      projectName - Name of the Project to add this entity to - PROJECTNAME
      content - 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 - STYLEDEFINITIONNAME
      content - 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 - THINGNAME
      name - New thing name - STRING
      description - New thing description - STRING
      tags - Tags - TAGS
      ownerUserName - 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 - STRING
      entityRefs - 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