Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

JIRA Cloud API Data Model

Navigation: Schema: Core > Tables

IssueLinkById: JIRA Cloud Issue Link by ID

 Contents Previous Home Next More

Catalog: JIRA

Schema: Core

Primary Keys: id

Label: Issue Link by ID

This is a read-only table function. The JIRA Cloud API may not support changing the data or the Invantive SQL driver for JIRA Cloud does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the JIRA Cloud API.

Select JIRA Cloud API URL: /issueLink/{id}

Insert JIRA Cloud API URL: /issueLink/{id}

Update JIRA Cloud API URL: /issueLink/{id}

Delete JIRA Cloud API URL: /issueLink/{id}

Field Selection Method: NotRequired

Table Function Parameters

The following parameters can be used to control the behaviour of the table function IssueLinkById. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

id

string

☑

 

 

 

Table Function Columns

The columns of the table function IssueLinkById are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

id

string

 

☐

The ID of the issue link.

inwardIssue_fields_assignee_accountId

string

 

☐

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user.

inwardIssue_fields_assignee_accountType

string

 

☐

The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk

inwardIssue_fields_assignee_active

boolean

 

☐

Indicates whether the user is active.

inwardIssue_fields_assignee_displayName

string

 

☐

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

inwardIssue_fields_assignee_emailAddress

string

 

☐

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

inwardIssue_fields_assignee_key

string

 

☐

This property is no longer available and will be removed from the documentation soon

inwardIssue_fields_assignee_locale

string

 

☐

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

inwardIssue_fields_assignee_name

string

 

☐

This property is no longer available and will be removed from the documentation soon.

inwardIssue_fields_assignee_timeZone

string

 

☐

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

inwardIssue_fields_issuetype_avatarId

int64

 

☐

The ID of the issue type's avatar.

inwardIssue_fields_issuetype_description

string

 

☐

The description of the issue type.

inwardIssue_fields_issuetype_entityId

string

 

☐

Unique ID, for next-gen projects.

inwardIssue_fields_issuetype_iconUrl

string

 

☐

The URL of the issue type's avatar.

inwardIssue_fields_issuetype_id

string

 

☐

The ID of the issue type.

inwardIssue_fields_issuetype_name

string

 

☐

The name of the issue type.

inwardIssue_fields_issuetype_subtask

boolean

 

☐

Indicates whether this issue type is used to create subtasks.

inwardIssue_fields_priority_description

string

 

☐

The description of the issue priority.

inwardIssue_fields_priority_iconUrl

string

 

☐

The URL of the icon for the issue priority.

inwardIssue_fields_priority_id

string

 

☐

The ID of the issue priority.

inwardIssue_fields_priority_name

string

 

☐

The name of the issue priority.

inwardIssue_fields_priority_self

string

 

☐

The URL of the issue priority.

inwardIssue_fields_priority_statusColor

string

 

☐

The color used to indicate the issue priority.

inwardIssue_fields_status_description

string

 

☐

Description.

inwardIssue_fields_status_iconUrl

string

 

☐

Icon URL.

inwardIssue_fields_status_id

string

 

☐

ID.

inwardIssue_fields_status_name

string

 

☐

Name.

inwardIssue_fields_status_statusCategory_colorName

string

 

☐

Name of color.

inwardIssue_fields_status_statusCategory_id

string

 

☐

ID.

inwardIssue_fields_status_statusCategory_key

string

 

☐

Key.

inwardIssue_fields_status_statusCategory_name

string

 

☐

Name.

inwardIssue_fields_summary

string

 

☐

The summary description of the linked issue.

inwardIssue_id

string

 

☐

The ID of an issue.

inwardIssue_key

string

 

☐

The key of an issue.

inwardIssue_self

string

 

☐

The URL of the issue.

outwardIssue_fields_assignee_accountId

string

 

☐

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user.

outwardIssue_fields_assignee_accountType

string

 

☐

The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk

outwardIssue_fields_assignee_active

boolean

 

☐

Indicates whether the user is active.

outwardIssue_fields_assignee_displayName

string

 

☐

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

outwardIssue_fields_assignee_emailAddress

string

 

☐

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

outwardIssue_fields_assignee_key

string

 

☐

This property is no longer available and will be removed from the documentation soon

outwardIssue_fields_assignee_locale

string

 

☐

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

outwardIssue_fields_assignee_name

string

 

☐

This property is no longer available and will be removed from the documentation soon.

outwardIssue_fields_assignee_timeZone

string

 

☐

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

outwardIssue_fields_issuetype_avatarId

int64

 

☐

The ID of the issue type's avatar.

outwardIssue_fields_issuetype_description

string

 

☐

The description of the issue type.

outwardIssue_fields_issuetype_entityId

string

 

☐

Unique ID, for next-gen projects.

outwardIssue_fields_issuetype_iconUrl

string

 

☐

The URL of the issue type's avatar.

outwardIssue_fields_issuetype_id

string

 

☐

The ID of the issue type.

outwardIssue_fields_issuetype_name

string

 

☐

The name of the issue type.

outwardIssue_fields_issuetype_subtask

boolean

 

☐

Indicates whether this issue type is used to create subtasks.

outwardIssue_fields_priority_description

string

 

☐

The description of the issue priority.

outwardIssue_fields_priority_iconUrl

string

 

☐

The URL of the icon for the issue priority.

outwardIssue_fields_priority_id

string

 

☐

The ID of the issue priority.

outwardIssue_fields_priority_name

string

 

☐

The name of the issue priority.

outwardIssue_fields_priority_self

string

 

☐

The URL of the issue priority.

outwardIssue_fields_priority_statusColor

string

 

☐

The color used to indicate the issue priority.

outwardIssue_fields_status_description

string

 

☐

Description.

outwardIssue_fields_status_iconUrl

string

 

☐

Icon URL.

outwardIssue_fields_status_id

string

 

☐

ID.

outwardIssue_fields_status_name

string

 

☐

Name.

outwardIssue_fields_status_statusCategory_colorName

string

 

☐

Name of color.

outwardIssue_fields_status_statusCategory_id

string

 

☐

ID.

outwardIssue_fields_status_statusCategory_key

string

 

☐

Key.

outwardIssue_fields_status_statusCategory_name

string

 

☐

Name.

outwardIssue_fields_summary

string

 

☐

The summary description of the linked issue.

outwardIssue_id

string

 

☐

The ID of an issue.

outwardIssue_key

string

 

☐

The key of an issue.

outwardIssue_self

string

 

☐

The URL of the issue.

self

string

 

☐

The URL of the issue link.

type_id

string

 

☐

The ID of the issue link type and is used as follows: in the issueLink resource it is the type of issue link.Required on create when name isn't provided. Otherwise, read only. In the issueLinkType resource it is read only.

type_inward

string

 

☐

The description of the issue link type inward link.

type_name

string

 

☐

The name of the issue link type.

type_outward

string

 

☐

The description of the issue link type outward link.

type_self

string

 

☐

The URL of the issue link type.

 

29-09-2021 12:42 Version 20.2.43-PROD+3437