Server
Jira Data Center / Reference / REST API

customFields

Postman Collection
Operations
GET/api/2/customFieldsDEL/api/2/customFieldsGET/api/2/customFields/{customFieldId}/options
GET

Get custom fields with pagination

Returns a list of Custom Fields in the given range.

Request

Query parameters

sortColumn

string

types

string

search

string

maxResults

string

sortOrder

string

screenIds

string

lastValueUpdate

string

projectIds

string

startAt

string

Responses

Returned if a custom field with the given customFieldId exists and user has permission to it.

application/json

CustomFieldBean
GET/api/2/customFields
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/customFields' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
DEL

Delete custom fields in bulk

Deletes custom fields in bulk.

Request

Query parameters

ids

string

Required

Responses

Returned if at least one custom field was deleted

application/json

BulkDeleteResponseBean
DEL/api/2/customFields
1 2 3 4 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/customFields?ids={ids}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get custom field optionsExperimental

Returns custom field's options defined in a given context composed of projects and issue types.

Request

Path parameters

customFieldId

string

Required

Query parameters

maxResults

string

issueTypeIds

string

query

string

sortByOptionName

string

useAllContexts

string

page

string

projectIds

string

Responses

Returned if a custom field with the given customFieldId exists and user has permission to it.

application/json

CustomFieldOptionsBean
GET/api/2/customFields/{customFieldId}/options
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/customFields/{customFieldId}/options' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'

Rate this page: