PUT Search?filterStr={filterStr}&searchTypeStr={searchTypeStr}&fileExtension={fileExtension}&isGZipCompressed={isGZipCompressed}&cropX={cropX}&cropY={cropY}&cropW={cropW}&cropH={cropH}&includeShapelets={includeShapelets}&customAPI={customAPI}&crawl_parameter={crawl_parameter}

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

Parameters

NameDescriptionAdditional information
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) fileType – type of file ("2D", "3D", "image", or "sketch")
                3) resultFileType – type of files to return ("Image", "ThreeD", "TwoD", or "Text")
                4) FT – free text search
                5) v – volume tolerance
                6) sa – surface area tolerance
                5 and 6 are used for 3D to 3D search only.
                    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=[your company Id]&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.

fileContent
Type: string (optional). The search input file(s), formatted in a JSON serialized array of base64-encoded file byte arrays

Define this parameter in the request body.

searchTypeStr
Type: string. ("prod" for product search, or "file" for file search). Default is "file"

Define this parameter in the request URI.

fileExtension
Type: URL encoded string (optional). The extension of the search input files (Ex. '.png')

Define this parameter in the request URI.

isGZipCompressed
Type: boolean (optional) (default = false). Indicates if the search input files are GZipCompressed

Define this parameter in the request URI.

cropX
(Depricated) Type: int (optional) X-coordinate of the crop area. 
            (The distance from the left edge of the image to the left edge of the crop area)

Define this parameter in the request URI.

cropY
(Depricated) Type: int (optional) Y-coordinate of the crop area. 
            (The distance from the top edge of the image to the top edge of the crop area)

Define this parameter in the request URI.

cropW
(Depricated) Type: int (optional) Width of the crop area

Define this parameter in the request URI.

cropH
(Depricated) Type: int (optional) Height of the crop area

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.

Request body formats

application/json, text/json

Sample:
"string"

application/x-www-form-urlencoded

Sample:
[0]=string

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}]}]}