Add screen tab field

POST

/rest/api/3/screens/{screenId}/tabs/{tabId}/fields

Adds a field to a screen tab.

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/screens//tabs//fields' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fieldId": "summary"
}'

Response Example

200 - Success

{"id":"summary","name":"Summary"}

Request

Path Params

screenId

integer

required

The ID of the screen.

tabId

integer

required

The ID of the screen tab.

Body Params application/json

fieldId

string

required

The ID of the field to add.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

A screen tab field.

string

read-onlyoptional

The ID of the screen tab field.

name

string

optional

The name of the screen tab field. Required on create and update. The maximum length is 255 characters.

🟠400Returned if the request is invalid.

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

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

🟠404Returned if the screen, screen tab, or field is not found.

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

Get all screen tab fields

Remove screen tab field