Project Custom Fields
This resource lets you access and configure custom fields in the specific project.
Resource | |
|---|---|
Returned entity | ProjectCustomField. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
Represents settings for custom fields in a particular project.
Below you can find the list of resources that let you work with this entity.
This table describes attributes of the ProjectCustomField entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the project custom field. |
field | The custom field in the project. | |
project | The project where the custom field belongs. | |
canBeEmpty | Boolean | If |
emptyFieldText | String | The text that is shown as a placeholder when the custom field has an empty value. |
ordinal | Int | The position number of this field on the list of project custom fields. |
isPublic | Boolean | If |
hasRunningJob | Boolean | If |
condition | The condition for showing the custom field. |
Read the list of custom fields that are attached to a specific project.
GET /api/admin/projects/{projectID}/customFields?{fields}&{$top}&{$skip}null | Database ID of ProjectCustomField |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of ProjectCustomField attributes that should be returned in the response. If no field is specified, only the |
$skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
$top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries. The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |
https://example.youtrack.cloud/api/admin/projects/0-0/customFields?$top=5&fields=id,field(name,fieldType($type)),project(shortName),canBeEmpty,isPublic[
{
"field": {
"fieldType": {
"$type": "FieldType"
},
"name": "Subsystem",
"$type": "CustomField"
},
"project": {
"shortName": "NP",
"$type": "Project"
},
"canBeEmpty": true,
"isPublic": true,
"id": "82-8",
"$type": "OwnedProjectCustomField"
},
{
"field": {
"fieldType": {
"$type": "FieldType"
},
"name": "Priority",
"$type": "CustomField"
},
"project": {
"shortName": "NP",
"$type": "Project"
},
"canBeEmpty": true,
"isPublic": true,
"id": "82-9",
"$type": "EnumProjectCustomField"
},
{
"field": {
"fieldType": {
"$type": "FieldType"
},
"name": "Type",
"$type": "CustomField"
},
"project": {
"shortName": "NP",
"$type": "Project"
},
"canBeEmpty": false,
"isPublic": true,
"id": "82-10",
"$type": "EnumProjectCustomField"
},
{
"field": {
"fieldType": {
"$type": "FieldType"
},
"name": "State",
"$type": "CustomField"
},
"project": {
"shortName": "NP",
"$type": "Project"
},
"canBeEmpty": false,
"isPublic": true,
"id": "82-11",
"$type": "StateProjectCustomField"
},
{
"field": {
"fieldType": {
"$type": "FieldType"
},
"name": "Fix versions",
"$type": "CustomField"
},
"project": {
"shortName": "NP",
"$type": "Project"
},
"canBeEmpty": true,
"isPublic": true,
"id": "82-12",
"$type": "VersionProjectCustomField"
},
{
"field": {
"fieldType": {
"$type": "FieldType"
},
"name": "Assignee",
"$type": "CustomField"
},
"project": {
"shortName": "NP",
"$type": "Project"
},
"canBeEmpty": true,
"isPublic": true,
"id": "84-111",
"$type": "UserProjectCustomField"
}
]Attach the custom field to the project.
Required fields: field (id) – the database ID of the CustomField prototype that you're attaching to the project, $type – the type of the ProjectCustomField that YouTrack will create as the result of this request. For the mapping between the prototype field type and the ProjectCustomField $type, see Type Mapping for Custom Fields.
Requires permissions: Update Project
POST /api/admin/projects/{projectID}/customFields?{fields}null | Database ID of ProjectCustomField |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of ProjectCustomField attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/projects/81-1/customFields?fields=field(fieldType(valueType,id),name,id){
"field": {
"name": "Last message related emails",
"id": "46-21",
"$type": "CustomField"
},
"$type": "SimpleProjectCustomField"
}{
"field": {
"fieldType": {
"valueType": "string",
"id": "string",
"$type": "FieldType"
},
"name": "Last message related emails",
"id": "46-21",
"$type": "CustomField"
},
"$type": "SimpleProjectCustomField"
}