Get custom field contexts for projects and issue types

Returns a paginated list of project and issue type mappings and, for each mapping, the ID of a custom field context that applies to the project and issue type.

If there is no custom field context assigned to the project then, if present, the custom field context that applies to all projects is returned if it also applies to the issue type or all issue types. If a custom field context is not found, the returned custom field context ID is null.

Duplicate project and issue type mappings cannot be provided in the request.

The order of the returned values is the same as provided in the request.

Permissions required: Administer Jira global permission.

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/field//context/mapping' \ --header 'Content-Type: application/json' \ --data-raw '{ "mappings": [ { "issueTypeId": "10000", "projectId": "10000" }, { "issueTypeId": "10001", "projectId": "10000" }, { "issueTypeId": "10002", "projectId": "10001" } ] }'

{"maxResults":50,"startAt":0,"total":3,"isLast":true,"values":[{"projectId":"10000","issueTypeId":"10000","contextId":"10000"},{"projectId":"10000","issueTypeId":"10001","contextId":null},{"projectId":"10001","issueTypeId":"10002","contextId":"10003"}]}

Request

Path Params

fieldId

string

required

The ID of the custom field.

Query Params

startAt

integer

optional

The index of the first item to return in a page of results (page offset).

maxResults

integer

optional

The maximum number of items to return per page.

Body Params application/json

The project and issue type mappings.

mappings

array[object (ProjectIssueTypeMapping) {2}]

write-onlyrequired

The project and issue type mappings.

issueTypeId

string

write-onlyrequired

The ID of the issue type.

projectId

string

write-onlyrequired

The ID of the project.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

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

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[object (ContextForProjectAndIssueType) {3}]

read-onlyoptional

The list of items.

contextId

string

required

The ID of the custom field context.

issueTypeId

string

required

The ID of the issue type.

projectId

string

required

The ID of the project.

🟠400Returned if the request is not valid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the required permissions.

🟠404Returned if the custom field, project, or issue type is not found.