Models

Create Records for models and receive the needed signed uploadUrl to upload the model files and initiate ingestion.

Current Limitations:

  • Filetypes Supported: '.3ds', '.asm', '.catpart', '.catproduct', '.glb', '.iges', '.igs', '.obj', '.par', '.prt', '.sldasm', '.sldprt', '.stl', '.step', '.stp', '.x_b', '.x_t',
  • Versioned Creo files are also supported. For example part.prt.1 or assembly.asm.2.
  • Maximum 100 Models can be created at once.
  • The folderName used in the filePath must be the name of a Folder that already exists.
  • Each filePath must be unique for each model.
  • filePath can not exceed 1024 bytes (this is roughly 1024 characters, unless unicode characters are included, which consume more bytes)
  • filePath can not contain any of the following characters: `['\n', '\r', '*', ':', '"', '<', '>', '|', '#', '[', ']', '?', '\'];
  • No duplicates of a model can be created within the same folder.

Assemblies can be created just like any other supported file, but all required subparts must be uploaded to the same folder (preferably beforehand to avoid unnecessary automatic reprocessing).

The model file can be uploaded via a PUT request to the <upload url> including the file and the supplied headers.

Example using curl command:

curl -X PUT --upload-file file.stl -H '<header1-name>: <header1-value>' -H '<header2-name>: <header2-value>' <upload-url>

After completing the upload, the model will be processed behind the scenes and be ready to match once it is in the finished state.

post/models

Query parameters

createMissingFoldersboolean

If set to true, any folders that do not exist will be created. If set to false, any folders that do not exist will cause an error.

collectionstring

Optional name of a collection the uploaded models will be added to. If the collection does not exist, it will be created.

Headers

X-PHYSNA-TENANTIDstring

Request body

Response

Ok

Changes