ONonshape
AppElement

Update the content for the specified app element.

See API Guide: Structured Storage for more information.

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

Request

  • Base URL
    https://api.onshape.com/api/v17
  • URL
    https://api.onshape.com/api/v17/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content
  • Auth
    OAuth 2 and HTTP basic
    Authorization code: /oauth/authorize
    Token URL: /oauth/token scopes: OAuth2Read, OAuth2Write

Path parameters

didstring required
eidstring required
wvmstring required
wvmidstring required

Request body

descriptionstring

The label that will appear in the document's edit history for this operation. If blank, a value will be auto-generated.

jsonPatchstring

A json patch that will be applied to the application element's json data. The JSON patch format is as specified in RFC 6902 from the IETF.

parentChangeIdstring

The id of the last change made to this application element. This can be retrieved from the response for any app element modification endpoint.

returnErrorboolean

If true, errors in request processing will be returned in a 200 response with a meaningful description. Otherwise, errors will result in a relevant HTTP error response.

returnJsonDifferenceFormat'default' | 'full_path' | 'json_patch'

If specified, and jsonTreeEdit is non-empty, the json difference will be returned in this format, otherwise no json difference will be returned.

transactionIdstring

The id of the transaction in which this operation should take place. Transaction ids can be generated through the AppElement startTransaction API.

Response

default response

changeIdstring required

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

elementIdstring

The id of the edited element.

elementIdsstring[]

The ids of the edited elements, if multiple elements were edited.

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.

propertyEditsMergedboolean

When committing a transaction, this field indicates if the properties of the application element were changed after the transaction was created.

transactionIdstring

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

Changes

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