Function: getBulkPinStatus()
ts
function getBulkPinStatus(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
moduleId?: string;
statuses?: object[];
}>;Defined in: src/cloud/api/issuePanels.ts:52
Get the pin status of an issue panel (added by a Forge app) for multiple projects.
The operation is read-only and runs synchronously. Projects that do not exist, or that you do not have permission to access, are returned in the response with the panel reported as not pinned and the reason in the error field; the request itself still succeeds.
Permissions required:Administer Jira global permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { moduleId: string; projectList: string[]; } | - |
parameters.moduleId | string | The moduleId of the Forge panel in the format ari:cloud:ecosystem::extension/{app-id}/{environment-id}/static/{module-key} |
parameters.projectList? | string[] | The IDs or keys of the projects to check the issue panel pin status for. |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; moduleId?: string; statuses?: object[]; }>