Atlassian: Issue custom field configuration apps schemas

8 Atlassian schemas with complete fields and constraints.

← Issue custom field configuration apps operations · All schemas

Bulk get custom field configurations — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	List of custom fields identifiers which will be used to filter configurations write Only: true Additional keys: not allowed
`fieldIdsOrKeys`	array	Required within parent	List of IDs or keys of the custom fields. It can be a mix of IDs and keys in the same query. Minimum items: 1
`fieldIdsOrKeys[]`	string	Each item

Bulk get custom field configurations — 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 Bulk get custom field configurations — response body — values The list of items item
`values (anyOf 2)`	null	Alternative

Referenced models: Bulk get custom field configurations — response body — values The list of items item

Bulk get custom field configurations — response body — values The list of items item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the contextual configuration for a custom field.
`configuration`	JSON	Optional
`configuration (anyOf 1)`	JSON	Alternative	The field configuration.
`configuration (anyOf 2)`	null	Alternative
`customFieldId`	JSON	Optional
`customFieldId (anyOf 1)`	string	Alternative	The ID of the custom field.
`customFieldId (anyOf 2)`	null	Alternative
`fieldContextId`	JSON	Optional
`fieldContextId (anyOf 1)`	string	Alternative	The ID of the field context the configuration is associated with. Read only: true
`fieldContextId (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the configuration.
`id (anyOf 2)`	null	Alternative
`schema`	JSON	Optional
`schema (anyOf 1)`	JSON	Alternative	The field value schema.
`schema (anyOf 2)`	null	Alternative

Get custom field configurations — request body — query

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`id`	array	Optional	Unique items: true
`id[]`	integer	Each item	Format: int64
`fieldContextId`	array	Optional	Unique items: true
`fieldContextId[]`	integer	Each item	Format: int64
`issueId`	integer	Optional	Format: int64
`projectKeyOrId`	string	Optional
`issueTypeId`	string	Optional
`startAt`	integer	Optional	Default: 0 Format: int64
`maxResults`	integer	Optional	Default: 100 Format: int32

Get custom field configurations — 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 configurations — response body — values The list of items item
`values (anyOf 2)`	null	Alternative

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the contextual configuration for a custom field.
`configuration`	JSON	Optional
`configuration (anyOf 1)`	JSON	Alternative	The field configuration.
`configuration (anyOf 2)`	null	Alternative
`fieldContextId`	JSON	Optional
`fieldContextId (anyOf 1)`	string	Alternative	The ID of the field context the configuration is associated with. Read only: true
`fieldContextId (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the configuration.
`id (anyOf 2)`	null	Alternative
`schema`	JSON	Optional
`schema (anyOf 1)`	JSON	Alternative	The field value schema.
`schema (anyOf 2)`	null	Alternative

Update custom field configurations — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of configurations for a custom field. write Only: true Additional keys: not allowed
`configurations`	array	Required within parent	The list of custom field configuration details. Maximum items: 1000 Minimum items: 1 Unique items: true
`configurations[]`	Model	Each item	Expand Update custom field configurations — request body — body configurations item

Referenced models: Update custom field configurations — request body — body configurations item

Update custom field configurations — request body — body configurations item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the contextual configuration for a custom field. Additional keys: not allowed
`configuration`	JSON	Optional	The field configuration.
`fieldContextId`	string	Required within parent	The ID of the field context the configuration is associated with. Read only: true
`id`	string	Required within parent	The ID of the configuration.
`schema`	JSON	Optional	The field value schema.

Report an issue with this page