Skip to main content

Files and references

RouteWhat it does
GET /versions/:id/artifactsThe files of a draft or version
POST /versions/:id/artifacts?kind=Upload, raw body, X-File-Name. Sources go into drafts only and queue a job
GET /versions/:id/artifacts/:kind/fileDownload
DELETE /versions/:id/artifacts/:kindRemove from a draft
GET /artifacts/:id, /artifacts/:id/fileA file by its id
POST /versions/:id/exportsExport an assembly: { format: "OFB" } or "STP". Runs as a job
GET /versions/:id/referencesAn assembly's references, resolved or pinned
GET /versions/:id/bomThe bill of material
GET /versions/:id/reference-updates, POSTNewer versions of what it uses; take them into the draft
GET /versions/:id/asm-json/resolvedThe asm.json with references as addresses ClassCAD can load

The kinds of file are listed in Files and jobs.

References​

An asm.json template points at a document like this:

{ "reference": { "location": "pdm://documents/ENG-1004@B" } }
FormMeans
pdm://documents/ENG-1004The newest release, else the newest version
pdm://documents/ENG-1004@BRevision B
pdm://documents/ENG-1004@v3Version 3

The document can be named by its number or its id. How references resolve and get pinned is in Assemblies and references.