Atlassian: Get remote issue link by ID
Atlassian issueRemoteLinks.getRemoteIssueLinkById: arguments, response, policy and SDK examples.
← Issue remote links operations · Get started
Operation atlassian.getremoteissuelinkbyid
Provider route: GET /{cloudId}/rest/api/3/issue/{issueIdOrKey}/remotelink/{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["issueRemoteLinks"]["getRemoteIssueLinkById"]>[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.issueRemoteLinks.getRemoteIssueLinkById(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_remote_links.get_remote_issue_link_by_id(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.issueIdOrKey | string | Required within parent | |
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 remote issue link by ID — response body |
Referenced models: Get remote issue link by ID — response body
Schemas
Section titled “Schemas”Get remote issue link by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue remote link. |
application | JSON | Optional | |
application (anyOf 1) | Model | Alternative | Expand Get remote issue link by ID — response body — application The application the linked item is in Details of the remote application the linked item is in. |
application (anyOf 2) | null | Alternative | |
globalId | JSON | Optional | |
globalId (anyOf 1) | string | Alternative | The global ID of the link, such as the ID of the item on the remote system. |
globalId (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the link. Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
object | JSON | Optional | |
object (anyOf 1) | Model | Alternative | Expand Get remote issue link by ID — response body — object The linked item Details of the item linked to. |
object (anyOf 2) | null | Alternative | |
relationship | JSON | Optional | |
relationship (anyOf 1) | string | Alternative | Description of the relationship between the issue and the linked item. |
relationship (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the link. Format: uri |
self (anyOf 2) | null | Alternative |
Referenced models: Get remote issue link by ID — response body — application The application the linked item is in, Get remote issue link by ID — response body — object The linked item
Get remote issue link by ID — response body — application The application the linked item is in
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The application the linked item is in. Additional keys: allowed |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "\[application name\] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last. |
name (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The name-spaced type of the application, used by registered rendering apps. |
type (anyOf 2) | null | Alternative |
Get remote issue link by ID — response body — object The linked item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The linked item. Additional keys: allowed |
icon | JSON | Optional | |
icon (anyOf 1) | Model | Alternative | Expand Get remote issue link by ID — response body — object The linked item icon An icon If no icon is defined: Details of the icon for the item. If no icon is defined, the default link icon is used in Jira. |
icon (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | Model | Alternative | Expand Get remote issue link by ID — response body — object The linked item status The status of the item The status of the item. |
status (anyOf 2) | null | Alternative | |
summary | JSON | Optional | |
summary (anyOf 1) | string | Alternative | The summary details of the item. |
summary (anyOf 2) | null | Alternative | |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | The title of the item. |
title (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The URL of the item. |
url (anyOf 2) | null | Alternative |
Referenced models: Get remote issue link by ID — response body — object The linked item icon An icon If no icon is defined:, Get remote issue link by ID — response body — object The linked item status The status of the item
Get remote issue link by ID — response body — object The linked item icon An icon If no icon is defined:
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An icon. If no icon is defined: * for a status icon, no status icon displays in Jira. * for the remote object icon, the default link icon displays in Jira. Additional keys: allowed |
link | JSON | Optional | |
link (anyOf 1) | string | Alternative | The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable. |
link (anyOf 2) | null | Alternative | |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | The title of the icon. This is used as follows: * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira. * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "\[application name\] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". |
title (anyOf 2) | null | Alternative | |
url16x16 | JSON | Optional | |
url16x16 (anyOf 1) | string | Alternative | The URL of an icon that displays at 16x16 pixel in Jira. |
url16x16 (anyOf 2) | null | Alternative |
Get remote issue link by ID — response body — object The linked item status The status of the item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The status of the item. Additional keys: allowed |
icon | JSON | Optional | |
icon (anyOf 1) | Model | Alternative | Expand Get remote issue link by ID — response body — object The linked item icon An icon If no icon is defined: Details of the icon representing the status. If not provided, no status icon displays in Jira. |
icon (anyOf 2) | null | Alternative | |
resolved | JSON | Optional | |
resolved (anyOf 1) | boolean | Alternative | Whether the item is resolved. If set to "true", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font. |
resolved (anyOf 2) | null | Alternative |
Referenced models: Get remote issue link by ID — response body — object The linked item icon An icon If no icon is defined:
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: atlassian.getremoteissuelinkbyid. Catalog operation: getremoteissuelinkbyid. 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"]