getRecordListForTable

Retrieves a list of records for a specific item type. A SOAP error envelope is returned if the operation fails.

To dynamically filter the results, use the getRecordListForTableWithQuery operation instead. You can use a JSON query to narrow results instead of using a filter that already exists in Helix ALM. You can also use a JSON query combined with a filter to further narrow the results. Returning fewer results may improve the speed of your SOAP applications.

Parameters

Parameter	Type	Description
cookie	long	Session cookie returned by projectLogon.
tablename	string	Table name to retrieve information from. Valid values: Defect, Test Case, Test Run, Requirement, Requirement Document, Test Variant, User, Customer, Task, Test Config, Folder, and Report. Use getTableList to retrieve a list of available tables.
filtername	string	Filter name to apply to the results. Set as an empty string to use no filter. Use getFilterListForTable to retrieve a list of filters for the table. Interactive filters are not supported.
columnlist	CTableColumn[]	List of columns in the table to retrieve information from. Limits the returned data to specific columns and you can apply a filter. Use the "Record ID" column name (case sensitive) to retrieve the record ID for a list of items.

Return value

Value	Type
recordlist	CRecordListSoap

Example

string[] columnNames = {"Number", "Status", "Summary"};

 

CTableColumn[] columns = new CTableColumn[columnNames.Length];

 

for (int x = 0; x < columns.Length; x++)

{

}

 

CRecordListSoap recList = ttsdk.getRecordListForTable(cookie, "Defect", "", columns);