Retrieves all Content Properties tied to a specified attachment.
Permissions required: Permission to view the attachment.
read:attachment:confluenceConnect app scope required: READ
string
Requiredstring
ContentPropertySortOrder
string
integer
Returned if the requested content properties are 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/{attachment-id}/properties`, {
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
{
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Creates a new content property for an attachment.
Permissions required: Permission to update the attachment.
read:attachment:confluence, write:attachment:confluenceConnect app scope required: WRITE
string
RequiredThe content property to be created
string
any
Returned if the content property was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/attachments/{attachment-id}/properties`, {
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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Retrieves a specific Content Property by ID that is attached to a specified attachment.
Permissions required: Permission to view the attachment.
read:attachment:confluenceConnect app scope required: READ
string
Requiredinteger
RequiredReturned if the requested content property is successfully retrieved.
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/{attachment-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Update a content property for attachment by its id.
Permissions required: Permission to edit the attachment.
read:attachment:confluence, write:attachment:confluenceConnect app scope required: WRITE
string
Requiredinteger
RequiredThe content property to be updated.
string
any
object
Returned if the content property was 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>",
"version": {
"number": 84,
"message": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/attachments/{attachment-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Deletes a content property for an attachment by its id.
Permissions required: Permission to attachment the page.
read:attachment:confluence, write:attachment:confluenceConnect app scope required: WRITE
string
Requiredinteger
RequiredReturned if the content property was deleted successfully.
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/attachments/{attachment-id}/properties/{property-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Retrieves all Content Properties tied to a specified blog post.
Permissions required: Permission to view the blog post.
read:page:confluenceConnect app scope required: READ
integer
Requiredstring
ContentPropertySortOrder
string
integer
Returned if the requested content properties are 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/blogposts/{blogpost-id}/properties`, {
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
{
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Creates a new property for a blogpost.
Permissions required: Permission to update the blog post.
read:page:confluence, write:page:confluenceConnect app scope required: WRITE
integer
RequiredThe content property to be created
string
any
Returned if the content property was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/blogposts/{blogpost-id}/properties`, {
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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Retrieves a specific Content Property by ID that is attached to a specified blog post.
Permissions required: Permission to view the blog post.
read:page:confluenceConnect app scope required: READ
integer
Requiredinteger
RequiredReturned if the requested content property is 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/blogposts/{blogpost-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Update a content property for blog post by its id.
Permissions required: Permission to edit the blog post.
read:page:confluence, write:page:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredThe content property to be updated.
string
any
object
Returned if the content property was 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>",
"version": {
"number": 84,
"message": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/blogposts/{blogpost-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Deletes a content property for a blogpost by its id.
Permissions required: Permission to edit the blog post.
read:page:confluence, write:page:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredReturned if the content property was deleted successfully.
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/blogposts/{blogpost-id}/properties/{property-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Retrieves Content Properties tied to a specified custom content.
Permissions required: Permission to view the custom content.
read:custom-content:confluenceConnect app scope required: READ
integer
Requiredstring
ContentPropertySortOrder
string
integer
Returned if the requested content properties are 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/{custom-content-id}/properties`, {
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
{
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Creates a new content property for a piece of custom content.
Permissions required: Permission to update the custom content.
read:custom-content:confluence, write:custom-content:confluenceConnect app scope required: WRITE
integer
RequiredThe content property to be created
string
any
Returned if the content property was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/custom-content/{custom-content-id}/properties`, {
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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Retrieves a specific Content Property by ID that is attached to a specified custom content.
Permissions required: Permission to view the page.
read:custom-content:confluenceConnect app scope required: READ
integer
Requiredinteger
RequiredReturned if the requested content property is successfully retrieved.
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/{custom-content-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Update a content property for a piece of custom content by its id.
Permissions required: Permission to edit the custom content.
read:custom-content:confluence, write:custom-content:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredThe content property to be updated.
string
any
object
Returned if the content property was 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>",
"version": {
"number": 84,
"message": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/custom-content/{custom-content-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Deletes a content property for a piece of custom content by its id.
Permissions required: Permission to edit the custom content.
read:custom-content:confluence, write:custom-content:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredReturned if the content property was deleted successfully.
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/custom-content/{custom-content-id}/properties/{property-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Retrieves Content Properties tied to a specified page.
Permissions required: Permission to view the page.
read:page:confluenceConnect app scope required: READ
integer
Requiredstring
ContentPropertySortOrder
string
integer
Returned if the requested content properties are 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/pages/{page-id}/properties`, {
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
{
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Creates a new content property for a page.
Permissions required: Permission to update the page.
read:page:confluence, write:page:confluenceConnect app scope required: WRITE
integer
RequiredThe content property to be created
string
any
Returned if the content property was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/pages/{page-id}/properties`, {
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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Retrieves a specific Content Property by ID that is attached to a specified page.
Permissions required: Permission to view the page.
read:page:confluenceConnect app scope required: READ
integer
Requiredinteger
RequiredReturned if the requested content property is successfully retrieved.
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/{page-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Update a content property for a page by its id.
Permissions required: Permission to edit the page.
read:page:confluence, write:page:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredThe content property to be updated.
string
any
object
Returned if the content property was 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>",
"version": {
"number": 84,
"message": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/pages/{page-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Deletes a content property for a page by its id.
Permissions required: Permission to edit the page.
read:page:confluence, write:page:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredReturned if the content property was deleted successfully.
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/pages/{page-id}/properties/{property-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Retrieves Content Properties tied to a specified whiteboard.
Permissions required: Permission to view the whiteboard.
read:whiteboard:confluenceConnect app scope required: READ
integer
Requiredstring
ContentPropertySortOrder
string
integer
Returned if the requested content properties are 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/whiteboards/{id}/properties`, {
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
{
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Creates a new content property for a whiteboard.
Permissions required: Permission to update the whiteboard.
read:whiteboard:confluence, write:whiteboard:confluenceConnect app scope required: WRITE
integer
RequiredThe content property to be created
string
any
Returned if the content property was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/whiteboards/{id}/properties`, {
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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Retrieves a specific Content Property by ID that is attached to a specified whiteboard.
Permissions required: Permission to view the whiteboard.
read:whiteboard:confluenceConnect app scope required: READ
integer
Requiredinteger
RequiredReturned if the requested content property is successfully retrieved.
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/whiteboards/{whiteboard-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Update a content property for a whiteboard by its id.
Permissions required: Permission to edit the whiteboard.
read:whiteboard:confluence, write:whiteboard:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredThe content property to be updated.
string
any
object
Returned if the content property was 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>",
"version": {
"number": 84,
"message": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/whiteboards/{whiteboard-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Deletes a content property for a whiteboard by its id.
Permissions required: Permission to edit the whiteboard.
read:whiteboard:confluence, write:whiteboard:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredReturned if the content property was deleted successfully.
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/whiteboards/{whiteboard-id}/properties/{property-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Retrieves Content Properties tied to a specified database.
Permissions required: Permission to view the database.
read:database:confluenceConnect app scope required: READ
integer
Requiredstring
ContentPropertySortOrder
string
integer
Returned if the requested content properties are 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/databases/{id}/properties`, {
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
{
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Creates a new content property for a database.
Permissions required: Permission to update the database.
read:database:confluence, write:database:confluenceConnect app scope required: WRITE
integer
RequiredThe content property to be created
string
any
Returned if the content property was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/databases/{id}/properties`, {
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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Retrieves a specific Content Property by ID that is attached to a specified database.
Permissions required: Permission to view the database.
read:database:confluenceConnect app scope required: READ
integer
Requiredinteger
RequiredReturned if the requested content property is successfully retrieved.
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/databases/{database-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Update a content property for a database by its id.
Permissions required: Permission to edit the database.
read:database:confluence, write:database:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredThe content property to be updated.
string
any
object
Returned if the content property was 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>",
"version": {
"number": 84,
"message": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/databases/{database-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Deletes a content property for a database by its id.
Permissions required: Permission to edit the database.
read:database:confluence, write:database:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredReturned if the content property was deleted successfully.
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/databases/{database-id}/properties/{property-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Retrieves Content Properties tied to a specified Smart Link in the content tree.
Permissions required: Permission to view the Smart Link in the content tree.
read:embed:confluenceConnect app scope required: READ
integer
Requiredstring
ContentPropertySortOrder
string
integer
Returned if the requested content properties are 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/embeds/{id}/properties`, {
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
{
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Creates a new content property for a Smart Link in the content tree.
Permissions required: Permission to update the Smart Link in the content tree.
read:embed:confluence, write:embed:confluenceConnect app scope required: WRITE
integer
RequiredThe content property to be created
string
any
Returned if the content property was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/embeds/{id}/properties`, {
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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Retrieves a specific Content Property by ID that is attached to a specified Smart Link in the content tree.
Permissions required: Permission to view the Smart Link in the content tree.
read:embed:confluenceConnect app scope required: READ
integer
Requiredinteger
RequiredReturned if the requested content property is successfully retrieved.
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/embeds/{embed-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Update a content property for a Smart Link in the content tree by its id.
Permissions required: Permission to edit the Smart Link in the content tree.
read:embed:confluence, write:embed:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredThe content property to be updated.
string
any
object
Returned if the content property was 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>",
"version": {
"number": 84,
"message": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/embeds/{embed-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Deletes a content property for a Smart Link in the content tree by its id.
Permissions required: Permission to edit the Smart Link in the content tree.
read:embed:confluence, write:embed:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredReturned if the content property was deleted successfully.
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/embeds/{embed-id}/properties/{property-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Retrieves Content Properties tied to a specified folder.
Permissions required: Permission to view the folder.
read:folder:confluenceConnect app scope required: READ
integer
Requiredstring
ContentPropertySortOrder
string
integer
Returned if the requested content properties are 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/folders/{id}/properties`, {
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
{
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Creates a new content property for a folder.
Permissions required: Permission to update the folder.
read:folder:confluence, write:folder:confluenceConnect app scope required: WRITE
integer
RequiredThe content property to be created
string
any
Returned if the content property was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/folders/{id}/properties`, {
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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Retrieves a specific Content Property by ID that is attached to a specified folder.
Permissions required: Permission to view the folder.
read:folder:confluenceConnect app scope required: READ
integer
Requiredinteger
RequiredReturned if the requested content property is successfully retrieved.
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/folders/{folder-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Update a content property for a folder by its id.
Permissions required: Permission to edit the folder.
read:folder:confluence, write:folder:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredThe content property to be updated.
string
any
object
Returned if the content property was 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>",
"version": {
"number": 84,
"message": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/folders/{folder-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Deletes a content property for a folder by its id.
Permissions required: Permission to edit the folder.
read:folder:confluence, write:folder:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredReturned if the content property was deleted successfully.
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/folders/{folder-id}/properties/{property-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Retrieves Content Properties attached to a specified comment.
Permissions required: Permission to view the comment.
read:comment:confluenceConnect app scope required: READ
integer
Requiredstring
ContentPropertySortOrder
string
integer
Returned if the requested content properties are 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/comments/{comment-id}/properties`, {
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
{
"results": [
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Creates a new content property for a comment.
Permissions required: Permission to update the comment.
read:comment:confluence, write:comment:confluenceConnect app scope required: WRITE
integer
RequiredThe content property to be created
string
any
Returned if the content property was created successfully.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>"
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/comments/{comment-id}/properties`, {
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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Retrieves a specific Content Property by ID that is attached to a specified comment.
Permissions required: Permission to view the comment.
read:comment:confluenceConnect app scope required: READ
integer
Requiredinteger
RequiredReturned if the requested content property is successfully retrieved.
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/comments/{comment-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Update a content property for a comment by its id.
Permissions required: Permission to edit the comment.
read:comment:confluence, write:comment:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredThe content property to be updated.
string
any
object
Returned if the content property was 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>",
"version": {
"number": 84,
"message": "<string>"
}
}`;
const response = await api.asUser().requestConfluence(route`/wiki/api/v2/comments/{comment-id}/properties/{property-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
{
"id": "<string>",
"key": "<string>",
"version": {
"createdAt": "<string>",
"message": "<string>",
"number": 19,
"minorEdit": true,
"authorId": "<string>"
}
}Deletes a content property for a comment by its id.
Permissions required: Permission to edit the comment.
read:comment:confluence, write:comment:confluenceConnect app scope required: WRITE
integer
Requiredinteger
RequiredReturned if the content property was deleted successfully.
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/comments/{comment-id}/properties/{property-id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: