GET Search?searchTypeStr={searchTypeStr}&filterStr={filterStr}&includeShapelets={includeShapelets}&customAPI={customAPI}&crawl_parameter={crawl_parameter}

Performs a search (user access token required for non-public searches)

Parameters

NameDescriptionAdditional information
searchTypeStr
Type: string (required). (prod (for product search), and file (for file search))

Define this parameter in the request URI.

filterStr
Type: URL encoded string(required). The filter string in a query string format 
            ("field=value" pairs separated by &). Possible filter "field" options are,
                1) uid - companyID of the company to search with
                2) fileUID – fileUID of the search input file uploaded using the Put File call
                3) fileType – type of file ("3D" or "image")
                4) resultFileType – type of files to return ("Image", "ThreeD", "TwoD", or "Text")
                5) FT – free text search
                6) v – volume tolerance
                7) sa – surface area tolerance
                6,7 - (used for 3D to 3D search)
                    Format: decimal form of the percent tolerance
                    Ex. ".1"(equivalent to +/-.1) or +0.3/-0.4 or "+.2" or "-.5"
                Example filterStr value:
                    a) For shape search only with the image file, 
                        uid=[your company Id]&fileUID=[file uid]&fileType=image
                    b) For text search only, uid=guid1&FT=chair
                    c) For shape and text search, 
                        uid=[your company Id]&fileUID=[file uid]&fileType=image&FT=chair

Define this parameter in the request URI.

includeShapelets
Type: boolean (optional) If the extracted file shapelets should be included

Define this parameter in the request URI.

customAPI
Type: int (optional) 10 if the raw JSON results should be included in the output

Define this parameter in the request URI.

crawl_parameter
Type: string (optional)

Define this parameter in the request URI.

Response Information

Returns a SearchResultSummary object that contains the following properties: ResultsList – contains the results including the shape match score. SearchFilters – contains the subsequent filters that could be used in the "Refine" section. Each "Filter" has "QueryString" (the field name to be used for the filterStr) and “Label” section. "FilterValues" contains the filter value (Value), name (Name) and count (Count).

Response body formats

text/json

Sample:

Sample not available.

application/json

Sample:
{'ResultsList':[{'ShapeResult': { 'Score': 0.449365, 'Name': 'Gear.stl' },'CompanyName':'[company name]','PublicURL':'[URL for full file]','CompanyVizSpaceID':'[companyID]','FullText':null,'FileType':4, 'ThumbnailURL':'[URL for file thumbnail preview]','FileName':null,'FileUID':'[fileUID]','ViewerFile':'', 'ViewURL':'https://www.vizseek.com/[companyname]/ViewFile.aspx?fileUID=[fileUID]','Name':'pulley.jpg'}],'TotalResults':1, 'SearchTime':'[DateTime of search]','Categories':null,'SearchFilters':[{'QueryString':'uid','Value':'[fileUID]', 'HelpText':null,'FilterValues':null},{'QueryString':'FT','Value':'color=blue', 'HelpText':null,'FilterValues':null},{'QueryString':'user','Value':'[userID]', 'HelpText':null,'FilterValues':null},{'QueryString':'resultFileType','Value':'Image,ThreeD,TwoD,Text', 'HelpText':null,'FilterValues':[{'Value':'Image','Name':'Image','Count':1}]},{'QueryString':'DIR','Value':null,'HelpText':null,'FilterValues':[{'Value':'prt','Name':'Online','Count':1}]}]}