Returns all modules registered dynamically by the calling app.
Permissions required: Only Connect apps can make this request.
Connect app scope required: NONE
This request has no parameters.
Returned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication
import api, { route } from "@forge/api";
const response = await api.requestJira(route`/rest/atlassian-connect/1/app/module/dynamic`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
"jiraEntityProperties": [
{
"keyConfigurations": [
{
"extractions": [
{
"objectName": "extension",
"type": "text",
"alias": "attachmentExtension"
}
],
"propertyKey": "attachment"
}
],
"entityType": "issue",
"name": {
"value": "Attachment Index Document"
},
"key": "dynamic-attachment-entity-property"
}
],
"jiraIssueFields": [
{
"description": {
"value": "A dynamically added single-select field"
},
"type": "single_select",
"extractions": [
{
"path": "category",
"type": "text",
"name": "categoryName"
}
],
"name": {
"value": "Dynamic single select"
},
"key": "dynamic-select-field"
}
]
}
Registers a list of modules.
Permissions required: Only Connect apps can make this request.
Connect app scope required: NONE
array<ConnectModule>
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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication
import api, { route } from "@forge/api";
var bodyData = `{
"jiraEntityProperties": [
{
"keyConfigurations": [
{
"extractions": [
{
"objectName": "extension",
"type": "text",
"alias": "attachmentExtension"
}
],
"propertyKey": "attachment"
}
],
"entityType": "issue",
"name": {
"value": "Attachment Index Document"
},
"key": "dynamic-attachment-entity-property"
}
],
"jiraIssueFields": [
{
"description": {
"value": "A dynamically added single-select field"
},
"type": "single_select",
"extractions": [
{
"path": "category",
"type": "text",
"name": "categoryName"
}
],
"name": {
"value": "Dynamic single select"
},
"key": "dynamic-select-field"
}
]
}`;
const response = await api.requestJira(route`/rest/atlassian-connect/1/app/module/dynamic`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());
Remove all or a list of modules registered by the calling app.
Permissions required: Only Connect apps can make this request.
Connect app scope required: NONE
array<string>
Returned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication
import api, { route } from "@forge/api";
const response = await api.requestJira(route`/rest/atlassian-connect/1/app/module/dynamic`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());
Rate this page: