Atlassian: Get issue link
Atlassian issueLinks.getIssueLink: arguments, response, policy and SDK examples.
← Issue links operations · Get started
Operation atlassian.getissuelink
Provider route: GET /{cloudId}/rest/api/3/issueLink/{linkId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AtlassianIntegration } from "@alter-ai/atlassian";
async function execute(input: Parameters<AtlassianIntegration["issueLinks"]["getIssueLink"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.issueLinks.getIssueLink(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_atlassian import AtlassianIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.issue_links.get_issue_link(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.cloudId | string | Required within parent | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
path.linkId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get issue link — response body |
Referenced models: Get issue link — response body
Schemas
Section titled “Schemas”10 more schemas are linked from the tables above, on the schema pages.
Get issue link — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a link between issues. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue link. Read only: true |
id (anyOf 2) | null | Alternative | |
inwardIssue | JSON | Optional | |
inwardIssue (anyOf 1) | Model | Alternative | Expand Get issue link — response body — inward Issue The ID or key of a linked issue Provides details about the linked issue. If presenting this link in a user interface, use the `inward` field of the issue link type to label the link. |
inwardIssue (anyOf 2) | null | Alternative | |
outwardIssue | JSON | Optional | |
outwardIssue (anyOf 1) | Model | Alternative | Expand Get issue link — response body — inward Issue The ID or key of a linked issue Provides details about the linked issue. If presenting this link in a user interface, use the `outward` field of the issue link type to label the link. |
outwardIssue (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the issue link. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | Model | Alternative | Expand Get issue link type — response body The type of link between the issues. |
type (anyOf 2) | null | Alternative |
Referenced models: Get issue link type — response body, Get issue link — response body — inward Issue The ID or key of a linked issue
Get issue link type — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](#api-rest-api-3-issueLinkType-get). * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it defines and reports on issue link types. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue link type and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only. |
id (anyOf 2) | null | Alternative | |
inward | JSON | Optional | |
inward (anyOf 1) | string | Alternative | The description of the issue link type inward link and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. |
inward (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue link type and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. |
name (anyOf 2) | null | Alternative | |
outward | JSON | Optional | |
outward (anyOf 1) | string | Alternative | The description of the issue link type outward link and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. |
outward (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the issue link type. Read only. Format: uri Read only: true |
self (anyOf 2) | null | Alternative |
Get issue link — response body — inward Issue The ID or key of a linked issue
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ID or key of a linked issue. |
fields | JSON | Optional | |
fields (anyOf 1) | Model | Alternative | Expand Get issue link — response body — inward Issue The ID or key of a linked issue fields Key fields from the linked issue The fields associated with the issue. Read only: true |
fields (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of an issue. Required if `key` isn't provided. |
id (anyOf 2) | null | Alternative | |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | The key of an issue. Required if `id` isn't provided. |
key (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the issue. Format: uri Read only: true |
self (anyOf 2) | null | Alternative |
Referenced models: Get issue link — response body — inward Issue The ID or key of a linked issue fields Key fields from the linked issue
Get issue link — response body — inward Issue The ID or key of a linked issue fields Key fields from the linked issue
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Key fields from the linked issue. |
assignee | JSON | Optional | |
assignee (anyOf 1) | Model | Alternative | Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone The assignee of the linked issue. Read only: true |
assignee (anyOf 2) | null | Alternative | |
issueType | JSON | Optional | |
issueType (anyOf 1) | Model | Alternative | Expand Get issue type — response body The type of the linked issue. Read only: true |
issueType (anyOf 2) | null | Alternative | |
issuetype | JSON | Optional | |
issuetype (anyOf 1) | Model | Alternative | Expand Get issue type — response body The type of the linked issue. |
issuetype (anyOf 2) | null | Alternative | |
priority | JSON | Optional | |
priority (anyOf 1) | Model | Alternative | Expand Get priority — response body The priority of the linked issue. Read only: true |
priority (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | Model | Alternative | Expand Get status — response body The status of the linked issue. Read only: true |
status (anyOf 2) | null | Alternative | |
summary | JSON | Optional | |
summary (anyOf 1) | string | Alternative | The summary description of the linked issue. Read only: true |
summary (anyOf 2) | null | Alternative | |
timetracking | JSON | Optional | |
timetracking (anyOf 1) | Model | Alternative | Expand Get issue link — response body — inward Issue The ID or key of a linked issue fields Key fields from the linked issue timetracking Time tracking details The time tracking of the linked issue. Read only: true |
timetracking (anyOf 2) | null | Alternative |
Referenced models: Get issue type — response body, Get priority — response body, Get status — response body, Get issue link — response body — inward Issue The ID or key of a linked issue fields Key fields from the linked issue timetracking Time tracking details, Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone
Get status — response body — scope project, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Additional keys: allowed |
project | JSON | Optional | |
project (anyOf 1) | Model | Alternative | Expand Get issue type screen scheme projects — response body — values The list of items item The project the item has scope in. Read only: true |
project (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The type of scope. Known values: PROJECT, TEMPLATE Read only: true |
type (anyOf 2) | null | Alternative |
Referenced models: Get issue type screen scheme projects — response body — values The list of items item
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: atlassian.getissuelink. Catalog operation: getissuelink. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["read:jira-work"]