Package com.thingworx.resources.entities

Class EntityServices

    • Constructor Detail

      • EntityServices

        public EntityServices()

    • Method Detail

      • DeleteApplicationKey

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteApplicationKey​(java.lang.String name)
                          throws java.lang.Exception
        Service Category:
        ApplicationKeys
        Service Description:
        Delete an application key.
        Parameters:
        name - ApplicationKey name - APPLICATIONKEYNAME
        Throws:
        java.lang.Exception - If an error occurs

      • CreateApplicationKey

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateApplicationKey​(java.lang.String name,
                                 java.lang.String description,
                                 java.lang.String user,
                                 TagCollection tags,
                                 java.lang.String projectName,
                                 java.lang.String whitelist,
                                 java.lang.String clientName,
                                 org.joda.time.DateTime expirationDate)
                          throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteUser

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

      • DeleteNetwork

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteNetwork​(java.lang.String name)
                   throws java.lang.Exception
        Service Category:
        Networks
        Service Description:
        Delete a network.
        Parameters:
        name - Network name - NETWORKNAME
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteMediaEntity

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteMediaEntity​(java.lang.String name)
                       throws java.lang.Exception
        Service Category:
        Media
        Service Description:
        Delete a media entity.
        Parameters:
        name - Media entity name - MEDIAENTITYNAME
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteOrganization

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteOrganization​(java.lang.String name)
                        throws java.lang.Exception
        Service Category:
        Organizations
        Service Description:
        Delete an organization.
        Parameters:
        name - Organization name - ORGANIZATIONNAME
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteGroup

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

      • DeleteThing

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteThing​(java.lang.String name)
                 throws java.lang.Exception
        Service Category:
        Things
        Service Description:
        Delete a thing.
        Parameters:
        name - Thing name - THINGNAME
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteThingTemplate

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteThingTemplate​(java.lang.String name)
                         throws java.lang.Exception
        Service Category:
        ThingTemplates
        Service Description:
        Delete a thing template.
        Parameters:
        name - Thing template name - THINGTEMPLATENAME
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteThingShape

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteThingShape​(java.lang.String name)
                      throws java.lang.Exception
        Service Category:
        ThingShapes
        Service Description:
        Delete a thing shape.
        Parameters:
        name - Thing shape name - THINGSHAPENAME
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteProject

        @ThingworxExtensionApiMethod(since={7,1})
public void DeleteProject​(java.lang.String name)
                   throws java.lang.Exception
        Service Category:
        Projects
        Service Description:
        Delete a Project.
        Parameters:
        name - Project name - PROJECTNAME
        Throws:
        java.lang.Exception - If an error occurs

      • CreateUser

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateUser​(java.lang.String name,
                       java.lang.String description,
                       TagCollection tags,
                       java.lang.String projectName,
                       java.lang.String password)
                throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CloneUser

        @ThingworxExtensionApiMethod(since={6,6})
public void CloneUser​(java.lang.String sourceUserName,
                      java.lang.String name,
                      java.lang.String description,
                      TagCollection tags,
                      java.lang.String password)
               throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CloneUserWithGroups

        @ThingworxExtensionApiMethod(since={6,6})
public void CloneUserWithGroups​(java.lang.String sourceUserName,
                                java.lang.String name,
                                java.lang.String description,
                                TagCollection tags,
                                java.lang.String password)
                         throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateUserWithOptions

        @ThingworxExtensionApiMethod(since={7,4})
public void CreateUserWithOptions​(InfoTable userOptions)
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • UpdateUserWithOptions

        @ThingworxExtensionApiMethod(since={7,4})
public void UpdateUserWithOptions​(InfoTable userOptions)
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteUserWithOptions

        @ThingworxExtensionApiMethod(since={7,4})
public void DeleteUserWithOptions​(InfoTable userOptions)
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateGroup

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateGroup​(java.lang.String name,
                        java.lang.String description,
                        TagCollection tags,
                        java.lang.String projectName)
                 throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateDataShape

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateDataShape​(java.lang.String name,
                            java.lang.String description,
                            TagCollection tags,
                            java.lang.String projectName,
                            InfoTable fields)
                     throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateDataTagVocabulary

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateDataTagVocabulary​(java.lang.String name,
                                    java.lang.String description,
                                    TagCollection tags,
                                    java.lang.String projectName,
                                    java.lang.Boolean dynamic)
                             throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateModelTagVocabulary

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateModelTagVocabulary​(java.lang.String name,
                                     java.lang.String description,
                                     TagCollection tags,
                                     java.lang.String projectName,
                                     java.lang.Boolean dynamic)
                              throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateNetwork

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateNetwork​(java.lang.String name,
                          java.lang.String description,
                          TagCollection tags,
                          java.lang.String projectName,
                          InfoTable connections)
                   throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateOrganization

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateOrganization​(java.lang.String name,
                               java.lang.String description,
                               TagCollection tags,
                               java.lang.String projectName,
                               java.lang.String topOUName,
                               java.lang.String topOUDescription)
                        throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateLocalizationTable

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateLocalizationTable​(java.lang.String name,
                                    java.lang.String description,
                                    TagCollection tags,
                                    java.lang.String projectName)
                             throws java.lang.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:
        java.lang.Exception - If an error occurs

      • SetLocalizationTableNames

        @ThingworxExtensionApiMethod(since={7,4})
public void SetLocalizationTableNames​(java.lang.String locale,
                                      java.lang.String nativeName,
                                      java.lang.String commonName,
                                      java.lang.String description,
                                      TagCollection tags)
                               throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateMediaEntity

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateMediaEntity​(java.lang.String name,
                              java.lang.String description,
                              TagCollection tags,
                              java.lang.String projectName,
                              byte[] content)
                       throws java.lang.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:
        java.lang.Exception - If an error occurs

      • UpdateMediaEntity

        @ThingworxExtensionApiMethod(since={6,6})
public void UpdateMediaEntity​(java.lang.String name,
                              byte[] content)
                       throws java.lang.Exception
        Service Category:
        Media
        Service Description:
        Update a media entity.
        Parameters:
        name - Existing media name - STRING
        content - Media content - IMAGE
        Throws:
        java.lang.Exception - If an error occurs

      • CreateThing

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateThing​(java.lang.String name,
                        java.lang.String description,
                        TagCollection tags,
                        java.lang.String projectName,
                        java.lang.String thingTemplateName)
                 throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateThingWithOwner

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateThingWithOwner​(java.lang.String name,
                                 java.lang.String description,
                                 TagCollection tags,
                                 java.lang.String projectName,
                                 java.lang.String thingTemplateName,
                                 java.lang.String ownerUserName)
                          throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateThingTemplate

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateThingTemplate​(java.lang.String name,
                                java.lang.String description,
                                TagCollection tags,
                                java.lang.String projectName,
                                java.lang.String thingTemplateName)
                         throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateThingTemplateWithOwner

        @ThingworxExtensionApiMethod(since={8,5,14})
public void CreateThingTemplateWithOwner​(java.lang.String name,
                                         java.lang.String description,
                                         TagCollection tags,
                                         java.lang.String projectName,
                                         java.lang.String thingTemplateName,
                                         java.lang.String ownerUserName)
                                  throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateThingShape

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateThingShape​(java.lang.String name,
                             java.lang.String description,
                             TagCollection tags,
                             java.lang.String projectName)
                      throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateThingShapeWithOwner

        @ThingworxExtensionApiMethod(since={8,5,14})
public void CreateThingShapeWithOwner​(java.lang.String name,
                                      java.lang.String description,
                                      TagCollection tags,
                                      java.lang.String projectName,
                                      java.lang.String ownerUserName)
                               throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateProject

        @ThingworxExtensionApiMethod(since={7,1},
                             deprecatedSince={9,1})
@Deprecated
public void CreateProject​(java.lang.String name,
                          java.lang.String description,
                          java.lang.String dependsOn,
                          TagCollection tags)
                   throws java.lang.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:
        java.lang.Exception

      • CreateProject

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateProject​(java.lang.String name,
                          java.lang.String projectType,
                          java.lang.String description,
                          java.lang.String dependsOn,
                          TagCollection tags)
                   throws java.lang.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:
        java.lang.Exception

      • CloneThing

        @ThingworxExtensionApiMethod(since={6,6})
public void CloneThing​(java.lang.String sourceThingName,
                       java.lang.String name,
                       java.lang.String description,
                       TagCollection tags)
                throws java.lang.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:
        java.lang.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​(java.lang.String sourceThingTemplateName,
                               java.lang.String name,
                               java.lang.String description,
                               TagCollection tags)
                        throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CloneThingTemplateWithOwner

        @ThingworxExtensionApiMethod(since={8,5,14})
public void CloneThingTemplateWithOwner​(java.lang.String sourceThingTemplateName,
                                        java.lang.String name,
                                        java.lang.String description,
                                        TagCollection tags,
                                        java.lang.String ownerUserName)
                                 throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CloneThingShape

        @ThingworxExtensionApiMethod(since={6,6})
public void CloneThingShape​(java.lang.String sourceThingShapeName,
                            java.lang.String name,
                            java.lang.String description,
                            TagCollection tags)
                     throws java.lang.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:
        java.lang.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​(java.lang.String sourceThingShapeName,
                                     java.lang.String name,
                                     java.lang.String description,
                                     TagCollection tags,
                                     java.lang.String ownerUserName)
                              throws java.lang.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:
        java.lang.Exception - If an error occurs

      • AddShapeToThing

        @ThingworxExtensionApiMethod(since={6,6})
public void AddShapeToThing​(java.lang.String name,
                            java.lang.String thingShapeName)
                     throws java.lang.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:
        java.lang.Exception - If an error occurs

      • AddShapeToThingTemplate

        @ThingworxExtensionApiMethod(since={6,6})
public void AddShapeToThingTemplate​(java.lang.String name,
                                    java.lang.String thingShapeName)
                             throws java.lang.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:
        java.lang.Exception - If an error occurs

      • RemoveShapeFromThing

        @ThingworxExtensionApiMethod(since={6,6})
public void RemoveShapeFromThing​(java.lang.String name,
                                 java.lang.String thingShapeName)
                          throws java.lang.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:
        java.lang.Exception - If an error occurs

      • RemoveShapeFromThingTemplate

        @ThingworxExtensionApiMethod(since={6,6})
public void RemoveShapeFromThingTemplate​(java.lang.String name,
                                         java.lang.String thingShapeName)
                                  throws java.lang.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:
        java.lang.Exception - If an error occurs

      • RestartDependenciesForThingTemplate

        @ThingworxExtensionApiMethod(since={6,6})
public void RestartDependenciesForThingTemplate​(java.lang.String name)
                                         throws java.lang.Exception
        Service Category:
        ThingTemplates
        Service Description:
        Restart dependencies for an existing thing template.
        Parameters:
        name - Thing template name - THINGTEMPLATENAME
        Throws:
        java.lang.Exception - If an error occurs

      • RestartDependenciesForThingShape

        @ThingworxExtensionApiMethod(since={6,6})
public void RestartDependenciesForThingShape​(java.lang.String name)
                                      throws java.lang.Exception
        Service Category:
        ThingShapes
        Service Description:
        Restart dependencies for an existing thing template.
        Parameters:
        name - Thing shape name - THINGSHAPENAME
        Throws:
        java.lang.Exception - If an error occurs

      • ReadEntityAsJSON

        @ThingworxExtensionApiMethod(since={6,6})
public org.json.JSONObject ReadEntityAsJSON​(java.lang.String type,
                                            java.lang.String name,
                                            java.lang.String key)
                                     throws java.lang.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:
        java.lang.Exception - If an error occurs

      • ReadEntityDefinitionAsJSON

        @ThingworxExtensionApiMethod(since={6,6})
public org.json.JSONObject ReadEntityDefinitionAsJSON​(java.lang.String type,
                                                      java.lang.String name)
                                               throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetEntityList

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetEntityList​(java.lang.String type,
                               java.lang.String nameMask,
                               TagCollection tags,
                               java.lang.Double maxItems)
                        throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetEntityListByRegEx

        @ThingworxExtensionApiMethod(since={9,0})
public InfoTable GetEntityListByRegEx​(java.lang.String type,
                                      java.lang.String nameMask,
                                      TagCollection tags,
                                      java.lang.Double maxItems)
                               throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetEntityListWithPermissionMask

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetEntityListWithPermissionMask​(java.lang.String type,
                                                 java.lang.String nameMask,
                                                 java.lang.String permissionType,
                                                 java.lang.String permissionTarget,
                                                 TagCollection tags,
                                                 java.lang.Double maxItems)
                                          throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetEntityListWithPermissionMaskByRegEx

        @ThingworxExtensionApiMethod(since={9,0})
public InfoTable GetEntityListWithPermissionMaskByRegEx​(java.lang.String type,
                                                        java.lang.String nameMask,
                                                        java.lang.String permissionType,
                                                        java.lang.String permissionTarget,
                                                        TagCollection tags,
                                                        java.lang.Double maxItems)
                                                 throws java.lang.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:
        java.lang.Exception - If an error occurs

      • IsRemoteThingBound

        @ThingworxExtensionApiMethod(since={6,6})
public java.lang.Boolean IsRemoteThingBound​(java.lang.String name)
                                     throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetThingNameForIdentifier

        @ThingworxExtensionApiMethod(since={6,6})
public java.lang.String GetThingNameForIdentifier​(java.lang.String identifier)
                                           throws java.lang.Exception
        Service Category:
        Service Description:
        Get the thing name associated with an identifier.
        Parameters:
        identifier - Identifier - STRING
        Returns:
        result Thing name - THINGNAME
        Throws:
        java.lang.Exception - If an error occurs

      • SetEntityVisibility

        @ThingworxExtensionApiMethod(since={7,1})
public void SetEntityVisibility​(java.lang.String organizationName,
                                TagCollection tags,
                                java.lang.String projectName,
                                java.lang.Boolean includeDependents)
                         throws java.lang.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:
        java.lang.Exception - If an error occurs

      • AddEntityVisibility

        @ThingworxExtensionApiMethod(since={7,2})
public void AddEntityVisibility​(java.lang.String organizationName,
                                TagCollection tags,
                                java.lang.String projectName,
                                java.lang.Boolean includeDependents)
                         throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteEntityVisibility

        @ThingworxExtensionApiMethod(since={7,1})
public void DeleteEntityVisibility​(java.lang.String organizationName,
                                   TagCollection tags,
                                   java.lang.String projectName,
                                   java.lang.Boolean includeDependents)
                            throws java.lang.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:
        java.lang.Exception - If an error occurs

      • SetEntityVisibilities

        @ThingworxExtensionApiMethod(since={7,2})
public void SetEntityVisibilities​(InfoTable organizationReferences,
                                  TagCollection tags,
                                  java.lang.String projectName,
                                  java.lang.Boolean includeDependents)
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • AddEntityVisibilities

        @ThingworxExtensionApiMethod(since={7,2})
public void AddEntityVisibilities​(InfoTable organizationReferences,
                                  TagCollection tags,
                                  java.lang.String projectName,
                                  java.lang.Boolean includeDependents)
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteEntityVisibilities

        @ThingworxExtensionApiMethod(since={7,2})
public void DeleteEntityVisibilities​(InfoTable organizationReferences,
                                     TagCollection tags,
                                     java.lang.String projectName,
                                     java.lang.Boolean includeDependents)
                              throws java.lang.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:
        java.lang.Exception - If an error occurs

      • SetThingVisibility

        @ThingworxExtensionApiMethod(since={7,2})
public void SetThingVisibility​(InfoTable organizationReferences,
                               java.lang.String entityName,
                               java.lang.String entityType,
                               org.json.JSONObject query)
                        throws java.lang.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:
        java.lang.Exception - If an error occurs

      • AddThingVisibility

        @ThingworxExtensionApiMethod(since={7,2})
public void AddThingVisibility​(InfoTable organizationReferences,
                               java.lang.String entityName,
                               java.lang.String entityType,
                               org.json.JSONObject query)
                        throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteThingVisibility

        @ThingworxExtensionApiMethod(since={7,2})
public void DeleteThingVisibility​(InfoTable organizationReferences,
                                  java.lang.String entityName,
                                  java.lang.String entityType,
                                  org.json.JSONObject query)
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • SetEntityPermission

        @ThingworxExtensionApiMethod(since={7,1})
public void SetEntityPermission​(java.lang.String name,
                                java.lang.String type,
                                java.lang.Boolean allow,
                                TagCollection tags,
                                java.lang.String projectName,
                                java.lang.Boolean includeDependents)
                         throws java.lang.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:
        java.lang.Exception - If an error occurs

      • SetResourceEntityPermission

        @ThingworxExtensionApiMethod(since={7,2})
public void SetResourceEntityPermission​(TagCollection tags,
                                        java.lang.String projectName,
                                        java.lang.Boolean includeDependents,
                                        InfoTable permissions)
                                 throws java.lang.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:
        java.lang.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,
                                        java.lang.String projectName,
                                        java.lang.Boolean includeDependents,
                                        InfoTable permissions)
                                 throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteEntityPermission

        @ThingworxExtensionApiMethod(since={7,1})
public void DeleteEntityPermission​(java.lang.String name,
                                   java.lang.String type,
                                   TagCollection tags,
                                   java.lang.String projectName,
                                   java.lang.Boolean includeDependents)
                            throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteResourceEntityPermission

        @ThingworxExtensionApiMethod(since={7,2})
public void DeleteResourceEntityPermission​(TagCollection tags,
                                           java.lang.String projectName,
                                           java.lang.Boolean includeDependents,
                                           InfoTable permissions)
                                    throws java.lang.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:
        java.lang.Exception - If an error occurs

      • SetThingPermission

        @ThingworxExtensionApiMethod(since={7,2})
public void SetThingPermission​(java.lang.String entityName,
                               java.lang.String entityType,
                               org.json.JSONObject query,
                               InfoTable permissions)
                        throws java.lang.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:
        java.lang.Exception - If an error occurs

      • AddThingPermission

        @ThingworxExtensionApiMethod(since={7,2})
public void AddThingPermission​(java.lang.String entityName,
                               java.lang.String entityType,
                               org.json.JSONObject query,
                               InfoTable permissions)
                        throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteThingPermission

        @ThingworxExtensionApiMethod(since={7,2})
public void DeleteThingPermission​(java.lang.String entityName,
                                  java.lang.String entityType,
                                  org.json.JSONObject query,
                                  InfoTable permissions)
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetLockedUsers

        @ThingworxExtensionApiMethod(since={7,2})
public InfoTable GetLockedUsers()
                         throws java.lang.Exception
        Service Category:
        Security
        Service Description:
        Return list of locked users.
        Returns:
        result List of locked users - INFOTABLE - Aspects {dataShape:LockedUsers}
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteModelTagVocabulary

        @ThingworxExtensionApiMethod(since={7,2})
public void DeleteModelTagVocabulary​(java.lang.String name)
                              throws java.lang.Exception
        Service Category:
        ModelTags
        Service Description:
        Delete a model tag vocabulary.
        Parameters:
        name - New vocabulary name - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteDataTagVocabulary

        @ThingworxExtensionApiMethod(since={7,2})
public void DeleteDataTagVocabulary​(java.lang.String name)
                             throws java.lang.Exception
        Service Category:
        DataTags
        Service Description:
        Delete a data tag vocabulary.
        Parameters:
        name - New vocabulary name - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • CreateNotificationDefinition

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateNotificationDefinition​(java.lang.String name,
                                         java.lang.String description,
                                         TagCollection tags,
                                         java.lang.String projectName,
                                         InfoTable notificationContents)
                                  throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteNotificationDefinition

        @ThingworxExtensionApiMethod(since={7,4})
public void DeleteNotificationDefinition​(java.lang.String name)
                                  throws java.lang.Exception
        Service Category:
        NotificationDefinitions
        Service Description:
        Delete a notification definition.
        Parameters:
        name - New notification definition name - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • CloneNotificationDefinition

        @ThingworxExtensionApiMethod(since={7,4})
public void CloneNotificationDefinition​(java.lang.String sourceNotificationDefinitionName,
                                        java.lang.String name,
                                        java.lang.String description,
                                        TagCollection tags)
                                 throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateNotificationContent

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateNotificationContent​(java.lang.String name,
                                      java.lang.String description,
                                      TagCollection tags,
                                      java.lang.String projectName,
                                      java.lang.String handlerID,
                                      java.lang.String handlerEntity)
                               throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteNotificationContent

        @ThingworxExtensionApiMethod(since={7,4})
public void DeleteNotificationContent​(java.lang.String name)
                               throws java.lang.Exception
        Service Category:
        NotificationContents
        Service Description:
        Delete a notification content.
        Parameters:
        name - Notification content name - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • CloneNotificationContent

        @ThingworxExtensionApiMethod(since={7,4})
public void CloneNotificationContent​(java.lang.String sourceNotificationContentName,
                                     java.lang.String name,
                                     java.lang.String description,
                                     TagCollection tags)
                              throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CreateStyleDefinition

        @ThingworxExtensionApiMethod(since={9,1})
public void CreateStyleDefinition​(java.lang.String name,
                                  java.lang.String description,
                                  TagCollection tags,
                                  java.lang.String projectName,
                                  org.json.JSONObject content)
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • DeleteStyleDefinition

        @ThingworxExtensionApiMethod(since={7,4})
public void DeleteStyleDefinition​(java.lang.String name)
                           throws java.lang.Exception
        Service Category:
        StyleDefinitions
        Service Description:
        Delete a style definition.
        Parameters:
        name - Style definition name - STYLEDEFINITIONNAME
        Throws:
        java.lang.Exception - If an error occurs

      • UpdateStyleDefinition

        @ThingworxExtensionApiMethod(since={7,4})
public void UpdateStyleDefinition​(java.lang.String name,
                                  org.json.JSONObject content)
                           throws java.lang.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:
        java.lang.Exception - If an error occurs

      • CloneThingWithOwner

        @ThingworxExtensionApiMethod(since={8,5,14})
public void CloneThingWithOwner​(java.lang.String sourceThingName,
                                java.lang.String name,
                                java.lang.String description,
                                TagCollection tags,
                                java.lang.String ownerUserName)
                         throws java.lang.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:
        java.lang.Exception - If an error occurs

      • GetAspects

        @ThingworxExtensionApiMethod(since={9,4})
public InfoTable GetAspects​(java.lang.String aspectName,
                            InfoTable entityRefs)
                     throws java.lang.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:
        java.lang.Exception - If an error occurs

      • SetAccessModifier

        @ThingworxExtensionApiMethod(since={9,4})
public void SetAccessModifier​(InfoTable accessModifierList)
                       throws java.lang.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:
        java.lang.Exception

      • SetDeprecated

        @ThingworxExtensionApiMethod(since={9,4})
public void SetDeprecated​(InfoTable deprecatedList)
                   throws java.lang.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:
        java.lang.Exception