Class ScreenTabFieldsService

This resource represents the screen tab fields used to record issue details. Use it to get, add, move, and remove fields from screen tabs.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields

Hierarchy

CommonHttpService
- ScreenTabFieldsService

Index

Constructors

constructor

Methods

addScreenTabField getAllScreenTabFields moveScreenTabField removeScreenTabField initialize

Constructors

constructor

new ScreenTabFieldsService(getClientInstance): ScreenTabFieldsService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns ScreenTabFieldsService
Inherited from CommonHttpService.constructor

Methods

addScreenTabField

addScreenTabField(params): Promise<ScreenableField>
Adds a field to a screen tab.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      addFieldBean: AddFieldBean;
      screenId: number;
      tabId: number;
  }
  - addFieldBean: AddFieldBean
    Example
    { "fieldId": "summary" }
  - screenId: number
    The ID of the screen.
  - tabId: number
    The ID of the screen tab.
Returns Promise<ScreenableField>
Returned if the request is successful.

example:
```
{
  "id": "summary",
  "name": "Summary"
}
```
Path
POST /rest/api/3/screens/{screenId}/tabs/{tabId}/fields @scopes-current manage:jira-project @scopes-beta read:screenable-field:jira, write:screenable-field:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields#api-rest-api-3-screens-screenid-tabs-tabid-fields-post

getAllScreenTabFields

getAllScreenTabFields(params): Promise<ScreenableField[]>
Returns all fields for a screen tab.

Permissions required:
- Administer Jira global permission.
- Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
Parameters
- params: {
      projectKey?: string;
      screenId: number;
      tabId: number;
  }
  - OptionalprojectKey?: string
    The key of the project.
  - screenId: number
    The ID of the screen.
  - tabId: number
    The ID of the screen tab.
Returns Promise<ScreenableField[]>
Returned if the request is successful.

Path
GET /rest/api/3/screens/{screenId}/tabs/{tabId}/fields @scopes-current manage:jira-project @scopes-beta read:screenable-field:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields#api-rest-api-3-screens-screenid-tabs-tabid-fields-get

moveScreenTabField

moveScreenTabField(params): Promise<void>
Moves a screen tab field.

If after and position are provided in the request, position is ignored.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      id: string;
      moveFieldBean: MoveFieldBean;
      screenId: number;
      tabId: number;
  }
  - id: string
    The ID of the field.
  - moveFieldBean: MoveFieldBean
  - screenId: number
    The ID of the screen.
  - tabId: number
    The ID of the screen tab.
Returns Promise<void>
Returned if the request is successful.

Path
POST /rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move @scopes-current manage:jira-project @scopes-beta write:screenable-field:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields#api-rest-api-3-screens-screenid-tabs-tabid-fields-id-move-post

removeScreenTabField

removeScreenTabField(params): Promise<void>
Removes a field from a screen tab.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      id: string;
      screenId: number;
      tabId: number;
  }
  - id: string
    The ID of the field.
  - screenId: number
    The ID of the screen.
  - tabId: number
    The ID of the screen tab.
Returns Promise<void>
Path
DELETE /rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id} @scopes-current manage:jira-project @scopes-beta delete:screenable-field:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields#api-rest-api-3-screens-screenid-tabs-tabid-fields-id-delete

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class ScreenTabFieldsService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns ScreenTabFieldsService

Methods

addScreenTabField

Parameters

addFieldBean: AddFieldBean

Example

screenId: number

tabId: number

Returns Promise<ScreenableField>

Path

See

getAllScreenTabFields

Parameters

OptionalprojectKey?: string

screenId: number

tabId: number

Returns Promise<ScreenableField[]>

Path

See

moveScreenTabField

Parameters

id: string

moveFieldBean: MoveFieldBean

screenId: number

tabId: number

Returns Promise<void>

Path

See

removeScreenTabField

Parameters

id: string

screenId: number

tabId: number

Returns Promise<void>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`projectKey?: string

`Protected` `Static`initialize