Operations

The Helix ALM SDK includes the following operations. Examples in C# are provided in for each operation.

The Helix ALM SDK uses the following names for item types: defects, requirements, requirement documents, test cases, and test runs. Keep in mind that your organization may have renamed these items in Helix ALM. The default terminology for ‘defect’ changed to ‘issue’ and 'test run' changed to 'manual test run'. To preserve backward compatibility, the SDK uses ‘defect’ and 'test run'.

Operation	Use to:
addCustomer	Add a customer to the project.
addDefect	Add a defect to the project.
addDefectWithLink	Add a defect from a test run and links the items.
addDropdownFieldValuesForTable	Add list values to an existing dropdown field.
addEntityToFolderByRecordID	Add an existing item to a folder in the project.
addFolder	Add a folder to the project.
addGlobalCustomer	Import a global customer from the Helix ALM License Server to the Helix ALM database and project.
addGlobalUser	Import a global user from the Helix ALM License Server to the Helix ALM database and project.
addLink	Add a link between items in the project.
addRequirement	Add a requirement to the project.
addRequirementDocument	Add a requirement document to the project.
addTask	Add a Workbook task to the project.
addTestCase	Add a test case to the project.
addTestConfig	Add a test configuration to the project.
addUser	Add a local user to the project.
appendToRequirementDocument	Append a requirement to the end of a requirement document or to a parent requirement in the document.
cancelSaveCustomer	Unlock a customer record locked for editing.
cancelSaveDefect	Unlock a defect record locked for editing.
cancelSaveFolder	Unlock a folder record locked for editing.
cancelSaveFolderItemRank	Unlock a folder record locked for editing the rank of items in the folder.
cancelSaveLink	Unlock a link record locked for editing.
cancelSaveRequirement	Unlock a requirement record locked for editing.
cancelSaveRequirementDocument	Unlock a requirement document record locked for editing.
cancelSaveTask	Unlock a Workbook task record locked for editing.
cancelSaveTestCase	Unlock a test case record locked for editing.
cancelSaveTestConfig	Unlock a test configuration record locked for editing.
cancelSaveTestRun	Unlock a test run record locked for editing.
cancelSaveUser	Unlock a user record locked for editing.
changeRequirementType	Change the type of a requirement.
createDefectForTestRun	Create a defect from a test run.
createSnapshot	Create a requirement document snapshot.
databaseLogoff	End the SOAP session and log out the user from the project.
deleteCustomer	Delete a customer from the project based on name.
deleteCustomerByRecordID	Delete a customer from the project based on record ID.
deleteDefect	Delete a defect from the project based on number or summary.
deleteDefectByRecordID	Delete a defect from the project based on record ID.
deleteFolder	Delete a folder from the project based on path.
deleteFolderByRecordID	Delete a folder from the project based on record ID.
deleteLink	Delete a link from the project.
deleteRequirement	Delete a requirement from the project based on number or summary.
deleteRequirementByRecordID	Delete a requirement from the project based on record ID.
deleteRequirementDocument	Delete a requirement document from the project based on number or name.
deleteRequirementDocumentByRecordID	Delete a requirement document from the project based on record ID.
deleteTask	Delete a Workbook task from the project based on summary.
deleteTaskByRecordID	Delete a Workbook task from the project based on record ID.
deleteTestCase	Delete a test case from the project based on number or summary.
deleteTestCaseByRecordID	Delete a test case from the project based on record ID.
deleteTestConfig	Delete a test configuration from the project based on name.
deleteTestConfigByRecordID	Delete a test configuration from the project based on record ID.
deleteTestRun	Delete a test run from the project based on number or summary.
deleteTestRunByRecordID	Delete a test run from the project based on record ID.
deleteUser	Delete a user from the project based on name.
deleteUserByRecordID	Delete a user from the project based on record ID.
editCustomer	Retrieve a customer record for editing based on name.
editCustomerByRecordID	Retrieve a customer record for editing based on record ID.
editDefect	Retrieve a defect record for editing based on number or summary.
editDefectbyRecordID	Retrieve a defect record for editing based on record ID.
editFolder	Retrieve a folder record for editing based on path.
editFolderByRecordID	Retrieve a folder record for editing based on record ID.
editFolderItemRank	Retrieve item ranking for a folder record for editing.
editLink	Retrieve a link record for editing.
editRequirement	Retrieve a requirement record for editing based on number or summary.
editRequirementByRecordID	Retrieve a requirement record for editing based on record ID.
editRequirementDocument	Retrieve a requirement document record for editing based on number or name.
editRequirementDocumentByRecordID	Retrieve a requirement document record for editing based on record ID.
editTask	Retrieve a Workbook task record for editing based on summary.
editTaskByRecordID	Retrieve a Workbook task record for editing based on record ID.
editTestCase	Retrieve a test case record for editing based on number or summary.
editTestCaseByRecordID	Retrieve a test case record for editing based on record ID.
editTestConfig	Retrieve a test configuration record for editing based on name.
editTestConfigByRecordID	Retrieve a test configuration record for editing based on record ID.
editTestRun	Retrieve a test run record for editing based on number or summary.
editTestRunByRecordID	Retrieve a test run record for editing based on record ID.
editUser	Retrieve a user record for editing based on name.
editUserByRecordID	Retrieve a user record for editing based on record ID.
formattedTextSupport	Enable or disable rich text support for fields.
generateBatchTestRuns	Generate test cases from multiple test cases.
generateTestRuns	Generate test runs from one test case.
getAttachment	Retrieve an attachment from an item or a workflow event on an item.
getAttachmentTypes	Retrieve a list of attachment type names.
getColumnsForTable	Retrieve column names from a table.
getCustomer	Retrieve a customer record based on name.
getCustomerByRecordID	Retrieve a customer record based on record ID.
getCustomFieldsDefintionList	Retrieve a list of custom field definitions from a table.
getDefect	Retrieve a defect record based on number or summary.
getDefectByRecordID	Retrieve a defect record based on record ID.
getDefectCustomFieldsDefinitionList	Retrieve a list of custom field definitions from the Defect table.
getDocForExportTemplate	Export items to a Microsoft Word document.
getDocForExportTemplateFolder	Export items from a specific folder to a Microsoft Word document.
getDocForExportTemplateReqDoc	Export a requirement document to a Microsoft Word document.
getDocumentIDsForRequirement	Retrieve a list of requirement document IDs associated with a requirement.
getDocumentTree	Retrieve the requirement hierarchy from a requirement document.
getDropdownFieldForTable	Retrieve the dropdown fields from a table.
getDropdownFieldValuesForTable	Retrieve the dropdown field values from a field.
getEntityListForFolderByRecordID	Retrieve a list of items in a folder by folder record ID.
getEventDefinitionList	Retrieve a list of workflow event definitions from a table.
getFilterList	Retrieve a list of filters in the project.
getFilterListForTable	Retrieve a list of filters from a table.
getFolder	Retrieve a folder record based on path.
getFolderByRecordID	Retrieve a folder record based on record ID.
getFolderListForEntityByRecordID	Retrieve a list of folders an item is in.
getFolderPathSeparator	Retrieve the byte equivalent of the separator character used in folder paths (/).
getFolderTree	Retrieve the folder hierarchy for a public or private folder by path.
getFolderTreeByRecordID	Retrieve the folder hierarchy for a public or private folder based on record ID.
getFolderTypeByName	Retrieve a folder type based on name.
getFolderTypeList	Retrieve a list of folder types in the project.
getGlobalCustomerList	Retrieve a list of global customers from the Helix ALM License Server.
getGlobalUserList	Retrieve a list of global users from the Helix ALM License Server.
getItemHyperlinks	Retrieve a hyperlink that can be used to access an item using the Helix ALM native or web clients.
getLink	Retrieve a link based on record ID.
getLinkDefinitionValues	Retrieve a list of link definitions in the project.
getLinksForDefect	Retrieve a list of links associated with a defect record.
getLinksForItem	Retrieve a list of links associated with an item.
getProjectDataOptionList	Retrieve a list of Helix ALM areas users can log in to (issue management, requirements management, and test case management).
getProjectList	Retrieve a list of available projects that a user can log in to.
getRecordListForTable	Retrieve a list of records for a specific item type.
getRecordListForTableWithQuery	Retrieve a list of records for a specific item type and limit the results using a JSON query.
getReportRunResultsByName	Run a report and return results based on report name.
getReportRunResultsByRecordID	Run a report and return results based on report record ID.
getRequirement	Retrieve a requirement record based on number or summary.
getRequirementByRecordID	Retrieve a requirement record based on record ID.
getRequirementDocument	Retrieve a requirement document record based on name or number.
getRequirementDocumentByRecordID	Retrieve a requirement document record based on record ID.
getRequirementIDsForDocument	Retrieve a list of record IDs for requirements in a requirement document.
getRootPrivateFolderPath	Retrieve the path of the Private root folder.
getRootPublicFolderPath	Retrieve the path of the Public root folder.
getTableList	Retrieve a list of tables from the project.
getTask	Retrieve a Workbook task record based on summary.
getTaskByRecordID	Retrieve a Workbook task record based on record ID.
getTestCase	Retrieve a test case record based on number or summary.
getTestCaseByRecordID	Retrieve a test case record based on record ID.
getTestConfig	Retrieve a test configuration record based on name.
getTestConfigByRecordID	Retrieve a test configuration record based on record ID.
getTestRun	Retrieve a test run record based on number or summary.
getTestRunByRecordID	Retrieve a test run record based on record ID.
getTestRunStepsModes	Retrieve a list of display modes for test run steps.
getTestVariantTypes	Retrieve a list of test variant types in the project.
getTTVersionInfo	Retrieve Helix ALM Server and SOAP CGI version information.
getUser	Retrieve a user record based on name.
getUserByRecordID	Retrieve a user record based on record ID.
getUserForCurrentSession	Retrieve the record for the user in the current SOAP session.
getUserLicenseList	Retrieve Helix ALM licensing and current usage information.
projectLogon	Send login information to the SOAP CGI.
promoteCustomer	Promote a local customer to a global customer on the Helix ALM License Server.
promoteUser	Promote a local user to a global user on the Helix ALM License Server.
removeEntityFromFolderByRecordID	Removes an item from a folder based on record ID.
saveCustomer	Save changes to and unlock a customer record.
saveDefect	Save changes to and unlock a defect record.
saveFolder	Save changes to and unlock a folder record.
saveFolderItemRank	Save changes to item ranking and unlock a folder record.
saveLink	Save changes to and unlock a link record.
saveRequirement	Save changes to and unlock a requirement record.
saveRequirementDocument	Save changes to and unlock a requirement document record.
saveTask	Save changes to and unlock a Workbook task record.
saveTestCase	Save changes to and unlock a test case record.
saveTestConfig	Save changes to and unlock a test configuration record.
saveTestRun	Save changes to and unlock a test run record.
saveUser	Save changes to and unlock a user record.