getTask

Retrieves a Workbook task record based on summary. A SOAP error envelope is returned if the operation fails.

To retrieve a task based on record ID, use getTaskByRecordID.

To edit a task, use editTask or editTaskByRecordID.

Defects, test cases, test runs, requirements, and requirement documents in the Workbook cannot be retrieved with this operation.

Parameters

Parameter Type Description
cookie long Session cookie returned by projectLogon.
summary string Summary of the task to retrieve. If the summary matches more than one task, the operation fails.

Return value

Value Type
pTask CTask

Example

CTask task = ttsdk.getTask(cookie, "Task summary");