How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Jira

Jira Field schemes API

This resource represents field schemes which are replacing field configuration schemes to control field associations. They are currently in beta and only available to customers who have opted-in to the beta program. For more information see [RFC-103: Jira Field Configuration Overhaul: Admin Experience and API Changes](https://community.developer.atlassian.com/t/rfc-103-jira-field-configuration-overhaul-admin-experience-and-api-changes/94205)

Documentation Provider Profile APIs.io OpenAPI GitHub

Jira Field schemes API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Field schemes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 15 operations across 9 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

Requests are made against a single base URL, https://your-domain.atlassian.net.

15 operations 9 paths 43 schemas 3 DELETE6 GET2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
Base URL
https://your-domain.atlassian.net/rest/api/2
Authentication
OAuth 2.0, HTTP Basic
Contact
ecosystem@atlassian.com
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Jira Field schemes API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 15

Across 9 paths, the API surfaces 15 operations — 3 DELETE, 6 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Field schemes 15

This resource represents field schemes which are replacing field configuration schemes to control field associations. They are currently in beta and only available to customers wh…

GET
/rest/api/3/config/fieldschemes
Get field schemes
getFieldAssociationSchemes 4 params → 200400401403404
POST
/rest/api/3/config/fieldschemes
Create field scheme
createFieldAssociationScheme body → 200400401403404
DELETE
/rest/api/3/config/fieldschemes/fields
Remove fields associated with field schemes
removeFieldsAssociatedWithSchemes body → 200204207400401403
PUT
/rest/api/3/config/fieldschemes/fields
Update fields associated with field schemes
updateFieldsAssociatedWithSchemes body → 200204207400401403
DELETE
/rest/api/3/config/fieldschemes/fields/parameters
Remove field parameters
removeFieldAssociationSchemeItemParameters body → 200204207400401403
PUT
/rest/api/3/config/fieldschemes/fields/parameters
Update field parameters
updateFieldAssociationSchemeItemParameters body → 200204207400401403
GET
/rest/api/3/config/fieldschemes/projects
Get projects with field schemes
getProjectsWithFieldSchemes 3 params → 200400401403404
PUT
/rest/api/3/config/fieldschemes/projects
Associate projects to field schemes
associateProjectsToFieldAssociationSchemes body → 200204207400401403
DELETE
/rest/api/3/config/fieldschemes/{id}
Delete a field scheme
deleteFieldAssociationScheme 1 param → 200400401403404409
GET
/rest/api/3/config/fieldschemes/{id}
Get field scheme
getFieldAssociationSchemeById 1 param → 200403404
PUT
/rest/api/3/config/fieldschemes/{id}
Update field scheme
updateFieldAssociationScheme 1 param body → 200400401403404
POST
/rest/api/3/config/fieldschemes/{id}/clone
Clone field scheme
cloneFieldAssociationScheme 1 param body → 200400401403404
GET
/rest/api/3/config/fieldschemes/{id}/fields
Search field scheme fields
searchFieldAssociationSchemeFields 4 params → 200400401403404
GET
/rest/api/3/config/fieldschemes/{id}/fields/{fieldId}/parameters
Get field parameters
getFieldAssociationSchemeItemParameters 2 params → 200400401403
GET
/rest/api/3/config/fieldschemes/{id}/projects
Search field scheme projects
searchFieldAssociationSchemeProjects 4 params → 200400401403404

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are PageBean2GetFieldAssociationSchemeResponse (7 properties), PageBean2GetProjectsWithFieldSchemesResponse (7 properties), GetFieldAssociationSchemeResponse (7 properties), PageBean2FieldAssociationSchemeFieldSearchResult (7 properties). Each schema is shown below with its type and property counts.

SuccessOrErrorResults
object
5 properties
ErrorCollections
object
FieldAssociationSchemeLinks
object
2 properties
FieldAssociationSchemeLinksBean
object
2 properties
RemoveFieldParametersResultError
object
Error during remove field parameters operation.
2 properties
FieldAssociationSchemeFieldSearchResult
object
Field association scheme field search results.
5 properties
CreateFieldAssociationSchemeRequest
object
Request object for creating a new field association scheme.
2 properties 1 required
FieldsSchemeItemParameter
object
The default parameters to apply to the field across all work types in the specified schemes, may be null if only work type-specific updates are needed
3 properties
FieldAssociationSchemeProjectSearchResult
object
Project search results for field association scheme.
5 properties
WorkTypeParameters
object
4 properties 2 required
FieldAssociationSchemeMatchedFilters
object
Matched filters for field association scheme search.
2 properties
CreateFieldAssociationSchemeResponse
object
Response object after successfully creating a new field association scheme.
4 properties
FieldSchemeToProjectsRequest
object
Request for associating field schemes to projects.
1 property 1 required
ParameterRemovalDetails
object
3 properties
PageBean2FieldAssociationSchemeFieldSearchResult
object
A page of items.
7 properties
UpdateFieldAssociationsRequestItem
object
Represents an association between a field and its operations.
2 properties 1 required
FieldSchemeToProjectsPartialFailure
object
Partial failure result when updating field scheme to projects associations.
4 properties 3 required
UpdateFieldSchemeParametersPartialFailure
object
Result of updating field scheme parameters for a specific field, scheme, and optional work type.
5 properties 3 required
UpdateFieldSchemeParametersRequest
object
Request bean for updating field scheme parameters across multiple schemes and work types.
3 properties
UpdateFieldSchemeParametersResponse
object
Response bean for field scheme parameter update operations.
1 property 1 required
RemoveFieldParametersResult
object
Result of remove field parameters operation.
1 property
FieldSchemeToFieldsResponse
object
Response for updating field associations.
1 property 1 required
MinimalFieldSchemeToFieldsResponse
object
Minimal response for updating field scheme to fields associations.
1 property 1 required
PageBean2GetFieldAssociationSchemeResponse
object
A page of items.
7 properties
SearchResultFieldParameters
object
3 properties
PageBean2GetProjectsWithFieldSchemesResponse
object
A page of items.
7 properties
GetFieldAssociationParametersResponse
object
Response object for getting field association parameters.
3 properties 1 required
CreateFieldAssociationSchemeLinksBean
object
2 properties
UpdateFieldAssociationSchemeLinksBean
object
2 properties
RemoveFieldAssociationsRequestItem
object
Request item for removing field associations.
1 property 1 required
UpdateFieldAssociationSchemeResponse
object
Response object after successfully updating an existing field association scheme.
4 properties
UpdateFieldAssociationSchemeRequest
object
Request object for updating an existing field association scheme.
2 properties
GetFieldAssociationSchemeResponse
object
Response object for getting a field association scheme.
7 properties
GetProjectsWithFieldSchemesResponse
object
Response item returned from get projects with field schemes.
2 properties
PageBean2FieldAssociationSchemeProjectSearchResult
object
A page of items.
7 properties
SearchResultWorkTypeParameters
object
4 properties
FieldSchemeToFieldsPartialFailure
object
Partial failure result when updating field scheme to fields associations.
5 properties 4 required
DeleteFieldAssociationSchemeResponse
object
Response object after successfully deleting a field association scheme.
2 properties
FieldAssociationParameters
object
3 properties 1 required
FieldsSchemeItemWorkTypeParameter
object
The list of work type-specific parameter overrides, may be empty if only default parameters are being updated
4 properties
GetFieldAssociationSchemeByIdResponse
object
Response object for getting a field association scheme by ID.
6 properties
MinimalFieldSchemeToFieldsPartialFailure
object
Minimal partial failure result when updating field scheme to fields associations.
4 properties 3 required
FieldSchemeToProjectsResponse
object
Response for updating field scheme to projects associations.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-field-schemes-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
AE Profile APIs.io
Jira Service Management Operations REST API
AE Profile APIs.io
Jira Align REST API
AE Profile APIs.io
Jira Customer Service Management REST API
AE Profile APIs.io
Jira Issue Comments API
AE Profile APIs.io
Jira Issue Priorities API
AE Profile APIs.io
Jira Issue Search API
AE Profile APIs.io
Jira Issue Statuses API
AE Profile APIs.io
Jira Issue Transitions API
AE Profile APIs.io
Jira Issue Types API
AE Profile APIs.io
Jira Issues API
AE Profile APIs.io
Jira Projects API
AE Profile APIs.io
#Field schemes
← Back to J APIs
API Details
ID
jira:jira-field-schemes-api
Base URL
https://your-domain.atlassian.net/rest/api/2
Docs
https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/
Provider
Jira
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=jira-field-schemes-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/jira-field-schemes-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Jira Field schemes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.