Class IssuePanelsService

This resource supports bulk pinning and unpinning of issue panels that are added by a Forge app. Only Jira administrators can use it.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-panels

Hierarchy

CommonHttpService
- IssuePanelsService

Index

Constructors

Methods

bulkPinUnpinProjectsAsync initialize

Constructors

constructor

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

Methods

bulkPinUnpinProjectsAsync

bulkPinUnpinProjectsAsync(params): Promise<ForgePanelProjectPinAsyncResponse>
Bulk pin or unpin an issue panel (added by a Forge app) to or from multiple projects.

The operation runs asynchronously. The response includes a task ID - use the Get task endpoint to check progress.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  forgePanelProjectPinRequest: ForgePanelProjectPinRequest;
  }
  - forgePanelProjectPinRequest: ForgePanelProjectPinRequest
    Forge module ID and the list of projects with pin or unpin action
Returns Promise<ForgePanelProjectPinAsyncResponse>
Accepted. Returns the task ID for polling progress.

Path
POST /rest/api/3/forge/panel/action/bulk/async

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-panels#api-rest-api-3-forge-panel-action-bulk-async-post

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize