Drawing

Modify a drawing via JSON payload.

See API Guide: Drawings for more information.When polling for drawing modifications to complete, use a reasonable interval (e.g., avoid polling multiple times a second, use an exponential backoff strategy, etc.). See Rate Limiting and API Limits for more information.

post/drawings/d/{did}/w/{wid}/e/{eid}/modify

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

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

widstring required

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

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.

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.

Example request

{
  "jsonRequests": [
    {
      "description": "Replicate annotations",
      "formatVersion": "2021-01-01",
      "messageName": "onshapeCreateAnnotations"
    }
  ]
}

Response

default response

documentIdstring
elementIdstring
failureReasonstring
hrefstring uri

URI to fetch complete information of the resource.

idstring

Id of the resource.

namestring

Name of the resource.

outputstring
outputStatusCodeinteger
parentDocumentMicroversionIdstring
parentElementMicroversionIdstring
requestState'ACTIVE' | 'DONE' | 'FAILED'
resultDocumentMicroversionIdstring
resultElementMicroversionIdstring
viewRefstring uri

URI to visualize the resource in a webclient if applicable.

workspaceIdstring

Changes

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