Show/Hide Toolbars

This request can perform two functions based on the document unique key parameter.

If you pass the unique key of a document file (parent), the response includes older document versions of that file.

If you pass the unique key of a folder, the response includes documents within that folder.

Parameters

readChildDocuments Parameter Descriptions

Parameter Name

Data Type

Description

parentUniqueKey

string

Either the unique key of the document record whose children (previous document versions) to return or the unique key of a folder.

properties

List<String>

A list of String values that identify the property names whose values to return with the resulting document.

Response

readChildDocuments Response Descriptions

Parameter Name

Data Type

Description

documents

List<document>

If the parentUniqueKey was a document file unique key, the list of documents includes previous versions of the given document.

If the parentUniqueKey was a document folder unique key, the list of documents includes the files, folders, shortcuts, and hyperlinks in the given folder.

A document record. Only specified property values are returned with the record.