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.

Parameters

NameDescriptionAdditional information
fileContent
Type: string, JSON serialized base64-encoded file bytes (required)

Define this parameter in the request body.

file
Type: URL encoded string (required). 
            If adding for search, just pass the extension (Ex. '.png')
            If adding to company, pass the file path (Ex. 'Design/chair.png')

Define this parameter in the request URI.

isGZipCompressed
Type: boolean (default = false).

Define this parameter in the request URI.

isSearchInput
Type: boolean (default = true). Use false if adding a file to a company

Define this parameter in the request URI.

attributes
Type: URL encoded string (optional). The file attributes in a query string format

Define this parameter in the request URI.

QRCodeId
Type: string ("attributeName=attributeValue" pairs separated by &)

Define this parameter in the request URI.

categoryId
Type: int (Required only for companies that use file categories)

Define this parameter in the request URI.

textOnly
Type: bool (default = false) True skips shape indexing

Define this parameter in the request URI.

attrTemplate
Type: string

Define this parameter in the request URI.

uid
Type: string. To use a specific uid for the file. Otherwise a random uid will be generated.

Define this parameter in the request URI.

rmIfDup
Type: boolean (default = false). If set to true, any duplicate files added after this one will be removed.

Define this parameter in the request URI.

isPriority
Type: boolean (default = false).

Define this parameter in the request URI.

fileType
Type: string (Optional. By default, the extension is used to get the file type). 
            Possible values: image, 2D, 3D, text, sketch

Define this parameter in the request URI.

overwriteFile
Type: nullable boolean (Optional. default = null). 
            This applies when uploading a file that already has a file name match in your database. 
            If true, the existing file will be replaced with the new one. If false, the new file will have a number appended to the name, like "Gear(2).jpg."
            If this value is not passed, your company's default setting will be used. (This can be changed in the VizSeek company profile page.)

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 the file's UID

Response body formats

application/json, text/json

Sample:
"string"