Create field configuration

POST

/rest/api/3/fieldconfiguration

Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.

This operation can only create configurations for use in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/fieldconfiguration' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "My field configuration description",
    "name": "My Field Configuration"
}'

Response Example

200 - Success

{"id":10001,"name":"My Field Configuration","description":"My field configuration description"}

Request

Body Params application/json

Details of a field configuration.

description

string

write-onlyoptional

The description of the field configuration.

<= 255 characters

name

string

write-onlyrequired

The name of the field configuration. Must be unique.

<= 255 characters

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

Details of a field configuration.

description

string

required

The description of the field configuration.

integer <int64>

required

The ID of the field configuration.

isDefault

boolean

optional

Whether the field configuration is the default.

name

string

required

The name of the field configuration.

🟠400Returned if the request is not valid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the necessary permission.

Modified at 2023-07-13 03:27:27

Get all field configurations

Update field configuration