editRequirementByRecordID

Retrieves a requirement record for editing based on record ID. A saveRequirement operation must be used with this operation to save any changes to the record. A SOAP error envelope is returned if the operation fails.

To unlock the record without saving changes, use cancelSaveRequirement.

To edit a requirement based on number or summary, use editRequirement.

Parameters

Parameter Type Description
cookie long Session cookie returned by projectLogon.
recordID long Unique requirement record ID.
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.editRequirementByRecordID(cookie, 1, false);

 

try

{

req.summary = "Requirement summary SOAP EDIT";

 

// The following line throws an exception if the operation fails.

ttsdk.saveRequirement(cookie, req);

}

catch (Exception e)

{

// The following operation unlocks the record.

ttsdk.cancelSaveRequirement(cookie, req.recordid);

}