Atlassian: Issue remote links schemas
11 Atlassian schemas with complete fields and constraints.
← Issue remote links operations · All schemas
Create or update remote issue link — response body — id, self
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the identifiers for a created or updated remote issue link. |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the remote issue link, such as the ID of the item on the remote system. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the remote issue link. Read only: true |
self (anyOf 2) | null | Alternative |
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:
Update remote issue link by ID — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a remote issue link. Additional keys: allowed |
application | Model | Optional | Expand Update remote issue link by ID — request body — body application Details of the remote application the linked item is in. For example, trello. |
globalId | string | Optional | An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: `appId=456&pageId=123`. Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID. The maximum length is 255 characters. |
object | Model | Required within parent | Expand Update remote issue link by ID — request body — body object Details of the item linked to. |
relationship | string | Optional | Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira. |
Referenced models: Update remote issue link by ID — request body — body application, Update remote issue link by ID — request body — body object
Update remote issue link by ID — request body — body application
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The application the linked item is in. Additional keys: allowed |
name | string | Optional | 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. |
type | string | Optional | The name-spaced type of the application, used by registered rendering apps. |
Update remote issue link by ID — request body — body object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The linked item. Additional keys: allowed |
icon | Model | Optional | Expand Update remote issue link by ID — request body — body object icon Details of the icon for the item. If no icon is defined, the default link icon is used in Jira. |
status | Model | Optional | Expand Update remote issue link by ID — request body — body object status The status of the item. |
summary | string | Optional | The summary details of the item. |
title | string | Required within parent | The title of the item. |
url | string | Required within parent | The URL of the item. |
Referenced models: Update remote issue link by ID — request body — body object icon, Update remote issue link by ID — request body — body object status
Update remote issue link by ID — request body — body object icon
| 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 | string | Optional | The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable. |
title | string | Optional | 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". |
url16x16 | string | Optional | The URL of an icon that displays at 16x16 pixel in Jira. |
Update remote issue link by ID — request body — body object status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The status of the item. Additional keys: allowed |
icon | Model | Optional | Expand Update remote issue link by ID — request body — body object icon Details of the icon representing the status. If not provided, no status icon displays in Jira. |
resolved | boolean | Optional | 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. |
Referenced models: Update remote issue link by ID — request body — body object icon