[This is preliminary documentation and is subject to change.]

The IDocument type exposes the following members.

Methods

  NameDescription
AcknowledgeDocument
Enables a user to acknowledge a Document record.
AddNote
Enables a user to add a note to a Document record.
AddUrlAttachmentItem
Allows the user to add an URL attachment item to a document attachment.
CreateNewDocument
Enables a user to raise a new Document record.
DeactivateDocument
Allows the user to update a document status to in-active or obsolete.
DistributeActiveDocument
Allows the user to distribute an active document.
GetDocument
Enables a user to view an existing Document record by supplying its document ID.
GetDocumentAndFolders
Enables a user to view an existing Document record and any associated folders by supplying its document ID.
GetDocumentAttachment
Enables a user to retrieve the attachment of a Document record.
GetDocumentByNumber
Enables a user to view an existing Document record by supplying its document number.
GetDocumentByRevisionID
Enables a user to view an existing Document record by supplying its document number and revision.
GetDocumentByRevisionReference
Enables a user to view an existing Document record by supplying its document number and revision.
GetDocumentFolderByID
Enables a user to retrieve their Document folders.
GetDocumentFolders
Enables a user to retrieve their Document folders.
GetDocumentFoldersByCategory
Enables a user to retrieve their Document folders by FolderCategory.
GetDocumentIDs
Enables a user to search for Document records. This method is an alternative to GetDocuments(). Where GetDocuments() returns full descriptions of found records, GetDocumentIDs() returns only the Document record numbers. You can then retrieve the full details using GetDocument()
GetDocumentIDsByFolder
Enables a user to retrieve IDs of Documents from a folder.
GetDocumentIDsByWorkload
Enables a user to search for IDs of Document records by workload e.g. outstanding distribution acknowledge ments.
GetDocuments
Enables a user to search for Document records. This method is an alternative to GetDocumentIDs(). Where GetDocumentIDs() returns only the Document record Numbers, GetDocuments() returns full descriptions of found records.
GetDocumentsByFolder
Enables a user to retrieve Documents from a folder.
GetDocumentsByIDs
Enables a user to view the latest verion of Document records by supplying a list of document ID.
GetDocumentsByWorkload
Enables a user to search for Document records by workload e.g. outstanding distribution acknowledge ments.
GetDocumentSummaries
Enables a user to search for summaries of Document records.
GetDocumentSummariesByFolder
Enables a user to retrieve Document Summaries from a folder.
GetDocumentSummariesByIDs
Enables a user to view the latest verion of DocumentSummary records by supplying a list of document ID.
GetDocumentSummariesByWorkload
Enables a user to search for DocumentSummary records by workload e.g. outstanding distribution acknowledge ments.
GetWorkloads
Enables a user to search for Document related workloads e.g. outstanding distribution acknowledge ments.
ReviseDocumentToActive
Allows the user to revise an active document to new active revision.

See Also