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

The IDocument type exposes the following members.

Methods

  NameDescription
Public methodAcknowledgeDocument
Enables a user to acknowledge a Document record.
Public methodAddDocumentRevisionTag
Enables a user to tag a document revision as being referenced by another system. This tag shows in the Q-Pulse UI against the record.
Public methodAddNote
Enables a user to add a note to a Document record.
Public methodAddUrlAttachmentItem
Allows the user to add an URL attachment item to a document attachment.
Public methodCreateNewDocument
Enables a user to raise a new Document record.
Public methodDeactivateDocument
Allows the user to update a document status to in-active or obsolete.
Public methodDistributeActiveDocument
Allows the user to distribute an active document.
Public methodGetDocument
Enables a user to view an existing Document record by supplying its document ID.
Public methodGetDocumentAndFolders
Enables a user to view an existing Document record and any associated folders by supplying its document ID.
Public methodGetDocumentAttachment
Enables a user to retrieve the attachment of a Document record.
Public methodGetDocumentByNumber
Enables a user to view an existing Document record by supplying its document number.
Public methodGetDocumentByRevisionID
Enables a user to view an existing Document record by supplying its document number and revision.
Public methodGetDocumentByRevisionReference
Enables a user to view an existing Document record by supplying its document number and revision.
Public methodGetDocumentFolderByID
Enables a user to retrieve their Document folders.
Public methodGetDocumentFolders
Enables a user to retrieve their Document folders.
Public methodGetDocumentFoldersByCategory
Enables a user to retrieve their Document folders by FolderCategory.
Public methodGetDocumentIDs
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()
Public methodGetDocumentIDsByFolder
Enables a user to retrieve IDs of Documents from a folder.
Public methodGetDocumentIDsByWorkload
Enables a user to search for IDs of Document records by workload e.g. outstanding distribution acknowledge ments.
Public methodGetDocuments
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.
Public methodGetDocumentsByFolder
Enables a user to retrieve Documents from a folder.
Public methodGetDocumentsByIDs
Enables a user to view the latest verion of Document records by supplying a list of document ID.
Public methodGetDocumentsByWorkload
Enables a user to search for Document records by workload e.g. outstanding distribution acknowledge ments.
Public methodGetDocumentSummaries
Enables a user to search for summaries of Document records.
Public methodGetDocumentSummariesByFolder
Enables a user to retrieve Document Summaries from a folder.
Public methodGetDocumentSummariesByIDs
Enables a user to view the latest verion of DocumentSummary records by supplying a list of document ID.
Public methodGetDocumentSummariesByWorkload
Enables a user to search for DocumentSummary records by workload e.g. outstanding distribution acknowledge ments.
Public methodGetWorkloads
Enables a user to search for Document related workloads e.g. outstanding distribution acknowledge ments.
Public methodRemoveDocumentRevisionTag
Allows the user to remove a tag from a document revision.
Public methodReviseDocumentToActive
Allows the user to revise an active document to new active revision.
Public methodUpdateDocumentRevisionTagReference
Allows the user to update a document revision tags source.
Public methodUpdateDocumentRevisionTagSource
Allows the user to update a document revision tags source.
Public methodUpdateDocumentRevisionTagText
Allows the user to update a document revision tags source.

See Also