getRequirement

Retrieves a requirement record based on number or summary. A SOAP error envelope is returned if the operation fails.

To retrieve a requirement based on record ID, use getRequirementByRecordID.

To edit a requirement, use editRequirement or editRequirementByRecordID.

Parameters

Parameter	Type	Description
cookie	long	Session cookie returned by projectLogon.
requirementNumber	long	Number of the requirement to retrieve. Set as 0 to search by summary.
summary	string	Summary of the requirement to retrieve. If the summary matches more than one requirement, the operation fails. This field is ignored unless requirementNumber is 0.
bDownloadAttachments	boolean	Indicates if attachments should be retrieved. Using False may improve performance when the file contents are not needed.

Return value

Value	Type
pRequirement	CRequirement

Example

CRequirement req = ttsdk.getRequirement(cookie, 0, "Requirement summary", false);