Retrieving information from the Helix ALM Server

To create a SOAP message that returns specific information from the Helix ALM Server, use the getRecordListForTable or getRecordListForTableWithQuery operations.

getRecordListForTable operation

The getRecordListForTable operation retrieves a list of items (rows) of a specific type based on a filter that already exists in Helix ALM. You can specify the columns to return. For example, you can create a SOAP message that returns a filtered list of issues, including the numbers, summaries, and assigned users.

getRecordListForTable can return fields from the following item types: customers, folders, issues, reports, requirements, requirement documents, test cases, test configurations, manual test runs, test variants, users, and workbook tasks.

See getRecordListForTable for more information and an example.

getRecordListForTableWithQuery operation

The getRecordListForTableWithQuery operation retrieves a list of items of a specific type based on a JSON query. This lets you perform a more dynamic query and narrow the number of items returned without using a filter that already exists in Helix ALM. You can use a JSON query combined with an existing filter to further narrow the results. Returning fewer results may improve the speed of your SOAP applications. For example, you can create a SOAP message that returns issues that contain a specific text string that your SOAP application code calculates.

getRecordListForTableWithQuery can return fields from the following item types: issues, requirements, requirement documents, test cases, and manual test runs.

See getRecordListForTableWithQuery for more information and an example.

Additional notes

• Manual test runs retrieved from the Helix ALM SDK typically return -1 for empty item fields. The Manual Test Run Estimated Run Time field is an exception because it always has data. If the manual test run uses this field to calculate estimated hours, 0 is returned if the field is empty or set to 0:00:00.