If the description does not specify that a user access token is required, then an app access token is required.
CompanyProfile
| Method | Description |
|---|---|
| GET CompanyProfile?companyID={companyID} |
Gets a company's profile (user access token required) |
ConvertFiles
| Method | Description |
|---|---|
| PUT ConvertFiles?fileNames={fileNames}&conversionExtension={conversionExtension}&useCompanyFolder={useCompanyFolder} |
CustomProductCategory
| Method | Description |
|---|---|
| GET CustomProductCategory?name={name} |
Creates a new product category (user access token required) |
File
| Method | Description |
|---|---|
| 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}&fileType={fileType}&overwriteFile={overwriteFile} |
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
| Method | Description |
|---|---|
| GET FileAttributes |
Gets a list of attributes for the current user's company |
| PUT FileAttributes?fileUID={fileUID}&fileName={fileName}&deleteExisting={deleteExisting} |
Adds attributes to a file. Either fileUID or fileName is required (user access token required) |
| DELETE FileAttributes?fileUID={fileUID} |
Removes all attributes from a file (user access token required) |
FileStatus
| Method | Description |
|---|---|
| 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
| Method | Description |
|---|---|
| GET IsEmployee?companyID={companyID} |
Checks if the current user is a member of a given company (user access token required) |
Product
| Method | Description |
|---|---|
| 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
| Method | Description |
|---|---|
| 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 |
Search
| Method | Description |
|---|---|
| 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) |
| GET Search?filterStr={filterStr}&searchTypeStr={searchTypeStr}&includeShapelets={includeShapelets}&customAPI={customAPI}&crawl_parameter={crawl_parameter} |
Performs a search (user access token required for non-public searches) |
User
| Method | Description |
|---|---|
| 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
| Method | Description |
|---|---|
| GET ValidUploadFileTypes |
Gets a list of allowed file types |
Version
| Method | Description |
|---|---|
| GET Version |
Using this method is an easy way to check connectivity. This will always return "1". |
VizSeekUtilizationPercent
| Method | Description |
|---|---|
| GET VizSeekUtilizationPercent |
Gets the percentage use of the company's file allotment (user access token required) |