CRequirement
Contains information for a specific requirement.
To retrieve a list of requirements associated with a document, use getRequirementIDsForDocument. To retrieve a list of documents a requirement is associated with, use getDocumentIDsForRequirement.
To append a requirement to a document, use appendToRequirementDocument.
Extends
Fields
| Field | Type | Description |
|---|---|---|
| recordid | long | Unique requirement record ID. |
| number | long | Unique requirement number. If the project is configured to not automatically assign numbers, the value is 0. |
| type | string | Dropdown list value. May be a renamed field. Use getDropdownFieldValuesForTable to retrieve a list of field values. |
| summary | string | Requirement summary. |
| tag | string | Requirement type tag. Read only. |
| dateEntered | DateTime | Date the requirement was entered. |
| enteredBy | string | User who entered the requirement. Set to the current SOAP user if another value is not specified. See Formatting name fields for formatting information. |
| importance | string | Dropdown list value. May be a renamed field. Use getDropdownFieldValuesForTable to retrieve a list of field values. |
| description | string | Multi-line text field. See Working with multi-line text fields for formatting information. |
| descriptionInlineAttachList | CFileAttachment[] | CFileAttachment items associated with the requirement Description field. |
| state | string | Current workflow state of the requirement. |
| attachmentList | CFileAttachment[] | CFileAttachment items associated with the requirement. |
| sccFileList | CSCCFileRecord[] | Source control files attached to the requirement. |
| customFieldList | CField[] | Custom field values for the requirement. |
| eventList | CEvent[] | Workflow events associated with the requirement. |
| versionList | CVersionInfo[] | List of requirement versions. |
| dateTimeCreated | DateTime | Date the requirement was added. |
| createdByUser | string | User who entered the requirement. See Formatting name fields for formatting information. |
| locationAddedFrom | string | Method used to add the requirement. Read only. |
| modifiedByUser | string | User who last modified the requirement. See Formatting name fields for formatting information. |
| dateTimeModified | DateTime | Date the requirement was last modified. |
| actualHours | double | Total number of actual effort hours. Read only. |
| estimatedHours | double | Number of estimated hours to complete the requirement. Read only. |
| remainingHours | double | Number of remaining hours to complete the requirement. 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 requirement. Read only. |
Returned by
Used in