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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
defaultValue | Model | Optional | Expand Add issue types to context — request body — body default Value |
isAnyIssueType | boolean | Optional | Whether to add or retain the any-issue-type mapping. At least one of this property or issueTypeIds is required. Defaults to false. |
issueTypeIds | JSON | Optional | |
issueTypeIds (anyOf 1) | array | Alternative | The issue type IDs to add. Optional when isAnyIssueType is true. |
issueTypeIds (anyOf 1)[] | JSON | Each item | |
issueTypeIds (anyOf 1)[] (anyOf 1) | string | Alternative | The issue type IDs to add. Optional when isAnyIssueType is true. |
issueTypeIds (anyOf 1)[] (anyOf 2) | null | Alternative | |
issueTypeIds (anyOf 2) | null | Alternative |
Referenced models: Add issue types to context — request body — body default Value
Add issue types to context — request body — body default Value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | discriminator: {"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) | Model | Alternative | Expand Add issue types to context — request body — body default Value type option cascading |
$ (oneOf 2) | Model | Alternative | Expand Add issue types to context — request body — body default Value type option multiple |
$ (oneOf 3) | Model | Alternative | Expand Add issue types to context — request body — body default Value type option single |
$ (oneOf 4) | Model | Alternative | Expand Add issue types to context — request body — body default Value type single user select |
$ (oneOf 5) | Model | Alternative | Expand Add issue types to context — request body — body default Value type multi user select |
$ (oneOf 6) | Model | Alternative | Expand Add issue types to context — request body — body default Value type grouppicker single |
$ (oneOf 7) | Model | Alternative | Expand Add issue types to context — request body — body default Value type grouppicker multiple |
$ (oneOf 8) | Model | Alternative | Expand Add issue types to context — request body — body default Value type datepicker |
$ (oneOf 9) | Model | Alternative | Expand Add issue types to context — request body — body default Value type datetimepicker |
$ (oneOf 10) | Model | Alternative | Expand Add issue types to context — request body — body default Value type url |
$ (oneOf 11) | Model | Alternative | Expand Add issue types to context — request body — body default Value type project |
$ (oneOf 12) | Model | Alternative | Expand Add issue types to context — request body — body default Value type float |
$ (oneOf 13) | Model | Alternative | Expand Add issue types to context — request body — body default Value type labels |
$ (oneOf 14) | Model | Alternative | Expand Add issue types to context — request body — body default Value type textfield |
$ (oneOf 15) | Model | Alternative | Expand Add issue types to context — request body — body default Value type textarea |
$ (oneOf 16) | Model | Alternative | Expand Add issue types to context — request body — body default Value type longtext |
$ (oneOf 17) | Model | Alternative | Expand Add issue types to context — request body — body default Value type readonly |
$ (oneOf 18) | Model | Alternative | Expand Add issue types to context — request body — body default Value type version single |
$ (oneOf 19) | Model | Alternative | Expand Add issue types to context — request body — body default Value type version multiple |
$ (oneOf 20) | Model | Alternative | Expand Add issue types to context — request body — body default Value type forge string |
$ (oneOf 21) | Model | Alternative | Expand Add issue types to context — request body — body default Value type forge string list |
$ (oneOf 22) | Model | Alternative | Expand Add issue types to context — request body — body default Value type forge object |
$ (oneOf 23) | Model | Alternative | Expand Add issue types to context — request body — body default Value type forge datetime |
$ (oneOf 24) | Model | Alternative | Expand Add issue types to context — request body — body default Value type forge group |
$ (oneOf 25) | Model | Alternative | Expand Add issue types to context — request body — body default Value type forge group list |
$ (oneOf 26) | Model | Alternative | Expand Add issue types to context — request body — body default Value type forge number |
$ (oneOf 27) | Model | Alternative | Expand Add issue types to context — request body — body default Value type forge user |
$ (oneOf 28) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a Date custom field. |
contextId | string | Required within parent | The ID of the context. |
date | string | Optional | The default date in ISO format. Ignored if `useCurrent` is true. |
type | string | Required within parent | Must equal: datepicker |
useCurrent | boolean | Optional | Whether to use the current date. Default: false |
Add issue types to context — request body — body default Value type datetimepicker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a date time custom field. |
contextId | string | Required within parent | The ID of the context. |
dateTime | string | Optional | The default date-time in ISO format. Ignored if `useCurrent` is true. |
type | string | Required within parent | Must equal: datetimepicker |
useCurrent | boolean | Optional | Whether to use the current date. Default: false |
Add issue types to context — request body — body default Value type float
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Default value for a float (number) custom field. |
contextId | string | Required within parent | The ID of the context. |
number | number | Required within parent | The default floating-point number. Format: double |
type | string | Required within parent | Must equal: float |
Add issue types to context — request body — body default Value type forge datetime
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a Forge date time custom field. |
contextId | string | Required within parent | The ID of the context. |
dateTime | string | Optional | The default date-time in ISO format. Ignored if `useCurrent` is true. |
type | string | Required within parent | Must equal: forge.datetime |
useCurrent | boolean | Optional | Whether to use the current date. Default: false |
Add issue types to context — request body — body default Value type forge group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a Forge group custom field. |
contextId | string | Required within parent | The ID of the context. |
groupId | string | Required within parent | The ID of the the default group. |
type | string | Required within parent | Must equal: forge.group |
Add issue types to context — request body — body default Value type forge group list
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a Forge collection of groups custom field. |
contextId | string | Required within parent | The ID of the context. |
groupIds | array | Required within parent | The IDs of the default groups. Unique items: true |
groupIds[] | string | Each item | The IDs of the default groups. |
type | string | Required within parent | Must equal: forge.group.list |
Add issue types to context — request body — body default Value type forge number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Default value for a Forge number custom field. |
contextId | string | Required within parent | The ID of the context. |
number | number | Required within parent | The default floating-point number. Format: double |
type | string | Required within parent | Must equal: forge.number |
Add issue types to context — request body — body default Value type forge object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a Forge object custom field. |
contextId | string | Required within parent | The ID of the context. |
object | object | Optional | The default JSON object. |
type | string | Required within parent | Must equal: forge.object |
Add issue types to context — request body — body default Value type forge string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a Forge string custom field. |
contextId | string | Required within parent | The ID of the context. |
text | string | Optional | The default text. The maximum length is 254 characters. |
type | string | Required within parent | Must equal: forge.string |
Add issue types to context — request body — body default Value type forge string list
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a Forge collection of strings custom field. |
contextId | string | Required within parent | The ID of the context. |
type | string | Required within parent | Must equal: forge.string.list |
values | array | Optional | List of string values. The maximum length for a value is 254 characters. |
values[] | string | Each item | List 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defaults for a Forge user custom field. |
accountId | string | Required within parent | The ID of the default user. |
contextId | string | Required within parent | The ID of the context. |
type | string | Required within parent | Must equal: forge.user |
userFilter | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defaults for a Forge collection of users custom field. |
accountIds | array | Required within parent | The IDs of the default users. |
accountIds[] | string | Each item | The IDs of the default users. |
contextId | string | Required within parent | The ID of the context. |
type | string | Required within parent | Must equal: forge.user.list |
Add issue types to context — request body — body default Value type forge user user Filter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Filter for a User Picker (single) custom field. |
enabled | boolean | Required within parent | Whether the filter is enabled. |
groups | array | Optional | User 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[] | string | Each item | User groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 groups can be provided. |
roleIds | array | Optional | Roles 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[] | integer | Each item | Roles 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a multiple group picker custom field. |
contextId | string | Required within parent | The ID of the context. |
groupIds | array | Required within parent | The IDs of the default groups. Unique items: true |
groupIds[] | string | Each item | The IDs of the default groups. |
type | string | Required within parent | Must equal: grouppicker.multiple |
Add issue types to context — request body — body default Value type grouppicker single
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a group picker custom field. |
contextId | string | Required within parent | The ID of the context. |
groupId | string | Required within parent | The ID of the the default group. |
type | string | Required within parent | Must equal: grouppicker.single |
Add issue types to context — request body — body default Value type labels
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Default value for a labels custom field. |
contextId | string | Required within parent | The ID of the context. |
labels | array | Required within parent | The default labels value. |
labels[] | string | Each item | The default labels value. |
type | string | Required within parent | Must equal: labels |
Add issue types to context — request body — body default Value type longtext
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a plain text paragraph custom field. |
contextId | string | Required within parent | The ID of the context. |
text | string | Optional | The default text. Line breaks are preserved. The maximum length is the instance's text field character limit. |
type | string | Required within parent | Must equal: longtext |
Add issue types to context — request body — body default Value type multi user select
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a User Picker (multiple) custom field. |
accountIds | array | Required within parent | The IDs of the default users. |
accountIds[] | string | Each item | The IDs of the default users. |
contextId | string | Required within parent | The ID of the context. |
type | string | Required within parent | Must equal: multi.user.select |
Add issue types to context — request body — body default Value type option cascading
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a cascading select custom field. |
cascadingOptionId | string | Optional | The ID of the default cascading option. |
contextId | string | Required within parent | The ID of the context. |
optionId | string | Required within parent | The ID of the default option. |
type | string | Required within parent | Must equal: option.cascading |
Add issue types to context — request body — body default Value type option multiple
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a multi-select custom field. |
contextId | string | Required within parent | The ID of the context. |
optionIds | array | Required within parent | The list of IDs of the default options. |
optionIds[] | string | Each item | The list of IDs of the default options. |
type | string | Required within parent | Must equal: option.multiple |
Add issue types to context — request body — body default Value type option single
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a single select custom field. |
contextId | string | Required within parent | The ID of the context. |
optionId | string | Required within parent | The ID of the default option. |
type | string | Required within parent | Must equal: option.single |
Add issue types to context — request body — body default Value type project
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a project custom field. |
contextId | string | Required within parent | The ID of the context. |
projectId | string | Required within parent | The ID of the default project. |
type | string | Required within parent | Must equal: project |
Add issue types to context — request body — body default Value type readonly
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a read only custom field. |
contextId | string | Required within parent | The ID of the context. |
text | string | Optional | The default text. The maximum length is 255 characters. |
type | string | Required within parent | Must equal: readonly |
Add issue types to context — request body — body default Value type single user select
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defaults for a User Picker (single) custom field. |
accountId | string | Required within parent | The ID of the default user. |
contextId | string | Required within parent | The ID of the context. |
type | string | Required within parent | Must equal: single.user.select |
userFilter | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a text area custom field. |
contextId | string | Required within parent | The ID of the context. |
text | string | Optional | The default text. The maximum length is 32767 characters. |
type | string | Required within parent | Must equal: textarea |
Add issue types to context — request body — body default Value type textfield
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a text custom field. |
contextId | string | Required within parent | The ID of the context. |
text | string | Optional | The default text. The maximum length is 254 characters. |
type | string | Required within parent | Must equal: textfield |
Add issue types to context — request body — body default Value type url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a URL custom field. |
contextId | string | Required within parent | The ID of the context. |
type | string | Required within parent | Must equal: url |
url | string | Required within parent | The default URL. |
Add issue types to context — request body — body default Value type version multiple
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a multiple version picker custom field. |
contextId | string | Required within parent | The ID of the context. |
type | string | Required within parent | Must equal: version.multiple |
versionIds | array | Required within parent | The IDs of the default versions. Unique items: true |
versionIds[] | string | Each item | The IDs of the default versions. |
versionOrder | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a version picker custom field. |
contextId | string | Required within parent | The ID of the context. |
type | string | Required within parent | Must equal: version.single |
versionId | string | Required within parent | The ID of the default version. |
versionOrder | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of project IDs. Additional keys: not allowed |
projectIds | array | Required within parent | The IDs of projects. write Only: true |
projectIds[] | string | Each item | write Only: true |
Create custom field context — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The details of a created custom field context. Additional keys: not allowed |
description | string | Optional | The description of the context. |
id | string | Optional | The ID of the context. Read only: true |
issueTypeIds | array | Optional | The list of issue types IDs for the context. If the list is empty, the context refers to all issue types. |
issueTypeIds[] | string | Each item | |
name | string | Required within parent | The name of the context. |
projectIds | array | Optional | The list of project IDs associated with the context. If the list is empty, the context is global. |
projectIds[] | string | Each item |
Create custom field context — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The details of a created custom field context. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the context. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the context. Read only: true |
id (anyOf 2) | null | Alternative | |
issueTypeIds | JSON | Optional | |
issueTypeIds (anyOf 1) | array | Alternative | The list of issue types IDs for the context. If the list is empty, the context refers to all issue types. |
issueTypeIds (anyOf 1)[] | string | Each item | |
issueTypeIds (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the context. |
name (anyOf 2) | null | Alternative | |
projectIds | JSON | Optional | |
projectIds (anyOf 1) | array | Alternative | The list of project IDs associated with the context. If the list is empty, the context is global. |
projectIds (anyOf 1)[] | string | Each item | |
projectIds (anyOf 2) | null | Alternative |
Get custom field contexts default values — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get custom field contexts default values — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | discriminator: {"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) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type option cascading |
$ (anyOf 2) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type option multiple |
$ (anyOf 3) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type option single |
$ (anyOf 4) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type single user select |
$ (anyOf 5) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type multi user select |
$ (anyOf 6) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type grouppicker single |
$ (anyOf 7) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type grouppicker multiple |
$ (anyOf 8) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type datepicker |
$ (anyOf 9) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type datetimepicker |
$ (anyOf 10) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type url |
$ (anyOf 11) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type project |
$ (anyOf 12) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type float |
$ (anyOf 13) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type labels |
$ (anyOf 14) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type textfield |
$ (anyOf 15) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type textarea |
$ (anyOf 16) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type longtext |
$ (anyOf 17) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type readonly |
$ (anyOf 18) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type version single |
$ (anyOf 19) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type version multiple |
$ (anyOf 20) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type forge string |
$ (anyOf 21) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type forge string list |
$ (anyOf 22) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type forge object |
$ (anyOf 23) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type forge datetime |
$ (anyOf 24) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type forge group |
$ (anyOf 25) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type forge group list |
$ (anyOf 26) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type forge number |
$ (anyOf 27) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item type forge user |
$ (anyOf 28) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a Date custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
date | JSON | Optional | |
date (anyOf 1) | string | Alternative | The default date in ISO format. Ignored if `useCurrent` is true. |
date (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: datepicker |
useCurrent | JSON | Optional | |
useCurrent (anyOf 1) | boolean | Alternative | Whether to use the current date. Default: false |
useCurrent (anyOf 2) | null | Alternative |
Get custom field contexts default values — response body — values The list of items item type datetimepicker
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a date time custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
dateTime | JSON | Optional | |
dateTime (anyOf 1) | string | Alternative | The default date-time in ISO format. Ignored if `useCurrent` is true. |
dateTime (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: datetimepicker |
useCurrent | JSON | Optional | |
useCurrent (anyOf 1) | boolean | Alternative | Whether to use the current date. Default: false |
useCurrent (anyOf 2) | null | Alternative |
Get custom field contexts default values — response body — values The list of items item type float
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Default value for a float (number) custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
number | JSON | Optional | |
number (anyOf 1) | JSON | Alternative | |
number (anyOf 1) (anyOf 1) | number | Alternative | The default floating-point number. Format: double |
number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: float |
Get custom field contexts default values — response body — values The list of items item type forge datetime
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a Forge date time custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
dateTime | JSON | Optional | |
dateTime (anyOf 1) | string | Alternative | The default date-time in ISO format. Ignored if `useCurrent` is true. |
dateTime (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: forge.datetime |
useCurrent | JSON | Optional | |
useCurrent (anyOf 1) | boolean | Alternative | Whether to use the current date. Default: false |
useCurrent (anyOf 2) | null | Alternative |
Get custom field contexts default values — response body — values The list of items item type forge group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a Forge group custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
groupId | JSON | Optional | |
groupId (anyOf 1) | string | Alternative | The ID of the the default group. |
groupId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: forge.group |
Get custom field contexts default values — response body — values The list of items item type forge group list
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a Forge collection of groups custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
groupIds | JSON | Optional | |
groupIds (anyOf 1) | array | Alternative | The IDs of the default groups. Unique items: true |
groupIds (anyOf 1)[] | string | Each item | The IDs of the default groups. |
groupIds (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: forge.group.list |
Get custom field contexts default values — response body — values The list of items item type forge number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Default value for a Forge number custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
number | JSON | Optional | |
number (anyOf 1) | JSON | Alternative | |
number (anyOf 1) (anyOf 1) | number | Alternative | The default floating-point number. Format: double |
number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: forge.number |
Get custom field contexts default values — response body — values The list of items item type forge object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a Forge object custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
object | JSON | Optional | |
object (anyOf 1) | object | Alternative | The default JSON object. |
object (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: forge.object |
Get custom field contexts default values — response body — values The list of items item type forge string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a Forge string custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
text | JSON | Optional | |
text (anyOf 1) | string | Alternative | The default text. The maximum length is 254 characters. |
text (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: forge.string |
Get custom field contexts default values — response body — values The list of items item type forge string list
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a Forge collection of strings custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: forge.string.list |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | List of string values. The maximum length for a value is 254 characters. |
values (anyOf 1)[] | string | Each item | List of string values. The maximum length for a value is 254 characters. |
values (anyOf 2) | null | Alternative |
Get custom field contexts default values — response body — values The list of items item type forge user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defaults for a Forge user custom field. |
accountId | JSON | Optional | |
accountId (anyOf 1) | string | Alternative | The ID of the default user. |
accountId (anyOf 2) | null | Alternative | |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: forge.user |
userFilter | JSON | Optional | |
userFilter (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defaults for a Forge collection of users custom field. |
accountIds | JSON | Optional | |
accountIds (anyOf 1) | array | Alternative | The IDs of the default users. |
accountIds (anyOf 1)[] | string | Each item | The IDs of the default users. |
accountIds (anyOf 2) | null | Alternative | |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Filter for a User Picker (single) custom field. |
enabled | JSON | Optional | |
enabled (anyOf 1) | boolean | Alternative | Whether the filter is enabled. |
enabled (anyOf 2) | null | Alternative | |
groups | JSON | Optional | |
groups (anyOf 1) | array | Alternative | User 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)[] | string | Each item | User 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) | null | Alternative | |
roleIds | JSON | Optional | |
roleIds (anyOf 1) | array | Alternative | Roles 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)[] | JSON | Each item | |
roleIds (anyOf 1)[] (anyOf 1) | integer | Alternative | Roles 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
roleIds (anyOf 2) | null | Alternative |
Get custom field contexts default values — response body — values The list of items item type grouppicker multiple
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a multiple group picker custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
groupIds | JSON | Optional | |
groupIds (anyOf 1) | array | Alternative | The IDs of the default groups. Unique items: true |
groupIds (anyOf 1)[] | string | Each item | The IDs of the default groups. |
groupIds (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: grouppicker.multiple |
Get custom field contexts default values — response body — values The list of items item type grouppicker single
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a group picker custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
groupId | JSON | Optional | |
groupId (anyOf 1) | string | Alternative | The ID of the the default group. |
groupId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: grouppicker.single |
Get custom field contexts default values — response body — values The list of items item type labels
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Default value for a labels custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
labels | JSON | Optional | |
labels (anyOf 1) | array | Alternative | The default labels value. |
labels (anyOf 1)[] | string | Each item | The default labels value. |
labels (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: labels |
Get custom field contexts default values — response body — values The list of items item type longtext
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a plain text paragraph custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
text | JSON | Optional | |
text (anyOf 1) | string | Alternative | The default text. Line breaks are preserved. The maximum length is the instance's text field character limit. |
text (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: longtext |
Get custom field contexts default values — response body — values The list of items item type multi user select
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a User Picker (multiple) custom field. |
accountIds | JSON | Optional | |
accountIds (anyOf 1) | array | Alternative | The IDs of the default users. |
accountIds (anyOf 1)[] | string | Each item | The IDs of the default users. |
accountIds (anyOf 2) | null | Alternative | |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: multi.user.select |
Get custom field contexts default values — response body — values The list of items item type option cascading
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a cascading select custom field. |
cascadingOptionId | JSON | Optional | |
cascadingOptionId (anyOf 1) | string | Alternative | The ID of the default cascading option. |
cascadingOptionId (anyOf 2) | null | Alternative | |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
optionId | JSON | Optional | |
optionId (anyOf 1) | string | Alternative | The ID of the default option. |
optionId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: option.cascading |
Get custom field contexts default values — response body — values The list of items item type option multiple
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a multi-select custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
optionIds | JSON | Optional | |
optionIds (anyOf 1) | array | Alternative | The list of IDs of the default options. |
optionIds (anyOf 1)[] | string | Each item | The list of IDs of the default options. |
optionIds (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: option.multiple |
Get custom field contexts default values — response body — values The list of items item type option single
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a single select custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
optionId | JSON | Optional | |
optionId (anyOf 1) | string | Alternative | The ID of the default option. |
optionId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: option.single |
Get custom field contexts default values — response body — values The list of items item type project
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a project custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | string | Alternative | The ID of the default project. |
projectId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: project |
Get custom field contexts default values — response body — values The list of items item type readonly
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a read only custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
text | JSON | Optional | |
text (anyOf 1) | string | Alternative | The default text. The maximum length is 255 characters. |
text (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: readonly |
Get custom field contexts default values — response body — values The list of items item type single user select
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defaults for a User Picker (single) custom field. |
accountId | JSON | Optional | |
accountId (anyOf 1) | string | Alternative | The ID of the default user. |
accountId (anyOf 2) | null | Alternative | |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: single.user.select |
userFilter | JSON | Optional | |
userFilter (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a text area custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
text | JSON | Optional | |
text (anyOf 1) | string | Alternative | The default text. The maximum length is 32767 characters. |
text (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: textarea |
Get custom field contexts default values — response body — values The list of items item type textfield
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default text for a text custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
text | JSON | Optional | |
text (anyOf 1) | string | Alternative | The default text. The maximum length is 254 characters. |
text (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: textfield |
Get custom field contexts default values — response body — values The list of items item type url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a URL custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: url |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The default URL. |
url (anyOf 2) | null | Alternative |
Get custom field contexts default values — response body — values The list of items item type version multiple
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a multiple version picker custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: version.multiple |
versionIds | JSON | Optional | |
versionIds (anyOf 1) | array | Alternative | The IDs of the default versions. Unique items: true |
versionIds (anyOf 1)[] | string | Each item | The IDs of the default versions. |
versionIds (anyOf 2) | null | Alternative | |
versionOrder | JSON | Optional | |
versionOrder (anyOf 1) | string | Alternative | The 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) | null | Alternative |
Get custom field contexts default values — response body — values The list of items item type version single
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The default value for a version picker custom field. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
type | string | Optional | Must equal: version.single |
versionId | JSON | Optional | |
versionId (anyOf 1) | string | Alternative | The ID of the default version. |
versionId (anyOf 2) | null | Alternative | |
versionOrder | JSON | Optional | |
versionOrder (anyOf 1) | string | Alternative | The 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) | null | Alternative |
Get custom field contexts for projects and issue types — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The project and issue type mappings. Additional keys: not allowed |
mappings | array | Required within parent | The project and issue type mappings. write Only: true |
mappings[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The project and issue type mapping. write Only: true Additional keys: not allowed |
issueTypeId | string | Required within parent | The ID of the issue type. write Only: true |
projectId | string | Required within parent | The ID of the project. write Only: true |
Get custom field contexts for projects and issue types — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get custom field contexts for projects and issue types — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The project and issue type mapping with a matching custom field context. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the custom field context. |
contextId (anyOf 2) | null | Alternative | |
issueTypeId | JSON | Optional | |
issueTypeId (anyOf 1) | string | Alternative | The ID of the issue type. |
issueTypeId (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | string | Alternative | The ID of the project. |
projectId (anyOf 2) | null | Alternative |
Get custom field contexts — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get custom field contexts — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The details of a custom field context. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the context. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the context. |
id (anyOf 2) | null | Alternative | |
isAnyIssueType | JSON | Optional | |
isAnyIssueType (anyOf 1) | boolean | Alternative | Whether the context apply to all issue types. |
isAnyIssueType (anyOf 2) | null | Alternative | |
isGlobalContext | JSON | Optional | |
isGlobalContext (anyOf 1) | boolean | Alternative | Whether the context is global. |
isGlobalContext (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the context. |
name (anyOf 2) | null | Alternative |
Get default values for a custom field grouped by context and issue type — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get default values for a custom field grouped by context and issue type — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Default values grouped by custom field context. |
contextId | JSON | Optional | |
contextId (anyOf 1) | JSON | Alternative | |
contextId (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the context. Format: int64 |
contextId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
contextId (anyOf 2) | null | Alternative | |
defaultValues | JSON | Optional | |
defaultValues (anyOf 1) | array | Alternative | Per-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)[] | Model | Each item | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A default value associated with an issue type within a context. |
isAnyIssueType | JSON | Optional | |
isAnyIssueType (anyOf 1) | JSON | Alternative | |
isAnyIssueType (anyOf 1) (anyOf 1) | boolean | Alternative | True 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) | null | Alternative | |
isAnyIssueType (anyOf 2) | null | Alternative | |
issueTypeId | JSON | Optional | |
issueTypeId (anyOf 1) | JSON | Alternative | |
issueTypeId (anyOf 1) (anyOf 1) | string | Alternative | The ID of the issue type this default value applies to. Null when isAnyIssueType is true. |
issueTypeId (anyOf 1) (anyOf 2) | null | Alternative | |
issueTypeId (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | Model | Alternative | Expand Get custom field contexts default values — response body — values The list of items item |
value (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get issue types for custom field context — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Mapping of an issue type to a context. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. |
contextId (anyOf 2) | null | Alternative | |
isAnyIssueType | JSON | Optional | |
isAnyIssueType (anyOf 1) | boolean | Alternative | Whether the context is mapped to any issue type. |
isAnyIssueType (anyOf 2) | null | Alternative | |
issueTypeId | JSON | Optional | |
issueTypeId (anyOf 1) | string | Alternative | The ID of the issue type. |
issueTypeId (anyOf 2) | null | Alternative |
Get project mappings for custom field context — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get project mappings for custom field context — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a context to project association. |
contextId | JSON | Optional | |
contextId (anyOf 1) | string | Alternative | The ID of the context. Read only: true |
contextId (anyOf 2) | null | Alternative | |
isGlobalContext | JSON | Optional | |
isGlobalContext (anyOf 1) | boolean | Alternative | Whether context is global. Read only: true |
isGlobalContext (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | string | Alternative | The ID of the project. Read only: true |
projectId (anyOf 2) | null | Alternative |
Remove issue types from context — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of issue type IDs. Additional keys: not allowed |
issueTypeIds | array | Required within parent | The list of issue type IDs. write Only: true |
issueTypeIds[] | string | Each item | write Only: true |
Set custom field contexts default values — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Default values to update. Additional keys: not allowed |
defaultValues | array | Optional | |
defaultValues[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Default value updates grouped by context and issue type. Additional keys: not allowed |
defaultValues | array | Optional | The default values to update. |
defaultValues[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A default value update for one issue-type scope in a context. Additional keys: not allowed |
contextId | integer | Required within parent | The ID of the context. Format: int64 |
isAnyIssueType | JSON | Optional | |
isAnyIssueType (anyOf 1) | boolean | Alternative | True when this is the catch-all default for issue types without a specific default. |
isAnyIssueType (anyOf 2) | null | Alternative | |
issueTypeId | JSON | Optional | |
issueTypeId (anyOf 1) | string | Alternative | The ID of the issue type this default value applies to. |
issueTypeId (anyOf 2) | null | Alternative | |
value | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a custom field context. Additional keys: not allowed |
description | string | Optional | The description of the custom field context. The maximum length is 255 characters. write Only: true |
name | string | Optional | The name of the custom field context. The name must be unique. The maximum length is 255 characters. write Only: true |