editTestRun

Retrieves a test run record for editing based on number or summary. A saveTestRun 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 cancelSaveTestRun.

To edit a test run based on record ID, use editTestRunByRecordID.

Test runs saved in detail grid view cannot be edited using the Helix ALM SDK.

Parameters

Parameter Type Description
cookie long Session cookie returned by projectLogon.
testRunNumber long Number of the test run to edit. Set as 0 to search by summary.
summary string Summary of the test run to edit. If the summary matches more than one test run, the operation fails. This field is ignored unless testRunNumber 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
pTestRun CTestRun

Example

CTestRun tr = ttsdk.editTestRun(cookie, 0, "Test run summary", false);

 

try

{

tr.summary = "Test run summary SOAP EDIT";

 

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

ttsdk.saveTestRun(cookie, tr);

}

catch (Exception e)

{

// The following operation unlocks the record.

ttsdk.cancelSaveTestRun(cookie, tr.recordid);

}