onshape-clients

<div class="main-content"> <h2><a name=""></a></h2> This is the API <h2><a name="addFeature1"></a>addFeature1</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features</code> <h3 class="section">HTTP Method</h3> <code>POST</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTFeatureDefinitionResponse"><a href="">BTFeatureDefinitionResponse</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wvm String One of w or v or m corresponding to whether a workspace or version or microversion was entered. </li> <li class="parameter"> Path: wvmid String Workspace (w), Version (v) or Microversion (m) ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> Body: body String(string) feature The serialized feature definition </li> </ul> <h2><a name="createPartStudio"></a>createPartStudio</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/w/{wid}</code> <h3 class="section">HTTP Method</h3> <code>POST</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTDocumentElementInfo"><a href="">BTDocumentElementInfo</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wid String Workspace ID. </li> <li class="parameter"> Body: BTModelElementParams BTModelElementParams(BTModelElementParams) </li> </ul> <h2><a name="exportPS1"></a>exportPS1</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/parasolid</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model=""><a href=""></a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wvm String One of w or v or m corresponding to whether a workspace or version or microversion was entered. </li> <li class="parameter"> Path: wvmid String Workspace (w), Version (v) or Microversion (m) ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> 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 </li> <li class="parameter"> Query: version String Parasolid version </li> <li class="parameter"> Query: includeExportIds Boolean Whether topolgy ids should be exported as parasolid attributes </li> <li class="parameter"> Query: configuration String Configuration string. </li> <li class="parameter"> 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. </li> </ul> <h2><a name="exportStl1"></a>exportStl1</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/stl</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model=""><a href=""></a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wvm String One of w or v or m corresponding to whether a workspace or version or microversion was entered. </li> <li class="parameter"> Path: wvmid String Workspace (w), Version (v) or Microversion (m) ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> 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 </li> <li class="parameter"> Query: mode String Type of file: text, binary </li> <li class="parameter"> Query: grouping Boolean Whether parts should be exported as a group or individually in a .zip file </li> <li class="parameter"> Query: scale Double Scale for measurements. </li> <li class="parameter"> Query: units String Name of base unit (meter, centimeter, millimeter, inch, foot, or yard) </li> <li class="parameter"> 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. </li> <li class="parameter"> 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. </li> <li class="parameter"> Query: maxFacetWidth Double Max facet width. This specifies the limit on the size of any side of a tessellation facet. </li> <li class="parameter"> Query: minFacetWidth Double Max facet width. This specifies the limit on the size of any side of a tessellation facet. </li> <li class="parameter"> Query: configuration String Configuration string. </li> <li class="parameter"> 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. </li> </ul> <h2><a name="getBodyDetails2"></a>getBodyDetails2</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/bodydetails</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTExportModelBodiesResponse"><a href="">List</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wvm String One of w or v or m corresponding to whether a workspace or version or microversion was entered. </li> <li class="parameter"> Path: wvmid String Workspace (w), Version (v) or Microversion (m) ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> Query: configuration String Configuration string. </li> <li class="parameter"> 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. </li> </ul> <h2><a name="getBoundingBoxes2"></a>getBoundingBoxes2</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/boundingboxes</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTBoundingBox"><a href="">BTBoundingBox</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wvm String One of w or v or m corresponding to whether a workspace or version or microversion was entered. </li> <li class="parameter"> Path: wvmid String Workspace (w), Version (v) or Microversion (m) ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> Query: includeHidden Boolean Whether or not to include bounding boxes for hidden parts. </li> <li class="parameter"> Query: includeWireBodies Boolean Whether to include wire bodies in the bounding box. </li> <li class="parameter"> Query: configuration String Configuration string. </li> <li class="parameter"> 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. </li> </ul> <h2><a name="getEdges2"></a>getEdges2</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/tessellatededges</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTExportTessellatedEdgesResponse"><a href="">BTExportTessellatedEdgesResponse</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String </li> <li class="parameter"> Path: wvm String </li> <li class="parameter"> Path: wvmid String </li> <li class="parameter"> Path: eid String </li> <li class="parameter"> Query: angleTolerance Double </li> <li class="parameter"> Query: chordTolerance Double </li> <li class="parameter"> Query: partId List(String) </li> <li class="parameter"> Query: edgeId List(String) </li> <li class="parameter"> Query: configuration String </li> <li class="parameter"> Query: linkDocumentId String </li> </ul> <h2><a name="getFaces2"></a>getFaces2</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/tessellatedfaces</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTExportTessellatedFacesResponse"><a href="">BTExportTessellatedFacesResponse</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wvm String One of w or v or m corresponding to whether a workspace or version or microversion was entered. </li> <li class="parameter"> Path: wvmid String Workspace (w), Version (v) or Microversion (m) ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> 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. </li> <li class="parameter"> 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. </li> <li class="parameter"> Query: maxFacetWidth Double Max facet width. This specifies the limit on the size of any side of a tessellation facet. </li> <li class="parameter"> Query: outputVertexNormals Boolean If true, output vertex normals corresponding to surface normals at facet vertex points. </li> <li class="parameter"> Query: outputFacetNormals Boolean Output facet normals. </li> <li class="parameter"> Query: outputTextureCoordinates Boolean Output texture coordinates. </li> <li class="parameter"> Query: outputIndexTable Boolean Output index table. </li> <li class="parameter"> 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 </li> <li class="parameter"> Query: faceId List(String) IDs of the faces to tessellate (repeat query param to add more than one, i.e. faceId=JHK&faceId=JHD) </li> <li class="parameter"> Query: outputErrorFaces Boolean Whether or not to output faces that cause an error </li> <li class="parameter"> Query: configuration String Configuration string. </li> <li class="parameter"> 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. </li> </ul> <h2><a name="getFeatures"></a>getFeatures</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTFeatureListResponse"><a href="">BTFeatureListResponse</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wvm String One of w or v or m corresponding to whether a workspace or version or microversion was entered. </li> <li class="parameter"> Path: wvmid String Workspace (w), Version (v) or Microversion (m) ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> Query: featureId List(String) ID of a feature; repeat query param to add more than one </li> <li class="parameter"> 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. </li> <li class="parameter"> Query: noSketchGeometry Boolean Whether or not to output simple sketch info without geometry </li> </ul> <h2><a name="getMassProperties"></a>getMassProperties</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/massproperties</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTMassPropResponse"><a href="">BTMassPropResponse</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wvm String One of w or v or m corresponding to whether a workspace or version or microversion was entered. </li> <li class="parameter"> Path: wvmid String Workspace (w), Version (v) or Microversion (m) ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> 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 </li> <li class="parameter"> Query: massAsGroup Boolean If true, specified parts will be evaluated as a single object instead of individually </li> <li class="parameter"> Query: configuration String Configuration string. </li> <li class="parameter"> 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. </li> </ul> <h2><a name="getNamedViews2"></a>getNamedViews2</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/e/{eid}/namedViews</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTNamedViewsInfo"><a href="">BTNamedViewsInfo</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> Query: skipPerspective Boolean Whether views with a perspective projection should be omitted. </li> </ul> <h2><a name="getOpenApi"></a>getOpenApi</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/openapi</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model="OpenAPI"><a href="">OpenAPI</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Query: fileType String The type of file to return. Defaults to JSON. </li> <li class="parameter"> Query: excludedTags String If an operation contains an excluded tag, it is not returned from this endpoint. </li> <li class="parameter"> Query: includedTags String Return at most all the operations with tags included in includedTags. If not given, this will default to all tags. </li> <li class="parameter"> 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. </li> </ul> <h2><a name="getShadedViews1"></a>getShadedViews1</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/shadedviews</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTShadedRenderDocumentResponse"><a href="">BTShadedRenderDocumentResponse</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wvm String One of w or v or m corresponding to whether a workspace or version or microversion was entered. </li> <li class="parameter"> Path: wvmid String Workspace (w), Version (v) or Microversion (m) ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> 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. </li> <li class="parameter"> Query: outputHeight Integer Output image height (in pixels) </li> <li class="parameter"> Query: outputWidth Integer Output image width (in pixels) </li> <li class="parameter"> 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. </li> <li class="parameter"> Query: edges String The treatment to be applied to edges in the display. Options are show: show visible edges, hide: hide visible edges. </li> <li class="parameter"> 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. </li> <li class="parameter"> 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. </li> <li class="parameter"> 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. </li> <li class="parameter"> Query: configuration String Configuration string. </li> <li class="parameter"> 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. </li> </ul> <h2><a name="getTranslatorFormats4"></a>getTranslatorFormats4</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/w/{wid}/e/{eid}/translationformats</code> <h3 class="section">HTTP Method</h3> <code>GET</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTModelFormatInfo"><a href="">List</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wid String Workspace ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> 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. </li> </ul> <h2><a name="translateFormat5"></a>translateFormat5</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wv}/{wvid}/e/{eid}/translations</code> <h3 class="section">HTTP Method</h3> <code>POST</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTTranslationRequestInfo"><a href="">BTTranslationRequestInfo</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wv String One of w or v corresponding to whether a workspace or version was entered. </li> <li class="parameter"> Path: wvid String Workspace (w) or Version (v). </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> Body: BTTranslateFormatParams BTTranslateFormatParams(BTTranslateFormatParams) </li> </ul> <h2><a name="translateIds1"></a>translateIds1</h2> <hr> <h3 class="section">URL</h3> <code>http://localhost/api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/idtranslations</code> <h3 class="section">HTTP Method</h3> <code>POST</code> <h3 class="section">Response Type</h3> <div class="model" data-model="BTIdTranslationInfo"><a href="">BTIdTranslationInfo</a></div> <h3 class="section">Parameters</h3> <ul> <li class="parameter"> Path: did String Document ID. </li> <li class="parameter"> Path: wvm String One of w or v or m corresponding to whether a workspace or version or microversion was entered. </li> <li class="parameter"> Path: wvmid String Workspace (w), Version (v) or Microversion (m) ID. </li> <li class="parameter"> Path: eid String Element ID. </li> <li class="parameter"> Body: BTIdTranslationParams BTIdTranslationParams(BTIdTranslationParams) </li> </ul> </div>