Class Searcher

    • Constructor Detail

      • Searcher

        public Searcher()
    • Method Detail

      • SearchAll

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchAll​(java.lang.String searchExpression,
                                   TagCollection dataTags,
                                   TagCollection modelTags,
                                   org.json.JSONObject types,
                                   java.lang.Double maxItems,
                                   java.lang.Double maxSearchItems)
                            throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search everything matches based on a term.
        Parameters:
        searchExpression - Search expression - STRING
        dataTags - Tags - TAGS
        modelTags - Source Tags - TAGS
        types - Entity types - JSON
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:SearchResults}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchVocabularyTerms

        @ThingworxExtensionApiMethod(since={6,6})
        @Deprecated
        public InfoTable SearchVocabularyTerms​(java.lang.String searchExpression,
                                               java.lang.String type,
                                               org.json.JSONObject names,
                                               java.lang.Double maxItems)
                                        throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception - If an error occurs
      • SearchVocabularyTerms

        @ThingworxExtensionApiMethod(since={8,5})
        public InfoTable SearchVocabularyTerms​(java.lang.String searchExpression,
                                               java.lang.String type,
                                               org.json.JSONObject names,
                                               java.lang.Double maxItems,
                                               java.lang.Double maxSearchItems)
                                        throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search vocabulary terms.
        Parameters:
        searchExpression - Search expression - STRING
        type - Entity type (DataTags, ModelTags) - STRING
        names - Vocabulary names - JSON
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:SearchResults}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchTags

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchTags​(java.lang.String searchExpression,
                                    org.json.JSONObject types,
                                    org.json.JSONObject names,
                                    java.lang.Double maxItems,
                                    java.lang.Double maxSearchItems)
                             throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search vocabularies matches based on a term.
        Parameters:
        searchExpression - Search expression - STRING
        types - Entity types (DataTags, ModelTags) - JSON
        names - Vocabulary names - JSON
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:SearchResults}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchData

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchData​(java.lang.String searchExpression,
                                    TagCollection dataTags,
                                    org.json.JSONObject dataTypes,
                                    org.json.JSONObject names,
                                    TagCollection modelTags,
                                    org.json.JSONObject sources,
                                    TagCollection sourceTags,
                                    org.json.JSONObject dataShapes,
                                    org.joda.time.DateTime startDate,
                                    org.joda.time.DateTime endDate,
                                    java.lang.Double maxItems,
                                    java.lang.Double maxSearchItems)
                             throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search everything matches based on a term.
        Parameters:
        searchExpression - Search expression - STRING
        dataTags - Tags - TAGS
        dataTypes - Data types - JSON
        names - Container names - JSON
        modelTags - Model Tags - TAGS
        sources - Sources - JSON
        sourceTags - Source Tags - TAGS
        dataShapes - Data shapes - JSON
        startDate - Start time - DATETIME
        endDate - End time - DATETIME
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:SearchResults}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchCollaboration

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchCollaboration​(java.lang.String searchExpression,
                                             TagCollection dataTags,
                                             org.json.JSONObject names,
                                             org.json.JSONObject types,
                                             TagCollection modelTags,
                                             TagCollection sourceTags,
                                             org.json.JSONObject sources,
                                             org.joda.time.DateTime startDate,
                                             org.joda.time.DateTime endDate,
                                             java.lang.Double maxItems,
                                             java.lang.Double maxSearchItems)
                                      throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Retrieve a list of all collaboration entries filtered by keyword query and optional date range.
        Parameters:
        searchExpression - Search expression - STRING
        dataTags - Tags - TAGS
        names - Entity names - JSON
        types - Entity types - JSON
        modelTags - Model Tags - TAGS
        sourceTags - Source Tags - TAGS
        sources - Sources - JSON
        startDate - Start time - DATETIME
        endDate - End time - DATETIME
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        Returns:
        result Matching entries - INFOTABLE - Aspects {dataShape:SearchResults}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchThings

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchThings​(java.lang.String searchExpression,
                                      TagCollection modelTags,
                                      org.json.JSONObject networks,
                                      org.json.JSONObject types,
                                      org.json.JSONObject thingTemplates,
                                      org.json.JSONObject thingShapes,
                                      org.json.JSONObject aspects,
                                      org.json.JSONObject excludedAspects,
                                      java.lang.String identifierSearchExpression,
                                      org.json.JSONObject query,
                                      java.lang.Double maxItems,
                                      java.lang.Double maxSearchItems)
                               throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search thing matches based on a term.
        Parameters:
        searchExpression - Search expression - STRING
        modelTags - Model Tags - TAGS
        networks - Networks - JSON
        types - Entity types - JSON
        thingTemplates - Thing templates - JSON
        thingShapes - Thing shapes - JSON
        aspects - Aspects to match - JSON
        excludedAspects - Aspects to exclude - JSON
        identifierSearchExpression - Identifier search expression - STRING
        query - Value-based query expression - QUERY
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:SearchResults}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchMashups

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchMashups​(java.lang.String searchExpression,
                                       TagCollection modelTags,
                                       org.json.JSONObject thingTemplates,
                                       org.json.JSONObject thingShapes,
                                       org.json.JSONObject aspects,
                                       org.json.JSONObject excludedAspects,
                                       java.lang.Double maxItems,
                                       java.lang.Double maxSearchItems)
                                throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search mashup matches based on a term.
        Parameters:
        searchExpression - Search expression - STRING
        modelTags - Tags - TAGS
        thingTemplates - Thing templates - JSON
        thingShapes - Thing shapes - JSON
        aspects - Aspects to match - JSON
        excludedAspects - Aspects to exclude - JSON
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:SearchResults}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchPeople

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchPeople​(java.lang.String searchExpression,
                                      TagCollection modelTags,
                                      org.json.JSONObject query,
                                      org.json.JSONObject aspects,
                                      org.json.JSONObject excludedAspects,
                                      java.lang.Double maxItems,
                                      java.lang.Double maxSearchItems)
                               throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search people matches based on a term.
        Parameters:
        searchExpression - Search expression - STRING
        modelTags - Tags - TAGS
        query - Query expression - QUERY
        aspects - Aspects to match - JSON
        excludedAspects - Aspects to exclude - JSON
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:SearchResults}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchModelTags

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchModelTags​(TagCollection tags,
                                         org.json.JSONObject types,
                                         org.json.JSONObject aspects,
                                         org.json.JSONObject excludedAspects,
                                         java.lang.Double maxItems)
                                  throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search model tag index for matches.
        Parameters:
        tags - Tags to search - TAGS
        types - Entity types - JSON
        aspects - Aspects to match - JSON
        excludedAspects - Aspects to exclude - JSON
        maxItems - Maximum search results - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:EntityDescriptor}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchDataTags

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchDataTags​(TagCollection tags,
                                        org.json.JSONObject types,
                                        java.lang.Double maxItems)
                                 throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search data tag index for matches.
        Parameters:
        tags - Tags to search - TAGS
        types - Entity types - JSON
        maxItems - Maximum search results - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:EntityDescriptor}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchModelTagTerm

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchModelTagTerm​(java.lang.String term,
                                            org.json.JSONObject types,
                                            org.json.JSONObject names,
                                            java.lang.Double maxItems)
                                     throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search model tag index for matches based on a term.
        Parameters:
        term - Term to search - STRING
        types - Entity types - JSON
        names - Vocabulary names - JSON
        maxItems - Maximum search results - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:EntityDescriptor}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchDataTagTerm

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchDataTagTerm​(java.lang.String term,
                                           org.json.JSONObject types,
                                           org.json.JSONObject names,
                                           java.lang.Double maxItems)
                                    throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search data tag index for matches based on a term.
        Parameters:
        term - Term to search - STRING
        types - Entity types - JSON
        names - Vocabulary names - JSON
        maxItems - Maximum search results - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:EntityDescriptor}
        Throws:
        java.lang.Exception - If an error occurs
      • FindModelTagTerm

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable FindModelTagTerm​(java.lang.String term,
                                          java.lang.Double maxItems)
                                   throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search model tag index for matches based on a term.
        Parameters:
        term - Term to search - STRING
        maxItems - Maximum search results - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:VocabularyTermList}
        Throws:
        java.lang.Exception - If an error occurs
      • FindDataTagTerm

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable FindDataTagTerm​(java.lang.String term,
                                         java.lang.Double maxItems)
                                  throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Search data tag index for matches based on a term.
        Parameters:
        term - Term to search - STRING
        maxItems - Maximum search results - NUMBER
        Returns:
        result Search Results - INFOTABLE - Aspects {dataShape:VocabularyTermList}
        Throws:
        java.lang.Exception - If an error occurs
      • SpotlightSearch

        @ThingworxExtensionApiMethod(since={6,6},
                                     deprecatedSince={7,1})
        @Deprecated
        public InfoTable SpotlightSearch​(java.lang.String searchExpression,
                                         TagCollection tags,
                                         org.json.JSONObject types,
                                         org.json.JSONObject thingTemplates,
                                         org.json.JSONObject thingShapes,
                                         org.json.JSONObject aspects,
                                         org.json.JSONObject excludedAspects,
                                         org.joda.time.DateTime startDate,
                                         org.joda.time.DateTime endDate,
                                         java.lang.Boolean searchDescriptions,
                                         java.lang.Boolean withPermissions,
                                         java.lang.String sortBy,
                                         java.lang.Boolean isAscending,
                                         java.lang.Double maxItems,
                                         java.lang.Double maxSearchItems)
                                  throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception - If an error occurs

      • SpotlightSearch

        @ThingworxExtensionApiMethod(since={7,1})
        public InfoTable SpotlightSearch​(java.lang.String searchExpression,
                                         TagCollection tags,
                                         org.json.JSONObject types,
                                         org.json.JSONObject thingTemplates,
                                         org.json.JSONObject thingShapes,
                                         org.json.JSONObject aspects,
                                         org.json.JSONObject excludedAspects,
                                         org.joda.time.DateTime startDate,
                                         org.joda.time.DateTime endDate,
                                         java.lang.Boolean searchDescriptions,
                                         java.lang.Boolean withPermissions,
                                         java.lang.String sortBy,
                                         java.lang.Boolean isAscending,
                                         java.lang.Double maxItems,
                                         java.lang.Double maxSearchItems,
                                         java.lang.String projectName)
                                  throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Spotlight search.
        Parameters:
        searchExpression - Search expression - STRING
        tags - Tags - TAGS
        types - Entity types - JSON
        thingTemplates - Thing templates - JSON
        thingShapes - Thing shapes - JSON
        aspects - Aspects to match - JSON
        excludedAspects - Aspects to exclude - JSON
        startDate - Only return entities modified since this date - DATETIME
        endDate - Only return entities modified before this date - DATETIME
        searchDescriptions - Search descriptions in addition to names - BOOLEAN
        withPermissions - Include user permissions - BOOLEAN
        sortBy - Sort mode - STRING
        isAscending - Ascending search - BOOLEAN
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        projectName - Project Name - PROJECTNAME
        Returns:
        result Matching entries - INFOTABLE - Aspects {dataShape:SpotlightSearch}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchModelEntities

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchModelEntities​(java.lang.String searchExpression,
                                             TagCollection tags,
                                             org.json.JSONObject types,
                                             org.json.JSONObject aspects,
                                             org.json.JSONObject excludedAspects,
                                             java.lang.Double maxItems,
                                             java.lang.Double maxSearchItems)
                                      throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Retrieve a list of all model entities filtered by keyword query.
        Parameters:
        searchExpression - Search expression - STRING
        tags - Tags - TAGS
        types - Entity types - JSON
        aspects - Aspects to match - JSON
        excludedAspects - Aspects to exclude - JSON
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        Returns:
        result Matching entries - INFOTABLE - Aspects {dataShape:EntityDescriptor}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchThingsByShape

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchThingsByShape​(java.lang.String thingShape,
                                             java.lang.Double maxItems,
                                             TagCollection tags,
                                             java.lang.String nameMask,
                                             org.json.JSONObject query)
                                      throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Return a list of all the things that implement this shape and their data.
        Parameters:
        thingShape - Thing shape - THINGSHAPENAME
        maxItems - Maximum number of items to return - NUMBER
        tags - Tags to search on - TAGS
        nameMask - Name pattern - STRING
        query - Query definition - QUERY
        Returns:
        result Implementing Things With Data - INFOTABLE - Aspects {dataShape:RootEntityList}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchThingsByTemplate

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchThingsByTemplate​(java.lang.String thingTemplate,
                                                java.lang.Double maxItems,
                                                TagCollection tags,
                                                java.lang.String nameMask,
                                                org.json.JSONObject query)
                                         throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Return a list of all the things that implement this template and their data.
        Parameters:
        thingTemplate - Thing template - THINGTEMPLATENAME
        maxItems - Maximum number of items to return - NUMBER
        tags - Tags to search on - TAGS
        nameMask - Name pattern - STRING
        query - Query definition - QUERY
        Returns:
        result Implementing Things With Data - INFOTABLE - Aspects {dataShape:RootEntityList}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchThingsByTemplateWithPersistent

        @ThingworxExtensionApiMethod(since={8,0})
        public InfoTable SearchThingsByTemplateWithPersistent​(java.lang.String thingTemplate,
                                                              java.lang.Double maxItems,
                                                              java.lang.String nameMask)
                                                       throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Return a list of all the things that implement this template, including transient Things.
        Parameters:
        thingTemplate - Thing template - THINGTEMPLATENAME
        maxItems - Maximum number of items to return - NUMBER
        nameMask - Name pattern - STRING
        Returns:
        result Implementing Things including isPersistent flag - INFOTABLE - Aspects {dataShape:SpotlightSearchWithPersistent}
        Throws:
        java.lang.Exception - If an error occurs
      • SearchModelEntitiesWithRestrictions

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchModelEntitiesWithRestrictions​(java.lang.String searchExpression,
                                                             TagCollection tags,
                                                             org.json.JSONObject types,
                                                             org.json.JSONObject aspects,
                                                             org.json.JSONObject excludedAspects,
                                                             java.lang.Double maxItems,
                                                             java.lang.Double maxSearchItems)
                                                      throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Retrieve a list of all model entities that are SQUEAL friendly.
        Parameters:
        searchExpression - Search expression - STRING
        tags - Tags - TAGS
        types - Entity types - JSON
        aspects - Aspects to match - JSON
        excludedAspects - Aspects to exclude - JSON
        maxItems - Maximum number of items to return - NUMBER
        maxSearchItems - Maximum number of items to search - NUMBER
        Returns:
        result Matching entries - INFOTABLE - Aspects {dataShape:EntityDescriptor}
        Throws:
        java.lang.Exception - If an error occurs