• Announcement banner
  • App data policies (EAP)
  • Application roles
  • Audit records
  • Avatars
  • Classification levels
  • Dashboards
  • Filters
  • Filter sharing
  • Group and user picker
  • Groups
  • Issues
  • UI modifications (apps)
  • Issue attachments
  • Issue comments
  • Issue comment properties
  • Issue fields
  • Issue field configurations
  • Issue custom field contexts
  • Issue custom field options
  • Issue custom field options (apps)
  • Issue custom field values (apps)
  • Issue custom field configuration (apps)
  • Issue navigator settings
  • Issue notification schemes
  • Issue priorities
  • Issue properties
  • Issue resolutions
  • Issue security level
  • Issue security schemes
  • Issue types
  • Issue type schemes
  • Issue type screen schemes
  • Issue type properties
  • Issue votes
  • Issue watchers
  • Issue worklogs
  • Issue worklog properties
  • Jira expressions
  • Jira settings
  • JQL
  • JQL functions (apps)
  • Labels
  • License metrics
  • Myself
  • Permissions
  • Permission schemes
  • Projects
  • Project avatars
  • Project categories
  • Project classification levels
  • Project components
  • Project email
  • Project features
  • Project key and name validation
  • Project permission schemes
  • Project properties
  • Project roles
  • Project role actors
  • Project types
  • Project versions
  • Screens
  • Screen tabs
  • Screen tab fields
  • Screen schemes
  • Server info
  • Status
  • Tasks
  • Time tracking
  • Users
  • User properties
  • Webhooks
  • Workflows
  • Workflow transition rules
  • Workflow schemes
  • Workflow scheme project associations
  • Workflow scheme drafts
  • Workflow statuses
  • Workflow status categories
  • Workflow transition properties
  • App properties
  • Dynamic modules
  • App migration
  • Service Registry
Cloud
Jira Cloud platform / Reference / REST API v3 (beta)

Issue custom field configuration (apps)

Postman Collection
OpenAPI

This resource represents configurations stored against a custom field context by a Forge app. Configurations are information used by the Forge app at runtime to determine how to handle or process the data in a custom field in a given context. Use this resource to set and read configurations.

GET

Get custom field configurations

Returns a paginated list of configurations for a custom field of a type created by a Forge app.

The result can be filtered by one of these criteria:

  • id.
  • fieldContextId.
  • issueId.
  • projectKeyOrId and issueTypeId.

Otherwise, all configurations are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:custom-field-contextual-configuration:jira

Request

Path parameters

fieldIdOrKey

string

Required

Query parameters

id

array<integer>

fieldContextId

array<integer>

issueId

integer

projectKeyOrId

string

issueTypeId

string

startAt

integer

maxResults

integer

Responses

Returned if the request is successful.

application/json

PageBeanContextualConfiguration

A page of items.

GET/rest/api/3/app/field/{fieldIdOrKey}/context/configuration
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/3/app/field/{fieldIdOrKey}/context/configuration`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
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 { "isLast": true, "maxResults": 1000, "startAt": 0, "total": 2, "values": [ { "id": "10000", "fieldContextId": "10010" }, { "id": "10001", "fieldContextId": "10011", "configuration": { "minValue": 0, "maxValue": 10000 }, "schema": { "properties": { "amount": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } } ] }
PUT

Update custom field configurations

Update the configuration for contexts of a custom field of a type created by a Forge app.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that created the custom field type.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:custom-field-contextual-configuration:jira

Request

Path parameters

fieldIdOrKey

string

Required

Request bodyapplication/json

configurations

array<ContextualConfiguration>

Required

Responses

Returned if the request is successful.

application/json

any

PUT/rest/api/3/app/field/{fieldIdOrKey}/context/configuration
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 37 38 39 40 41 42 43 44 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "configurations": [ { "id": "10000" }, { "configuration": { "maxValue": 10000, "minValue": 0 }, "id": "10001", "schema": { "properties": { "amount": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } } ] }`; const response = await api.asUser().requestJira(route`/rest/api/3/app/field/{fieldIdOrKey}/context/configuration`, { method: 'PUT', 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: