CRequirementDocument

Contains information for a specific requirement document.

To retrieve the requirements tree for a document using the document ID, use getDocumentTree.

To append a requirement to a document, use appendToRequirementDocument.

To retrieve a list of requirements associated with a requirement document, use getRequirementIDsForDocument. To retrieve a list of documents a requirement is associated with, use getDocumentIDsForRequirement.

Extends

CItemToTrack

Fields

Field	Type	Description
recordid	long	Unique document record ID.
number	long	Unique document number. If the project is configured to not automatically assign numbers, the value is 0.
name	string	Document name.
description	string	Multi-line text field. See Working with multi-line text fields for formatting information.
descriptionInlineAttachList	CFileAttachment[]	CFileAttachment items associated with the document Description field.
state	string	Dropdown list value. May be a renamed field. Use getDropdownFieldValuesForTable to retrieve a list of field values.
attachmentList	CFileAttachment[]	CFileAttachment items associated with the document.
sccFileList	CSCCFileRecord[]	Source control files attached to the document.
customFieldList	CField[]	Custom field values for the document.
eventList	CEvent[]	Workflow events associated with the document.
snapshotList	CSnapshotInfo[]	Document snapshot version information.
dateTimeCreated	DateTime	Date the document was added.
createdByUser	string	User who added the document. See Formatting name fields for formatting information.
locationAddedFrom	string	Method used to add the document. Read only.
modifiedByUser	string	User who last modified the document. See Formatting name fields for formatting information.
dateTimeModified	DateTime	Date the document was last modified.
actualHours	double	Total number of actual effort hours. Read only.
estimatedHours	double	Number of estimated hours to complete the document. Read only.
remainingHours	double	Number of remaining hours to complete the document. Read only.
variance	double	Difference between actualHours and remainingHours compared to estimatedHours. Read only.
storyPoints	long	Unit-less quantity representation of time remaining.
percentDone	long	Percent complete for the document. Read only.

Returned by

• editRequirementDocumentByRecordID
• editRequirementDocument
• getRequirementDocumentByRecordID
• getRequirementDocument

Used in

• addRequirementDocument
• saveRequirementDocument