latestOpenAPI 3.0.1Apache 2.02026-08-133021,2261.8 MB

aaa3e1322450

ProductStructure

Find where a part or assembly is used.

Only supported for Enterprise and Professional plans. See Dev Docs: Where Used for a tutorial on using this endpoint.

get/productstructure/whereused

Query parameters

documentIdstring

Document that contains the part or assembly.

elementIdstring

Element that contains the part or assembly.

versionIdstring

Version that contains the part or assembly. One of versionId and useLatestVersion is required.

configurationstring

URL-encoded string of configuration values (separated by ;). See the Configurations API Guide for details.

partIdstring

Part to find. When elementId is a Part Studio, partId or partNumber is required. Call getPartsWMVE to get a list of parts in the Part Studio.

partNumberstring

Part to find. When elementId is a Part Studio, partId or partNumber is required. Call getPartsWMVE to get a list of parts in the Part Studio.

includePropertiesboolean

If true, include metadata properties for each result item.

filterinteger

Filter results by one of the following: 0: LATEST_REVISION, 1: ALL_REVISIONS, 2: ALL_VERSIONS (default), 3: ALL, 5: LATEST_VERSIONS, 6: MOST_RECENT_REVISION.

includeVersionInfoboolean

If true, include the list of document versions in which the queried item has been referenced by other documents. Each entry contains the version ID and name.

useLatestVersionboolean

If true, automatically resolves to the most recent referenced document version for the queried item. One of versionId and useLatestVersion is required.

limitToTypesstring

Comma-separated list of element types to limit results to. Valid values: 0: PARTSTUDIO, 1: ASSEMBLY, 2: DRAWING.

Response

Success!