Document

Retrieve insertables by document ID and workspace or version ID.

Changed on
get/documents/d/{did}/{wv}/{wvid}/insertables

Request

  • Base URL: https://api.onshape.com/api/v17
  • URL: https://api.onshape.com/api/v17/documents/d/{did}/{wv}/{wvid}/insertables
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token, scopes: OAuth2Read) and HTTP basic

Path parameters

didstring required
wvstring required
wvidstring required

Query parameters

elementIdstring
configurationstring
linkDocumentIdstring

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

includeElementGroupsboolean

Whether to include the element group object in the response (versions only).

includePartsboolean
includeSurfacesboolean
includeSketchesboolean
includeReferenceFeaturesboolean
includeAssembliesboolean
includeFeatureStudiosboolean
includeBlobsboolean
allowedBlobMimeTypesstring
excludeNewerFSVersionsboolean
maxFeatureScriptVersioninteger
includePartStudiosboolean
includeNonEmptyPartStudiosboolean
includeFeaturesboolean
includeMeshesboolean
includeWiresboolean
includeFlattenedBodiesboolean
includeApplicationsboolean
allowedApplicationMimeTypesstring
includeCompositePartsboolean
includeFSTablesboolean
includeFSComputedPartPropertyFunctionsboolean
includeVariablesboolean
includeVariableStudiosboolean
allowedBlobExtensionsstring
isObsoletionboolean

Response

default response

Changes

  • c16acb88e3eaRevision changes
    • info

      added the new optional query request parameter includeNonEmptyPartStudios

  • 5fa7a57a26ddRevision changes
    • info

      added the new optional query request parameter includeElementGroups

    • info

      added the optional property to the response with the status