Skip to content

Atlassian: Issue custom field contexts schemas

83 Atlassian schemas with complete fields and constraints.

← Issue custom field contexts operations · All schemas

Add issue types to context — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
defaultValueModelOptionalExpand Add issue types to context — request body — body default Value
isAnyIssueTypebooleanOptionalWhether to add or retain the any-issue-type mapping. At least one of this property or issueTypeIds is required. Defaults to false.
issueTypeIdsJSONOptional
issueTypeIds (anyOf 1)arrayAlternativeThe issue type IDs to add. Optional when isAnyIssueType is true.
issueTypeIds (anyOf 1)[]JSONEach item
issueTypeIds (anyOf 1)[] (anyOf 1)stringAlternativeThe issue type IDs to add. Optional when isAnyIssueType is true.
issueTypeIds (anyOf 1)[] (anyOf 2)nullAlternative
issueTypeIds (anyOf 2)nullAlternative

Referenced models: Add issue types to context — request body — body default Value

Add issue types to context — request body — body default Value

FieldTypePresenceDescription and constraints
$objectRootdiscriminator: {"mapping": {"datepicker": "#/components/schemas/CustomFieldContextDefaultValueDate", "datetimepicker": "#/components/schemas/CustomFieldContextDefaultValueDateTime", "float": "#/components/schemas/CustomFieldContextDefaultValueFloat", "forge.datetime": "#/components/schemas/CustomFieldContextDefaultValueForgeDateTimeField", "forge.group": "#/components/schemas/CustomFieldContextDefaultValueForgeGroupField", "forge.group.list": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiGroupField", "forge.number": "#/components/schemas/CustomFieldContextDefaultValueForgeNumberField", "forge.object": "#/components/schemas/CustomFieldContextDefaultValueForgeObjectField", "forge.string": "#/components/schemas/CustomFieldContextDefaultValueForgeStringField", "forge.string.list": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiStringField", "forge.user": "#/components/schemas/CustomFieldContextDefaultValueForgeUserField", "forge.user.list": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiUserField", "grouppicker.multiple": "#/components/schemas/CustomFieldContextDefaultValueMultipleGroupPicker", "grouppicker.single": "#/components/schemas/CustomFieldContextDefaultValueSingleGroupPicker", "labels": "#/components/schemas/CustomFieldContextDefaultValueLabels", "longtext": "#/components/schemas/CustomFieldContextDefaultValueLongText", "multi.user.select": "#/components/schemas/CustomFieldContextDefaultValueMultiUserPicker", "option.cascading": "#/components/schemas/CustomFieldContextDefaultValueCascadingOption", "option.multiple": "#/components/schemas/CustomFieldContextDefaultValueMultipleOption", "option.single": "#/components/schemas/CustomFieldContextDefaultValueSingleOption", "project": "#/components/schemas/CustomFieldContextDefaultValueProject", "readonly": "#/components/schemas/CustomFieldContextDefaultValueReadOnly", "single.user.select": "#/components/schemas/CustomFieldContextSingleUserPickerDefaults", "textarea": "#/components/schemas/CustomFieldContextDefaultValueTextArea", "textfield": "#/components/schemas/CustomFieldContextDefaultValueTextField", "url": "#/components/schemas/CustomFieldContextDefaultValueURL", "version.multiple": "#/components/schemas/CustomFieldContextDefaultValueMultipleVersionPicker", "version.single": "#/components/schemas/CustomFieldContextDefaultValueSingleVersionPicker"}, "propertyName": "type"}
Additional keys: not allowed
$ (oneOf 1)ModelAlternativeExpand Add issue types to context — request body — body default Value type option cascading
$ (oneOf 2)ModelAlternativeExpand Add issue types to context — request body — body default Value type option multiple
$ (oneOf 3)ModelAlternativeExpand Add issue types to context — request body — body default Value type option single
$ (oneOf 4)ModelAlternativeExpand Add issue types to context — request body — body default Value type single user select
$ (oneOf 5)ModelAlternativeExpand Add issue types to context — request body — body default Value type multi user select
$ (oneOf 6)ModelAlternativeExpand Add issue types to context — request body — body default Value type grouppicker single
$ (oneOf 7)ModelAlternativeExpand Add issue types to context — request body — body default Value type grouppicker multiple
$ (oneOf 8)ModelAlternativeExpand Add issue types to context — request body — body default Value type datepicker
$ (oneOf 9)ModelAlternativeExpand Add issue types to context — request body — body default Value type datetimepicker
$ (oneOf 10)ModelAlternativeExpand Add issue types to context — request body — body default Value type url
$ (oneOf 11)ModelAlternativeExpand Add issue types to context — request body — body default Value type project
$ (oneOf 12)ModelAlternativeExpand Add issue types to context — request body — body default Value type float
$ (oneOf 13)ModelAlternativeExpand Add issue types to context — request body — body default Value type labels
$ (oneOf 14)ModelAlternativeExpand Add issue types to context — request body — body default Value type textfield
$ (oneOf 15)ModelAlternativeExpand Add issue types to context — request body — body default Value type textarea
$ (oneOf 16)ModelAlternativeExpand Add issue types to context — request body — body default Value type longtext
$ (oneOf 17)ModelAlternativeExpand Add issue types to context — request body — body default Value type readonly
$ (oneOf 18)ModelAlternativeExpand Add issue types to context — request body — body default Value type version single
$ (oneOf 19)ModelAlternativeExpand Add issue types to context — request body — body default Value type version multiple
$ (oneOf 20)ModelAlternativeExpand Add issue types to context — request body — body default Value type forge string
$ (oneOf 21)ModelAlternativeExpand Add issue types to context — request body — body default Value type forge string list
$ (oneOf 22)ModelAlternativeExpand Add issue types to context — request body — body default Value type forge object
$ (oneOf 23)ModelAlternativeExpand Add issue types to context — request body — body default Value type forge datetime
$ (oneOf 24)ModelAlternativeExpand Add issue types to context — request body — body default Value type forge group
$ (oneOf 25)ModelAlternativeExpand Add issue types to context — request body — body default Value type forge group list
$ (oneOf 26)ModelAlternativeExpand Add issue types to context — request body — body default Value type forge number
$ (oneOf 27)ModelAlternativeExpand Add issue types to context — request body — body default Value type forge user
$ (oneOf 28)ModelAlternativeExpand Add issue types to context — request body — body default Value type forge user list

Referenced models: Add issue types to context — request body — body default Value type option cascading, Add issue types to context — request body — body default Value type datepicker, Add issue types to context — request body — body default Value type datetimepicker, Add issue types to context — request body — body default Value type float, Add issue types to context — request body — body default Value type forge datetime, Add issue types to context — request body — body default Value type forge group, Add issue types to context — request body — body default Value type forge group list, Add issue types to context — request body — body default Value type forge string list, Add issue types to context — request body — body default Value type forge user list, Add issue types to context — request body — body default Value type forge number, Add issue types to context — request body — body default Value type forge object, Add issue types to context — request body — body default Value type forge string, Add issue types to context — request body — body default Value type forge user, Add issue types to context — request body — body default Value type labels, Add issue types to context — request body — body default Value type longtext, Add issue types to context — request body — body default Value type multi user select, Add issue types to context — request body — body default Value type grouppicker multiple, Add issue types to context — request body — body default Value type option multiple, Add issue types to context — request body — body default Value type version multiple, Add issue types to context — request body — body default Value type project, Add issue types to context — request body — body default Value type readonly, Add issue types to context — request body — body default Value type grouppicker single, Add issue types to context — request body — body default Value type option single, Add issue types to context — request body — body default Value type version single, Add issue types to context — request body — body default Value type textarea, Add issue types to context — request body — body default Value type textfield, Add issue types to context — request body — body default Value type url, Add issue types to context — request body — body default Value type single user select

Add issue types to context — request body — body default Value type datepicker

FieldTypePresenceDescription and constraints
$objectRootThe default value for a Date custom field.
contextIdstringRequired within parentThe ID of the context.
datestringOptionalThe default date in ISO format. Ignored if `useCurrent` is true.
typestringRequired within parentMust equal: datepicker
useCurrentbooleanOptionalWhether to use the current date.
Default: false

Add issue types to context — request body — body default Value type datetimepicker

FieldTypePresenceDescription and constraints
$objectRootThe default value for a date time custom field.
contextIdstringRequired within parentThe ID of the context.
dateTimestringOptionalThe default date-time in ISO format. Ignored if `useCurrent` is true.
typestringRequired within parentMust equal: datetimepicker
useCurrentbooleanOptionalWhether to use the current date.
Default: false

Add issue types to context — request body — body default Value type float

FieldTypePresenceDescription and constraints
$objectRootDefault value for a float (number) custom field.
contextIdstringRequired within parentThe ID of the context.
numbernumberRequired within parentThe default floating-point number.
Format: double
typestringRequired within parentMust equal: float

Add issue types to context — request body — body default Value type forge datetime

FieldTypePresenceDescription and constraints
$objectRootThe default value for a Forge date time custom field.
contextIdstringRequired within parentThe ID of the context.
dateTimestringOptionalThe default date-time in ISO format. Ignored if `useCurrent` is true.
typestringRequired within parentMust equal: forge.datetime
useCurrentbooleanOptionalWhether to use the current date.
Default: false

Add issue types to context — request body — body default Value type forge group

FieldTypePresenceDescription and constraints
$objectRootThe default value for a Forge group custom field.
contextIdstringRequired within parentThe ID of the context.
groupIdstringRequired within parentThe ID of the the default group.
typestringRequired within parentMust equal: forge.group

Add issue types to context — request body — body default Value type forge group list

FieldTypePresenceDescription and constraints
$objectRootThe default value for a Forge collection of groups custom field.
contextIdstringRequired within parentThe ID of the context.
groupIdsarrayRequired within parentThe IDs of the default groups.
Unique items: true
groupIds[]stringEach itemThe IDs of the default groups.
typestringRequired within parentMust equal: forge.group.list

Add issue types to context — request body — body default Value type forge number

FieldTypePresenceDescription and constraints
$objectRootDefault value for a Forge number custom field.
contextIdstringRequired within parentThe ID of the context.
numbernumberRequired within parentThe default floating-point number.
Format: double
typestringRequired within parentMust equal: forge.number

Add issue types to context — request body — body default Value type forge object

FieldTypePresenceDescription and constraints
$objectRootThe default value for a Forge object custom field.
contextIdstringRequired within parentThe ID of the context.
objectobjectOptionalThe default JSON object.
typestringRequired within parentMust equal: forge.object

Add issue types to context — request body — body default Value type forge string

FieldTypePresenceDescription and constraints
$objectRootThe default text for a Forge string custom field.
contextIdstringRequired within parentThe ID of the context.
textstringOptionalThe default text. The maximum length is 254 characters.
typestringRequired within parentMust equal: forge.string

Add issue types to context — request body — body default Value type forge string list

FieldTypePresenceDescription and constraints
$objectRootThe default text for a Forge collection of strings custom field.
contextIdstringRequired within parentThe ID of the context.
typestringRequired within parentMust equal: forge.string.list
valuesarrayOptionalList of string values. The maximum length for a value is 254 characters.
values[]stringEach itemList of string values. The maximum length for a value is 254 characters.

Add issue types to context — request body — body default Value type forge user

FieldTypePresenceDescription and constraints
$objectRootDefaults for a Forge user custom field.
accountIdstringRequired within parentThe ID of the default user.
contextIdstringRequired within parentThe ID of the context.
typestringRequired within parentMust equal: forge.user
userFilterModelRequired within parentExpand Add issue types to context — request body — body default Value type forge user user Filter

Referenced models: Add issue types to context — request body — body default Value type forge user user Filter

Add issue types to context — request body — body default Value type forge user list

FieldTypePresenceDescription and constraints
$objectRootDefaults for a Forge collection of users custom field.
accountIdsarrayRequired within parentThe IDs of the default users.
accountIds[]stringEach itemThe IDs of the default users.
contextIdstringRequired within parentThe ID of the context.
typestringRequired within parentMust equal: forge.user.list

Add issue types to context — request body — body default Value type forge user user Filter

FieldTypePresenceDescription and constraints
$objectRootFilter for a User Picker (single) custom field.
enabledbooleanRequired within parentWhether the filter is enabled.
groupsarrayOptionalUser groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 groups can be provided.
Unique items: true
groups[]stringEach itemUser groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 groups can be provided.
roleIdsarrayOptionalRoles that autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 roles can be provided.
Unique items: true
roleIds[]integerEach itemRoles that autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 roles can be provided.
Format: int64

Add issue types to context — request body — body default Value type grouppicker multiple

FieldTypePresenceDescription and constraints
$objectRootThe default value for a multiple group picker custom field.
contextIdstringRequired within parentThe ID of the context.
groupIdsarrayRequired within parentThe IDs of the default groups.
Unique items: true
groupIds[]stringEach itemThe IDs of the default groups.
typestringRequired within parentMust equal: grouppicker.multiple

Add issue types to context — request body — body default Value type grouppicker single

FieldTypePresenceDescription and constraints
$objectRootThe default value for a group picker custom field.
contextIdstringRequired within parentThe ID of the context.
groupIdstringRequired within parentThe ID of the the default group.
typestringRequired within parentMust equal: grouppicker.single

Add issue types to context — request body — body default Value type labels

FieldTypePresenceDescription and constraints
$objectRootDefault value for a labels custom field.
contextIdstringRequired within parentThe ID of the context.
labelsarrayRequired within parentThe default labels value.
labels[]stringEach itemThe default labels value.
typestringRequired within parentMust equal: labels

Add issue types to context — request body — body default Value type longtext

FieldTypePresenceDescription and constraints
$objectRootThe default text for a plain text paragraph custom field.
contextIdstringRequired within parentThe ID of the context.
textstringOptionalThe default text. Line breaks are preserved. The maximum length is the instance's text field character limit.
typestringRequired within parentMust equal: longtext

Add issue types to context — request body — body default Value type multi user select

FieldTypePresenceDescription and constraints
$objectRootThe default value for a User Picker (multiple) custom field.
accountIdsarrayRequired within parentThe IDs of the default users.
accountIds[]stringEach itemThe IDs of the default users.
contextIdstringRequired within parentThe ID of the context.
typestringRequired within parentMust equal: multi.user.select

Add issue types to context — request body — body default Value type option cascading

FieldTypePresenceDescription and constraints
$objectRootThe default value for a cascading select custom field.
cascadingOptionIdstringOptionalThe ID of the default cascading option.
contextIdstringRequired within parentThe ID of the context.
optionIdstringRequired within parentThe ID of the default option.
typestringRequired within parentMust equal: option.cascading

Add issue types to context — request body — body default Value type option multiple

FieldTypePresenceDescription and constraints
$objectRootThe default value for a multi-select custom field.
contextIdstringRequired within parentThe ID of the context.
optionIdsarrayRequired within parentThe list of IDs of the default options.
optionIds[]stringEach itemThe list of IDs of the default options.
typestringRequired within parentMust equal: option.multiple

Add issue types to context — request body — body default Value type option single

FieldTypePresenceDescription and constraints
$objectRootThe default value for a single select custom field.
contextIdstringRequired within parentThe ID of the context.
optionIdstringRequired within parentThe ID of the default option.
typestringRequired within parentMust equal: option.single

Add issue types to context — request body — body default Value type project

FieldTypePresenceDescription and constraints
$objectRootThe default value for a project custom field.
contextIdstringRequired within parentThe ID of the context.
projectIdstringRequired within parentThe ID of the default project.
typestringRequired within parentMust equal: project

Add issue types to context — request body — body default Value type readonly

FieldTypePresenceDescription and constraints
$objectRootThe default text for a read only custom field.
contextIdstringRequired within parentThe ID of the context.
textstringOptionalThe default text. The maximum length is 255 characters.
typestringRequired within parentMust equal: readonly

Add issue types to context — request body — body default Value type single user select

FieldTypePresenceDescription and constraints
$objectRootDefaults for a User Picker (single) custom field.
accountIdstringRequired within parentThe ID of the default user.
contextIdstringRequired within parentThe ID of the context.
typestringRequired within parentMust equal: single.user.select
userFilterModelRequired within parentExpand Add issue types to context — request body — body default Value type forge user user Filter

Referenced models: Add issue types to context — request body — body default Value type forge user user Filter

Add issue types to context — request body — body default Value type textarea

FieldTypePresenceDescription and constraints
$objectRootThe default text for a text area custom field.
contextIdstringRequired within parentThe ID of the context.
textstringOptionalThe default text. The maximum length is 32767 characters.
typestringRequired within parentMust equal: textarea

Add issue types to context — request body — body default Value type textfield

FieldTypePresenceDescription and constraints
$objectRootThe default text for a text custom field.
contextIdstringRequired within parentThe ID of the context.
textstringOptionalThe default text. The maximum length is 254 characters.
typestringRequired within parentMust equal: textfield

Add issue types to context — request body — body default Value type url

FieldTypePresenceDescription and constraints
$objectRootThe default value for a URL custom field.
contextIdstringRequired within parentThe ID of the context.
typestringRequired within parentMust equal: url
urlstringRequired within parentThe default URL.

Add issue types to context — request body — body default Value type version multiple

FieldTypePresenceDescription and constraints
$objectRootThe default value for a multiple version picker custom field.
contextIdstringRequired within parentThe ID of the context.
typestringRequired within parentMust equal: version.multiple
versionIdsarrayRequired within parentThe IDs of the default versions.
Unique items: true
versionIds[]stringEach itemThe IDs of the default versions.
versionOrderstringOptionalThe order the pickable versions are displayed in. If not provided, the released-first order is used. Available version orders are `"releasedFirst"` and `"unreleasedFirst"`.

Add issue types to context — request body — body default Value type version single

FieldTypePresenceDescription and constraints
$objectRootThe default value for a version picker custom field.
contextIdstringRequired within parentThe ID of the context.
typestringRequired within parentMust equal: version.single
versionIdstringRequired within parentThe ID of the default version.
versionOrderstringOptionalThe order the pickable versions are displayed in. If not provided, the released-first order is used. Available version orders are `"releasedFirst"` and `"unreleasedFirst"`.

Assign custom field context to projects — request body — body

FieldTypePresenceDescription and constraints
$objectRootA list of project IDs.
Additional keys: not allowed
projectIdsarrayRequired within parentThe IDs of projects.
write Only: true
projectIds[]stringEach itemwrite Only: true

Create custom field context — request body — body

FieldTypePresenceDescription and constraints
$objectRootThe details of a created custom field context.
Additional keys: not allowed
descriptionstringOptionalThe description of the context.
idstringOptionalThe ID of the context.
Read only: true
issueTypeIdsarrayOptionalThe list of issue types IDs for the context. If the list is empty, the context refers to all issue types.
issueTypeIds[]stringEach item
namestringRequired within parentThe name of the context.
projectIdsarrayOptionalThe list of project IDs associated with the context. If the list is empty, the context is global.
projectIds[]stringEach item

Create custom field context — response body

FieldTypePresenceDescription and constraints
$objectRootThe details of a created custom field context.
descriptionJSONOptional
description (anyOf 1)stringAlternativeThe description of the context.
description (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeThe ID of the context.
Read only: true
id (anyOf 2)nullAlternative
issueTypeIdsJSONOptional
issueTypeIds (anyOf 1)arrayAlternativeThe list of issue types IDs for the context. If the list is empty, the context refers to all issue types.
issueTypeIds (anyOf 1)[]stringEach item
issueTypeIds (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the context.
name (anyOf 2)nullAlternative
projectIdsJSONOptional
projectIds (anyOf 1)arrayAlternativeThe list of project IDs associated with the context. If the list is empty, the context is global.
projectIds (anyOf 1)[]stringEach item
projectIds (anyOf 2)nullAlternative

Get custom field contexts default values — response body

FieldTypePresenceDescription and constraints
$objectRootA page of items.
isLastJSONOptional
isLast (anyOf 1)booleanAlternativeWhether this is the last page.
Read only: true
isLast (anyOf 2)nullAlternative
maxResultsJSONOptional
maxResults (anyOf 1)JSONAlternative
maxResults (anyOf 1) (anyOf 1)integerAlternativeThe maximum number of items that could be returned.
Format: int32
Read only: true
maxResults (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)nullAlternative
nextPageJSONOptional
nextPage (anyOf 1)stringAlternativeIf there is another page of results, the URL of the next page.
Format: uri
Read only: true
nextPage (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the page.
Format: uri
Read only: true
self (anyOf 2)nullAlternative
startAtJSONOptional
startAt (anyOf 1)JSONAlternative
startAt (anyOf 1) (anyOf 1)integerAlternativeThe index of the first item returned.
Format: int64
Read only: true
startAt (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)JSONAlternative
total (anyOf 1) (anyOf 1)integerAlternativeThe number of items returned.
Format: int64
Read only: true
total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)nullAlternative
valuesJSONOptional
values (anyOf 1)arrayAlternativeThe list of items.
Read only: true
values (anyOf 1)[]ModelEach itemExpand Get custom field contexts default values — response body — values The list of items item
values (anyOf 2)nullAlternative

Referenced models: Get custom field contexts default values — response body — values The list of items item

Get custom field contexts default values — response body — values The list of items item

FieldTypePresenceDescription and constraints
$objectRootdiscriminator: {"mapping": {"datepicker": "#/components/schemas/CustomFieldContextDefaultValueDate", "datetimepicker": "#/components/schemas/CustomFieldContextDefaultValueDateTime", "float": "#/components/schemas/CustomFieldContextDefaultValueFloat", "forge.datetime": "#/components/schemas/CustomFieldContextDefaultValueForgeDateTimeField", "forge.group": "#/components/schemas/CustomFieldContextDefaultValueForgeGroupField", "forge.group.list": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiGroupField", "forge.number": "#/components/schemas/CustomFieldContextDefaultValueForgeNumberField", "forge.object": "#/components/schemas/CustomFieldContextDefaultValueForgeObjectField", "forge.string": "#/components/schemas/CustomFieldContextDefaultValueForgeStringField", "forge.string.list": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiStringField", "forge.user": "#/components/schemas/CustomFieldContextDefaultValueForgeUserField", "forge.user.list": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiUserField", "grouppicker.multiple": "#/components/schemas/CustomFieldContextDefaultValueMultipleGroupPicker", "grouppicker.single": "#/components/schemas/CustomFieldContextDefaultValueSingleGroupPicker", "labels": "#/components/schemas/CustomFieldContextDefaultValueLabels", "longtext": "#/components/schemas/CustomFieldContextDefaultValueLongText", "multi.user.select": "#/components/schemas/CustomFieldContextDefaultValueMultiUserPicker", "option.cascading": "#/components/schemas/CustomFieldContextDefaultValueCascadingOption", "option.multiple": "#/components/schemas/CustomFieldContextDefaultValueMultipleOption", "option.single": "#/components/schemas/CustomFieldContextDefaultValueSingleOption", "project": "#/components/schemas/CustomFieldContextDefaultValueProject", "readonly": "#/components/schemas/CustomFieldContextDefaultValueReadOnly", "single.user.select": "#/components/schemas/CustomFieldContextSingleUserPickerDefaults", "textarea": "#/components/schemas/CustomFieldContextDefaultValueTextArea", "textfield": "#/components/schemas/CustomFieldContextDefaultValueTextField", "url": "#/components/schemas/CustomFieldContextDefaultValueURL", "version.multiple": "#/components/schemas/CustomFieldContextDefaultValueMultipleVersionPicker", "version.single": "#/components/schemas/CustomFieldContextDefaultValueSingleVersionPicker"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type option cascading
$ (anyOf 2)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type option multiple
$ (anyOf 3)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type option single
$ (anyOf 4)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type single user select
$ (anyOf 5)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type multi user select
$ (anyOf 6)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type grouppicker single
$ (anyOf 7)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type grouppicker multiple
$ (anyOf 8)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type datepicker
$ (anyOf 9)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type datetimepicker
$ (anyOf 10)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type url
$ (anyOf 11)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type project
$ (anyOf 12)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type float
$ (anyOf 13)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type labels
$ (anyOf 14)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type textfield
$ (anyOf 15)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type textarea
$ (anyOf 16)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type longtext
$ (anyOf 17)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type readonly
$ (anyOf 18)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type version single
$ (anyOf 19)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type version multiple
$ (anyOf 20)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge string
$ (anyOf 21)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge string list
$ (anyOf 22)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge object
$ (anyOf 23)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge datetime
$ (anyOf 24)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge group
$ (anyOf 25)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge group list
$ (anyOf 26)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge number
$ (anyOf 27)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge user
$ (anyOf 28)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge user list

Referenced models: Get custom field contexts default values — response body — values The list of items item type option cascading, Get custom field contexts default values — response body — values The list of items item type datepicker, Get custom field contexts default values — response body — values The list of items item type datetimepicker, Get custom field contexts default values — response body — values The list of items item type float, Get custom field contexts default values — response body — values The list of items item type forge datetime, Get custom field contexts default values — response body — values The list of items item type forge group, Get custom field contexts default values — response body — values The list of items item type forge group list, Get custom field contexts default values — response body — values The list of items item type forge string list, Get custom field contexts default values — response body — values The list of items item type forge user list, Get custom field contexts default values — response body — values The list of items item type forge number, Get custom field contexts default values — response body — values The list of items item type forge object, Get custom field contexts default values — response body — values The list of items item type forge string, Get custom field contexts default values — response body — values The list of items item type forge user, Get custom field contexts default values — response body — values The list of items item type labels, Get custom field contexts default values — response body — values The list of items item type longtext, Get custom field contexts default values — response body — values The list of items item type multi user select, Get custom field contexts default values — response body — values The list of items item type grouppicker multiple, Get custom field contexts default values — response body — values The list of items item type option multiple, Get custom field contexts default values — response body — values The list of items item type version multiple, Get custom field contexts default values — response body — values The list of items item type project, Get custom field contexts default values — response body — values The list of items item type readonly, Get custom field contexts default values — response body — values The list of items item type grouppicker single, Get custom field contexts default values — response body — values The list of items item type option single, Get custom field contexts default values — response body — values The list of items item type version single, Get custom field contexts default values — response body — values The list of items item type textarea, Get custom field contexts default values — response body — values The list of items item type textfield, Get custom field contexts default values — response body — values The list of items item type url, Get custom field contexts default values — response body — values The list of items item type single user select

Get custom field contexts default values — response body — values The list of items item type datepicker

FieldTypePresenceDescription and constraints
$objectRootThe default value for a Date custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
dateJSONOptional
date (anyOf 1)stringAlternativeThe default date in ISO format. Ignored if `useCurrent` is true.
date (anyOf 2)nullAlternative
typestringOptionalMust equal: datepicker
useCurrentJSONOptional
useCurrent (anyOf 1)booleanAlternativeWhether to use the current date.
Default: false
useCurrent (anyOf 2)nullAlternative

Get custom field contexts default values — response body — values The list of items item type datetimepicker

FieldTypePresenceDescription and constraints
$objectRootThe default value for a date time custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
dateTimeJSONOptional
dateTime (anyOf 1)stringAlternativeThe default date-time in ISO format. Ignored if `useCurrent` is true.
dateTime (anyOf 2)nullAlternative
typestringOptionalMust equal: datetimepicker
useCurrentJSONOptional
useCurrent (anyOf 1)booleanAlternativeWhether to use the current date.
Default: false
useCurrent (anyOf 2)nullAlternative

Get custom field contexts default values — response body — values The list of items item type float

FieldTypePresenceDescription and constraints
$objectRootDefault value for a float (number) custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
numberJSONOptional
number (anyOf 1)JSONAlternative
number (anyOf 1) (anyOf 1)numberAlternativeThe default floating-point number.
Format: double
number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number (anyOf 2)nullAlternative
typestringOptionalMust equal: float

Get custom field contexts default values — response body — values The list of items item type forge datetime

FieldTypePresenceDescription and constraints
$objectRootThe default value for a Forge date time custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
dateTimeJSONOptional
dateTime (anyOf 1)stringAlternativeThe default date-time in ISO format. Ignored if `useCurrent` is true.
dateTime (anyOf 2)nullAlternative
typestringOptionalMust equal: forge.datetime
useCurrentJSONOptional
useCurrent (anyOf 1)booleanAlternativeWhether to use the current date.
Default: false
useCurrent (anyOf 2)nullAlternative

Get custom field contexts default values — response body — values The list of items item type forge group

FieldTypePresenceDescription and constraints
$objectRootThe default value for a Forge group custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
groupIdJSONOptional
groupId (anyOf 1)stringAlternativeThe ID of the the default group.
groupId (anyOf 2)nullAlternative
typestringOptionalMust equal: forge.group

Get custom field contexts default values — response body — values The list of items item type forge group list

FieldTypePresenceDescription and constraints
$objectRootThe default value for a Forge collection of groups custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
groupIdsJSONOptional
groupIds (anyOf 1)arrayAlternativeThe IDs of the default groups.
Unique items: true
groupIds (anyOf 1)[]stringEach itemThe IDs of the default groups.
groupIds (anyOf 2)nullAlternative
typestringOptionalMust equal: forge.group.list

Get custom field contexts default values — response body — values The list of items item type forge number

FieldTypePresenceDescription and constraints
$objectRootDefault value for a Forge number custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
numberJSONOptional
number (anyOf 1)JSONAlternative
number (anyOf 1) (anyOf 1)numberAlternativeThe default floating-point number.
Format: double
number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number (anyOf 2)nullAlternative
typestringOptionalMust equal: forge.number

Get custom field contexts default values — response body — values The list of items item type forge object

FieldTypePresenceDescription and constraints
$objectRootThe default value for a Forge object custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
objectJSONOptional
object (anyOf 1)objectAlternativeThe default JSON object.
object (anyOf 2)nullAlternative
typestringOptionalMust equal: forge.object

Get custom field contexts default values — response body — values The list of items item type forge string

FieldTypePresenceDescription and constraints
$objectRootThe default text for a Forge string custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
textJSONOptional
text (anyOf 1)stringAlternativeThe default text. The maximum length is 254 characters.
text (anyOf 2)nullAlternative
typestringOptionalMust equal: forge.string

Get custom field contexts default values — response body — values The list of items item type forge string list

FieldTypePresenceDescription and constraints
$objectRootThe default text for a Forge collection of strings custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
typestringOptionalMust equal: forge.string.list
valuesJSONOptional
values (anyOf 1)arrayAlternativeList of string values. The maximum length for a value is 254 characters.
values (anyOf 1)[]stringEach itemList of string values. The maximum length for a value is 254 characters.
values (anyOf 2)nullAlternative

Get custom field contexts default values — response body — values The list of items item type forge user

FieldTypePresenceDescription and constraints
$objectRootDefaults for a Forge user custom field.
accountIdJSONOptional
accountId (anyOf 1)stringAlternativeThe ID of the default user.
accountId (anyOf 2)nullAlternative
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
typestringOptionalMust equal: forge.user
userFilterJSONOptional
userFilter (anyOf 1)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge user user Filter Filter for a User Picker (single) custom field
userFilter (anyOf 2)nullAlternative

Referenced models: Get custom field contexts default values — response body — values The list of items item type forge user user Filter Filter for a User Picker (single) custom field

Get custom field contexts default values — response body — values The list of items item type forge user list

FieldTypePresenceDescription and constraints
$objectRootDefaults for a Forge collection of users custom field.
accountIdsJSONOptional
accountIds (anyOf 1)arrayAlternativeThe IDs of the default users.
accountIds (anyOf 1)[]stringEach itemThe IDs of the default users.
accountIds (anyOf 2)nullAlternative
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
typestringOptionalMust equal: forge.user.list

Get custom field contexts default values — response body — values The list of items item type forge user user Filter Filter for a User Picker (single) custom field

FieldTypePresenceDescription and constraints
$objectRootFilter for a User Picker (single) custom field.
enabledJSONOptional
enabled (anyOf 1)booleanAlternativeWhether the filter is enabled.
enabled (anyOf 2)nullAlternative
groupsJSONOptional
groups (anyOf 1)arrayAlternativeUser groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 groups can be provided.
Unique items: true
groups (anyOf 1)[]stringEach itemUser groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 groups can be provided.
groups (anyOf 2)nullAlternative
roleIdsJSONOptional
roleIds (anyOf 1)arrayAlternativeRoles that autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 roles can be provided.
Unique items: true
roleIds (anyOf 1)[]JSONEach item
roleIds (anyOf 1)[] (anyOf 1)integerAlternativeRoles that autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 roles can be provided.
Format: int64
roleIds (anyOf 1)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
roleIds (anyOf 2)nullAlternative

Get custom field contexts default values — response body — values The list of items item type grouppicker multiple

FieldTypePresenceDescription and constraints
$objectRootThe default value for a multiple group picker custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
groupIdsJSONOptional
groupIds (anyOf 1)arrayAlternativeThe IDs of the default groups.
Unique items: true
groupIds (anyOf 1)[]stringEach itemThe IDs of the default groups.
groupIds (anyOf 2)nullAlternative
typestringOptionalMust equal: grouppicker.multiple

Get custom field contexts default values — response body — values The list of items item type grouppicker single

FieldTypePresenceDescription and constraints
$objectRootThe default value for a group picker custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
groupIdJSONOptional
groupId (anyOf 1)stringAlternativeThe ID of the the default group.
groupId (anyOf 2)nullAlternative
typestringOptionalMust equal: grouppicker.single

Get custom field contexts default values — response body — values The list of items item type labels

FieldTypePresenceDescription and constraints
$objectRootDefault value for a labels custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
labelsJSONOptional
labels (anyOf 1)arrayAlternativeThe default labels value.
labels (anyOf 1)[]stringEach itemThe default labels value.
labels (anyOf 2)nullAlternative
typestringOptionalMust equal: labels

Get custom field contexts default values — response body — values The list of items item type longtext

FieldTypePresenceDescription and constraints
$objectRootThe default text for a plain text paragraph custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
textJSONOptional
text (anyOf 1)stringAlternativeThe default text. Line breaks are preserved. The maximum length is the instance's text field character limit.
text (anyOf 2)nullAlternative
typestringOptionalMust equal: longtext

Get custom field contexts default values — response body — values The list of items item type multi user select

FieldTypePresenceDescription and constraints
$objectRootThe default value for a User Picker (multiple) custom field.
accountIdsJSONOptional
accountIds (anyOf 1)arrayAlternativeThe IDs of the default users.
accountIds (anyOf 1)[]stringEach itemThe IDs of the default users.
accountIds (anyOf 2)nullAlternative
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
typestringOptionalMust equal: multi.user.select

Get custom field contexts default values — response body — values The list of items item type option cascading

FieldTypePresenceDescription and constraints
$objectRootThe default value for a cascading select custom field.
cascadingOptionIdJSONOptional
cascadingOptionId (anyOf 1)stringAlternativeThe ID of the default cascading option.
cascadingOptionId (anyOf 2)nullAlternative
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
optionIdJSONOptional
optionId (anyOf 1)stringAlternativeThe ID of the default option.
optionId (anyOf 2)nullAlternative
typestringOptionalMust equal: option.cascading

Get custom field contexts default values — response body — values The list of items item type option multiple

FieldTypePresenceDescription and constraints
$objectRootThe default value for a multi-select custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
optionIdsJSONOptional
optionIds (anyOf 1)arrayAlternativeThe list of IDs of the default options.
optionIds (anyOf 1)[]stringEach itemThe list of IDs of the default options.
optionIds (anyOf 2)nullAlternative
typestringOptionalMust equal: option.multiple

Get custom field contexts default values — response body — values The list of items item type option single

FieldTypePresenceDescription and constraints
$objectRootThe default value for a single select custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
optionIdJSONOptional
optionId (anyOf 1)stringAlternativeThe ID of the default option.
optionId (anyOf 2)nullAlternative
typestringOptionalMust equal: option.single

Get custom field contexts default values — response body — values The list of items item type project

FieldTypePresenceDescription and constraints
$objectRootThe default value for a project custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
projectIdJSONOptional
projectId (anyOf 1)stringAlternativeThe ID of the default project.
projectId (anyOf 2)nullAlternative
typestringOptionalMust equal: project

Get custom field contexts default values — response body — values The list of items item type readonly

FieldTypePresenceDescription and constraints
$objectRootThe default text for a read only custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
textJSONOptional
text (anyOf 1)stringAlternativeThe default text. The maximum length is 255 characters.
text (anyOf 2)nullAlternative
typestringOptionalMust equal: readonly

Get custom field contexts default values — response body — values The list of items item type single user select

FieldTypePresenceDescription and constraints
$objectRootDefaults for a User Picker (single) custom field.
accountIdJSONOptional
accountId (anyOf 1)stringAlternativeThe ID of the default user.
accountId (anyOf 2)nullAlternative
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
typestringOptionalMust equal: single.user.select
userFilterJSONOptional
userFilter (anyOf 1)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item type forge user user Filter Filter for a User Picker (single) custom field
userFilter (anyOf 2)nullAlternative

Referenced models: Get custom field contexts default values — response body — values The list of items item type forge user user Filter Filter for a User Picker (single) custom field

Get custom field contexts default values — response body — values The list of items item type textarea

FieldTypePresenceDescription and constraints
$objectRootThe default text for a text area custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
textJSONOptional
text (anyOf 1)stringAlternativeThe default text. The maximum length is 32767 characters.
text (anyOf 2)nullAlternative
typestringOptionalMust equal: textarea

Get custom field contexts default values — response body — values The list of items item type textfield

FieldTypePresenceDescription and constraints
$objectRootThe default text for a text custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
textJSONOptional
text (anyOf 1)stringAlternativeThe default text. The maximum length is 254 characters.
text (anyOf 2)nullAlternative
typestringOptionalMust equal: textfield

Get custom field contexts default values — response body — values The list of items item type url

FieldTypePresenceDescription and constraints
$objectRootThe default value for a URL custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
typestringOptionalMust equal: url
urlJSONOptional
url (anyOf 1)stringAlternativeThe default URL.
url (anyOf 2)nullAlternative

Get custom field contexts default values — response body — values The list of items item type version multiple

FieldTypePresenceDescription and constraints
$objectRootThe default value for a multiple version picker custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
typestringOptionalMust equal: version.multiple
versionIdsJSONOptional
versionIds (anyOf 1)arrayAlternativeThe IDs of the default versions.
Unique items: true
versionIds (anyOf 1)[]stringEach itemThe IDs of the default versions.
versionIds (anyOf 2)nullAlternative
versionOrderJSONOptional
versionOrder (anyOf 1)stringAlternativeThe order the pickable versions are displayed in. If not provided, the released-first order is used. Available version orders are `"releasedFirst"` and `"unreleasedFirst"`.
versionOrder (anyOf 2)nullAlternative

Get custom field contexts default values — response body — values The list of items item type version single

FieldTypePresenceDescription and constraints
$objectRootThe default value for a version picker custom field.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
typestringOptionalMust equal: version.single
versionIdJSONOptional
versionId (anyOf 1)stringAlternativeThe ID of the default version.
versionId (anyOf 2)nullAlternative
versionOrderJSONOptional
versionOrder (anyOf 1)stringAlternativeThe order the pickable versions are displayed in. If not provided, the released-first order is used. Available version orders are `"releasedFirst"` and `"unreleasedFirst"`.
versionOrder (anyOf 2)nullAlternative

Get custom field contexts for projects and issue types — request body — body

FieldTypePresenceDescription and constraints
$objectRootThe project and issue type mappings.
Additional keys: not allowed
mappingsarrayRequired within parentThe project and issue type mappings.
write Only: true
mappings[]ModelEach itemExpand Get custom field contexts for projects and issue types — request body — body mappings item

Referenced models: Get custom field contexts for projects and issue types — request body — body mappings item

Get custom field contexts for projects and issue types — request body — body mappings item

FieldTypePresenceDescription and constraints
$objectRootThe project and issue type mapping.
write Only: true
Additional keys: not allowed
issueTypeIdstringRequired within parentThe ID of the issue type.
write Only: true
projectIdstringRequired within parentThe ID of the project.
write Only: true

Get custom field contexts for projects and issue types — response body

FieldTypePresenceDescription and constraints
$objectRootA page of items.
isLastJSONOptional
isLast (anyOf 1)booleanAlternativeWhether this is the last page.
Read only: true
isLast (anyOf 2)nullAlternative
maxResultsJSONOptional
maxResults (anyOf 1)JSONAlternative
maxResults (anyOf 1) (anyOf 1)integerAlternativeThe maximum number of items that could be returned.
Format: int32
Read only: true
maxResults (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)nullAlternative
nextPageJSONOptional
nextPage (anyOf 1)stringAlternativeIf there is another page of results, the URL of the next page.
Format: uri
Read only: true
nextPage (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the page.
Format: uri
Read only: true
self (anyOf 2)nullAlternative
startAtJSONOptional
startAt (anyOf 1)JSONAlternative
startAt (anyOf 1) (anyOf 1)integerAlternativeThe index of the first item returned.
Format: int64
Read only: true
startAt (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)JSONAlternative
total (anyOf 1) (anyOf 1)integerAlternativeThe number of items returned.
Format: int64
Read only: true
total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)nullAlternative
valuesJSONOptional
values (anyOf 1)arrayAlternativeThe list of items.
Read only: true
values (anyOf 1)[]ModelEach itemExpand Get custom field contexts for projects and issue types — response body — values The list of items item
values (anyOf 2)nullAlternative

Referenced models: Get custom field contexts for projects and issue types — response body — values The list of items item

Get custom field contexts for projects and issue types — response body — values The list of items item

FieldTypePresenceDescription and constraints
$objectRootThe project and issue type mapping with a matching custom field context.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the custom field context.
contextId (anyOf 2)nullAlternative
issueTypeIdJSONOptional
issueTypeId (anyOf 1)stringAlternativeThe ID of the issue type.
issueTypeId (anyOf 2)nullAlternative
projectIdJSONOptional
projectId (anyOf 1)stringAlternativeThe ID of the project.
projectId (anyOf 2)nullAlternative

Get custom field contexts — response body

FieldTypePresenceDescription and constraints
$objectRootA page of items.
isLastJSONOptional
isLast (anyOf 1)booleanAlternativeWhether this is the last page.
Read only: true
isLast (anyOf 2)nullAlternative
maxResultsJSONOptional
maxResults (anyOf 1)JSONAlternative
maxResults (anyOf 1) (anyOf 1)integerAlternativeThe maximum number of items that could be returned.
Format: int32
Read only: true
maxResults (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)nullAlternative
nextPageJSONOptional
nextPage (anyOf 1)stringAlternativeIf there is another page of results, the URL of the next page.
Format: uri
Read only: true
nextPage (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the page.
Format: uri
Read only: true
self (anyOf 2)nullAlternative
startAtJSONOptional
startAt (anyOf 1)JSONAlternative
startAt (anyOf 1) (anyOf 1)integerAlternativeThe index of the first item returned.
Format: int64
Read only: true
startAt (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)JSONAlternative
total (anyOf 1) (anyOf 1)integerAlternativeThe number of items returned.
Format: int64
Read only: true
total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)nullAlternative
valuesJSONOptional
values (anyOf 1)arrayAlternativeThe list of items.
Read only: true
values (anyOf 1)[]ModelEach itemExpand Get custom field contexts — response body — values The list of items item
values (anyOf 2)nullAlternative

Referenced models: Get custom field contexts — response body — values The list of items item

Get custom field contexts — response body — values The list of items item

FieldTypePresenceDescription and constraints
$objectRootThe details of a custom field context.
descriptionJSONOptional
description (anyOf 1)stringAlternativeThe description of the context.
description (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeThe ID of the context.
id (anyOf 2)nullAlternative
isAnyIssueTypeJSONOptional
isAnyIssueType (anyOf 1)booleanAlternativeWhether the context apply to all issue types.
isAnyIssueType (anyOf 2)nullAlternative
isGlobalContextJSONOptional
isGlobalContext (anyOf 1)booleanAlternativeWhether the context is global.
isGlobalContext (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the context.
name (anyOf 2)nullAlternative

Get default values for a custom field grouped by context and issue type — response body

FieldTypePresenceDescription and constraints
$objectRootA page of items.
isLastJSONOptional
isLast (anyOf 1)booleanAlternativeWhether this is the last page.
Read only: true
isLast (anyOf 2)nullAlternative
maxResultsJSONOptional
maxResults (anyOf 1)JSONAlternative
maxResults (anyOf 1) (anyOf 1)integerAlternativeThe maximum number of items that could be returned.
Format: int32
Read only: true
maxResults (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)nullAlternative
nextPageJSONOptional
nextPage (anyOf 1)stringAlternativeIf there is another page of results, the URL of the next page.
Format: uri
Read only: true
nextPage (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the page.
Format: uri
Read only: true
self (anyOf 2)nullAlternative
startAtJSONOptional
startAt (anyOf 1)JSONAlternative
startAt (anyOf 1) (anyOf 1)integerAlternativeThe index of the first item returned.
Format: int64
Read only: true
startAt (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)JSONAlternative
total (anyOf 1) (anyOf 1)integerAlternativeThe number of items returned.
Format: int64
Read only: true
total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)nullAlternative
valuesJSONOptional
values (anyOf 1)arrayAlternativeThe list of items.
Read only: true
values (anyOf 1)[]ModelEach itemExpand Get default values for a custom field grouped by context and issue type — response body — values The list of items item
values (anyOf 2)nullAlternative

Referenced models: Get default values for a custom field grouped by context and issue type — response body — values The list of items item

Get default values for a custom field grouped by context and issue type — response body — values The list of items item

FieldTypePresenceDescription and constraints
$objectRootDefault values grouped by custom field context.
contextIdJSONOptional
contextId (anyOf 1)JSONAlternative
contextId (anyOf 1) (anyOf 1)integerAlternativeThe ID of the context.
Format: int64
contextId (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
contextId (anyOf 2)nullAlternative
defaultValuesJSONOptional
defaultValues (anyOf 1)arrayAlternativePer-issue-type default values for this context. May contain a single entry for unconverted contexts, or one entry per issue type for converted contexts.
defaultValues (anyOf 1)[]ModelEach itemExpand Get default values for a custom field grouped by context and issue type — response body — values The list of items item default Values array item
defaultValues (anyOf 2)nullAlternative

Referenced models: Get default values for a custom field grouped by context and issue type — response body — values The list of items item default Values array item

Get default values for a custom field grouped by context and issue type — response body — values The list of items item default Values array item

FieldTypePresenceDescription and constraints
$objectRootA default value associated with an issue type within a context.
isAnyIssueTypeJSONOptional
isAnyIssueType (anyOf 1)JSONAlternative
isAnyIssueType (anyOf 1) (anyOf 1)booleanAlternativeTrue when this default value applies to every issue type covered by the context (no specific issue type). Only present when true; omitted otherwise.
isAnyIssueType (anyOf 1) (anyOf 2)nullAlternative
isAnyIssueType (anyOf 2)nullAlternative
issueTypeIdJSONOptional
issueTypeId (anyOf 1)JSONAlternative
issueTypeId (anyOf 1) (anyOf 1)stringAlternativeThe ID of the issue type this default value applies to. Null when isAnyIssueType is true.
issueTypeId (anyOf 1) (anyOf 2)nullAlternative
issueTypeId (anyOf 2)nullAlternative
valueJSONOptional
value (anyOf 1)ModelAlternativeExpand Get custom field contexts default values — response body — values The list of items item
value (anyOf 2)nullAlternative

Referenced models: Get custom field contexts default values — response body — values The list of items item

Get issue types for custom field context — response body

FieldTypePresenceDescription and constraints
$objectRootA page of items.
isLastJSONOptional
isLast (anyOf 1)booleanAlternativeWhether this is the last page.
Read only: true
isLast (anyOf 2)nullAlternative
maxResultsJSONOptional
maxResults (anyOf 1)JSONAlternative
maxResults (anyOf 1) (anyOf 1)integerAlternativeThe maximum number of items that could be returned.
Format: int32
Read only: true
maxResults (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)nullAlternative
nextPageJSONOptional
nextPage (anyOf 1)stringAlternativeIf there is another page of results, the URL of the next page.
Format: uri
Read only: true
nextPage (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the page.
Format: uri
Read only: true
self (anyOf 2)nullAlternative
startAtJSONOptional
startAt (anyOf 1)JSONAlternative
startAt (anyOf 1) (anyOf 1)integerAlternativeThe index of the first item returned.
Format: int64
Read only: true
startAt (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)JSONAlternative
total (anyOf 1) (anyOf 1)integerAlternativeThe number of items returned.
Format: int64
Read only: true
total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)nullAlternative
valuesJSONOptional
values (anyOf 1)arrayAlternativeThe list of items.
Read only: true
values (anyOf 1)[]ModelEach itemExpand Get issue types for custom field context — response body — values The list of items item
values (anyOf 2)nullAlternative

Referenced models: Get issue types for custom field context — response body — values The list of items item

Get issue types for custom field context — response body — values The list of items item

FieldTypePresenceDescription and constraints
$objectRootMapping of an issue type to a context.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
contextId (anyOf 2)nullAlternative
isAnyIssueTypeJSONOptional
isAnyIssueType (anyOf 1)booleanAlternativeWhether the context is mapped to any issue type.
isAnyIssueType (anyOf 2)nullAlternative
issueTypeIdJSONOptional
issueTypeId (anyOf 1)stringAlternativeThe ID of the issue type.
issueTypeId (anyOf 2)nullAlternative

Get project mappings for custom field context — response body

FieldTypePresenceDescription and constraints
$objectRootA page of items.
isLastJSONOptional
isLast (anyOf 1)booleanAlternativeWhether this is the last page.
Read only: true
isLast (anyOf 2)nullAlternative
maxResultsJSONOptional
maxResults (anyOf 1)JSONAlternative
maxResults (anyOf 1) (anyOf 1)integerAlternativeThe maximum number of items that could be returned.
Format: int32
Read only: true
maxResults (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)nullAlternative
nextPageJSONOptional
nextPage (anyOf 1)stringAlternativeIf there is another page of results, the URL of the next page.
Format: uri
Read only: true
nextPage (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the page.
Format: uri
Read only: true
self (anyOf 2)nullAlternative
startAtJSONOptional
startAt (anyOf 1)JSONAlternative
startAt (anyOf 1) (anyOf 1)integerAlternativeThe index of the first item returned.
Format: int64
Read only: true
startAt (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)JSONAlternative
total (anyOf 1) (anyOf 1)integerAlternativeThe number of items returned.
Format: int64
Read only: true
total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)nullAlternative
valuesJSONOptional
values (anyOf 1)arrayAlternativeThe list of items.
Read only: true
values (anyOf 1)[]ModelEach itemExpand Get project mappings for custom field context — response body — values The list of items item
values (anyOf 2)nullAlternative

Referenced models: Get project mappings for custom field context — response body — values The list of items item

Get project mappings for custom field context — response body — values The list of items item

FieldTypePresenceDescription and constraints
$objectRootDetails of a context to project association.
contextIdJSONOptional
contextId (anyOf 1)stringAlternativeThe ID of the context.
Read only: true
contextId (anyOf 2)nullAlternative
isGlobalContextJSONOptional
isGlobalContext (anyOf 1)booleanAlternativeWhether context is global.
Read only: true
isGlobalContext (anyOf 2)nullAlternative
projectIdJSONOptional
projectId (anyOf 1)stringAlternativeThe ID of the project.
Read only: true
projectId (anyOf 2)nullAlternative

Remove issue types from context — request body — body

FieldTypePresenceDescription and constraints
$objectRootThe list of issue type IDs.
Additional keys: not allowed
issueTypeIdsarrayRequired within parentThe list of issue type IDs.
write Only: true
issueTypeIds[]stringEach itemwrite Only: true

Set custom field contexts default values — request body — body

FieldTypePresenceDescription and constraints
$objectRootDefault values to update.
Additional keys: not allowed
defaultValuesarrayOptional
defaultValues[]ModelEach itemExpand Add issue types to context — request body — body default Value

Referenced models: Add issue types to context — request body — body default Value

Set default values for a custom field by context and issue type — request body — body

FieldTypePresenceDescription and constraints
$objectRootDefault value updates grouped by context and issue type.
Additional keys: not allowed
defaultValuesarrayOptionalThe default values to update.
defaultValues[]ModelEach itemExpand Set default values for a custom field by context and issue type — request body — body default Values item

Referenced models: Set default values for a custom field by context and issue type — request body — body default Values item

Set default values for a custom field by context and issue type — request body — body default Values item

FieldTypePresenceDescription and constraints
$objectRootA default value update for one issue-type scope in a context.
Additional keys: not allowed
contextIdintegerRequired within parentThe ID of the context.
Format: int64
isAnyIssueTypeJSONOptional
isAnyIssueType (anyOf 1)booleanAlternativeTrue when this is the catch-all default for issue types without a specific default.
isAnyIssueType (anyOf 2)nullAlternative
issueTypeIdJSONOptional
issueTypeId (anyOf 1)stringAlternativeThe ID of the issue type this default value applies to.
issueTypeId (anyOf 2)nullAlternative
valueModelOptionalExpand Add issue types to context — request body — body default Value

Referenced models: Add issue types to context — request body — body default Value

Update custom field context — request body — body

FieldTypePresenceDescription and constraints
$objectRootDetails of a custom field context.
Additional keys: not allowed
descriptionstringOptionalThe description of the custom field context. The maximum length is 255 characters.
write Only: true
namestringOptionalThe name of the custom field context. The name must be unique. The maximum length is 255 characters.
write Only: true

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.