Package com.thingworx.vocabularies

Class Vocabulary

    • Method Detail

      • AddVocabularyTerm

        @ThingworxExtensionApiMethod(since={6,6})
public void AddVocabularyTerm​(java.lang.String term)
                       throws java.lang.Exception
        Service Category:
        Terms
        Service Description:
        Add a new vocabulary term.
        Parameters:
        term - Vocabulary Term - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteVocabularyTerm

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteVocabularyTerm​(java.lang.String term)
                          throws java.lang.Exception
        Service Category:
        Terms
        Service Description:
        Delete a specific vocabulary term.
        Parameters:
        term - Vocabulary Term - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • GetVocabularyTerms

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetVocabularyTerms()
                             throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Return a list of vocabulary terms.
        Returns:
        result Vocabulary Terms - INFOTABLE - Aspects {dataShape:VocabularyTerm}
        Throws:
        java.lang.Exception - If an error occurs

      • GetVocabularyTerm

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

      • GetVocabularyTermUsage

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

      • GetVocabularyTermLinks

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

      • IsDynamic

        @ThingworxExtensionApiMethod(since={6,6})
public java.lang.Boolean IsDynamic()
                            throws java.lang.Exception
        Service Category:
        Metadata
        Service Description:
        Whether the vocabulary is dynamic or not.
        Returns:
        IsDynamic Is dynamic vocabulary indicator - BOOLEAN
        Throws:
        java.lang.Exception - If an error occurs

      • GetVocabularyLinks

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

      • QueryVocabularyTerms

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

      • QueryVocabularyTermUsage

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

      • QueryVocabularyTermLinks

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryVocabularyTermLinks​(java.lang.String term,
                                          org.json.JSONObject types,
                                          java.lang.String filter,
                                          java.lang.Double maxItems)
                                   throws java.lang.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:
        java.lang.Exception - If an error occurs