Please enable JavaScript to view this site.

YouTrack Forums

YouTrack API Data Model

Navigation: Schema: CustomFields > Tables

CustomFieldsByCustomFieldPrototypeId3

Catalog: YouTrack

Schema: CustomFields

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: /admin/customFieldSettings/customFields/{id}/instances

Insert YouTrack API URL: /admin/customFieldSettings/customFields/{id}/instances

Update YouTrack API URL: /admin/customFieldSettings/customFields/{id}/instances

Delete YouTrack API URL: /admin/customFieldSettings/customFields/{id}/instances

Field Selection Method: NotRequired

Select YouTrack API Operation: get /admin/customFieldSettings/customFields/{id}/instances

Parameters of Table Function

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

Name

Data Type

Label

Required

Documentation

$type

string

 

☐

 

canBeEmpty

boolean

Nullable

☐

 

condition_$type

string

 

☐

 

condition_id

string

 

☐

 

condition_parent_$type

string

 

☐

 

condition_parent_canBeEmpty

boolean

 

☐

 

condition_parent_emptyFieldText

string

 

☐

 

condition_parent_hasRunningJob

boolean

 

☐

 

condition_parent_id

string

 

☐

 

condition_parent_isPublic

boolean

 

☐

 

condition_parent_ordinal

int32

 

☐

 

emptyFieldText

string

Empty Field Text

☐

 

field_$type

string

 

☐

 

field_aliases

string

 

☐

 

field_fieldDefaults_$type

string

 

☐

 

field_fieldDefaults_canBeEmpty

boolean

 

☐

 

field_fieldDefaults_emptyFieldText

string

 

☐

 

field_fieldDefaults_id

string

 

☐

 

field_fieldDefaults_isPublic

boolean

 

☐

 

field_fieldType_$type

string

 

☐

 

field_fieldType_id

string

 

☐

 

field_hasRunningJob

boolean

 

☐

 

field_id

string

 

☐

 

field_isAutoAttached

boolean

 

☐

 

field_isDisplayedInIssueList

boolean

 

☐

 

field_isUpdateable

boolean

 

☐

 

field_localizedName

string

 

☐

 

field_name

string

 

☐

 

field_ordinal

int32

 

☐

 

hasRunningJob

boolean

Has Running Job

☐

 

id

string

ID

☐

 

isPublic

boolean

Is Public

☐

 

ordinal

int32

Ordinal

☐

 

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

 

☐

 

 

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