Previous Topic: getDocumentsByIDsNext Topic: createDocument


getDocument

The following parameters apply to the getDocument method:

Parameter

Type

Description

SID

Integer

Identifies the session retrieved from logging in.

docId

Integer

Identifies the document ID to retrieve.

propertyList

String

Identifies the comma-separated list of database fields from which you want to retrieve information. Leave blank to retrieve all fields.

relatedDoc

Boolean

Indicates whether to retrieve a list of documents that are related to this document.

getAttmnt

Boolean

Indicates whether to retrieve the list of attachments and URL links for the document.

getHistory

Boolean

Indicates whether you want to retrieve the complete history for the document.

getComment

Boolean

Indicates whether you want to retrieve all comments for the document.

getNotiList

Boolean

Indicates whether you want to retrieve the email notification list for the document.

Description

Retrieves information for a document.

Returns

A <UDSObject> node, as described in the <UDSObject> Node Description, with requested <Attributes> provided by the propertList parameter.