PartStudio

Get a list of features instantiated in the Part Studio.

Changed on

See the Features API Guide for additional information.

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

Request

  • Base URL
    https://api.onshape.com/api/v17
  • Auth
    OAuth 2 and HTTP basic
    Authorization code/oauth/authorize
    Token URL/oauth/token
    ScopesOAuth2Read

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.

includeGeometryIdsboolean

If true, include the underlying geometry IDs in the feature definition.

featureIdstring[]

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

noSketchGeometryboolean

Whether or not to output simple sketch info without geometry

Response

default response

btTypestring

Type of JSON object.

featureStatesobject

State of each feature, indicating if the feature is valid. Incorrectly defined features will still appear in the Feature list.

isCompleteboolean

true if the features represent the entire part studio or false for a filtered subset.

libraryVersioninteger

FeatureScript version used in the Part Studio. Do not modify.

microversionSkewboolean

On output, true indicates a microversion mismatch was encountered.

rejectMicroversionSkewboolean

If true, the call will refuse to make the addition if the current microversion for the document does not match the source microversion. If false, a best-effort attempt is made to re-interpret the feature addition in the context of a newer document microversion.

rollbackIndexinteger

Index of the rollback bar location. -1 indicates the bar is at the end of the Feature List.

serializationVersionstring

Version of the structure serialization rules used to encode the output. This enables incompatibility detection during software updates.

sourceMicroversionstring

The document microversion from which the result was extracted. Part, face, edge, and vertex IDs are only valid for the same microversion.

Changes

    • info

      added BTMSketch3D-2231 discriminator mapping keys to the / response property for the response status

    • info

      added BTMSketch3D-2231 discriminator mapping keys to the / response property for the response status

    • info

      added BTMSketch3DEntity-5972 discriminator mapping keys to the ////// response property for the response status

    • info

      added BTMSketch3DEntity-5972 discriminator mapping keys to the ////// response property for the response status

    • info

      added BTMSketch3DEntity-5972 discriminator mapping keys to the ///// response property for the response status