Package com.thingworx.vocabularies

Class Vocabulary

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.vocabularies.Vocabulary

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})
public class Vocabulary
extends ServiceProviderEntity

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_FIELD

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
Vocabulary()

Method Summary

Modifier and Type	Method	Description
void	AddVocabularyTerm(String term)	Service Category: Terms Service Description: Add a new vocabulary term.
void	DeleteVocabularyTerm(String term)	Service Category: Terms Service Description: Delete a specific vocabulary term.
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()
InfoTable	GetVocabularyLinks(Double maxItems)	Service Category: Queries Service Description: Return a list of entities linked to this vocabulary.
InfoTable	GetVocabularyTerm(String name)	Service Category: Terms Service Description: Return a specific vocabulary term.
InfoTable	GetVocabularyTermLinks(String term, Double maxItems)	Service Category: Queries Service Description: Return a list of entities linked to this vocabulary term.
InfoTable	GetVocabularyTerms()	Service Category: Queries Service Description: Return a list of vocabulary terms.
InfoTable	GetVocabularyTermUsage(Double maxItems)	Service Category: Queries Service Description: Return a list of vocabulary terms and their usage/frequency.
RelationshipTypes.ThingworxRelationshipTypes	getVocabularyType()
Boolean	IsDynamic()	Service Category: Metadata Service Description: Whether the vocabulary is dynamic or not.
InfoTable	QueryVocabularyTermLinks(String term, org.json.JSONObject types, String filter, Double maxItems)	Service Category: Queries Service Description: Return a list of entities linked to this vocabulary term.
InfoTable	QueryVocabularyTerms(String filter, Double maxItems)	Service Category: Queries Service Description: Return a list of vocabulary terms.
InfoTable	QueryVocabularyTermUsage(String filter, Double maxItems)	Service Category: Queries Service Description: Return a list of vocabulary terms and their usage/frequency.
void	setVocabularyType(RelationshipTypes.ThingworxRelationshipTypes value)

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

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

Methods inherited from class com.thingworx.entities.RootEntity

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

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

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

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

getID, hasID

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

getID, getName

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Field Details

KEY_FIELD

public static final String KEY_FIELD

See Also:

• Constant Field Values

Constructor Details

Vocabulary

@ThingworxExtensionApiMethod(since={6,6})
public Vocabulary()
           throws DataAccessException

Throws:

DataAccessException - If an error occurs

Method Details

getVocabularyType

@ThingworxExtensionApiMethod(since={6,6})
public RelationshipTypes.ThingworxRelationshipTypes getVocabularyType()

setVocabularyType

@ThingworxExtensionApiMethod(since={6,6})
public void setVocabularyType(RelationshipTypes.ThingworxRelationshipTypes value)

AddVocabularyTerm

@ThingworxExtensionApiMethod(since={6,6})
public void AddVocabularyTerm(String term)
                       throws Exception

Service Category:

Terms

Service Description:

Add a new vocabulary term.

Parameters:

term - Vocabulary Term - STRING

Throws:

Exception - If an error occurs

DeleteVocabularyTerm

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteVocabularyTerm(String term)
                          throws Exception

Service Category:

Terms

Service Description:

Delete a specific vocabulary term.

Parameters:

term - Vocabulary Term - STRING

Throws:

Exception - If an error occurs

GetVocabularyTerms

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetVocabularyTerms()
                             throws Exception

Service Category:

Queries

Service Description:

Return a list of vocabulary terms.

Returns:

result Vocabulary Terms - INFOTABLE - Aspects {dataShape:VocabularyTerm}

Throws:

Exception - If an error occurs

GetVocabularyTerm

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetVocabularyTerm(String name)
                            throws Exception

Service Category:

Terms

Service Description:

Return a specific vocabulary term.

Parameters:

name - Vocabulary term - STRING

Returns:

result Vocabulary Terms - INFOTABLE - Aspects {dataShape:VocabularyTerm}

Throws:

Exception - If an error occurs

GetVocabularyTermUsage

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetVocabularyTermUsage(Double maxItems)
                                 throws Exception

Service Category:

Queries

Service Description:

Return a list of vocabulary terms and their usage/frequency.

Parameters:

maxItems - Maximum number of items to return - NUMBER

Returns:

result Vocabulary Term Usage - INFOTABLE - Aspects {dataShape:VocabularyTermUsage}

Throws:

Exception - If an error occurs

GetVocabularyTermLinks

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetVocabularyTermLinks(String term,
 Double maxItems)
                                 throws Exception

Service Category:

Queries

Service Description:

Return a list of entities linked to this vocabulary term.

Parameters:

term - Term to match - STRING

maxItems - Maximum number of items to return - NUMBER

Returns:

result Vocabulary Term Links - INFOTABLE - Aspects {dataShape:EntityDescriptor}

Throws:

Exception - If an error occurs

IsDynamic

@ThingworxExtensionApiMethod(since={6,6})
public Boolean IsDynamic()
                  throws Exception

Service Category:

Metadata

Service Description:

Whether the vocabulary is dynamic or not.

Returns:

IsDynamic Is dynamic vocabulary indicator - BOOLEAN

Throws:

Exception - If an error occurs

GetVocabularyLinks

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetVocabularyLinks(Double maxItems)
                             throws Exception

Service Category:

Queries

Service Description:

Return a list of entities linked to this vocabulary.

Parameters:

maxItems - Maximum number of items to return - NUMBER

Returns:

result Vocabulary Links - INFOTABLE - Aspects {dataShape:EntityDescriptor}

Throws:

Exception - If an error occurs

QueryVocabularyTerms

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryVocabularyTerms(String filter,
 Double maxItems)
                               throws Exception

Service Category:

Queries

Service Description:

Return a list of vocabulary terms.

Parameters:

filter - Term filter - STRING

maxItems - Maximum number of items to return - NUMBER

Returns:

result Vocabulary Terms - INFOTABLE - Aspects {dataShape:VocabularyTerm}

Throws:

Exception - If an error occurs

QueryVocabularyTermUsage

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryVocabularyTermUsage(String filter,
 Double maxItems)
                                   throws Exception

Service Category:

Queries

Service Description:

Return a list of vocabulary terms and their usage/frequency.

Parameters:

filter - Term filter - STRING

maxItems - Maximum number of items to return - NUMBER

Returns:

result Vocabulary Term Usage - INFOTABLE - Aspects {dataShape:VocabularyTermUsage}

Throws:

Exception - If an error occurs

QueryVocabularyTermLinks

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryVocabularyTermLinks(String term,
 org.json.JSONObject types,
 String filter,
 Double maxItems)
                                   throws Exception

Service Category:

Queries

Service Description:

Return a list of entities linked to this vocabulary term.

Parameters:

term - Term to match - STRING

types - Entity types - JSON

filter - Term filter - STRING

maxItems - Maximum number of items to return - NUMBER

Returns:

result Vocabulary Term Links - INFOTABLE - Aspects {dataShape:EntityDescriptor}

Throws:

Exception - If an error occurs

getEntityType

@ThingworxExtensionApiMethod(since={6,6})
public RelationshipTypes.ThingworxRelationshipTypes getEntityType()

Description copied from class: RootEntity

Returns the type of this entity.

Specified by:

getEntityType in class RootEntity

Returns:

the entity type