Please enable JavaScript to view this site.

Made in EU
YouTrack Forums

YouTrack API Data Model

Navigation: Schema: Agile > Tables

SprintIssuesBySprintId1

Catalog: YouTrack

Schema: Agile

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

Insert YouTrack API URL: /agiles/{id}/sprints

Update YouTrack API URL: /agiles/{id}/sprints

Delete YouTrack API URL: /agiles/{id}/sprints

Field Selection Method: NotRequired

Base Path: issues[*]

Select YouTrack API Operation: get /agiles/{id}/sprints

Parameters of Table Function

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

Name

Data Type

Label

Required

Documentation

$type_1

string

 

☐

 

$type

string

 

☐

 

agile_$type

string

 

☐

 

agile_colorCoding_$type

string

 

☐

 

agile_colorCoding_id

string

 

☐

 

agile_columnSettings_$type

string

 

☐

 

agile_columnSettings_id

string

 

☐

 

agile_currentSprint_$type

string

 

☐

 

agile_currentSprint_archived

boolean

 

☐

 

agile_currentSprint_finish

int64

 

☐

 

agile_currentSprint_goal

string

 

☐

 

agile_currentSprint_id

string

 

☐

 

agile_currentSprint_isDefault

boolean

 

☐

 

agile_currentSprint_name

string

 

☐

 

agile_currentSprint_start

int64

 

☐

 

agile_currentSprint_unresolvedIssuesCount

int32

 

☐

 

agile_estimationField_$type

string

 

☐

 

agile_estimationField_aliases

string

 

☐

 

agile_estimationField_hasRunningJob

boolean

 

☐

 

agile_estimationField_id

string

 

☐

 

agile_estimationField_isAutoAttached

boolean

 

☐

 

agile_estimationField_isDisplayedInIssueList

boolean

 

☐

 

agile_estimationField_isUpdateable

boolean

 

☐

 

agile_estimationField_localizedName

string

 

☐

 

agile_estimationField_name

string

 

☐

 

agile_estimationField_ordinal

int32

 

☐

 

agile_hideOrphansSwimlane

boolean

 

☐

 

agile_id

string

 

☐

 

agile_name

string

 

☐

 

agile_originalEstimationField_$type

string

 

☐

 

agile_originalEstimationField_aliases

string

 

☐

 

agile_originalEstimationField_hasRunningJob

boolean

 

☐

 

agile_originalEstimationField_id

string

 

☐

 

agile_originalEstimationField_isAutoAttached

boolean

 

☐

 

agile_originalEstimationField_isDisplayedInIssueList

boolean

 

☐

 

agile_originalEstimationField_isUpdateable

boolean

 

☐

 

agile_originalEstimationField_localizedName

string

 

☐

 

agile_originalEstimationField_name

string

 

☐

 

agile_originalEstimationField_ordinal

int32

 

☐

 

agile_orphansAtTheTop

boolean

 

☐

 

agile_owner_$type

string

 

☐

 

agile_owner_avatarUrl

string

 

☐

 

agile_owner_banned

boolean

 

☐

 

agile_owner_email

string

 

☐

 

agile_owner_fullName

string

 

☐

 

agile_owner_guest

boolean

 

☐

 

agile_owner_id

string

 

☐

 

agile_owner_jabberAccountName

string

 

☐

 

agile_owner_login

string

 

☐

 

agile_owner_online

boolean

 

☐

 

agile_owner_ringId

string

 

☐

 

agile_sprintsSettings_$type

string

 

☐

 

agile_sprintsSettings_cardOnSeveralSprints

boolean

 

☐

 

agile_sprintsSettings_disableSprints

boolean

 

☐

 

agile_sprintsSettings_explicitQuery

string

 

☐

 

agile_sprintsSettings_hideSubtasksOfCards

boolean

 

☐

 

agile_sprintsSettings_id

string

 

☐

 

agile_sprintsSettings_isExplicit

boolean

 

☐

 

agile_status_$type

string

 

☐

 

agile_status_hasJobs

boolean

 

☐

 

agile_status_id

string

 

☐

 

agile_status_valid

boolean

 

☐

 

agile_swimlaneSettings_$type

string

 

☐

 

agile_swimlaneSettings_enabled

boolean

 

☐

 

agile_swimlaneSettings_id

string

 

☐

 

agile_updateableBy_$type

string

 

☐

 

agile_updateableBy_allUsersGroup

boolean

 

☐

 

agile_updateableBy_icon

string

 

☐

 

agile_updateableBy_id

string

 

☐

 

agile_updateableBy_name

string

 

☐

 

agile_updateableBy_ringId

string

 

☐

 

agile_updateableBy_usersCount

int64

 

☐

 

agile_updateableByProjectBased

boolean

 

☐

 

agile_visibleFor_$type

string

 

☐

 

agile_visibleFor_allUsersGroup

boolean

 

☐

 

agile_visibleFor_icon

string

 

☐

 

agile_visibleFor_id

string

 

☐

 

agile_visibleFor_name

string

 

☐

 

agile_visibleFor_ringId

string

 

☐

 

agile_visibleFor_usersCount

int64

 

☐

 

agile_visibleForProjectBased

boolean

 

☐

 

archived

boolean

Archived

☐

 

commentsCount

int32

Comments Count

☐

 

created

int64

Created

☐

 

description

string

Description

☐

 

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_ringId

string

 

☐

 

externalIssue_$type

string

 

☐

 

externalIssue_id

string

 

☐

 

externalIssue_key

string

 

☐

 

externalIssue_name

string

 

☐

 

externalIssue_url

string

 

☐

 

finish

int64

Finish

☐

 

goal

string

Goal

☐

 

id_1

string

 

☐

 

id

string

ID

☐

 

idReadable

string

Readable ID

☐

 

isDefault

boolean

Is Default

☐

 

isDraft

boolean

Is Draft

☐

 

name

string

Name

☐

 

numberInProject

int64

Number in Project

☐

 

parent_$type

string

 

☐

 

parent_direction

string

 

☐

 

parent_id

string

 

☐

 

previousSprint_$type

string

 

☐

 

previousSprint_agile_$type

string

 

☐

 

previousSprint_agile_hideOrphansSwimlane

boolean

 

☐

 

previousSprint_agile_id

string

 

☐

 

previousSprint_agile_name

string

 

☐

 

previousSprint_agile_orphansAtTheTop

boolean

 

☐

 

previousSprint_agile_updateableByProjectBased

boolean

 

☐

 

previousSprint_agile_visibleForProjectBased

boolean

 

☐

 

previousSprint_archived

boolean

 

☐

 

previousSprint_finish

int64

 

☐

 

previousSprint_goal

string

 

☐

 

previousSprint_id

string

 

☐

 

previousSprint_isDefault

boolean

 

☐

 

previousSprint_name

string

 

☐

 

previousSprint_previousSprint_$type

string

 

☐

 

previousSprint_previousSprint_archived

boolean

 

☐

 

previousSprint_previousSprint_finish

int64

 

☐

 

previousSprint_previousSprint_goal

string

 

☐

 

previousSprint_previousSprint_id

string

 

☐

 

previousSprint_previousSprint_isDefault

boolean

 

☐

 

previousSprint_previousSprint_name

string

 

☐

 

previousSprint_previousSprint_start

int64

 

☐

 

previousSprint_previousSprint_unresolvedIssuesCount

int32

 

☐

 

previousSprint_start

int64

 

☐

 

previousSprint_unresolvedIssuesCount

int32

 

☐

 

project_archived

boolean

 

☐

 

project_description

string

 

☐

 

project_fromEmail

string

 

☐

 

project_iconUrl

string

 

☐

 

project_replyToEmail

string

 

☐

 

project_shortName

string

 

☐

 

project_startingNumber

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_ringId

string

 

☐

 

resolved

int64

Resolved

☐

 

start

int64

Start

☐

 

subtasks_$type

string

 

☐

 

subtasks_direction

string

 

☐

 

subtasks_id

string

 

☐

 

summary

string

Summary

☐

 

unresolvedIssuesCount

int32

Unresolved Issue Count

☐

 

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