Returns the comments of the specific attachment.
The number of results is limited by the limit parameter and additional results (if available) will be available through
the next URL present in the Link response header.
Permissions required: Permission to view the attachment and its corresponding containers.
read:comment:confluenceConnect app scope required: READ
string
RequiredPrimaryBodyRepresentation
string
integer
CommentSortOrder
integer
Returned if the attachment comments were successfully retrieved
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/attachments/{id}/footer-comments`, {
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
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"attachmentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {},
"view": {}
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the comments of the specific custom content.
The number of results is limited by the limit parameter and additional results (if available) will be available through
the next URL present in the Link response header.
Permissions required: Permission to view the custom content and its corresponding containers.
read:comment:confluenceConnect app scope required: READ
integer
RequiredPrimaryBodyRepresentation
string
integer
CommentSortOrder
Returned if the custom content comments were successfully retrieved
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/custom-content/{id}/footer-comments`, {
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
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"customContentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {},
"view": {}
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the root footer comments of specific page. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the page and its corresponding space.
read:comment:confluenceConnect app scope required: READ
integer
RequiredPrimaryBodyRepresentation
array<string>
CommentSortOrder
string
integer
Returned if the requested footer comments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/pages/{id}/footer-comments`, {
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
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"pageId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {}
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the root inline comments of specific page. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the page and its corresponding space.
read:comment:confluenceConnect app scope required: READ
integer
RequiredPrimaryBodyRepresentation
array<string>
array<string>
CommentSortOrder
string
integer
Returned if the requested inline comments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/pages/{id}/inline-comments`, {
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
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"pageId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {}
},
"resolutionStatus": "open",
"properties": {
"inlineMarkerRef": "<string>",
"inlineOriginalSelection": "<string>",
"inline-marker-ref": "<string>",
"inline-original-selection": "<string>"
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the root footer comments of specific blog post. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the blog post and its corresponding space.
read:comment:confluenceConnect app scope required: READ
integer
RequiredPrimaryBodyRepresentation
array<string>
CommentSortOrder
string
integer
Returned if the requested footer comments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/blogposts/{id}/footer-comments`, {
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
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"blogPostId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {}
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the root inline comments of specific blog post. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the blog post and its corresponding space.
read:comment:confluenceConnect app scope required: READ
integer
RequiredPrimaryBodyRepresentation
array<string>
array<string>
CommentSortOrder
string
integer
Returned if the requested inline comments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/blogposts/{id}/inline-comments`, {
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
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"blogPostId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {}
},
"resolutionStatus": "open",
"properties": {
"inlineMarkerRef": "<string>",
"inlineOriginalSelection": "<string>",
"inline-marker-ref": "<string>",
"inline-original-selection": "<string>"
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns all footer comments. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the container and its corresponding space.
read:comment:confluenceConnect app scope required: READ
PrimaryBodyRepresentation
CommentSortOrder
string
integer
Returned if the requested footer comments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/footer-comments`, {
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"blogPostId": "<string>",
"pageId": "<string>",
"attachmentId": "<string>",
"customContentId": "<string>",
"parentCommentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"properties": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {}
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"operations": {
"results": [
{
"operation": "<string>",
"targetType": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"likes": {
"results": [
{
"accountId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"versions": {
"results": [
{
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"body": {
"storage": {},
"atlas_doc_format": {},
"view": {}
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Create a footer comment.
The footer comment can be made against several locations:
Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.
write:comment:confluenceConnect app scope required: WRITE
The footer comment to be created
string
string
string
string
string
oneOf [CommentBodyWrite, CommentNestedBodyWrite]
Returned if the footer comment is created.
string
allOf [FooterCommentModel, object]
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"blogPostId": "<string>",
"pageId": "<string>",
"parentCommentId": "<string>",
"attachmentId": "<string>",
"customContentId": "<string>",
"body": {
"representation": "storage",
"value": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/footer-comments`, {
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
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
{
"id": "<string>",
"status": "current",
"title": "<string>",
"blogPostId": "<string>",
"pageId": "<string>",
"attachmentId": "<string>",
"customContentId": "<string>",
"parentCommentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"properties": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {}
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"operations": {
"results": [
{
"operation": "<string>",
"targetType": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"likes": {
"results": [
{
"accountId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"versions": {
"results": [
{
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"body": {
"storage": {},
"atlas_doc_format": {},
"view": {}
},
"_links": {
"base": "<string>"
}
}Retrieves a footer comment by id
Permissions required: Permission to view the content of the container and its corresponding space.
read:comment:confluenceConnect app scope required: READ
integer
RequiredPrimaryBodyRepresentationSingle
integer
boolean
boolean
boolean
boolean
boolean
Returned if the footer comment is successfully retrieved.
allOf [FooterCommentModel, object]
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/footer-comments/{comment-id}`, {
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
{
"id": "<string>",
"status": "current",
"title": "<string>",
"blogPostId": "<string>",
"pageId": "<string>",
"attachmentId": "<string>",
"customContentId": "<string>",
"parentCommentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"properties": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {}
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"operations": {
"results": [
{
"operation": "<string>",
"targetType": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"likes": {
"results": [
{
"accountId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"versions": {
"results": [
{
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"body": {
"storage": {},
"atlas_doc_format": {},
"view": {}
},
"_links": {
"base": "<string>"
}
}Update a footer comment. This can be used to update the body text of a comment.
Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.
write:comment:confluenceConnect app scope required: WRITE
integer
RequiredThe footer comment to be created
allOf [UpdateFooterCommentModel, object]
Returned if the footer comment is updated successfully
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"version": {
"number": 78,
"message": "<string>"
},
"body": {
"representation": "storage",
"value": "<string>"
},
"_links": {
"base": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/footer-comments/{comment-id}`, {
method: 'PUT',
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
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
{
"id": "<string>",
"status": "current",
"title": "<string>",
"blogPostId": "<string>",
"pageId": "<string>",
"attachmentId": "<string>",
"customContentId": "<string>",
"parentCommentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"properties": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"operations": {
"results": [
{
"operation": "<string>",
"targetType": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"likes": {
"results": [
{
"accountId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"versions": {
"results": [
{
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"body": {
"storage": {
"representation": "<string>",
"value": "<string>"
},
"atlas_doc_format": {
"representation": "<string>",
"value": "<string>"
},
"view": {
"representation": "<string>",
"value": "<string>"
}
},
"_links": {
"webui": "<string>"
}
}Deletes a footer comment. This is a permanent deletion and cannot be reverted.
Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to delete comments in the space.
delete:comment:confluenceConnect app scope required: DELETE
integer
RequiredReturned if the footer comment is deleted.
1
2
3
4
5
6
7
8
9
10
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/footer-comments/{comment-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returns the children footer comments of specific comment. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the page and its corresponding space.
read:comment:confluenceConnect app scope required: READ
integer
RequiredPrimaryBodyRepresentation
CommentSortOrder
string
integer
Returned if the requested footer comments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/footer-comments/{id}/children`, {
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
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"parentCommentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {}
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns all inline comments. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the page and its corresponding space.
read:comment:confluenceConnect app scope required: READ
PrimaryBodyRepresentation
CommentSortOrder
string
integer
Returned if the requested inline comments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/inline-comments`, {
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"blogPostId": "<string>",
"pageId": "<string>",
"parentCommentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {},
"view": {}
},
"resolutionLastModifierId": "<string>",
"resolutionLastModifiedAt": "<string>",
"resolutionStatus": "open",
"properties": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {}
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
},
"inlineMarkerRef": "<string>",
"inlineOriginalSelection": "<string>",
"inline-marker-ref": "<string>",
"inline-original-selection": "<string>"
},
"operations": {
"results": [
{
"operation": "<string>",
"targetType": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"likes": {
"results": [
{
"accountId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"versions": {
"results": [
{
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Create an inline comment. This can be at the top level (specifying pageId or blogPostId in the request body) or as a reply (specifying parentCommentId in the request body). Note the inlineCommentProperties object in the request body is used to select the text the inline comment should be tied to. This is what determines the text highlighting when viewing a page in Confluence.
Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.
write:comment:confluenceConnect app scope required: WRITE
The inline comment to be created
string
string
string
oneOf [CommentBodyWrite, CommentNestedBodyWrite]
object
Returned if the inline comment is created.
string
allOf [InlineCommentModel, object]
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"blogPostId": "<string>",
"pageId": "<string>",
"parentCommentId": "<string>",
"body": {
"representation": "storage",
"value": "<string>"
},
"inlineCommentProperties": {
"textSelection": "<string>",
"textSelectionMatchCount": 113,
"textSelectionMatchIndex": 238
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/inline-comments`, {
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
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
{
"id": "<string>",
"status": "current",
"title": "<string>",
"blogPostId": "<string>",
"pageId": "<string>",
"parentCommentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {},
"view": {}
},
"resolutionLastModifierId": "<string>",
"resolutionLastModifiedAt": "<string>",
"resolutionStatus": "open",
"properties": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {}
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
},
"inlineMarkerRef": "<string>",
"inlineOriginalSelection": "<string>",
"inline-marker-ref": "<string>",
"inline-original-selection": "<string>"
},
"operations": {
"results": [
{
"operation": "<string>",
"targetType": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"likes": {
"results": [
{
"accountId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"versions": {
"results": [
{
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"_links": {
"base": "<string>"
}
}Retrieves an inline comment by id
Permissions required: Permission to view the content of the page or blogpost and its corresponding space.
read:comment:confluenceConnect app scope required: READ
integer
RequiredPrimaryBodyRepresentationSingle
integer
boolean
boolean
boolean
boolean
boolean
Returned if the inline comment is successfully retrieved.
allOf [InlineCommentModel, object]
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/inline-comments/{comment-id}`, {
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
{
"id": "<string>",
"status": "current",
"title": "<string>",
"blogPostId": "<string>",
"pageId": "<string>",
"parentCommentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {},
"view": {}
},
"resolutionLastModifierId": "<string>",
"resolutionLastModifiedAt": "<string>",
"resolutionStatus": "open",
"properties": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {}
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
},
"inlineMarkerRef": "<string>",
"inlineOriginalSelection": "<string>",
"inline-marker-ref": "<string>",
"inline-original-selection": "<string>"
},
"operations": {
"results": [
{
"operation": "<string>",
"targetType": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"likes": {
"results": [
{
"accountId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"versions": {
"results": [
{
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"_links": {
"base": "<string>"
}
}Update an inline comment. This can be used to update the body text of a comment and/or to resolve the comment
Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to create comments in the space.
write:comment:confluenceConnect app scope required: WRITE
integer
RequiredThe inline comment to be updated
object
oneOf [CommentBodyWrite, CommentNestedBodyWrite]
boolean
Returned if the inline comment is updated successfully.
allOf [InlineCommentModel, object]
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"version": {
"number": 78,
"message": "<string>"
},
"body": {
"representation": "storage",
"value": "<string>"
},
"resolved": true
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/inline-comments/{comment-id}`, {
method: 'PUT',
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
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
{
"id": "<string>",
"status": "current",
"title": "<string>",
"blogPostId": "<string>",
"pageId": "<string>",
"parentCommentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {},
"view": {}
},
"resolutionLastModifierId": "<string>",
"resolutionLastModifiedAt": "<string>",
"resolutionStatus": "open",
"properties": {
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {}
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
},
"inlineMarkerRef": "<string>",
"inlineOriginalSelection": "<string>",
"inline-marker-ref": "<string>",
"inline-original-selection": "<string>"
},
"operations": {
"results": [
{
"operation": "<string>",
"targetType": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"likes": {
"results": [
{
"accountId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"versions": {
"results": [
{
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
],
"meta": {
"hasMore": true,
"cursor": "<string>"
},
"_links": {
"self": "<string>"
}
},
"_links": {
"base": "<string>"
}
}Deletes an inline comment. This is a permanent deletion and cannot be reverted.
Permissions required: Permission to view the content of the page or blogpost and its corresponding space. Permission to delete comments in the space.
delete:comment:confluenceConnect app scope required: DELETE
integer
RequiredReturned if the inline comment is deleted.
1
2
3
4
5
6
7
8
9
10
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/inline-comments/{comment-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returns the children inline comments of specific comment. The number of results is limited by the limit parameter and additional results (if available)
will be available through the next URL present in the Link response header.
Permissions required: Permission to view the content of the page and its corresponding space.
read:comment:confluenceConnect app scope required: READ
integer
RequiredPrimaryBodyRepresentation
CommentSortOrder
string
integer
Returned if the requested footer comments are returned.
string
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/inline-comments/{id}/children`, {
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
{
"results": [
{
"id": "<string>",
"status": "current",
"title": "<string>",
"parentCommentId": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
},
"body": {
"storage": {},
"atlas_doc_format": {}
},
"resolutionStatus": "open",
"properties": {
"inlineMarkerRef": "<string>",
"inlineOriginalSelection": "<string>",
"inline-marker-ref": "<string>",
"inline-original-selection": "<string>"
},
"_links": {
"webui": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Rate this page: