Add an ALM issue comment

Requires Requirement:Update and an active integration in the current
project. Comments are posted with the credentials of the account that set up the ALM connection.
These are the integration's stored provider credentials, not the TestOps
caller's or API-key user's provider identity. Repeating a request can add another
comment; check the result before retrying after an uncertain outcome.

Without a template, Jira receives the supplied wiki markup unchanged;
Azure DevOps receives HTML-escaped text. With a template, content is
rendered as Jira wiki markup or Azure DevOps HTML. A missing or unknown
slug in a non-null template returns 400. Null or blank title falls back
to the supplied content. Template authorName only changes displayed
text; it does not select the provider-side commenter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Existing project integration ID from the UI or the integration record's id in GET /v2/alm/connections/integrations (configuration endpoint outside this reference). Not a connection ID or external project ID.

string
required

ALM issue key or the provider's own issue ID. For linked requirements use sourceId, not externalIssueId; for defects use issueId. A requirement's numeric externalIssueId is not a substitute for its Jira key here. Azure DevOps uses a numeric work-item ID as a string. Xray is not supported.

Body Params

Supply content for the comment. Nullable fields do not imply that every provider accepts an empty comment; no field-length or non-null validation guarantee is specified.

string | null
template
object | null

If supplied and non-null, slug must be requirement-clarification-questions-answers. A missing, null, or unknown slug returns 400.

Headers
uuid

Account UUID, when needed to resolve account context.

int64

Organization ID, when needed to resolve organization context.

int64
required

Project containing the preconfigured ALM integration.

Responses

400

Invalid input, including a missing or unknown template slug or a nonnumeric Azure DevOps work-item ID. Provider errors can use other statuses.

default

Request failed. Check authentication, project access, operation permission, integration ownership, and provider access. Provider failures are not guaranteed to use a uniform status or response body.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json