Package com.thingworx.resources.queries

Class Searcher

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.entities.ExtensibleRootEntity

com.thingworx.resources.Resource

com.thingworx.resources.queries.Searcher

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class Searcher
extends Resource

See Also:

• Serialized Form

Field Summary

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
Searcher()

Method Summary

Modifier and Type	Method	Description
InfoTable	FindDataTagTerm(String term, Double maxItems)	Service Category: Queries Service Description: Search data tag index for matches based on a term.
InfoTable	FindModelTagTerm(String term, Double maxItems)	Service Category: Queries Service Description: Search model tag index for matches based on a term.
InfoTable	SearchAll(String searchExpression, TagCollection dataTags, TagCollection modelTags, org.json.JSONObject types, Double maxItems, Double maxSearchItems)	Service Category: Queries Service Description: Search everything matches based on a term.
InfoTable	SearchCollaboration(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, Double maxItems, Double maxSearchItems)	Service Category: Queries Service Description: Retrieve a list of all collaboration entries filtered by keyword query and optional date range.
InfoTable	SearchData(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, Double maxItems, Double maxSearchItems)	Service Category: Queries Service Description: Search everything matches based on a term.
InfoTable	SearchDataTags(TagCollection tags, org.json.JSONObject types, Double maxItems)	Service Category: Queries Service Description: Search data tag index for matches.
InfoTable	SearchDataTagTerm(String term, org.json.JSONObject types, org.json.JSONObject names, Double maxItems)	Service Category: Queries Service Description: Search data tag index for matches based on a term.
InfoTable	SearchMashups(String searchExpression, TagCollection modelTags, org.json.JSONObject thingTemplates, org.json.JSONObject thingShapes, org.json.JSONObject aspects, org.json.JSONObject excludedAspects, Double maxItems, Double maxSearchItems)	Service Category: Queries Service Description: Search mashup matches based on a term.
InfoTable	SearchModelEntities(String searchExpression, TagCollection tags, org.json.JSONObject types, org.json.JSONObject aspects, org.json.JSONObject excludedAspects, Double maxItems, Double maxSearchItems)	Service Category: Queries Service Description: Retrieve a list of all model entities filtered by keyword query.
InfoTable	SearchModelEntitiesWithRestrictions(String searchExpression, TagCollection tags, org.json.JSONObject types, org.json.JSONObject aspects, org.json.JSONObject excludedAspects, Double maxItems, Double maxSearchItems)	Service Category: Queries Service Description: Retrieve a list of all model entities that are SQUEAL friendly.
InfoTable	SearchModelTags(TagCollection tags, org.json.JSONObject types, org.json.JSONObject aspects, org.json.JSONObject excludedAspects, Double maxItems)	Service Category: Queries Service Description: Search model tag index for matches.
InfoTable	SearchModelTagTerm(String term, org.json.JSONObject types, org.json.JSONObject names, Double maxItems)	Service Category: Queries Service Description: Search model tag index for matches based on a term.
InfoTable	SearchPeople(String searchExpression, TagCollection modelTags, org.json.JSONObject query, org.json.JSONObject aspects, org.json.JSONObject excludedAspects, Double maxItems, Double maxSearchItems)	Service Category: Queries Service Description: Search people matches based on a term.
InfoTable	SearchTags(String searchExpression, org.json.JSONObject types, org.json.JSONObject names, Double maxItems, Double maxSearchItems)	Service Category: Queries Service Description: Search vocabularies matches based on a term.
InfoTable	SearchThings(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, String identifierSearchExpression, org.json.JSONObject query, Double maxItems, Double maxSearchItems)	Service Category: Queries Service Description: Search thing matches based on a term.
InfoTable	SearchThingsByShape(String thingShape, Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query)	Service Category: Queries Service Description: Return a list of all the things that implement this shape and their data.
InfoTable	SearchThingsByTemplate(String thingTemplate, Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query)	Service Category: Queries Service Description: Return a list of all the things that implement this template and their data.
InfoTable	SearchThingsByTemplateV2(String thingTemplate, Double maxItems, TagCollection tags, String nameMask, org.json.JSONObject query)	Service Category: Queries Service Description: Return a list of all the things that implement this template and their data including accessModifier, deprecated information.
InfoTable	SearchThingsByTemplateWithPersistent(String thingTemplate, Double maxItems, String searchText)	Service Category: Queries Service Description: Return a list of all the things that implement this template, including transient Things.
InfoTable	SearchThingsByTemplateWithPersistentV2(String thingTemplate, Double maxItems, String searchText)	Service Category: Queries Service Description: Return a list of all the things that implement this template, including transient Things and their data including accessModifier, deprecated and namespace information.
InfoTable	SearchVocabularyTerms(String searchExpression, String type, org.json.JSONObject names, Double maxItems)	Deprecated.
InfoTable	SearchVocabularyTerms(String searchExpression, String type, org.json.JSONObject names, Double maxItems, Double maxSearchItems)	Service Category: Queries Service Description: Search vocabulary terms.
InfoTable	SpotlightSearch(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, Boolean searchDescriptions, Boolean withPermissions, String sortBy, Boolean isAscending, Double maxItems, Double maxSearchItems)	Deprecated.
InfoTable	SpotlightSearch(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, Boolean searchDescriptions, Boolean withPermissions, String sortBy, Boolean isAscending, Double maxItems, Double maxSearchItems, String projectName)	Deprecated.
InfoTable	SpotlightSearch(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, Boolean searchDescriptions, Boolean withPermissions, String sortBy, Boolean isAscending, Double maxItems, Double maxSearchItems, String projectName, Boolean includeInheritedThingShapes)	Service Category: Queries Service Description: Spotlight search.
InfoTable	SpotlightSearchV2(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, Boolean searchDescriptions, Boolean withPermissions, String sortBy, Boolean isAscending, Double maxItems, Double maxSearchItems, String projectName, String namespace, Boolean includeInheritedThingShapes)	Service Category: Queries Service Description: Spotlight search V2.

Methods inherited from class com.thingworx.resources.Resource

getEntityType

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

Constructor Details

Searcher

public Searcher()

Method Details

SearchAll

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchAll(String searchExpression,
 TagCollection dataTags,
 TagCollection modelTags,
 org.json.JSONObject types,
 Double maxItems,
 Double maxSearchItems)
                    throws 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:

Exception - If an error occurs

SearchVocabularyTerms

@ThingworxExtensionApiMethod(since={6,6})
@Deprecated
public InfoTable SearchVocabularyTerms(String searchExpression,
 String type,
 org.json.JSONObject names,
 Double maxItems)
                                throws Exception

Deprecated.

Throws:

Exception - If an error occurs

SearchVocabularyTerms

@ThingworxExtensionApiMethod(since={8,5})
public InfoTable SearchVocabularyTerms(String searchExpression,
 String type,
 org.json.JSONObject names,
 Double maxItems,
 Double maxSearchItems)
                                throws 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:

Exception - If an error occurs

SearchTags

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchTags(String searchExpression,
 org.json.JSONObject types,
 org.json.JSONObject names,
 Double maxItems,
 Double maxSearchItems)
                     throws 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:

Exception - If an error occurs

SearchData

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchData(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,
 Double maxItems,
 Double maxSearchItems)
                     throws 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:

Exception - If an error occurs

SearchCollaboration

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchCollaboration(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,
 Double maxItems,
 Double maxSearchItems)
                              throws 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:

Exception - If an error occurs

SearchThings

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchThings(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,
 String identifierSearchExpression,
 org.json.JSONObject query,
 Double maxItems,
 Double maxSearchItems)
                       throws 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:

Exception - If an error occurs

SearchMashups

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchMashups(String searchExpression,
 TagCollection modelTags,
 org.json.JSONObject thingTemplates,
 org.json.JSONObject thingShapes,
 org.json.JSONObject aspects,
 org.json.JSONObject excludedAspects,
 Double maxItems,
 Double maxSearchItems)
                        throws 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:

Exception - If an error occurs

SearchPeople

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchPeople(String searchExpression,
 TagCollection modelTags,
 org.json.JSONObject query,
 org.json.JSONObject aspects,
 org.json.JSONObject excludedAspects,
 Double maxItems,
 Double maxSearchItems)
                       throws 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:

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,
 Double maxItems)
                          throws 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:

Exception - If an error occurs

SearchDataTags

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchDataTags(TagCollection tags,
 org.json.JSONObject types,
 Double maxItems)
                         throws 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:

Exception - If an error occurs

SearchModelTagTerm

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchModelTagTerm(String term,
 org.json.JSONObject types,
 org.json.JSONObject names,
 Double maxItems)
                             throws 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:

Exception - If an error occurs

SearchDataTagTerm

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchDataTagTerm(String term,
 org.json.JSONObject types,
 org.json.JSONObject names,
 Double maxItems)
                            throws 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:

Exception - If an error occurs

FindModelTagTerm

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable FindModelTagTerm(String term,
 Double maxItems)
                           throws 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:

Exception - If an error occurs

FindDataTagTerm

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable FindDataTagTerm(String term,
 Double maxItems)
                          throws 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:

Exception - If an error occurs

SpotlightSearch

@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={7,1})
@Deprecated
public InfoTable SpotlightSearch(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,
 Boolean searchDescriptions,
 Boolean withPermissions,
 String sortBy,
 Boolean isAscending,
 Double maxItems,
 Double maxSearchItems)
                          throws Exception

Deprecated.

Throws:

Exception - If an error occurs

SpotlightSearch

@Deprecated
@ThingworxExtensionApiMethod(since={7,1},
                             deprecatedSince={9,4})
public InfoTable SpotlightSearch(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,
 Boolean searchDescriptions,
 Boolean withPermissions,
 String sortBy,
 Boolean isAscending,
 Double maxItems,
 Double maxSearchItems,
 String projectName)
                          throws Exception

Deprecated.

Throws:

Exception - If an error occurs

Legacy spotlightSearch API, now calls the new API with a null includeInheritedThingShapes flag.

SpotlightSearch

@ThingworxExtensionApiMethod(since={9,4})
public InfoTable SpotlightSearch(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,
 Boolean searchDescriptions,
 Boolean withPermissions,
 String sortBy,
 Boolean isAscending,
 Double maxItems,
 Double maxSearchItems,
 String projectName,
 Boolean includeInheritedThingShapes)
                          throws 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

includeInheritedThingShapes - Consider ThingShapes at all levels in the inheritance heirarchy while selecting Things/templates - BOOLEAN

Returns:

result Matching entries - INFOTABLE - Aspects {dataShape:SpotlightSearch}

Throws:

Exception - If an error occurs

SearchModelEntities

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchModelEntities(String searchExpression,
 TagCollection tags,
 org.json.JSONObject types,
 org.json.JSONObject aspects,
 org.json.JSONObject excludedAspects,
 Double maxItems,
 Double maxSearchItems)
                              throws 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:

Exception - If an error occurs

SearchThingsByShape

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchThingsByShape(String thingShape,
 Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query)
                              throws 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:

Exception - If an error occurs

SearchThingsByTemplate

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchThingsByTemplate(String thingTemplate,
 Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query)
                                 throws 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:

Exception - If an error occurs

SearchThingsByTemplateV2

@ThingworxExtensionApiMethod(since={9,4})
public InfoTable SearchThingsByTemplateV2(String thingTemplate,
 Double maxItems,
 TagCollection tags,
 String nameMask,
 org.json.JSONObject query)
                                   throws Exception

Service Category:

Queries

Service Description:

Return a list of all the things that implement this template and their data including accessModifier, deprecated information.

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 including accessModifier and deprecated information - INFOTABLE - Aspects {dataShape:RootEntityListV2}

Throws:

Exception - If an error occurs

SearchThingsByTemplateWithPersistent

@ThingworxExtensionApiMethod(since={8,0})
public InfoTable SearchThingsByTemplateWithPersistent(String thingTemplate,
 Double maxItems,
 String searchText)
                                               throws 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

searchText - Name pattern - STRING

Returns:

result Implementing Things including isPersistent flag - INFOTABLE - Aspects {dataShape:SpotlightSearchWithPersistent}

Throws:

Exception - If an error occurs

SearchThingsByTemplateWithPersistentV2

@ThingworxExtensionApiMethod(since={9,4})
public InfoTable SearchThingsByTemplateWithPersistentV2(String thingTemplate,
 Double maxItems,
 String searchText)
                                                 throws Exception

Service Category:

Queries

Service Description:

Return a list of all the things that implement this template, including transient Things and their data including accessModifier, deprecated and namespace information.

Parameters:

thingTemplate - Thing template - THINGTEMPLATENAME

maxItems - Maximum number of items to return - NUMBER

searchText - Name pattern - STRING

Returns:

result Implementing Things including isPersistent flag , namespace , accessModifier and deprecated information - INFOTABLE - Aspects {dataShape:SpotlightSearchWithPersistentV2}

Throws:

Exception - If an error occurs

SearchModelEntitiesWithRestrictions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable SearchModelEntitiesWithRestrictions(String searchExpression,
 TagCollection tags,
 org.json.JSONObject types,
 org.json.JSONObject aspects,
 org.json.JSONObject excludedAspects,
 Double maxItems,
 Double maxSearchItems)
                                              throws 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:

Exception - If an error occurs

SpotlightSearchV2

@ThingworxExtensionApiMethod(since={9,4})
public InfoTable SpotlightSearchV2(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,
 Boolean searchDescriptions,
 Boolean withPermissions,
 String sortBy,
 Boolean isAscending,
 Double maxItems,
 Double maxSearchItems,
 String projectName,
 String namespace,
 Boolean includeInheritedThingShapes)
                            throws Exception

Service Category:

Queries

Service Description:

Spotlight search V2.

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

namespace - Namespace to match - STRING

includeInheritedThingShapes - Consider ThingShapes at all levels in the inheritance heirarchy while selecting Things/templates - BOOLEAN

Returns:

result Matching entries - INFOTABLE - Aspects {dataShape:SpotlightSearchV2}

Throws:

Exception - If an error occurs