Request

Description

insertDocument

Saves a new Document object to the

repository.

createShortcut

Creates a shortcut or link to a document (file, folder, or existing shortcut) with a given unique key. The parentFolderUniqueKey defines the folder where the shortcut will be created.

createSubFolder

Creates a sub-folder with given name

in given parent folder.

createHyperlinkDefaultCategory

Creates a hyperlink and sets its category to the default Document category.

createHyperlink

Creates a hyperlink.

updateDocument

Updates a previously saved document.

readDocument

Retrieves a Document from the repository based on a unique key. For a list of available properties, see the type class, Document.

readDocumentsByCriteria

Retrieves a set of documents based on specified criteria. If the criteria is empty, then the search will be for all documents. The specified limit takes precedence over the current system setting for the maximum number of search results to obtain. For a list of available properties, see the type class, Document.

readChildDocuments

Performs two functions:

•For a given document file (parent), gets older document versions of that file.

•For a given folder, gets documents within that folder.

Returns documents with only specified property values. For a list of available properties, see the type class, document.

readChildDocumentForName

Retrieves a document from the repository given the file name and the unique ID of its parent folder.

readDocumentFolderForDocumentOwner

Retrieves a document folder from the repository given the unique key of the folder's owner (user).

readDocumentByPath

Retrieves a Document from the repository based on a folder path.

checkOut

Attempts to check out a document with a given unique key.

undoCheckOut

Attempts to undo check out of a given document.

checkIn

Attempts to check in a document with a given unique key.

revert

Attempts to revert a given document to a given old version.

moveDocument

Moves a document to a new parent folder.

copyDocument

Copies a document to a new parent folder.

deleteDocument

Deletes the persistent document specified by the unique key.

ReadRecentlyViewedDocuments

Retrieves a list of recently viewed documents.

setDocumentAsRecentlyViewed

Set a document as recently viewed.

readFolderHierarchy

Retrieves a hierarchical list of document folders for one or more projects.

Data Object

Description

1 document

2 documentCreate

3 documentUpdate

1 Document record property container returned when you read or search documents. When defining a repository search's return properties, refer to the property names defined in this object.

2 Document record property container used to set a new document's properties. This object is passed as a request parameter when you create (insert) a document.

3 Document record property container used to update or clear a document's properties. This object is passed as a request parameter when you update a document.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TDocument object.

documentContentType

This object defines the document file type. In an application you would typically use this object's properties to read or search documents.

Note: For more information about the data restrictions for properties that belong to this object, see the Object Model Reference for the YDocuContentType object.

documentType

An enumeration used to indicate the document type.

Options include:

•FILE

•FOLDER

•HYPERLINK

•SHORTCUT

•HISTORY—the documentType for previous versions of a document file. Note that a document with documentType HISTORY is different from a history record.

Note: For more information about the data restrictions for properties that belong to this object, see the Object Model Reference for the YDocuContentType object.