This resource supports bulk pinning and unpinning of issue panels that are added by a Forge app. Only Jira administrators can use it.
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.
manage:jira-projectConnect apps cannot access this REST resource.
Forge module ID and the list of projects with pin or unpin action.
string
Requiredarray<ProjectPinAction>
RequiredAccepted. Returns the task ID for polling progress.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestJira } from "@forge/bridge";
var bodyData = `{
"moduleId": "<string>",
"projectList": [
{
"action": "PIN",
"projectIdOrKey": "<string>"
}
]
}`;
const response = await requestJira(`/rest/api/3/forge/panel/action/bulk/async`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
{
"taskId": "<string>"
}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.
manage:jira-projectConnect apps cannot access this REST resource.
Forge module ID and the list of projects to check.
string
Requiredarray<string>
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestJira } from "@forge/bridge";
var bodyData = `{
"moduleId": "<string>",
"projectList": [
"<string>"
]
}`;
const response = await requestJira(`/rest/api/3/forge/panel/action/bulk/status`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
{
"moduleId": "<string>",
"statuses": [
{
"error": "<string>",
"pinned": true,
"pinnedAt": 74,
"projectIdOrKey": "<string>"
}
]
}Rate this page: