If the description does not specify that a user access token is required, then an app access token is required.

CompanyProfile

MethodDescription
GET CompanyProfile?companyID={companyID}

Gets a company's profile (user access token required)

ConvertFiles

MethodDescription
PUT ConvertFiles?fileNames={fileNames}&conversionExtension={conversionExtension}

Converts 3D model files into either .stl or .step files (user access token required)

CustomProductCategory

MethodDescription
GET CustomProductCategory?name={name}

Creates a new product category (user access token required)

File

MethodDescription
GET File?fileUID={fileUID}&fileName={fileName}&includeShapelets={includeShapelets}&lgFileNumber={lgFileNumber}

Returns an existing file, using either the fileUID or fileName

PUT File?file={file}&isGZipCompressed={isGZipCompressed}&isSearchInput={isSearchInput}&attributes={attributes}&QRCodeId={QRCodeId}&categoryId={categoryId}&textOnly={textOnly}&attrTemplate={attrTemplate}&uid={uid}&rmIfDup={rmIfDup}&isPriority={isPriority}

Saves a new file for search input or to the company database. The difference is that a file only used for search will not be available later in the company database. You will be returned the fileUID to use for the search method.

DELETE File?fileUID={fileUID}

Deletes an existing file (user access token required)

FileAttributes

MethodDescription
PUT FileAttributes?fileUID={fileUID}&deleteExisting={deleteExisting}

Adds attributes to a file (user access token required)

DELETE FileAttributes?fileUID={fileUID}

Removes all attributes from a file (user access token required)

FileStatus

MethodDescription
GET FileStatus?fileUID={fileUID}

Returns null if the file has not been indexed; returns the timestamp if it has been indexed; or returns a list of dulpicate fileUIDs and a list of similar fileUIDs and their corresponding match scores if the file has been indexed and there are dulpicates. If the file was added with rmIfDup(remove if duplicate) set to true, the file will be removed.

IsEmployee

MethodDescription
GET IsEmployee?companyID={companyID}

Checks if the current user is a member of a given company (user access token required)

Product

MethodDescription
GET Product?pid={pid}

Gets an existing product

PUT Product?pid={pid}&categoryID={categoryID}&title={title}&description={description}&brand={brand}&materialID={materialID}&materialAlloyOrType={materialAlloyOrType}

Saves a product (user access token required)

DELETE Product?pid={pid}

Deletes an existing product (user access token required)

SavedSearches

MethodDescription
PUT SavedSearches

Gets the list of the user's saved searches (user access token required)

GET SavedSearches?name={name}&searchVizSpaceID={searchVizSpaceID}&queryStr={queryStr}&searchType={searchType}

Saves a search (user access token required)

DELETE SavedSearches/{id}

Deletes a saved search

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

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)

User

MethodDescription
GET User?emailID={emailID}&password={password}

Authenticates the given credentials (a null response is most likely due to invalid credentials)

PUT User?emailID={emailID}&firstName={firstName}&lastName={lastName}&password={password}

Creates a new user

ValidUploadFileTypes

MethodDescription
GET ValidUploadFileTypes

Gets a list of allowed file types

Version

MethodDescription
GET Version

Using this method is an easy way to check connectivity. This will always return "1".

VizSeekUtilizationPercent

MethodDescription
GET VizSeekUtilizationPercent

Gets the percentage use of the company's file allotment (user access token required)