Atlassian rest/api/3/field/ — Issue Custom Field Options (Apps)

naftiko: 1.0.0-alpha2
info:
  label: Atlassian rest/api/3/field/ — Issue Custom Field Options (Apps)
  description: 'Atlassian rest/api/3/field/ — Issue Custom Field Options (Apps). 8 operations. Lead operation: Atlassian Get
    All Issue Field Options. Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Issue Custom Field Options (Apps)
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-api-3-field--issue-custom-field-options-apps
    baseUri: https://your-domain.atlassian.net
    description: Atlassian rest/api/3/field/ — Issue Custom Field Options (Apps) business capability. Self-contained, no shared
      references.
    resources:
    - name: rest-api-3-field-fieldKey-option
      path: /rest/api/3/field/{fieldKey}/option
      operations:
      - name: atlassiangetallissuefieldoptions
        method: GET
        description: Atlassian Get All Issue Field Options
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: fieldKey
          in: path
          type: string
          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 `fiel'
          required: true
      - name: atlassiancreateissuefieldoption
        method: POST
        description: Atlassian Create Issue Field Option
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fieldKey
          in: path
          type: string
          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 `fiel'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-field-fieldKey-option-suggestions-edit
      path: /rest/api/3/field/{fieldKey}/option/suggestions/edit
      operations:
      - name: atlassiangetselectableissuefieldoptions
        method: GET
        description: Atlassian Get Selectable Issue Field Options
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: projectId
          in: query
          type: integer
          description: Filters the results to options that are only available in the specified project.
        - name: fieldKey
          in: path
          type: string
          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 `fiel'
          required: true
    - name: rest-api-3-field-fieldKey-option-suggestions-search
      path: /rest/api/3/field/{fieldKey}/option/suggestions/search
      operations:
      - name: atlassiangetvisibleissuefieldoptions
        method: GET
        description: Atlassian Get Visible Issue Field Options
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: projectId
          in: query
          type: integer
          description: Filters the results to options that are only available in the specified project.
        - name: fieldKey
          in: path
          type: string
          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 `fiel'
          required: true
    - name: rest-api-3-field-fieldKey-option-optionId
      path: /rest/api/3/field/{fieldKey}/option/{optionId}
      operations:
      - name: atlassiandeleteissuefieldoption
        method: DELETE
        description: Atlassian Delete Issue Field Option
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fieldKey
          in: path
          type: string
          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 `fiel'
          required: true
        - name: optionId
          in: path
          type: integer
          description: The ID of the option to be deleted.
          required: true
      - name: atlassiangetissuefieldoption
        method: GET
        description: Atlassian Get Issue Field Option
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fieldKey
          in: path
          type: string
          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 `fiel'
          required: true
        - name: optionId
          in: path
          type: integer
          description: The ID of the option to be returned.
          required: true
      - name: atlassianupdateissuefieldoption
        method: PUT
        description: Atlassian Update Issue Field Option
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fieldKey
          in: path
          type: string
          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 `fiel'
          required: true
        - name: optionId
          in: path
          type: integer
          description: The ID of the option to be updated.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-field-fieldKey-option-optionId-issue
      path: /rest/api/3/field/{fieldKey}/option/{optionId}/issue
      operations:
      - name: atlassianreplaceissuefieldoption
        method: DELETE
        description: Atlassian Replace Issue Field Option
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: replaceWith
          in: query
          type: integer
          description: The ID of the option that will replace the currently selected option.
        - name: jql
          in: query
          type: string
          description: A JQL query that specifies the issues to be updated. For example, *project=10000*.
        - name: overrideScreenSecurity
          in: query
          type: boolean
          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
          in: query
          type: boolean
          description: Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect
            and Forge app users with *Administer Jira* [global permissi
        - name: fieldKey
          in: path
          type: string
          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 `fiel'
          required: true
        - name: optionId
          in: path
          type: integer
          description: The ID of the option to be deselected.
          required: true
  exposes:
  - type: rest
    namespace: rest-api-3-field--issue-custom-field-options-apps-rest
    port: 8080
    description: REST adapter for Atlassian rest/api/3/field/ — Issue Custom Field Options (Apps). One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/field/{fieldkey}/option
      name: rest-api-3-field-fieldkey-option
      description: REST surface for rest-api-3-field-fieldKey-option.
      operations:
      - method: GET
        name: atlassiangetallissuefieldoptions
        description: Atlassian Get All Issue Field Options
        call: rest-api-3-field--issue-custom-field-options-apps.atlassiangetallissuefieldoptions
        with:
          startAt: rest.startAt
          maxResults: rest.maxResults
          fieldKey: rest.fieldKey
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassiancreateissuefieldoption
        description: Atlassian Create Issue Field Option
        call: rest-api-3-field--issue-custom-field-options-apps.atlassiancreateissuefieldoption
        with:
          fieldKey: rest.fieldKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/field/{fieldkey}/option/suggestions/edit
      name: rest-api-3-field-fieldkey-option-suggestions-edit
      description: REST surface for rest-api-3-field-fieldKey-option-suggestions-edit.
      operations:
      - method: GET
        name: atlassiangetselectableissuefieldoptions
        description: Atlassian Get Selectable Issue Field Options
        call: rest-api-3-field--issue-custom-field-options-apps.atlassiangetselectableissuefieldoptions
        with:
          startAt: rest.startAt
          maxResults: rest.maxResults
          projectId: rest.projectId
          fieldKey: rest.fieldKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/field/{fieldkey}/option/suggestions/search
      name: rest-api-3-field-fieldkey-option-suggestions-search
      description: REST surface for rest-api-3-field-fieldKey-option-suggestions-search.
      operations:
      - method: GET
        name: atlassiangetvisibleissuefieldoptions
        description: Atlassian Get Visible Issue Field Options
        call: rest-api-3-field--issue-custom-field-options-apps.atlassiangetvisibleissuefieldoptions
        with:
          startAt: rest.startAt
          maxResults: rest.maxResults
          projectId: rest.projectId
          fieldKey: rest.fieldKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/field/{fieldkey}/option/{optionid}
      name: rest-api-3-field-fieldkey-option-optionid
      description: REST surface for rest-api-3-field-fieldKey-option-optionId.
      operations:
      - method: DELETE
        name: atlassiandeleteissuefieldoption
        description: Atlassian Delete Issue Field Option
        call: rest-api-3-field--issue-custom-field-options-apps.atlassiandeleteissuefieldoption
        with:
          fieldKey: rest.fieldKey
          optionId: rest.optionId
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetissuefieldoption
        description: Atlassian Get Issue Field Option
        call: rest-api-3-field--issue-custom-field-options-apps.atlassiangetissuefieldoption
        with:
          fieldKey: rest.fieldKey
          optionId: rest.optionId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassianupdateissuefieldoption
        description: Atlassian Update Issue Field Option
        call: rest-api-3-field--issue-custom-field-options-apps.atlassianupdateissuefieldoption
        with:
          fieldKey: rest.fieldKey
          optionId: rest.optionId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/field/{fieldkey}/option/{optionid}/issue
      name: rest-api-3-field-fieldkey-option-optionid-issue
      description: REST surface for rest-api-3-field-fieldKey-option-optionId-issue.
      operations:
      - method: DELETE
        name: atlassianreplaceissuefieldoption
        description: Atlassian Replace Issue Field Option
        call: rest-api-3-field--issue-custom-field-options-apps.atlassianreplaceissuefieldoption
        with:
          replaceWith: rest.replaceWith
          jql: rest.jql
          overrideScreenSecurity: rest.overrideScreenSecurity
          overrideEditableFlag: rest.overrideEditableFlag
          fieldKey: rest.fieldKey
          optionId: rest.optionId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-api-3-field--issue-custom-field-options-apps-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian rest/api/3/field/ — Issue Custom Field Options (Apps). One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: atlassian-get-all-issue-field
      description: Atlassian Get All Issue Field Options
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-api-3-field--issue-custom-field-options-apps.atlassiangetallissuefieldoptions
      with:
        startAt: tools.startAt
        maxResults: tools.maxResults
        fieldKey: tools.fieldKey
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-create-issue-field-option
      description: Atlassian Create Issue Field Option
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-api-3-field--issue-custom-field-options-apps.atlassiancreateissuefieldoption
      with:
        fieldKey: tools.fieldKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-selectable-issue-field
      description: Atlassian Get Selectable Issue Field Options
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-api-3-field--issue-custom-field-options-apps.atlassiangetselectableissuefieldoptions
      with:
        startAt: tools.startAt
        maxResults: tools.maxResults
        projectId: tools.projectId
        fieldKey: tools.fieldKey
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-visible-issue-field
      description: Atlassian Get Visible Issue Field Options
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-api-3-field--issue-custom-field-options-apps.atlassiangetvisibleissuefieldoptions
      with:
        startAt: tools.startAt
        maxResults: tools.maxResults
        projectId: tools.projectId
        fieldKey: tools.fieldKey
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-issue-field-option
      description: Atlassian Delete Issue Field Option
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-api-3-field--issue-custom-field-options-apps.atlassiandeleteissuefieldoption
      with:
        fieldKey: tools.fieldKey
        optionId: tools.optionId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-issue-field-option
      description: Atlassian Get Issue Field Option
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-api-3-field--issue-custom-field-options-apps.atlassiangetissuefieldoption
      with:
        fieldKey: tools.fieldKey
        optionId: tools.optionId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-update-issue-field-option
      description: Atlassian Update Issue Field Option
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-api-3-field--issue-custom-field-options-apps.atlassianupdateissuefieldoption
      with:
        fieldKey: tools.fieldKey
        optionId: tools.optionId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-replace-issue-field-option
      description: Atlassian Replace Issue Field Option
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-api-3-field--issue-custom-field-options-apps.atlassianreplaceissuefieldoption
      with:
        replaceWith: tools.replaceWith
        jql: tools.jql
        overrideScreenSecurity: tools.overrideScreenSecurity
        overrideEditableFlag: tools.overrideEditableFlag
        fieldKey: tools.fieldKey
        optionId: tools.optionId
      outputParameters:
      - type: object
        mapping: $.