Field schemes

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/2/config/fieldschemes/{id}/projects

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/config/fieldschemes/{id}/projects
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL 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 associated projects

Query parameters

startAtinteger

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

maxResultsinteger

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

projectIdinteger[]

The project Ids to filter by, if empty then all projects belonging to a field association scheme will be returned

Response

Returns a paginated list of projects associated with the field association scheme, matching the specified filter criteria.

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

No recorded changes to this operation across all 26 revisions of this API.