Rate this page:
GET /wiki/rest/api/content/{id}/property
Returns the properties for a piece of content. For more information about content properties, see Confluence entity properties.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Connect app scope required: READ
read:content-details:confluencestring
The ID of the content to be queried for its properties.
Array<string>
The key of the content property.
Array<string>
A multi-value parameter indicating which properties of the content to
expand. By default, the version object is expanded.
content returns the content that the property is stored against.version returns information about the version of the property, such
as the version number, when it was created, etc.formValid values: content, version
integer
The starting index of the returned properties.
0, Minimum: 0, Format: int32integer
The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.
10, Minimum: 0, Format: int321 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.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/property`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the requested properties are returned.
| Content type | Value |
|---|---|
| application/json |
POST /wiki/rest/api/content/{id}/property
Creates a property for an existing piece of content. For more information about content properties, see Confluence entity properties.
This is the same as Create content property for key except that the key is specified in the request body instead of as a path parameter.
Content properties can also be added when creating a new piece of content
by including them in the metadata.properties of the request.
Permissions required: Permission to update the content.
Connect app scope required: WRITE
read:content.property:confluence, write:content.property:confluencestring
The ID of the content to add the property to.
string
The key of the new property.
255oneOf [Array<string>, boolean, object, string]
The value of the content property. This can be empty or a complex object.
anything
Extra properties of any type may be provided to this object.
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 api, { route } from "@forge/api";
var bodyData = `{
"key": "<string>",
"value": [
"<string>"
]
}`;
const response = await api.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/property`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the content property is created.
| Content type | Value |
|---|---|
| application/json |
GET /wiki/rest/api/content/{id}/property/{key}
Returns a content property for a piece of content. For more information, see Confluence entity properties.
Permissions required: 'View' permission for the space, and permission to view the content if it is a page.
Connect app scope required: READ
read:content-details:confluencestring
The ID of the content to be queried for the property.
string
The key of the content property.
Array<string>
A multi-value parameter indicating which properties of the content to
expand. By default, the version object is expanded.
content returns the content that the property is stored against.version returns information about the version of the property, such
as the version number, when it was created, etc.formValid values: content, version
Array<string>
Filter the results to a set of content based on their status. If set to any,
content with any status is returned. By default it will fetch current and archived statuses ?status=current&status=archived.
All supported statuses
form1 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.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/property/{key}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the content property is returned.
| Content type | Value |
|---|---|
| application/json |
PUT /wiki/rest/api/content/{id}/property/{key}
Updates an existing content property. This method will also create a new property for a piece of content, if the property key does not exist and the property version is 1. For more information about content properties, see Confluence entity properties.
Permissions required: Permission to update the content.
Connect app scope required: WRITE
read:content.property:confluence, write:content.property:confluencestring
The ID of the content that the property belongs to.
string
The key of the property.
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 api, { route } from "@forge/api";
var bodyData = `{
"value": [
"<string>"
],
"version": {
"number": 2154,
"minorEdit": true
}
}`;
const response = await api.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/property/{key}`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the content property is created.
| Content type | Value |
|---|---|
| application/json |
POST /wiki/rest/api/content/{id}/property/{key}
Creates a property for an existing piece of content. For more information about content properties, see Confluence entity properties.
This is the same as Create content property except that the key is specified as a path parameter instead of in the request body.
Content properties can also be added when creating a new piece of content
by including them in the metadata.properties of the request.
Permissions required: Permission to update the content.
Connect app scope required: WRITE
read:content.property:confluence, write:content.property:confluencestring
The ID of the content to add the property to.
string
The key of the content property. Required.
oneOf [Array<string>, boolean, object, string]
The value of the content property. This can be empty or a complex object.
anything
Extra properties of any type may be provided to this object.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"value": [
"<string>"
]
}`;
const response = await api.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/property/{key}`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returned if the content property is created.
| Content type | Value |
|---|---|
| application/json |
DELETE /wiki/rest/api/content/{id}/property/{key}
Deletes a content property. For more information about content properties, see Confluence entity properties.
Permissions required: Permission to update the content.
Connect app scope required: WRITE
write:content.property:confluencestring
The ID of the content that the property belongs to.
string
The key of the property.
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.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/property/{key}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returned if the content property is deleted.
A schema has not been defined for this response code.
Rate this page: