{
  "opencollection": "1.0.0",
  "info": {
    "name": "Atlassian Admin Account Issue Custom Field Options (Apps) API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Issue Custom Field Options (Apps)",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Atlassian Get All Issue Field Options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/field/:fieldKey/option",
            "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": "fieldKey",
                "value": "",
                "type": "path",
                "description": "The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following:\n\n *  open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager.\n *  run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"`"
              }
            ]
          },
          "docs": "Returns a [paginated](#pagination) list of all the options of a select list issue field. A select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that enables a user to select a value from a list of options.<br><br>Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom fi"
        },
        {
          "info": {
            "name": "Atlassian Create Issue Field Option",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/field/:fieldKey/option",
            "params": [
              {
                "name": "fieldKey",
                "value": "",
                "type": "path",
                "description": "The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following:\n\n *  open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager.\n *  run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates an option for a select list issue field.<br><br>Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.<br><br>Each field can have a maximum of 10000 options, and each option can have a maximum of 10000 scopes.<br><br>**[Permissions](#permissions) required:** *Administer"
        },
        {
          "info": {
            "name": "Atlassian Get Selectable Issue Field Options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/field/:fieldKey/option/suggestions/edit",
            "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": "Filters the results to options that are only available in the specified project."
              },
              {
                "name": "fieldKey",
                "value": "",
                "type": "path",
                "description": "The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following:\n\n *  open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager.\n *  run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"`"
              }
            ]
          },
          "docs": "Returns a [paginated](#pagination) list of options for a select list issue field that can be viewed and selected by the user.<br><br>Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.<br><br>**[Permissions](#permissions) required:** Permission to access Jira."
        },
        {
          "info": {
            "name": "Atlassian Get Visible Issue Field Options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/field/:fieldKey/option/suggestions/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": "projectId",
                "value": "",
                "type": "query",
                "description": "Filters the results to options that are only available in the specified project."
              },
              {
                "name": "fieldKey",
                "value": "",
                "type": "path",
                "description": "The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following:\n\n *  open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager.\n *  run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"`"
              }
            ]
          },
          "docs": "Returns a [paginated](#pagination) list of options for a select list issue field that can be viewed by the user.<br><br>Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.<br><br>**[Permissions](#permissions) required:** Permission to access Jira."
        },
        {
          "info": {
            "name": "Atlassian Get Issue Field Option",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/field/:fieldKey/option/:optionId",
            "params": [
              {
                "name": "fieldKey",
                "value": "",
                "type": "path",
                "description": "The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following:\n\n *  open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager.\n *  run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"`"
              },
              {
                "name": "optionId",
                "value": "",
                "type": "path",
                "description": "The ID of the option to be returned."
              }
            ]
          },
          "docs": "Returns an option from a select list issue field.<br><br>Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required f"
        },
        {
          "info": {
            "name": "Atlassian Update Issue Field Option",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/field/:fieldKey/option/:optionId",
            "params": [
              {
                "name": "fieldKey",
                "value": "",
                "type": "path",
                "description": "The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following:\n\n *  open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager.\n *  run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"`"
              },
              {
                "name": "optionId",
                "value": "",
                "type": "path",
                "description": "The ID of the option to be updated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical.<br><br>Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom "
        },
        {
          "info": {
            "name": "Atlassian Delete Issue Field Option",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/field/:fieldKey/option/:optionId",
            "params": [
              {
                "name": "fieldKey",
                "value": "",
                "type": "path",
                "description": "The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following:\n\n *  open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager.\n *  run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"`"
              },
              {
                "name": "optionId",
                "value": "",
                "type": "path",
                "description": "The ID of the option to be deleted."
              }
            ]
          },
          "docs": "Deletes an option from a select list issue field.<br><br>Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required f"
        },
        {
          "info": {
            "name": "Atlassian Replace Issue Field Option",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/field/:fieldKey/option/:optionId/issue",
            "params": [
              {
                "name": "replaceWith",
                "value": "",
                "type": "query",
                "description": "The ID of the option that will replace the currently selected option."
              },
              {
                "name": "jql",
                "value": "",
                "type": "query",
                "description": "A JQL query that specifies the issues to be updated. For example, *project=10000*."
              },
              {
                "name": "overrideScreenSecurity",
                "value": "",
                "type": "query",
                "description": "Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission."
              },
              {
                "name": "overrideEditableFlag",
                "value": "",
                "type": "query",
                "description": "Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
              },
              {
                "name": "fieldKey",
                "value": "",
                "type": "path",
                "description": "The field key is specified in the following format: **$(app-key)\\_\\_$(field-key)**. For example, *example-add-on\\_\\_example-issue-field*. To determine the `fieldKey` value, do one of the following:\n\n *  open the app's plugin descriptor, then **app-key** is the key at the top and **field-key** is the key in the `jiraIssueFields` module. **app-key** can also be found in the app listing in the Atlassian Universal Plugin Manager.\n *  run [Get fields](#api-rest-api-3-field-get) and in the field details the value is returned in `key`. For example, `\"key\": \"teams-add-on__team-issue-field\"`"
              },
              {
                "name": "optionId",
                "value": "",
                "type": "path",
                "description": "The ID of the option to be deselected."
              }
            ]
          },
          "docs": "Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query.<br><br>Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can override the screen security configuration using `overrideScreenSecurity` and `overrideEditableFlag`.<br><br>This is an [asynchronous operation]"
        }
      ]
    }
  ],
  "bundled": true
}