latestOpenAPI 3.0.1Apache 2.02026-08-133021,2261.8 MB

aaa3e1322450

PartStudio

Get the mass properties for a Part Studio.

Parts must have density. The returned schema includes the same information as in the Onshape Mass Properties Tool.

When three values are returned:

  • The first is the calculated value.
  • The second is the minimum possible value, considering tolerance.
  • The third is the maximum possible value, considering tolerance.

See the Part Studios API Guide for details and tutorials.

get/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/massproperties

Path parameters

didstring required

The id of the document in which to perform the operation.

wvm'w' | 'v' | 'm' required

Indicates which of workspace (w), version (v), or document microversion (m) id is specified below.

wvmidstring required

The id of the workspace, version or document microversion in which the operation should be performed.

eidstring required

The id of the element in which to perform the operation.

Query parameters

linkDocumentIdstring

The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both.

configurationstring

URL-encoded string of configuration values (separated by ;). See the Configurations API Guide for details.

rollbackBarIndexinteger

Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist.

elementMicroversionIdstring

A specific element microversion in which to evaluate the request.

partIdstring[]
massAsGroupboolean

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

useMassPropertyOverridesboolean

If true, use the user mass property overrides when calculated mass properties

Response

default response