Please enable JavaScript to view this site.

YouTrack API Data Model YouTrack Forums

Navigation: Schema: Agile > Tables

SprintById1

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}

Insert YouTrack API URL: /agiles/{id}

Update YouTrack API URL: /agiles/{id}

Delete YouTrack API URL: /agiles/{id}

Field Selection Method: NotRequired

Base Path: sprints[*]

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

Parameters of Table Function

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

boolean

 

☐

 

agile_id

string

 

☐

 

agile_name

string

 

☐

 

agile_orphansAtTheTop

boolean

 

☐

 

agile_updateableByProjectBased

boolean

 

☐

 

agile_visibleForProjectBased

boolean

 

☐

 

archived

boolean

Archived

☐

 

colorCoding_$type

string

 

☐

 

colorCoding_id

string

 

☐

 

columnSettings_$type

string

 

☐

 

columnSettings_field_$type

string

 

☐

 

columnSettings_field_aliases

string

 

☐

 

columnSettings_field_hasRunningJob

boolean

 

☐

 

columnSettings_field_id

string

 

☐

 

columnSettings_field_isAutoAttached

boolean

 

☐

 

columnSettings_field_isDisplayedInIssueList

boolean

 

☐

 

columnSettings_field_isUpdateable

boolean

 

☐

 

columnSettings_field_localizedName

string

 

☐

 

columnSettings_field_name

string

 

☐

 

columnSettings_field_ordinal

int32

 

☐

 

columnSettings_id

string

 

☐

 

currentSprint_$type

string

 

☐

 

currentSprint_agile_$type

string

 

☐

 

currentSprint_agile_hideOrphansSwimlane

boolean

 

☐

 

currentSprint_agile_id

string

 

☐

 

currentSprint_agile_name

string

 

☐

 

currentSprint_agile_orphansAtTheTop

boolean

 

☐

 

currentSprint_agile_updateableByProjectBased

boolean

 

☐

 

currentSprint_agile_visibleForProjectBased

boolean

 

☐

 

currentSprint_archived

boolean

 

☐

 

currentSprint_finish

int64

 

☐

 

currentSprint_goal

string

 

☐

 

currentSprint_id

string

 

☐

 

currentSprint_isDefault

boolean

 

☐

 

currentSprint_name

string

 

☐

 

currentSprint_previousSprint_$type

string

 

☐

 

currentSprint_previousSprint_archived

boolean

 

☐

 

currentSprint_previousSprint_finish

int64

 

☐

 

currentSprint_previousSprint_goal

string

 

☐

 

currentSprint_previousSprint_id

string

 

☐

 

currentSprint_previousSprint_isDefault

boolean

 

☐

 

currentSprint_previousSprint_name

string

 

☐

 

currentSprint_previousSprint_start

int64

 

☐

 

currentSprint_previousSprint_unresolvedIssuesCount

int32

 

☐

 

currentSprint_start

int64

 

☐

 

currentSprint_unresolvedIssuesCount

int32

 

☐

 

estimationField_$type

string

 

☐

 

estimationField_aliases

string

 

☐

 

estimationField_fieldDefaults_$type

string

 

☐

 

estimationField_fieldDefaults_canBeEmpty

boolean

 

☐

 

estimationField_fieldDefaults_emptyFieldText

string

 

☐

 

estimationField_fieldDefaults_id

string

 

☐

 

estimationField_fieldDefaults_isPublic

boolean

 

☐

 

estimationField_fieldType_$type

string

 

☐

 

estimationField_fieldType_id

string

 

☐

 

estimationField_hasRunningJob

boolean

 

☐

 

estimationField_id

string

 

☐

 

estimationField_isAutoAttached

boolean

 

☐

 

estimationField_isDisplayedInIssueList

boolean

 

☐

 

estimationField_isUpdateable

boolean

 

☐

 

estimationField_localizedName

string

 

☐

 

estimationField_name

string

 

☐

 

estimationField_ordinal

int32

 

☐

 

finish

int64

Finish

☐

 

goal

string

Goal

☐

 

hideOrphansSwimlane

boolean

 

☐

 

id_1

string

 

☐

 

id

string

ID

☐

 

isDefault

boolean

Is Default

☐

 

name_1

string

 

☐

 

name

string

Name

☐

 

originalEstimationField_$type

string

 

☐

 

originalEstimationField_aliases

string

 

☐

 

originalEstimationField_fieldDefaults_$type

string

 

☐

 

originalEstimationField_fieldDefaults_canBeEmpty

boolean

 

☐

 

originalEstimationField_fieldDefaults_emptyFieldText

string

 

☐

 

originalEstimationField_fieldDefaults_id

string

 

☐

 

originalEstimationField_fieldDefaults_isPublic

boolean

 

☐

 

originalEstimationField_fieldType_$type

string

 

☐

 

originalEstimationField_fieldType_id

string

 

☐

 

originalEstimationField_hasRunningJob

boolean

 

☐

 

originalEstimationField_id

string

 

☐

 

originalEstimationField_isAutoAttached

boolean

 

☐

 

originalEstimationField_isDisplayedInIssueList

boolean

 

☐

 

originalEstimationField_isUpdateable

boolean

 

☐

 

originalEstimationField_localizedName

string

 

☐

 

originalEstimationField_name

string

 

☐

 

originalEstimationField_ordinal

int32

 

☐

 

orphansAtTheTop

boolean

 

☐

 

owner_$type

string

 

☐

 

owner_avatarUrl

string

 

☐

 

owner_banned

boolean

 

☐

 

owner_email

string

 

☐

 

owner_fullName

string

 

☐

 

owner_guest

boolean

 

☐

 

owner_id

string

 

☐

 

owner_jabberAccountName

string

 

☐

 

owner_login

string

 

☐

 

owner_online

boolean

 

☐

 

owner_profiles_$type

string

 

☐

 

owner_profiles_id

string

 

☐

 

owner_ringId

string

 

☐

 

previousSprint_$type

string

 

☐

 

previousSprint_archived

boolean

 

☐

 

previousSprint_finish

int64

 

☐

 

previousSprint_goal

string

 

☐

 

previousSprint_id

string

 

☐

 

previousSprint_isDefault

boolean

 

☐

 

previousSprint_name

string

 

☐

 

previousSprint_start

int64

 

☐

 

previousSprint_unresolvedIssuesCount

int32

 

☐

 

sprintsSettings_$type

string

 

☐

 

sprintsSettings_cardOnSeveralSprints

boolean

 

☐

 

sprintsSettings_defaultSprint_$type

string

 

☐

 

sprintsSettings_defaultSprint_archived

boolean

 

☐

 

sprintsSettings_defaultSprint_finish

int64

 

☐

 

sprintsSettings_defaultSprint_goal

string

 

☐

 

sprintsSettings_defaultSprint_id

string

 

☐

 

sprintsSettings_defaultSprint_isDefault

boolean

 

☐

 

sprintsSettings_defaultSprint_name

string

 

☐

 

sprintsSettings_defaultSprint_start

int64

 

☐

 

sprintsSettings_defaultSprint_unresolvedIssuesCount

int32

 

☐

 

sprintsSettings_disableSprints

boolean

 

☐

 

sprintsSettings_explicitQuery

string

 

☐

 

sprintsSettings_hideSubtasksOfCards

boolean

 

☐

 

sprintsSettings_id

string

 

☐

 

sprintsSettings_isExplicit

boolean

 

☐

 

sprintsSettings_sprintSyncField_$type

string

 

☐

 

sprintsSettings_sprintSyncField_aliases

string

 

☐

 

sprintsSettings_sprintSyncField_hasRunningJob

boolean

 

☐

 

sprintsSettings_sprintSyncField_id

string

 

☐

 

sprintsSettings_sprintSyncField_isAutoAttached

boolean

 

☐

 

sprintsSettings_sprintSyncField_isDisplayedInIssueList

boolean

 

☐

 

sprintsSettings_sprintSyncField_isUpdateable

boolean

 

☐

 

sprintsSettings_sprintSyncField_localizedName

string

 

☐

 

sprintsSettings_sprintSyncField_name

string

 

☐

 

sprintsSettings_sprintSyncField_ordinal

int32

 

☐

 

start

int64

Start

☐

 

status_$type

string

 

☐

 

status_hasJobs

boolean

 

☐

 

status_id

string

 

☐

 

status_valid

boolean

 

☐

 

swimlaneSettings_$type

string

 

☐

 

swimlaneSettings_enabled

boolean

 

☐

 

swimlaneSettings_id

string

 

☐

 

unresolvedIssuesCount

int32

Unresolved Issue Count

☐

 

updateableBy_$type

string

 

☐

 

updateableBy_allUsersGroup

boolean

 

☐

 

updateableBy_icon

string

 

☐

 

updateableBy_id

string

 

☐

 

updateableBy_name

string

 

☐

 

updateableBy_ringId

string

 

☐

 

updateableBy_teamForProject_archived

boolean

 

☐

 

updateableBy_teamForProject_description

string

 

☐

 

updateableBy_teamForProject_fromEmail

string

 

☐

 

updateableBy_teamForProject_iconUrl

string

 

☐

 

updateableBy_teamForProject_replyToEmail

string

 

☐

 

updateableBy_teamForProject_shortName

string

 

☐

 

updateableBy_teamForProject_startingNumber

int64

 

☐

 

updateableBy_teamForProject_template

boolean

 

☐

 

updateableBy_usersCount

int64

 

☐

 

updateableByProjectBased

boolean

 

☐

 

visibleFor_$type

string

 

☐

 

visibleFor_allUsersGroup

boolean

 

☐

 

visibleFor_icon

string

 

☐

 

visibleFor_id

string

 

☐

 

visibleFor_name

string

 

☐

 

visibleFor_ringId

string

 

☐

 

visibleFor_teamForProject_archived

boolean

 

☐

 

visibleFor_teamForProject_description

string

 

☐

 

visibleFor_teamForProject_fromEmail

string

 

☐

 

visibleFor_teamForProject_iconUrl

string

 

☐

 

visibleFor_teamForProject_replyToEmail

string

 

☐

 

visibleFor_teamForProject_shortName

string

 

☐

 

visibleFor_teamForProject_startingNumber

int64

 

☐

 

visibleFor_teamForProject_template

boolean

 

☐

 

visibleFor_usersCount

int64

 

☐

 

visibleForProjectBased

boolean

 

☐

 

 

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