Get Document Path

workdocs_get_document_path

R Documentation

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

Description¶

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.

Usage¶

workdocs_get_document_path(AuthenticationToken, DocumentId, Limit,
  Fields, Marker)

Arguments¶

AuthenticationToken: Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
DocumentId: [required] The ID of the document.
Limit: The maximum number of levels in the hierarchy to return.
Fields: A comma-separated list of values. Specify NAME to include the names of the parent folders.
Marker: This value is not supported.

Value¶

A list with the following syntax:

list(
  Path = list(
    Components = list(
      list(
        Id = "string",
        Name = "string"
      )
    )
  )
)

Request syntax¶

svc$get_document_path(
  AuthenticationToken = "string",
  DocumentId = "string",
  Limit = 123,
  Fields = "string",
  Marker = "string"
)