add_comment_to_testartifact
Adds a general comment to an IBM Engineering Test Management test artifact.
Purpose
This tool adds a comment to any test artifact in the artifact's formal review section as a general comment. The comment is associated with the current authenticated user and displays in the artifact's formal review section. Use this tool when you need to add review comments to test artifacts, document test execution observations, provide feedback on test cases or plans, or record approval decisions with explanations.
Note: You must have write access to the specific artifact in project area
Tags: QM | Write | Basic
Supported artifact types
Following artifact types are supported:
- TestPlan
- TestCase
- TestSuite
- TestScript
- TestCaseResult
- TestSuiteResult
Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| project_area_uuid | string | Yes | The project area UUID that identifies which project contains the artifact | _stJVgGfqEd24KMoDcFLfcQ |
| artifact_type | string | Yes | Type of test artifact. Must be one of the supported artifact type | TestCase |
| artifact_id | integer | Yes | The artifact web ID visible in UI | 209 |
| html_comment | string | Yes | The comment text in HTML format. Must be a valid HTML string. The comment displays in the artifact's approval and comment section |
Approved for execution |
Note: In the Opt In project area, the default configuration (stream) is automatically selected when retrieving data.
Output schema
| Field | Type | Description |
|---|---|---|
| status | string | Operation status: success or failed |
| message | string | Success message describing the operation (present when status is success) |
| error | string | Error message describing what went wrong (present when status is failed) |
Common use cases
- Adding review comments to test cases before approval
- Documenting test execution observations in test results
- Providing feedback on test plans or test suites
- Recording approval decisions with explanations
- Adding clarifications or questions about test scripts
- Documenting issues found during test case review
- Adding notes about test case modifications
- Recording test execution context or environment details