[This is preliminary documentation and is subject to change.]
The Document type exposes the following members.
Fields
| Name | Description | |
|---|---|---|
| ActiveDateTime |
Active Date
| |
| AffectedDocumentID |
ID of the Affected Document
| |
| ApproverNotesCount |
Number of Approver Notes
| |
| ApproversCount |
Number of Approvers
| |
| AttachmentName |
Name of Attachment
| |
| AuthorPersonID |
ID of the Document author
If a value is not assigned to this, the user associated
with the authentication token will be assigned as the Author.
| |
| AuthorPersonName |
Name of the Document author
| |
| BrokenRulesCollection |
A collection of broken rules on the object.
| |
| CanAcknowledgeReceipt |
boolean indicating whether receipt of Document can be acknowledged
| |
| CanDistribute |
boolean indicating whether the Document can be distributed
| |
| CanRespond |
boolean indicating whether response to Document is allowed
| |
| ChangeAttachmentName |
Change Attachment Name
| |
| ChangeDetails |
Change Details
| |
| ChangeRequestsCollection |
Change Requests associated with this Document
| |
| ChangeRequestsCount |
Number of Change Requests
| |
| CopyHoldersCollection |
Copy Holders associated with this Document
| |
| CopyHoldersCount |
Number of Copy Holders
| |
| CreatedByPersonID |
ID of the person who created the Document
| |
| DoCheckIn |
DoCheckIn
| |
| DocumentDeleted |
boolean indicating whether Document has been deleted
| |
| DocumentID |
ID of the Document
| |
| DocumentNotesCollection |
Notes associated with Document
| |
| DocumentRelatedDepartmentID |
ID of Related Department
| |
| DocumentRelatedDepartmentsCollection |
Departments related to this Document
| |
| DocumentRelatedDocumentsIDs |
IDs of Related Documents
| |
| DocumentRelatedProcessesCollection |
Processes related to this Document
| |
| DocumentRelatedStandardsCollection |
Standards related to this Document
| |
| DocumentReviewsCollection |
Document Reviews associated with this Document
| |
| DocumentTypeDescription |
Description of Document Type
| |
| DocumentTypeID |
This is a mandatory field. ID of Document Type.
possible values can be obtained via the GetManagedList()
method of the Core service.
| |
| FriendlyName |
FriendlyName
| |
| HasAttachedFiles |
boolean indicating whether Document has files attached
| |
| HasDraftRevision |
boolean indicating whether Document has a draft revision
| |
| HasDraftText |
Draft Text
| |
| ID |
ID
| |
| ImplementByDateTime |
Implement By Date
| |
| IsCheckedOut |
boolean indicating whether Document is checked out
| |
| IsOnlyVisibleToAuthor |
boolean indicating whether document is only visible to Author
| |
| Keywords |
Keywords
| |
| LastCycleStatusID |
ID of Last Cycle Status
| |
| Number |
This is a mandatory field. Document Number.
If this isn't specified, a Document Number will be generated based
on the Document Type specified.
| |
| OwnerPersonID |
ID of the Document owner.
If a value is not assigned to this, the user associated
with the authentication token will be assigned as the Owner.
| |
| OwnerPersonName |
Name of the Document owner
| |
| PersonTrainingEventRenewBy |
date to renew Person Training events by
| |
| RenewPeronTrainingEvents |
boolean indicating whether to renew Person Training events
| |
| ReviewDateTime |
Review Date
| |
| ReviewsCount |
Number of reviews
| |
| RevisionIDs |
IDs of the Revisions associated with this Document.
Use GetRevision() Service method to fetch the Revision.
| |
| RevisionReference |
Document Revision Reference. This is assigned a
default value.
| |
| Status |
Status info related to Document
| |
| StatusName |
Status Name
| |
| SubmissionDateTime |
Submission Date
| |
| Title |
Title
| |
| UserDefinedField1Description |
UserDefinedField1 Description
| |
| UserDefinedField1ID |
UserDefinedField1 ID
| |
| UserDefinedField2Description |
UserDefinedField2 Description
| |
| UserDefinedField2ID |
UserDefinedField2 ID
| |
| UserDefinedField3Description |
UserDefinedField3 Description
| |
| UserDefinedField3ID |
UserDefinedField3 ID
| |
| UserDefinedField4Description |
UserDefinedField4 Description
| |
| UserDefinedField4ID |
UserDefinedField4 ID
| |
| UserDefinedField5PersonID |
UserDefinedField5 Person ID
| |
| UserDefinedField5PersonName |
UserDefinedField5 Person Name
|