This is the API

addFeature1

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features

HTTP Method

POST

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wvm String

  One of w or v or m corresponding to whether a workspace or version or microversion was entered.

• Path: wvmid String

  Workspace (w), Version (v) or Microversion (m) ID.

• Path: eid String

  Element ID.

• Body: body String(string)

  feature The serialized feature definition

createPartStudio

---

URL

http://localhost/api/partstudios/d/{did}/w/{wid}

HTTP Method

POST

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wid String

  Workspace ID.

• Body: BTModelElementParams BTModelElementParams(BTModelElementParams)

exportPS1

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/parasolid

HTTP Method

GET

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wvm String

  One of w or v or m corresponding to whether a workspace or version or microversion was entered.

• Path: wvmid String

  Workspace (w), Version (v) or Microversion (m) ID.

• Path: eid String

  Element ID.

• Query: partIds String

  IDs of the parts to retrieve. Repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with other ID filters

• Query: version String

  Parasolid version

• Query: includeExportIds Boolean

  Whether topolgy ids should be exported as parasolid attributes

• Query: configuration String

  Configuration string.

• Query: linkDocumentId String

  Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

exportStl1

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/stl

HTTP Method

GET

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wvm String

  One of w or v or m corresponding to whether a workspace or version or microversion was entered.

• Path: wvmid String

  Workspace (w), Version (v) or Microversion (m) ID.

• Path: eid String

  Element ID.

• Query: partIds String

  IDs of the parts to retrieve. Repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with other ID filters

• Query: mode String

  Type of file: text, binary

• Query: grouping Boolean

  Whether parts should be exported as a group or individually in a .zip file

• Query: scale Double

  Scale for measurements.

• Query: units String

  Name of base unit (meter, centimeter, millimeter, inch, foot, or yard)

• Query: angleTolerance Double

  Angle tolerance (in radians). This specifies the limit on the sum of the angular deviations of a tessellation chord from the tangent vectors at two chord endpoints. The specified value must be less than PI/2. This parameter currently has a default value chosen based on the complexity of the parts being tessellated.

• Query: chordTolerance Double

  Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true surface/edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated.

• Query: maxFacetWidth Double

  Max facet width. This specifies the limit on the size of any side of a tessellation facet.

• Query: minFacetWidth Double

  Max facet width. This specifies the limit on the size of any side of a tessellation facet.

• Query: configuration String

  Configuration string.

• Query: linkDocumentId String

  Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

getBodyDetails2

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/bodydetails

HTTP Method

GET

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wvm String

  One of w or v or m corresponding to whether a workspace or version or microversion was entered.

• Path: wvmid String

  Workspace (w), Version (v) or Microversion (m) ID.

• Path: eid String

  Element ID.

• Query: configuration String

  Configuration string.

• Query: linkDocumentId String

  Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

getBoundingBoxes2

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/boundingboxes

HTTP Method

GET

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wvm String

  One of w or v or m corresponding to whether a workspace or version or microversion was entered.

• Path: wvmid String

  Workspace (w), Version (v) or Microversion (m) ID.

• Path: eid String

  Element ID.

• Query: includeHidden Boolean

  Whether or not to include bounding boxes for hidden parts.

• Query: includeWireBodies Boolean

  Whether to include wire bodies in the bounding box.

• Query: configuration String

  Configuration string.

• Query: linkDocumentId String

  Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

getEdges2

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/tessellatededges

HTTP Method

GET

Response Type

Parameters

• Path: did String

• Path: wvm String

• Path: wvmid String

• Path: eid String

• Query: angleTolerance Double

• Query: chordTolerance Double

• Query: partId List(String)

• Query: edgeId List(String)

• Query: configuration String

• Query: linkDocumentId String

getFaces2

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/tessellatedfaces

HTTP Method

GET

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wvm String

  One of w or v or m corresponding to whether a workspace or version or microversion was entered.

• Path: wvmid String

  Workspace (w), Version (v) or Microversion (m) ID.

• Path: eid String

  Element ID.

• Query: angleTolerance Double

  Angle tolerance (in radians). This specifies the limit on the sum of the angular deviations of a tessellation chord from the tangent vectors at two chord endpoints. The specified value must be less than PI/2. This parameter currently has a default value chosen based on the complexity of the parts being tessellated.

• Query: chordTolerance Double

  Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true surface/edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated.

• Query: maxFacetWidth Double

  Max facet width. This specifies the limit on the size of any side of a tessellation facet.

• Query: outputVertexNormals Boolean

  If true, output vertex normals corresponding to surface normals at facet vertex points.

• Query: outputFacetNormals Boolean

  Output facet normals.

• Query: outputTextureCoordinates Boolean

  Output texture coordinates.

• Query: outputIndexTable Boolean

  Output index table.

• Query: partId List(String)

  IDs of the parts to retrieve. Repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with other ID filters

• Query: faceId List(String)

  IDs of the faces to tessellate (repeat query param to add more than one, i.e. faceId=JHK&faceId=JHD)

• Query: outputErrorFaces Boolean

  Whether or not to output faces that cause an error

• Query: configuration String

  Configuration string.

• Query: linkDocumentId String

  Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

getFeatures

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features

HTTP Method

GET

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wvm String

  One of w or v or m corresponding to whether a workspace or version or microversion was entered.

• Path: wvmid String

  Workspace (w), Version (v) or Microversion (m) ID.

• Path: eid String

  Element ID.

• Query: featureId List(String)

  ID of a feature; repeat query param to add more than one

• Query: linkDocumentId String

  Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

• Query: noSketchGeometry Boolean

  Whether or not to output simple sketch info without geometry

getMassProperties

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/massproperties

HTTP Method

GET

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wvm String

  One of w or v or m corresponding to whether a workspace or version or microversion was entered.

• Path: wvmid String

  Workspace (w), Version (v) or Microversion (m) ID.

• Path: eid String

  Element ID.

• Query: partId List(String)

  IDs of the parts to retrieve. Repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with other ID filters

• Query: massAsGroup Boolean

  If true, specified parts will be evaluated as a single object instead of individually

• Query: configuration String

  Configuration string.

• Query: linkDocumentId String

  Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

getNamedViews2

---

URL

http://localhost/api/partstudios/d/{did}/e/{eid}/namedViews

HTTP Method

GET

Response Type

Parameters

• Path: did String

  Document ID.

• Path: eid String

  Element ID.

• Query: skipPerspective Boolean

  Whether views with a perspective projection should be omitted.

getOpenApi

---

URL

http://localhost/api/openapi

HTTP Method

GET

Response Type

Parameters

• Query: fileType String

  The type of file to return. Defaults to JSON.

• Query: excludedTags String

  If an operation contains an excluded tag, it is not returned from this endpoint.

• Query: includedTags String

  Return at most all the operations with tags included in includedTags. If not given, this will default to all tags.

• Query: documentationStatus List(String)

  Only return endpoints that have the specified document status. Default is to return all the keys the user should have access to.

getShadedViews1

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/shadedviews

HTTP Method

GET

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wvm String

  One of w or v or m corresponding to whether a workspace or version or microversion was entered.

• Path: wvmid String

  Workspace (w), Version (v) or Microversion (m) ID.

• Path: eid String

  Element ID.

• Query: viewMatrix String

  12-number view matrix (comma-separated), or one of the following named views: top, bottom, front, back, left, right The 12 entries in the view matrix form three rows and four columns, which is a linear transformation applied to the model itself. The matrix's first three columns maps the coordinate axes of the model to the coordinate axes of the view, and the fourth column translates the origin (in meters). The view coordinates have x pointing right, y pointing up, and z pointing towards the viewer, while a front view of the model has x pointing right, y pointing away from the viewer, and z pointing up. For example, the identity matrix viewMatrix=1,0,0,0,0,1,0,0,0,0,1,0 corresponds to the top view, and viewMatrix=0.612,0.612,0,0,-0.354,0.354,0.707,0,0.707,-0.707,0.707,0 corresponds (approximately) to the isometric view. The first three columns of the view matrix should be orthonormal and have a positive determinant. If this is not the case, view behavior may be undefined.

• Query: outputHeight Integer

  Output image height (in pixels)

• Query: outputWidth Integer

  Output image width (in pixels)

• Query: pixelSize Double

  Height and width represented by each pixel (in meters). If the value is 0, the display will be sized to fit the output image dimensions.

• Query: edges String

  The treatment to be applied to edges in the display. Options are show: show visible edges, hide: hide visible edges.

• Query: showAllParts Boolean

  Whether or not all parts should be shown in the element, regardless of user setting. If false, the visibility setting made by the user will be reflected in the image. If true, all parts will be shown.

• Query: includeSurfaces Boolean

  Whether or not surfaces should be shown in the element. It is applicable only when showAllParts is true. If false, surfaces will be excluded. If true, all surfaces will be shown.

• Query: useAntiAliasing Boolean

  If true, an anti-aliasing factor will be used to smooth model boundaries in the final image result. If false, the image will be rasterized at the given resolution. Setting to true can have negative performance implications with respect to rendering time and memory usage. If a high-resolution image is requested and anti-aliasing is turned on, the server may not be able to fulfill the request.

• Query: configuration String

  Configuration string.

• Query: linkDocumentId String

  Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

getTranslatorFormats4

---

URL

http://localhost/api/partstudios/d/{did}/w/{wid}/e/{eid}/translationformats

HTTP Method

GET

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wid String

  Workspace ID.

• Path: eid String

  Element ID.

• Query: checkContent Boolean

  Whether the current content or lack thereof should be considered when determining the available formats. Empty part studios cannot be translated into any format.

translateFormat5

---

URL

http://localhost/api/partstudios/d/{did}/{wv}/{wvid}/e/{eid}/translations

HTTP Method

POST

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wv String

  One of w or v corresponding to whether a workspace or version was entered.

• Path: wvid String

  Workspace (w) or Version (v).

• Path: eid String

  Element ID.

• Body: BTTranslateFormatParams BTTranslateFormatParams(BTTranslateFormatParams)

translateIds1

---

URL

http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/idtranslations

HTTP Method

POST

Response Type

Parameters

• Path: did String

  Document ID.

• Path: wvm String

  One of w or v or m corresponding to whether a workspace or version or microversion was entered.

• Path: wvmid String

  Workspace (w), Version (v) or Microversion (m) ID.

• Path: eid String

  Element ID.

• Body: BTIdTranslationParams BTIdTranslationParams(BTIdTranslationParams)