editRequirementDocumentByRecordID
Retrieves a requirement document record for editing based on record ID. A saveRequirementDocument 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 cancelSaveRequirementDocument.
To edit a document based on number or name, use editRequirementDocument.
Parameters
| Parameter | Type | Description |
|---|---|---|
| cookie | long | Session cookie returned by projectLogon. |
| recordID | long | Unique requirement document 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 |
|---|---|
| pRequirementDocument | CRequirementDocument |
Example
CRequirementDocument reqDoc = ttsdk.editRequirementDocumentByRecordID(cookie, 1, false);
try
{
reqDoc.name = "Requirement document name SOAP EDIT";
// The following line throws an exception if the operation fails.
ttsdk.saveRequirementDocument(cookie, reqDoc);
}
catch (Exception e)
{
// The following option unlocks the record.
ttsdk.cancelSaveRequirementDocument(cookie, reqDoc.recordid);
}