AppElement

Creates a reference to an app element.

post/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references

Request

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

Path parameters

didstring required
eidstring required
wvmstring required
wvmidstring required

Request body

hasDocumentMicroversionsboolean
idTagstring
idTagMicroversionIdstring
isLockedboolean
isSketchOnlyboolean
parentChangeIdstring
parentViewIdstring
partNumberstring
pureSketchboolean
referenceTypeinteger
returnErrorboolean
revisionstring
sketchIdsstring[]
targetConfigurationstring
targetDocumentIdstring
targetElementIdstring
targetMicroversionIdstring
targetVersionIdstring
trackNewVersionsboolean
transactionIdstring
updateSketchInfoboolean

Response

default response

changeIdstring required

The latest change id for the element, after the edit was committed.

errorCodeinteger

0: OK (healthy) | 1: INFO | 2: WARNING | 3: ERROR (dangling or view generation call failed) | 4: UNKNOWN

errorDescriptionstring

A human-readable value for the error that occurred, if one occurred.

errorValue'OK' | 'TRANSACTION_CONFLICT' | 'NOT_FOUND' | 'INCONSISTENT_CHANGES'
parentChangeIdstring

The latest change id for the element, before the edit was made.

referenceIdstring
transactionIdstring

The id of the transaction in which the edit was applied.

Changes

No recorded changes to this operation across all 14 revisions of this API.