Metadata

Get the metadata for all elements in a document.

See API Guide: Metadata for details.

  • You can specify the optional depth query parameter to get multiple levels in an assembly. Default depth is 1.
  • linkDocumentId can be specified where applicable. Combined with inferMetadataOwner (default value is false), this is used to infer metadata owner.
  • includeComputedProperties can be used to include or omit computed properties. Default value is true.
  • includeComputedAssemblyProperties can be used to query computed assembly properties which are generally expensive. Default value is false.
  • You can also choose to include a thumbnail. Default value is false.
get/metadata/d/{did}/{wvm}/{wvmid}/e

Request

  • Base URL: https://cad.onshape.com/api/v17
  • URL: https://cad.onshape.com/api/v17/metadata/d/{did}/{wvm}/{wvmid}/e
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token, scopes: OAuth2Read) and HTTP basic

Path parameters

didstring required
wvmstring required
wvmidstring required

Query parameters

linkDocumentIdstring
inferMetadataOwnerboolean
depthstring
includeComputedPropertiesboolean
includeComputedAssemblyPropertiesboolean
thumbnailboolean

Response

default response

Changes

No recorded changes to this operation across all 1 revision of this API.