Get an ALM issue

Returns one issue from the project's Jira or Azure DevOps integration. The
issue is read from the provider when you call this operation. The
integration must be active.

Pass a Jira issue key or an Azure DevOps work-item ID. For a linked
requirement, use its sourceId; for a defect, use its issueId. Do not
use a requirement's externalIssueId.

Requires the Requirement:Read 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.

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

404

The issue does not exist in the provider. A common cause is passing a requirement's externalIssueId instead of its sourceId.

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