Add an ALM issue comment

Adds a comment to one issue in the project's Jira or Azure DevOps
integration. The integration must be active. 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 identity
of the API key's user. Repeating a request can add another comment; check
the issue before you retry after a timeout.

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.

Requires the Requirement:Update permission.

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

ALM integration ID: almIntegrationId from Search requirements, or integrationId from Find defects. You can also find it in the project's integration settings. 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

Optional comment layout. The only supported slug is requirement-clarification-questions-answers. If a template is sent, 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, the operation's permission, that the integration belongs to the project, and provider access. Provider errors can use any status and response body.

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