Please enable JavaScript to view this site.

Made in EU
YouTrack Forums

YouTrack API Data Model

Navigation: Schema: Issues > Tables

Links

Catalog: YouTrack

Schema: Issues

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

Select YouTrack API URL: /issues

Insert YouTrack API URL: /issues

Update YouTrack API URL: /issues

Delete YouTrack API URL: /issues

Field Selection Method: NotRequired

Base Path: links[*]

Select YouTrack API Operation: get /issues

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function Links. 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

customFields

string

☐

 

<p>The name of the custom field to show in the response. When you use this parameter and request the custom field data in the request URL, the response only shows the requested custom fields instead of all of them.</p><p>To show more than one custom field, use this parameter several times.</p><p>See Sample 2 for reference.</p>

query

string

☐

 

Issues search query. Read more about search syntax here: <a href="https://www.jetbrains.com/help/youtrack/incloud/?Search-and-Command-Attributes">Search Query Reference</a>

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

$type_1

string

 

☐

 

$type

string

 

☐

 

commentsCount

int32

Comments Count

☐

 

created

int64

Created

☐

 

description

string

Description

☐

 

direction

string

Direction

☐

 

draftOwner_$type

string

 

☐

 

draftOwner_avatarUrl

string

 

☐

 

draftOwner_banned

boolean

 

☐

 

draftOwner_email

string

 

☐

 

draftOwner_fullName

string

 

☐

 

draftOwner_guest

boolean

 

☐

 

draftOwner_id

string

 

☐

 

draftOwner_jabberAccountName

string

 

☐

 

draftOwner_login

string

 

☐

 

draftOwner_online

boolean

 

☐

 

draftOwner_profiles_$type

string

 

☐

 

draftOwner_profiles_id

string

 

☐

 

draftOwner_ringId

string

 

☐

 

externalIssue_$type

string

 

☐

 

externalIssue_id

string

 

☐

 

externalIssue_key

string

 

☐

 

externalIssue_name

string

 

☐

 

externalIssue_url

string

 

☐

 

id_1

string

 

☐

 

id

string

ID

☐

 

idReadable

string

Readable ID

☐

 

isDraft

boolean

Is Draft

☐

 

linkType_$type

string

 

☐

 

linkType_aggregation

boolean

 

☐

 

linkType_directed

boolean

 

☐

 

linkType_id

string

 

☐

 

linkType_localizedName

string

 

☐

 

linkType_localizedSourceToTarget

string

 

☐

 

linkType_localizedTargetToSource

string

 

☐

 

linkType_name

string

 

☐

 

linkType_readOnly

boolean

 

☐

 

linkType_sourceToTarget

string

 

☐

 

linkType_targetToSource

string

 

☐

 

numberInProject

int64

Number in Project

☐

 

parent_$type

string

 

☐

 

parent_direction

string

 

☐

 

parent_id

string

 

☐

 

parent_linkType_$type

string

 

☐

 

parent_linkType_aggregation

boolean

 

☐

 

parent_linkType_directed

boolean

 

☐

 

parent_linkType_id

string

 

☐

 

parent_linkType_localizedName

string

 

☐

 

parent_linkType_localizedSourceToTarget

string

 

☐

 

parent_linkType_localizedTargetToSource

string

 

☐

 

parent_linkType_name

string

 

☐

 

parent_linkType_readOnly

boolean

 

☐

 

parent_linkType_sourceToTarget

string

 

☐

 

parent_linkType_targetToSource

string

 

☐

 

project_archived

boolean

 

☐

 

project_createdBy_$type

string

 

☐

 

project_createdBy_avatarUrl

string

 

☐

 

project_createdBy_banned

boolean

 

☐

 

project_createdBy_email

string

 

☐

 

project_createdBy_fullName

string

 

☐

 

project_createdBy_guest

boolean

 

☐

 

project_createdBy_id

string

 

☐

 

project_createdBy_jabberAccountName

string

 

☐

 

project_createdBy_login

string

 

☐

 

project_createdBy_online

boolean

 

☐

 

project_createdBy_ringId

string

 

☐

 

project_description

string

 

☐

 

project_fromEmail

string

 

☐

 

project_iconUrl

string

 

☐

 

project_leader_$type

string

 

☐

 

project_leader_avatarUrl

string

 

☐

 

project_leader_banned

boolean

 

☐

 

project_leader_email

string

 

☐

 

project_leader_fullName

string

 

☐

 

project_leader_guest

boolean

 

☐

 

project_leader_id

string

 

☐

 

project_leader_jabberAccountName

string

 

☐

 

project_leader_login

string

 

☐

 

project_leader_online

boolean

 

☐

 

project_leader_ringId

string

 

☐

 

project_replyToEmail

string

 

☐

 

project_shortName

string

 

☐

 

project_startingNumber

int64

 

☐

 

project_team_$type

string

 

☐

 

project_team_allUsersGroup

boolean

 

☐

 

project_team_icon

string

 

☐

 

project_team_id

string

 

☐

 

project_team_name

string

 

☐

 

project_team_ringId

string

 

☐

 

project_team_usersCount

int64

 

☐

 

project_template

boolean

 

☐

 

reporter_$type

string

 

☐

 

reporter_avatarUrl

string

 

☐

 

reporter_banned

boolean

 

☐

 

reporter_email

string

 

☐

 

reporter_fullName

string

 

☐

 

reporter_guest

boolean

 

☐

 

reporter_id

string

 

☐

 

reporter_jabberAccountName

string

 

☐

 

reporter_login

string

 

☐

 

reporter_online

boolean

 

☐

 

reporter_profiles_$type

string

 

☐

 

reporter_profiles_id

string

 

☐

 

reporter_ringId

string

 

☐

 

resolved

int64

Resolved

☐

 

subtasks_$type

string

 

☐

 

subtasks_direction

string

 

☐

 

subtasks_id

string

 

☐

 

subtasks_linkType_$type

string

 

☐

 

subtasks_linkType_aggregation

boolean

 

☐

 

subtasks_linkType_directed

boolean

 

☐

 

subtasks_linkType_id

string

 

☐

 

subtasks_linkType_localizedName

string

 

☐

 

subtasks_linkType_localizedSourceToTarget

string

 

☐

 

subtasks_linkType_localizedTargetToSource

string

 

☐

 

subtasks_linkType_name

string

 

☐

 

subtasks_linkType_readOnly

boolean

 

☐

 

subtasks_linkType_sourceToTarget

string

 

☐

 

subtasks_linkType_targetToSource

string

 

☐

 

summary

string

Summary

☐

 

updated

int64

Updated

☐

 

updater_$type

string

 

☐

 

updater_avatarUrl

string

 

☐

 

updater_banned

boolean

 

☐

 

updater_email

string

 

☐

 

updater_fullName

string

 

☐

 

updater_guest

boolean

 

☐

 

updater_id

string

 

☐

 

updater_jabberAccountName

string

 

☐

 

updater_login

string

 

☐

 

updater_online

boolean

 

☐

 

updater_profiles_$type

string

 

☐

 

updater_profiles_id

string

 

☐

 

updater_ringId

string

 

☐

 

usesMarkdown

boolean

Uses Mark Down

☐

 

visibility_$type

string

 

☐

 

visibility_id

string

 

☐

 

voters_$type

string

 

☐

 

voters_hasVote

boolean

 

☐

 

voters_id

string

 

☐

 

votes

int32

Votes

☐

 

watchers_$type

string

 

☐

 

watchers_hasStar

boolean

 

☐

 

watchers_id

string

 

☐

 

wikifiedDescription

string

Wikified Description

☐

 

 

23-06-2022 19:43 Version 22.0.248-PROD+3461

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer