Please enable JavaScript to view this site.

YouTrack Forums

YouTrack API Data Model

Navigation: Schema: Users > Tables

WorkItemById

Catalog: YouTrack

Schema: Users

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: /workItems/{id}

Insert YouTrack API URL: /workItems/{id}

Update YouTrack API URL: /workItems/{id}

Delete YouTrack API URL: /workItems/{id}

Field Selection Method: NotRequired

Select YouTrack API Operation: get /workItems/{id}

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function WorkItemById. 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 WorkItemById are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

$type

string

 

☐

 

author_$type

string

 

☐

 

author_avatarUrl

string

 

☐

 

author_banned

boolean

 

☐

 

author_email

string

 

☐

 

author_fullName

string

 

☐

 

author_guest

boolean

 

☐

 

author_id

string

 

☐

 

author_jabberAccountName

string

 

☐

 

author_login

string

 

☐

 

author_online

boolean

 

☐

 

author_profiles_$type

string

 

☐

 

author_profiles_id

string

 

☐

 

author_ringId

string

 

☐

 

created

int64

Created

☐

 

creator_$type

string

 

☐

 

creator_avatarUrl

string

 

☐

 

creator_banned

boolean

 

☐

 

creator_email

string

 

☐

 

creator_fullName

string

 

☐

 

creator_guest

boolean

 

☐

 

creator_id

string

 

☐

 

creator_jabberAccountName

string

 

☐

 

creator_login

string

 

☐

 

creator_online

boolean

 

☐

 

creator_profiles_$type

string

 

☐

 

creator_profiles_id

string

 

☐

 

creator_ringId

string

 

☐

 

date

int64

Date

☐

 

duration_$type

string

 

☐

 

duration_id

string

 

☐

 

duration_minutes

int32

 

☐

 

duration_presentation

string

 

☐

 

id

string

ID

☐

 

issue_$type

string

 

☐

 

issue_commentsCount

int32

 

☐

 

issue_created

int64

 

☐

 

issue_description

string

 

☐

 

issue_draftOwner_$type

string

 

☐

 

issue_draftOwner_avatarUrl

string

 

☐

 

issue_draftOwner_banned

boolean

 

☐

 

issue_draftOwner_email

string

 

☐

 

issue_draftOwner_fullName

string

 

☐

 

issue_draftOwner_guest

boolean

 

☐

 

issue_draftOwner_id

string

 

☐

 

issue_draftOwner_jabberAccountName

string

 

☐

 

issue_draftOwner_login

string

 

☐

 

issue_draftOwner_online

boolean

 

☐

 

issue_draftOwner_ringId

string

 

☐

 

issue_externalIssue_$type

string

 

☐

 

issue_externalIssue_id

string

 

☐

 

issue_externalIssue_key

string

 

☐

 

issue_externalIssue_name

string

 

☐

 

issue_externalIssue_url

string

 

☐

 

issue_id

string

 

☐

 

issue_idReadable

string

 

☐

 

issue_isDraft

boolean

 

☐

 

issue_numberInProject

int64

 

☐

 

issue_parent_$type

string

 

☐

 

issue_parent_direction

string

 

☐

 

issue_parent_id

string

 

☐

 

issue_project_archived

boolean

 

☐

 

issue_project_description

string

 

☐

 

issue_project_fromEmail

string

 

☐

 

issue_project_iconUrl

string

 

☐

 

issue_project_replyToEmail

string

 

☐

 

issue_project_shortName

string

 

☐

 

issue_project_startingNumber

int64

 

☐

 

issue_project_template

boolean

 

☐

 

issue_reporter_$type

string

 

☐

 

issue_reporter_avatarUrl

string

 

☐

 

issue_reporter_banned

boolean

 

☐

 

issue_reporter_email

string

 

☐

 

issue_reporter_fullName

string

 

☐

 

issue_reporter_guest

boolean

 

☐

 

issue_reporter_id

string

 

☐

 

issue_reporter_jabberAccountName

string

 

☐

 

issue_reporter_login

string

 

☐

 

issue_reporter_online

boolean

 

☐

 

issue_reporter_ringId

string

 

☐

 

issue_resolved

int64

 

☐

 

issue_subtasks_$type

string

 

☐

 

issue_subtasks_direction

string

 

☐

 

issue_subtasks_id

string

 

☐

 

issue_summary

string

 

☐

 

issue_updated

int64

 

☐

 

issue_updater_$type

string

 

☐

 

issue_updater_avatarUrl

string

 

☐

 

issue_updater_banned

boolean

 

☐

 

issue_updater_email

string

 

☐

 

issue_updater_fullName

string

 

☐

 

issue_updater_guest

boolean

 

☐

 

issue_updater_id

string

 

☐

 

issue_updater_jabberAccountName

string

 

☐

 

issue_updater_login

string

 

☐

 

issue_updater_online

boolean

 

☐

 

issue_updater_ringId

string

 

☐

 

issue_usesMarkdown

boolean

 

☐

 

issue_visibility_$type

string

 

☐

 

issue_visibility_id

string

 

☐

 

issue_voters_$type

string

 

☐

 

issue_voters_hasVote

boolean

 

☐

 

issue_voters_id

string

 

☐

 

issue_votes

int32

 

☐

 

issue_watchers_$type

string

 

☐

 

issue_watchers_hasStar

boolean

 

☐

 

issue_watchers_id

string

 

☐

 

issue_wikifiedDescription

string

 

☐

 

text

string

Text

☐

 

textPreview

string

Text Preview

☐

 

type_$type

string

 

☐

 

type_autoAttached

boolean

 

☐

 

type_id

string

 

☐

 

type_name

string

 

☐

 

updated

int64

Updated

☐

 

usesMarkdown

boolean

Uses Mark Down

☐

 

 

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