config

associate-projects-to-field-association-schemes

Associate projects to field schemes

Associate projects to field association schemes.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/config/fieldschemes/projects

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

Example:

jr config associate-projects-to-field-association-schemes

clone-field-association-scheme

Clone field scheme

Endpoint for cloning an existing field association scheme into a new one.

Permissions required: Administer Jira global permission.

POST /rest/api/3/config/fieldschemes/{id}/clone

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	The ID of the source field association scheme to clone from

Example:

jr config clone-field-association-scheme --id <id>

create-field-association-scheme

Create field scheme

Endpoint for creating a new field association scheme.

Permissions required: Administer Jira global permission.

POST /rest/api/3/config/fieldschemes

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

Example:

jr config create-field-association-scheme

delete-field-association-scheme

Delete a field scheme

Delete a specified field association scheme

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/config/fieldschemes/{id}

Flag	Type	Required	Description
--id	string	Yes	The ID of the field association scheme to delete.

Example:

jr config delete-field-association-scheme --id <id>

get-field-association-scheme-by-id

Get field scheme

Endpoint for fetching a field association scheme by its ID

Permissions required: Administer Jira global permission.

GET /rest/api/3/config/fieldschemes/{id}

Flag	Type	Required	Description
--id	string	Yes	The scheme id to fetch

Example:

jr config get-field-association-scheme-by-id --id <id>

get-field-association-scheme-item-parameters

Get field parameters

Retrieve field association parameters on a field association scheme

Permissions required: Administer Jira global permission.

GET /rest/api/3/config/fieldschemes/{id}/fields/{fieldId}/parameters

Flag	Type	Required	Description
--fieldId	string	Yes	the ID of the field
--id	string	Yes	the ID of the field association scheme to retrieve parameters for

Example:

jr config get-field-association-scheme-item-parameters --fieldId <fieldId> --id <id>

get-field-association-schemes

Get field schemes

REST endpoint for retrieving a paginated list of field association schemes with optional filtering.

This endpoint allows clients to fetch field association schemes with optional filtering by project IDs and text queries. The response includes scheme details with navigation links and filter metadata when applicable.

Filtering Behavior:

• When projectId or query parameters are provided, the response includes matchedFilters metadata showing which filters were applied.
• When no filters are applied, matchedFilters is omitted from individual scheme objects

Permissions required: Administer Jira global permission.

GET /rest/api/3/config/fieldschemes

Flag	Type	Required	Description
--maxResults	string	No	Maximum number of items to return per page (default: 50, max: 100)
--projectId	string	No	(optional) List of project IDs to filter schemes by. If not provided, schemes from all projects are returned.
--query	string	No	(optional) Text filter for scheme name or description matching (case-insensitive). If not provided, no text filtering is applied.
--startAt	string	No	Zero-based index of the first item to return (default: 0)

Example:

jr config get-field-association-schemes

get-projects-with-field-schemes

Get projects with field schemes

Get projects with field association schemes. This will be a temporary API but useful when transitioning from the legacy field configuration APIs to the new ones.

Permissions required: Administer Jira global permission.

GET /rest/api/3/config/fieldschemes/projects

Flag	Type	Required	Description
--maxResults	string	No	The maximum number of projects to return per page, maximum allowed value is 100.
--projectId	string	No	List of project ids to filter the results by.
--startAt	string	No	The starting index of the returned projects. Base index: 0.

Example:

jr config get-projects-with-field-schemes

remove-field-association-scheme-item-parameters

Remove field parameters

Remove field association parameters overrides for work types.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/config/fieldschemes/fields/parameters

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

Example:

jr config remove-field-association-scheme-item-parameters

remove-fields-associated-with-schemes

Remove fields associated with field schemes

Remove fields associated with field association schemes.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/config/fieldschemes/fields

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

Example:

jr config remove-fields-associated-with-schemes

search-field-association-scheme-fields

Search field scheme fields

Search for fields belonging to a given field association scheme.

Permissions required: Administer Jira global permission.

GET /rest/api/3/config/fieldschemes/{id}/fields

Flag	Type	Required	Description
--fieldId	string	No	The field IDs to filter by, if empty then all fields belonging to a field association scheme will be returned
--id	string	Yes	The scheme ID to search for child fields
--maxResults	string	No	The maximum number of fields to return per page, maximum allowed value is 100.
--startAt	string	No	The starting index of the returned fields. Base index: 0.

Example:

jr config search-field-association-scheme-fields --id <id>

search-field-association-scheme-projects

Search field scheme projects

REST Endpoint for searching for projects belonging to a given field association scheme

Permissions required: Administer Jira global permission.

GET /rest/api/3/config/fieldschemes/{id}/projects

Flag	Type	Required	Description
--id	string	Yes	The scheme id to search for associated projects
--maxResults	string	No	The maximum number of projects to return per page, maximum allowed value is 100.
--projectId	string	No	The project Ids to filter by, if empty then all projects belonging to a field association scheme will be returned
--startAt	string	No	The starting index of the returned projects. Base index: 0.

Example:

jr config search-field-association-scheme-projects --id <id>

update-field-association-scheme

Update field scheme

Endpoint for updating an existing field association scheme.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/config/fieldschemes/{id}

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

Example:

jr config update-field-association-scheme --id <id>

update-field-association-scheme-item-parameters

Update field parameters

Update field association item parameters in field association schemes.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/config/fieldschemes/fields/parameters

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

Example:

jr config update-field-association-scheme-item-parameters

update-fields-associated-with-schemes

Update fields associated with field schemes

Update fields associated with field association schemes.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/config/fieldschemes/fields

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

Example:

jr config update-fields-associated-with-schemes