Skip to content

Atlassian: Issue links schemas

10 Atlassian schemas with complete fields and constraints.

← Issue links operations · All schemas

Create issue link — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
commentModelOptionalExpand Add comment — request body — body
inwardIssueModelRequired within parentExpand Create issue link — request body — body inward Issue
outwardIssueModelRequired within parentExpand Create issue link — request body — body inward Issue
typeModelRequired within parentExpand Create issue link type — request body — body

Referenced models: Add comment — request body — body, Create issue link type — request body — body, Create issue link — request body — body inward Issue

Create issue link — request body — body inward Issue

FieldTypePresenceDescription and constraints
$objectRootThe ID or key of a linked issue.
Additional keys: not allowed
fieldsModelOptionalExpand Create issue link — request body — body inward Issue fields
The fields associated with the issue.
Read only: true
idstringOptionalThe ID of an issue. Required if `key` isn't provided.
keystringOptionalThe key of an issue. Required if `id` isn't provided.
selfstringOptionalThe URL of the issue.
Format: uri
Read only: true

Referenced models: Create issue link — request body — body inward Issue fields

Create issue link — request body — body inward Issue fields

FieldTypePresenceDescription and constraints
$objectRootKey fields from the linked issue.
Additional keys: not allowed
assigneeModelOptionalExpand Add comment — request body — body author
The assignee of the linked issue.
Read only: true
issueTypeModelOptionalExpand Create workflow scheme — request body — body issue Types value
The type of the linked issue.
Read only: true
issuetypeModelOptionalExpand Create workflow scheme — request body — body issue Types value
The type of the linked issue.
priorityModelOptionalExpand Create issue link — request body — body inward Issue fields priority
The priority of the linked issue.
Read only: true
statusModelOptionalExpand Edit issue — request body — body transition to
The status of the linked issue.
Read only: true
summarystringOptionalThe summary description of the linked issue.
Read only: true
timetrackingModelOptionalExpand Create issue link — request body — body inward Issue fields timetracking
The time tracking of the linked issue.
Read only: true

Referenced models: Create workflow scheme — request body — body issue Types value, Create issue link — request body — body inward Issue fields priority, Edit issue — request body — body transition to, Create issue link — request body — body inward Issue fields timetracking, Add comment — request body — body author

Create issue link — request body — body inward Issue fields priority

FieldTypePresenceDescription and constraints
$objectRootAn issue priority.
Additional keys: allowed
avatarIdintegerOptionalThe avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs.
Format: int64
descriptionstringOptionalThe description of the issue priority.
iconUrlstringOptionalThe URL of the icon for the issue priority.
idstringOptionalThe ID of the issue priority.
isDefaultbooleanOptionalWhether this priority is the default.
namestringOptionalThe name of the issue priority.
schemesModelOptionalExpand Create issue link — request body — body inward Issue fields priority schemes
Priority schemes associated with the issue priority.
selfstringOptionalThe URL of the issue priority.
statusColorstringOptionalThe color used to indicate the issue priority.

Referenced models: Create issue link — request body — body inward Issue fields priority schemes

Create issue link — request body — body inward Issue fields priority schemes

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
maxResultsintegerOptionalFormat: int32
startAtintegerOptionalFormat: int64
totalintegerOptionalFormat: int64

Create issue link — request body — body inward Issue fields timetracking

FieldTypePresenceDescription and constraints
$objectRootTime tracking details.
Additional keys: not allowed
originalEstimatestringOptionalThe original estimate of time needed for this issue in readable format.
Read only: true
originalEstimateSecondsintegerOptionalThe original estimate of time needed for this issue in seconds.
Format: int64
Read only: true
remainingEstimatestringOptionalThe remaining estimate of time needed for this issue in readable format.
Read only: true
remainingEstimateSecondsintegerOptionalThe remaining estimate of time needed for this issue in seconds.
Format: int64
Read only: true
timeSpentstringOptionalTime worked on this issue in readable format.
Read only: true
timeSpentSecondsintegerOptionalTime worked on this issue in seconds.
Format: int64
Read only: true

Get issue link — response body

FieldTypePresenceDescription and constraints
$objectRootDetails of a link between issues.
idJSONOptional
id (anyOf 1)stringAlternativeThe ID of the issue link.
Read only: true
id (anyOf 2)nullAlternative
inwardIssueJSONOptional
inwardIssue (anyOf 1)ModelAlternativeExpand 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)nullAlternative
outwardIssueJSONOptional
outwardIssue (anyOf 1)ModelAlternativeExpand 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)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the issue link.
Format: uri
Read only: true
self (anyOf 2)nullAlternative
typeJSONOptional
type (anyOf 1)ModelAlternativeExpand Get issue link type — response body
The type of link between the issues.
type (anyOf 2)nullAlternative

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 — response body — inward Issue The ID or key of a linked issue

FieldTypePresenceDescription and constraints
$objectRootThe ID or key of a linked issue.
fieldsJSONOptional
fields (anyOf 1)ModelAlternativeExpand 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)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeThe ID of an issue. Required if `key` isn't provided.
id (anyOf 2)nullAlternative
keyJSONOptional
key (anyOf 1)stringAlternativeThe key of an issue. Required if `id` isn't provided.
key (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the issue.
Format: uri
Read only: true
self (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootKey fields from the linked issue.
assigneeJSONOptional
assignee (anyOf 1)ModelAlternativeExpand 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)nullAlternative
issueTypeJSONOptional
issueType (anyOf 1)ModelAlternativeExpand Get issue type — response body
The type of the linked issue.
Read only: true
issueType (anyOf 2)nullAlternative
issuetypeJSONOptional
issuetype (anyOf 1)ModelAlternativeExpand Get issue type — response body
The type of the linked issue.
issuetype (anyOf 2)nullAlternative
priorityJSONOptional
priority (anyOf 1)ModelAlternativeExpand Get priority — response body
The priority of the linked issue.
Read only: true
priority (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)ModelAlternativeExpand Get status — response body
The status of the linked issue.
Read only: true
status (anyOf 2)nullAlternative
summaryJSONOptional
summary (anyOf 1)stringAlternativeThe summary description of the linked issue.
Read only: true
summary (anyOf 2)nullAlternative
timetrackingJSONOptional
timetracking (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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 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

FieldTypePresenceDescription and constraints
$objectRootTime tracking details.
originalEstimateJSONOptional
originalEstimate (anyOf 1)stringAlternativeThe original estimate of time needed for this issue in readable format.
Read only: true
originalEstimate (anyOf 2)nullAlternative
originalEstimateSecondsJSONOptional
originalEstimateSeconds (anyOf 1)JSONAlternative
originalEstimateSeconds (anyOf 1) (anyOf 1)integerAlternativeThe original estimate of time needed for this issue in seconds.
Format: int64
Read only: true
originalEstimateSeconds (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
originalEstimateSeconds (anyOf 2)nullAlternative
remainingEstimateJSONOptional
remainingEstimate (anyOf 1)stringAlternativeThe remaining estimate of time needed for this issue in readable format.
Read only: true
remainingEstimate (anyOf 2)nullAlternative
remainingEstimateSecondsJSONOptional
remainingEstimateSeconds (anyOf 1)JSONAlternative
remainingEstimateSeconds (anyOf 1) (anyOf 1)integerAlternativeThe remaining estimate of time needed for this issue in seconds.
Format: int64
Read only: true
remainingEstimateSeconds (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
remainingEstimateSeconds (anyOf 2)nullAlternative
timeSpentJSONOptional
timeSpent (anyOf 1)stringAlternativeTime worked on this issue in readable format.
Read only: true
timeSpent (anyOf 2)nullAlternative
timeSpentSecondsJSONOptional
timeSpentSeconds (anyOf 1)JSONAlternative
timeSpentSeconds (anyOf 1) (anyOf 1)integerAlternativeTime worked on this issue in seconds.
Format: int64
Read only: true
timeSpentSeconds (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timeSpentSeconds (anyOf 2)nullAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.