Sign in
latestOpenAPI 3.0.1Apache 2.02026-08-133021,2261.8 MB

aaa3e1322450

Document

Retrieve tabs and folders by document ID and workspace or version or microversion ID.

Returns information on tabs and folders in the document.

get/documents/d/{did}/{wvm}/{wvmid}/contents

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.

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.

elementType'PARTSTUDIO' | 'ASSEMBLY' | 'DRAWING' | 'FEATURESTUDIO' | 'BLOB' | 'APPLICATION' | 'TABLE' | 'BILLOFMATERIALS' | 'VARIABLESTUDIO' | 'PUBLICATIONITEM' | 'UNKNOWN'

If specified, information for elements of this type are returned. Note, the folder structure is not affected by this filter.

elementIdstring

If specified, only the element with this id is returned. Note, the folder structure is not affected by this filter.

withZipContentsboolean

When true, returns the names of the files inside each zip file tab. Ignored if the document contains more than 10 zip files.

Response

default response