AppElement

Get the JSON at specified paths for an element.

Use this endpoint to return the JSON at the specified path instead of returning the entire JSON for the element. This POST endpoint does not write any information.

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

Request

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

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.

transactionIdstring
changeIdstring

Request body

btTypestring

Type of JSON object.

pathsstring[]

Response

default response

Changes

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