Field schemes

Search field scheme fields

Changed on

Search for fields belonging to a given field association scheme.

Permissions required: Administer Jira global permission.

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

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/config/fieldschemes/{id}/fields
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-configuration

Path parameters

idinteger required

The scheme ID to search for child fields

Query parameters

startAtinteger

The starting index of the returned fields. Base index: 0.

maxResultsinteger

The maximum number of fields to return per page, maximum allowed value is 100.

fieldIdstring[]

The field IDs to filter by, if empty then all fields belonging to a field association scheme will be returned

Response

Returns the matching fields, at the specified page of the results.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes

  • 23cd462c2497Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 5021849ab549Revision changes
    • info

      endpoint added