Get contexts for a field

Deprecated

GET

/rest/api/3/field/{fieldId}/contexts

Returns a paginated list of the contexts a field is used in. Deprecated, use Get custom field contexts.

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/field//contexts'

Response Example

200 - Success

{"maxResults":1,"startAt":0,"total":5,"isLast":false,"values":[{"id":10001,"name":"Default Context"}]}

Request

Path Params

fieldId

string

required

The ID of the field to return contexts for.

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.

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 (Context) {3}]

read-onlyoptional

The list of items.

integer <int64>

read-onlyoptional

The ID of the context.

name

string

read-onlyoptional

The name of the context.

scope

object

optional

The scope of the context.

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

🟠403Returned if the user does not have the necessary permission.

Modified at 2023-07-13 03:27:27

Update custom field

Delete custom field