Class ScreenTabsService

This resource represents the screen tabs used to record issue details. Use it to get, create, update, move, and delete screen tabs.

See

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

Hierarchy

CommonHttpService
- ScreenTabsService

Index

Constructors

constructor

Methods

addScreenTab deleteScreenTab getAllScreenTabs getBulkScreenTabs moveScreenTab renameScreenTab initialize

Constructors

constructor

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

Methods

addScreenTab

addScreenTab(params): Promise<ScreenableTab>
Creates a tab for a screen.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  screenableTab: ScreenableTab;
  screenId: number;
  }
  - screenableTab: ScreenableTab
    Example
    { "name": "Fields Tab" }
  - screenId: number
    The ID of the screen.
Returns Promise<ScreenableTab>
Returned if the request is successful.

example:
```
{
  "id": 10000,
  "name": "Fields Tab"
}
```
Path
POST /rest/api/3/screens/{screenId}/tabs @scopes-current manage:jira-project @scopes-beta read:screen-tab:jira, write:screen-tab:jira

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

deleteScreenTab

deleteScreenTab(params): Promise<void>
Deletes a screen tab.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  screenId: number;
  tabId: number;
  }
  - 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} @scopes-current manage:jira-project @scopes-beta delete:screen-tab:jira

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

getAllScreenTabs

getAllScreenTabs(params): Promise<ScreenableTab[]>
Returns the list of tabs for a screen.

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;
  }
  - OptionalprojectKey?: string
    The key of the project.
  - screenId: number
    The ID of the screen.
Returns Promise<ScreenableTab[]>
Returned if the request is successful.

Path
GET /rest/api/3/screens/{screenId}/tabs @scopes-current manage:jira-project @scopes-beta read:screen-tab:jira

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

getBulkScreenTabs

getBulkScreenTabs(params?): Promise<unknown>
Returns the list of tabs for a bulk of screens.

Permissions required:
- Administer Jira global permission.
Parameters
- params: {
      maxResult?: number;
      screenId?: number[];
      startAt?: number;
      tabId?: number[];
  } = {}
  - OptionalmaxResult?: number
    The maximum number of items to return per page. The maximum number is 100,
  - OptionalscreenId?: number[]
    The list of screen IDs. To include multiple screen IDs, provide an ampersand-separated list. For example, screenId=10000&screenId=10001.
  - OptionalstartAt?: number
    The index of the first item to return in a page of results (page offset).
  - OptionaltabId?: number[]
    The list of tab IDs. To include multiple tab IDs, provide an ampersand-separated list. For example, tabId=10000&tabId=10001.
Returns Promise<unknown>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 100,
  "startAt": 0,
  "total": 2,
  "values": [
    {
      "screenId": 10000,
      "tabId": 10001,
      "tabName": "My Custom Tab 1"
    },
    {
      "screenId": 10001,
      "tabId": 10002,
      "tabName": "My Custom Tab 2"
    }
  ]
}
```
Path
GET /rest/api/3/screens/tabs @scopes-current manage:jira-project @scopes-beta read:screen-tab:jira

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

moveScreenTab

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

Permissions required: Administer Jira global permission.
Parameters
- params: {
      pos: number;
      screenId: number;
      tabId: number;
  }
  - pos: number
    The position of tab. The base index is 0.
  - 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}/move/{pos} @scopes-current manage:jira-project @scopes-beta write:screen:jira

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

renameScreenTab

renameScreenTab(params): Promise<ScreenableTab>
Updates the name of a screen tab.

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

example:
```
{
  "id": 10000,
  "name": "Fields Tab"
}
```
Path
PUT /rest/api/3/screens/{screenId}/tabs/{tabId} @scopes-current manage:jira-project @scopes-beta read:screen-tab:jira, write:screen-tab:jira

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

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class ScreenTabsService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns ScreenTabsService

Methods

addScreenTab

Parameters

screenableTab: ScreenableTab

Example

screenId: number

Returns Promise<ScreenableTab>

Path

See

deleteScreenTab

Parameters

screenId: number

tabId: number

Returns Promise<void>

Path

See

getAllScreenTabs

Parameters

OptionalprojectKey?: string

screenId: number

Returns Promise<ScreenableTab[]>

Path

See

getBulkScreenTabs

Parameters

OptionalmaxResult?: number

OptionalscreenId?: number[]

OptionalstartAt?: number

OptionaltabId?: number[]

Returns Promise<unknown>

Path

See

moveScreenTab

Parameters

pos: number

screenId: number

tabId: number

Returns Promise<void>

Path

See

renameScreenTab

Parameters

screenableTab: ScreenableTab

screenId: number

tabId: number

Returns Promise<ScreenableTab>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`projectKey?: string

`Optional`maxResult?: number

`Optional`screenId?: number[]

`Optional`startAt?: number

`Optional`tabId?: number[]

`Protected` `Static`initialize