YouTrack API Data Model
AdminCustomFieldSettingsCustomFieldsByIdInstances |
Catalog: YouTrack
Retrieve: true
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 AdminCustomFieldSettingsCustomFieldsByIdInstances. 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 AdminCustomFieldSettingsCustomFieldsByIdInstances 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 |
|
☐ |
|
21-06-2022 17:34 Version 22.1.46-BETA+3385
