Date: Thu, 28 Mar 2024 13:58:40 +0100 (CET) Message-ID: <100801878.17427.1711630720026@09e9d69a2016> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_17426_165037690.1711630720025" ------=_Part_17426_165037690.1711630720025 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Adds a property to a docu= ment.
Adds a property to a document.
Backup your Data!
There is no undo!
It is strongly recommend= ed to run commands only on backed-up instances!
Make a backup of your data before starting to work with this API! Consid= er to run your experiments on a copy of the production data!
Properties do not track modification date and ETag. Therefore the returned information refers to the= enclosing document.
All path parameters are required to be specified.
The name of the requested property.
The unique identifier of the requested projectdoc document.
Flag to control whet=
her a new version should be created. If set to false
, the docu=
ment is saved without creating a new version. Defaults to true
=
to create a new version.
The parameter is available since v=
ersion 1.2.
The optional comment= for the version. If no new version is created, the current comment is over= ridden.
The parameter is available since v=
ersion 1.2.
The format of the representation to post to the URL may be XML or JSON.<= /p>
Here is the basic structure in JSON:
{ "name": "", "value": "", "controls": "", "position": "", "ref": "" }
Only the following position values are allowed:
before
- insert the new property before the referenced (after
- insert the new property after the referenced (ref
) propertyfirst
- insert the new property at the first positionlast
- insert the new property at the last positionThe ref
parameter allows to specify an existing document pr=
operty. This is relevant if new properties are added relative to an existin=
g property. If the property specified by ref
cannot be found, =
404
is returned.
The following examples show usage scenarios for this service.
For all examples keep in mind: The name of the property, as well as the = document it is part of, is specified in the URL.
Insert a Property Value
Shows how a property is added in front of an existing property (So=
rt Key
in this case).
{ "value": "The value of the new property.", "position": "before", "ref": "Sort Key" }
Insert a Property with Controls
Besides setting the value, the controls may also be set.
{ "value": "The value of the new property.", "controls": "hide", "position": "before", "ref": "Sort Key" }