{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Issue Field Configurations API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Issue Field Configurations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Update Field Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/fieldconfiguration/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the field configuration."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Delete Field Configuration",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/api/3/fieldconfiguration/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the field configuration."
}
]
},
"docs": "Deletes a field configuration.
This operation can only delete configurations used in company-managed (classic) projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get Field Configuration Items",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/fieldconfiguration/:id/fields",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the field configuration."
},
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
}
]
},
"docs": "Returns a [paginated](#pagination) list of all fields for a configuration.
Only the fields from configurations used in company-managed (classic) projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Update Field Configuration Items",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/fieldconfiguration/:id/fields",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the field configuration."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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`).
**[P"
},
{
"info": {
"name": "Atlassian Get Field Configuration Issue Type Items",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/fieldconfigurationscheme/mapping",
"params": [
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
},
{
"name": "fieldConfigurationSchemeId",
"value": "",
"type": "query",
"description": "The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: `fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001`."
}
]
},
"docs": "Returns a [paginated](#pagination) list of field configuration issue type items.
Only items used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get Field Configuration Schemes For Projects",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/fieldconfigurationscheme/project",
"params": [
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`."
}
]
},
"docs": "Returns a [paginated](#pagination) 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Assign Field Configuration Scheme To Project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/fieldconfigurationscheme/project",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Update Field Configuration Scheme",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/fieldconfigurationscheme/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the field configuration scheme."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a field configuration scheme.
This operation can only update field configuration schemes used in company-managed (classic) projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Delete Field Configuration Scheme",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/api/3/fieldconfigurationscheme/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the field configuration scheme."
}
]
},
"docs": "Deletes a field configuration scheme.
This operation can only delete field configuration schemes used in company-managed (classic) projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Assign Issue Types To Field Configurations",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/fieldconfigurationscheme/:id/mapping",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the field configuration scheme."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Remove Issue Types From Field Configuration Scheme",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/fieldconfigurationscheme/:id/mapping/delete",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the field configuration scheme."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Removes issue types from the field configuration scheme.
This operation can only modify field configuration schemes used in company-managed (classic) projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get All Field Configurations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/fieldconfiguration",
"params": [
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`."
},
{
"name": "isDefault",
"value": "",
"type": "query",
"description": "If *true* returns default field configurations only."
},
{
"name": "query",
"value": "",
"type": "query",
"description": "The query string used to match against field configuration names and descriptions."
}
]
},
"docs": "Returns a [paginated](#pagination) list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:
* a list of field configuration item IDs.
* whether the field configuration is a default.
* whether the field configuration name or description contains a query string.
Only field configurations used in company-managed (classic) projects are returned.
**[Permissions](#permissions) required:** *A"
},
{
"info": {
"name": "Atlassian Create Field Configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/fieldconfiguration",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get All Field Configuration Schemes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/fieldconfigurationscheme",
"params": [
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`."
}
]
},
"docs": "Returns a [paginated](#pagination) list of field configuration schemes.
Only field configuration schemes used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Create Field Configuration Scheme",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/fieldconfigurationscheme",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a field configuration scheme.
This operation can only create field configuration schemes used in company-managed (classic) projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
}
]
}
],
"bundled": true
}