QMetry: Update Test Suite
qmetry_update_test_suiteUpdate a QMetry test suite using its numeric ID or entity key, automatically resolving folder and project info to change name, description, owner, or state.
Instructions
Update an existing QMetry test suite by id(testsuite numeric id), with auto-resolution from entityKey.
Toolset: Test Suites
Parameters:
id (number) required: Id of Test Suite to be updated (required)
TsFolderID (number): Folder ID where Test Suite resides - SYSTEM AUTOMATICALLY RESOLVES THIS. Leave empty unless you have a specific folder ID. System will fetch project info using the projectKey and extract rootFolders.TS.id automatically. Manual folder ID only needed if you want to override the automatic resolution.
entityKey (string) required: Entity Key of Test Suite to be updated (required)
name (string): Name of the Test Suite
description (string): Description of the Test Suite
testsuiteOwner (number): Owner ID of the Test Suite
testSuiteState (number): State of the Test Suite
Output Description: JSON object containing the new test suite ID, summary, and creation metadata.
Use Cases: 1. Update test suite summary (name) 2. Change owner, or state of a test suite 3. Bulk update using entityKey auto-resolution 4. Modify test suite description
Examples:
Update test suite summary (updated name)
{
"id": 1505898,
"entityKey": "VT-TS-7",
"TsFolderID": 1644087,
"name": "MAC Test11"
}Expected Output: Test suite summary updated. Only 'name' field changed. Field IDs auto-resolved from project info. id(test suite numeric id) resolved from entityKey. TsFolderID auto-resolved. from the project info. info on rootFolders.TS.id.
Update state to Open and owner of the test suite
{
"id": 1505898,
"entityKey": "VT-TS-7",
"TsFolderID": 1644087,
"testSuiteState": 505036,
"testsuiteOwner": 6963
}Expected Output: State and owner updated. Example uses: testSuiteState=505036 (Open from customListObjs.testSuiteState[index].id), testsuiteOwner=6963 (umang.savaliya from customListObjs.owner[index].id). Field IDs auto-resolved from project info. id(test suite numeric id) resolved from entityKey. TsFolderID auto-resolved from the project info rootFolders.TS.id.
Update only description of the test suite
{
"id": 1505898,
"entityKey": "VT-TS-7",
"TsFolderID": 1644087,
"description": "Updated description for the test suite."
}Expected Output: description updated only. Field IDs auto-resolved from project info. id(test suite numeric id) resolved from entityKey. TsFolderID auto-resolved. from the project info. info on rootFolders.TS.id.
Hints: 1. If user provides entityKey (e.g., MAC-TS-7), first call Fetch Test Suites with a filter on entityKeyId to resolve the id (test suite numeric id) and TsFolderID from rootFolders.TS.id. 2. To get valid values for owner, state, etc., call the 'Admin/Get info Service' API (FETCH_PROJECT_INFO tool) and use the returned customListObjs IDs. 3. CRITICAL: For testsuiteOwner mapping - Call API 'Admin/Get info Service', from the response get value from customListObjs.owner[].id. Match the user by customListObjs.owner[].name. 4. If the user provides an owner name, fetch project info, find the matching user in customListObjs.owner[index].name, and use its ID in the payload as testsuiteOwner. If the name is not found, skip the testsuiteOwner field (it is not required) and show a user-friendly message: 'Test suite updated without owner, as given owner is not available in the current project.' 5. CRITICAL: For testSuiteState mapping - Call API 'Admin/Get info Service', from the response get value from customListObjs.testSuiteState[].id. Match the state by customListObjs.testSuiteState[].name. 6. If the user provides a test suite state name, fetch project info, find the matching state in customListObjs.testSuiteState[index].name, and use its ID in the payload as testSuiteState. If the name is not found, skip the testSuiteState field (it is not required) and show a user-friendly message: 'Test suite updated without test suite state, as given state is not available in the current project.' 7. If either owner or state is not found in project info, the update for that field will be skipped and a user-friendly message will be shown to the user. 8. UDF fields in steps must match your QMetry custom field configuration. 9. All IDs (testSuiteState from customListObjs.testSuiteState[index].id, testsuiteOwner from customListObjs.owner[index].id) must be valid for your QMetry instance. 10. If a custom field is mandatory, include it in the UDF object.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of Test Suite to be updated (required) | |
| name | No | Name of the Test Suite | |
| entityKey | Yes | Entity Key of Test Suite to be updated (required) | |
| TsFolderID | No | Folder ID where Test Suite resides - SYSTEM AUTOMATICALLY RESOLVES THIS. Leave empty unless you have a specific folder ID. System will fetch project info using the projectKey and extract rootFolders.TS.id automatically. Manual folder ID only needed if you want to override the automatic resolution. | |
| description | No | Description of the Test Suite | |
| testSuiteState | No | State of the Test Suite | |
| testsuiteOwner | No | Owner ID of the Test Suite |