v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444236171.7 KB

Retrieves the path information (the hierarchy from the root folder) for the requested document.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

get/api/v1/documents/{DocumentId}/path

Path parameters

DocumentIdstring required

The ID of the document.

Query parameters

limitinteger

The maximum number of levels in the hierarchy to return.

fieldsstring

A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.

markerstring

This value is not supported.

Headers

Authenticationstring password

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Response

Success