This resource represents issue field configurations. Use it to get, set, and delete field configurations and field configuration schemes.
Returns a paginated list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:
Only field configurations used in company-managed (classic) projects are returned.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationread:field-configuration:jirainteger
integer
array<integer>
boolean
string
Returned if the request is successful.
A page of items.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfiguration`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 2,
"values": [
{
"id": 10000,
"name": "Default Field Configuration",
"description": "The default field configuration description",
"isDefault": true
},
{
"id": 10001,
"name": "My Field Configuration",
"description": "My field configuration description"
}
]
}Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.
This operation can only create configurations for use in company-managed (classic) projects.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationread:field-configuration:jira, write:field-configuration:jirastring
string
RequiredReturned if the request is successful.
Details of a field configuration.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"description": "My field configuration description",
"name": "My Field Configuration"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfiguration`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
{
"description": "My field configuration description",
"id": 10001,
"name": "My Field Configuration"
}Updates a field configuration. The name and the description provided in the request override the existing values.
This operation can only update configurations used in company-managed (classic) projects.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:field-configuration:jirainteger
Requiredstring
string
RequiredReturned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"description": "A brand new description",
"name": "My Modified Field Configuration"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfiguration/{id}`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Deletes a field configuration.
This operation can only delete configurations used in company-managed (classic) projects.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationdelete:field-configuration:jirainteger
RequiredReturned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfiguration/{id}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returns a paginated list of all fields for a configuration.
Only the fields from configurations used in company-managed (classic) projects are returned.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationread:field-configuration:jirainteger
Requiredinteger
integer
Returned if the request is successful.
A page of items.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfiguration/{id}/fields`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 2,
"values": [
{
"description": "For example operating system, software platform and/or hardware specifications (include as appropriate for the issue).",
"id": "environment",
"isHidden": false,
"isRequired": false
},
{
"id": "description",
"isHidden": false,
"isRequired": false
}
]
}Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.
This operation can only update field configurations used in company-managed (classic) projects.
The operation can set the renderer for text fields to the default text renderer (text-renderer) or wiki style renderer (wiki-renderer). However, the renderer cannot be updated for fields using the autocomplete renderer (autocomplete-renderer).
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:field-configuration:jirainteger
Requiredarray<FieldConfigurationItem>
RequiredReturned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"fieldConfigurationItems": [
{
"description": "The new description of this item.",
"id": "customfield_10012",
"isHidden": false
},
{
"id": "customfield_10011",
"isRequired": true
},
{
"description": "Another new description.",
"id": "customfield_10010",
"isHidden": false,
"isRequired": false,
"renderer": "wiki-renderer"
}
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfiguration/{id}/fields`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returns a paginated list of field configuration schemes.
Only field configuration schemes used in classic projects are returned.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationread:field-configuration-scheme:jirainteger
integer
array<integer>
Returned if the request is successful.
A page of items.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfigurationscheme`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"isLast": true,
"maxResults": 10,
"startAt": 0,
"total": 3,
"values": [
{
"id": "10000",
"name": "Field Configuration Scheme for Bugs",
"description": "This field configuration scheme is for bugs only."
},
{
"id": "10001",
"name": "Field Configuration Scheme for software related projects",
"description": "We can use this one for software projects."
},
{
"id": "10002",
"name": "Field Configuration Scheme for Epics",
"description": "Use this one for Epic issue type."
}
]
}Creates a field configuration scheme.
This operation can only create field configuration schemes used in company-managed (classic) projects.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:field-configuration-scheme:jira, read:field-configuration-scheme:jiraThe details of the field configuration scheme.
string
string
RequiredReturned if the request is successful.
Details of a field configuration scheme.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"description": "We can use this one for software projects.",
"name": "Field Configuration Scheme for software related projects"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfigurationscheme`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
{
"id": "10002",
"name": "Field Configuration Scheme for software related projects",
"description": "We can use this one for software projects."
}Returns a paginated list of field configuration issue type items.
Only items used in classic projects are returned.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationread:field-configuration-scheme:jirainteger
integer
array<integer>
Returned if the request is successful.
A page of items.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfigurationscheme/mapping`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 5,
"values": [
{
"fieldConfigurationSchemeId": "10020",
"issueTypeId": "10000",
"fieldConfigurationId": "10010"
},
{
"fieldConfigurationSchemeId": "10020",
"issueTypeId": "10001",
"fieldConfigurationId": "10010"
},
{
"fieldConfigurationSchemeId": "10021",
"issueTypeId": "10002",
"fieldConfigurationId": "10000"
},
{
"fieldConfigurationSchemeId": "10022",
"issueTypeId": "default",
"fieldConfigurationId": "10011"
},
{
"fieldConfigurationSchemeId": "10023",
"issueTypeId": "default",
"fieldConfigurationId": "10000"
}
]
}Returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it.
The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.
Only field configuration schemes used in classic projects are returned.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationread:field-configuration-scheme:jirainteger
integer
array<integer>
RequiredReturned if the request is successful.
A page of items.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfigurationscheme/project?projectId={projectId}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 5,
"values": [
{
"projectIds": [
"10",
"11"
]
},
{
"fieldConfigurationScheme": {
"id": "10002",
"name": "Field Configuration Scheme for software related projects",
"description": "We can use this one for software projects."
},
"projectIds": [
"12",
"13",
"14"
]
}
]
}Assigns a field configuration scheme to a project. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme.
Field configuration schemes can only be assigned to classic projects.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:field-configuration-scheme:jirastring
string
RequiredReturned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"fieldConfigurationSchemeId": "10000",
"projectId": "10000"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfigurationscheme/project`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Updates a field configuration scheme.
This operation can only update field configuration schemes used in company-managed (classic) projects.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:field-configuration-scheme:jirainteger
RequiredThe details of the field configuration scheme.
string
string
RequiredReturned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"description": "We can use this one for software projects.",
"name": "Field Configuration Scheme for software related projects"
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfigurationscheme/{id}`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Deletes a field configuration scheme.
This operation can only delete field configuration schemes used in company-managed (classic) projects.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationdelete:field-configuration-scheme:jirainteger
RequiredReturned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfigurationscheme/{id}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Assigns issue types to field configurations on field configuration scheme.
This operation can only modify field configuration schemes used in company-managed (classic) projects.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:field-configuration-scheme:jira, read:field-configuration-scheme:jirainteger
Requiredarray<FieldConfigurationToIssueTypeMapping>
RequiredReturned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"mappings": [
{
"fieldConfigurationId": "10000",
"issueTypeId": "default"
},
{
"fieldConfigurationId": "10002",
"issueTypeId": "10001"
},
{
"fieldConfigurationId": "10001",
"issueTypeId": "10002"
}
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfigurationscheme/{id}/mapping`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Removes issue types from the field configuration scheme.
This operation can only modify field configuration schemes used in company-managed (classic) projects.
Permissions required: Administer Jira global permission.
Connect app scope required: ADMIN
manage:jira-configurationwrite:field-configuration-scheme:jirainteger
RequiredThe issue type IDs to remove.
array<string>
RequiredReturned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"issueTypeIds": [
"10000",
"10001",
"10002"
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/2/fieldconfigurationscheme/{id}/mapping/delete`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Rate this page: