{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Issue Fields API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Issue Fields",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Get Fields Paginated",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/field/search",
"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": "type",
"value": "",
"type": "query",
"description": "The type of fields to search."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "The IDs of the custom fields to return or, where `query` is specified, filter."
},
{
"name": "query",
"value": "",
"type": "query",
"description": "String used to perform a case-insensitive partial match with field names or descriptions."
},
{
"name": "orderBy",
"value": "",
"type": "query",
"description": "[Order](#ordering) the results by a field:\n\n * `contextsCount` sorts by the number of contexts related to a field\n * `lastUsed` sorts by the date when the value of the field last changed\n * `name` sorts by the field name\n * `screensCount` sorts by the number of screens related to a field"
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `key` returns the key for each field\n * `lastUsed` returns the date when the value of the field last changed\n * `screensCount` returns the number of screens related to a field\n * `contextsCount` returns the number of contexts related to a field\n * `isLocked` returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og)\n * `searcherKey` returns the searcher key for each custom field"
}
]
},
"docs": "Returns a [paginated](#pagination) list of fields for Classic Jira projects. The list can include:
* all fields
* specific fields, by defining `id`
* fields that contain a string in the field name or description, by defining `query`
* specific fields that contain a string in the field name or description, by defining `id` and `query`
Only custom fields can be queried, `type` must be set to `custom`.
**[Permissions](#permissions) required:** *Administer Jira*"
},
{
"info": {
"name": "Atlassian Get Fields In Trash Paginated",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/field/search/trashed",
"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"
},
{
"name": "query",
"value": "",
"type": "query",
"description": "String used to perform a case-insensitive partial match with field names or descriptions."
},
{
"name": "expand",
"value": "",
"type": "query"
},
{
"name": "orderBy",
"value": "",
"type": "query",
"description": "[Order](#ordering) the results by a field:\n\n * `name` sorts by the field name\n * `trashDate` sorts by the date the field was moved to the trash\n * `plannedDeletionDate` sorts by the planned deletion date"
}
]
},
"docs": "Returns a [paginated](#pagination) list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string.
Only custom fields can be queried, `type` must be set to `custom`.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Update Custom Field",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the custom field."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a custom field.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get Contexts For A Field",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/field/:fieldId/contexts",
"params": [
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "The ID of the field to return contexts for."
},
{
"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 the contexts a field is used in. Deprecated, use [ Get custom field contexts](#api-rest-api-3-field-fieldId-context-get).
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Delete Custom Field",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/api/3/field/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of a custom field."
}
]
},
"docs": "Deletes a custom field. The custom field is deleted whether it is in the trash or not. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields.
This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
**[Permissions](#permissions) required:** *Administer Ji"
},
{
"info": {
"name": "Atlassian Restore Custom Field From Trash",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/field/:id/restore",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of a custom field."
}
]
},
"docs": "Restores a custom field from trash. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Move Custom Field To Trash",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/field/:id/trash",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of a custom field."
}
]
},
"docs": "Moves a custom field to trash. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
{
"info": {
"name": "Atlassian Get Fields",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/field"
},
"docs": "Returns system and custom issue fields according to the following rules:
* Fields that cannot be added to the issue navigator are always returned.
* Fields that cannot be placed on an issue screen are always returned.
* Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
* For all other fields, this operation only returns the fields that the user has permission to view (that is"
},
{
"info": {
"name": "Atlassian Create Custom Field",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/field",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a custom field.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
}
]
}
],
"bundled": true
}