You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
Updates and renames a document property.
Updates and renames a document property.
If your environment does not support the HTTP PATCH method try to use the patch resource at projectdoc/1/patch/document/{id}/property/{name}
as a workaround.
Properties do not track modification date and ETag. Therefore the returned information refers to the enclosing document.
Path Parameter
All path parameters are required to be specified.
new-version
Flag to control whether a new version should be created. If set to false
, the document is saved without creating a new version. Defaults to true
to create a new version.
The parameter is available since version 1.2.
Representation
The format of the representation to post to the URL may be XML or JSON.
Here is the basic structure in JSON:
{
"name": "",
"value": "",
"controls": "",
"position": ""
}
Only the following position values are allowed:
replace-or-add
- replaces an existing property or - if it does not exist - add it (default)replace
- replaces an existing propertymerge
- merges the information into an existing property
Examples
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.