fieldconfiguration

create-field-configuration

Create field configuration

Deprecated, use Field schemes which supports field association schemes.

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.

POST /rest/api/3/fieldconfiguration

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr fieldconfiguration create-field-configuration

delete-field-configuration

Delete field configuration

Deprecated, use Field schemes which supports field association schemes.

Deletes a field configuration.

This operation can only delete configurations used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/fieldconfiguration/{id}

Flag	Type	Required	Description
--id	string	Yes	The ID of the field configuration.

Example:

jr fieldconfiguration delete-field-configuration --id <id>

get-all-field-configurations

Get all field configurations

Deprecated, use Field schemes which supports field association schemes.

Returns a paginated list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:

• a list of field configuration item IDs.
• whether the field configuration is a default.
• whether the field configuration name or description contains a query string.

Only field configurations used in company-managed (classic) projects are returned.

Permissions required: Administer Jira global permission.

GET /rest/api/3/fieldconfiguration

Flag	Type	Required	Description
--id	string	No	The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
--isDefault	string	No	If true returns default field configurations only.
--maxResults	string	No	The maximum number of items to return per page.
--query	string	No	The query string used to match against field configuration names and descriptions.
--startAt	string	No	The index of the first item to return in a page of results (page offset).

Example:

jr fieldconfiguration get-all-field-configurations

get-field-configuration-items

Get field configuration items

Deprecated, use Field schemes which supports field association schemes.

Returns a paginated list of all fields for a configuration.

Only the fields from configurations used in company-managed (classic) projects are returned.

Permissions required: Administer Jira global permission.

GET /rest/api/3/fieldconfiguration/{id}/fields

Flag	Type	Required	Description
--id	string	Yes	The ID of the field configuration.
--maxResults	string	No	The maximum number of items to return per page.
--startAt	string	No	The index of the first item to return in a page of results (page offset).

Example:

jr fieldconfiguration get-field-configuration-items --id <id>

update-field-configuration

Update field configuration

Deprecated, use Field schemes which supports field association schemes.

Updates a field configuration. The name and the description provided in the request override the existing values.

This operation can only update configurations used in company-managed (classic) projects.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/fieldconfiguration/{id}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	The ID of the field configuration.

Example:

jr fieldconfiguration update-field-configuration --id <id>

update-field-configuration-items

Update field configuration items

Deprecated, use Field schemes which supports field association schemes.

Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.

This operation can only update field configurations used in company-managed (classic) projects.

The operation can set the renderer for text fields to the default text renderer (text-renderer) or wiki style renderer (wiki-renderer). However, the renderer cannot be updated for fields using the autocomplete renderer (autocomplete-renderer).

Hiding a field deletes it from the field configuration - deleting the required, description and renderer type values as well. As a result, hiding and unhiding will not restore the other values but use their default values.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/fieldconfiguration/{id}/fields

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	The ID of the field configuration.

Example:

jr fieldconfiguration update-field-configuration-items --id <id>