- Created by Robert Reiner, last modified on 05. Jul 2021
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 9 Current »
projectdoc Toolbox
Adds a property to a document.
- Short Name
- POST
- Type
- Extension
- Since
- 1.1
Adds a property to a document.
Backup your Data!
There is no undo!
It is strongly recommended to run commands only on backed-up instances!
Make a backup of your data before starting to work with this API! Consider 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.
Path Parameter
All path parameters are required to be specified.
name
The name of the requested property.
Since 10.0
Since version 10.0 this parameter refers to the current or reference property name.
Prior to that version the property referred to the new property name.
id
The unique identifier of the requested projectdoc document.
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.
comment
The optional comment for the version. If no new version is created, the current comment is overridden.
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": "",
"ref": ""
}
Only the following position values are allowed:
before- insert the new property before the referenced (ref) propertyafter- insert the new property after the referenced (ref) propertyfirst- insert the new property at the first positionlast- insert the new property at the last position
The ref parameter allows to specify an existing document property. This is relevant if new properties are added relative to an existing property. If the property specified by ref cannot be found, 404 is returned.
Since 10.0
Since version 10.0 the name path parameter is used to reference the existing resource on the server. This may either be the current name of the resource or – in case of adding a new property – the name of the property relative to which the new property is added.
Therefore:
- The name property in the JSON file refers to the new property name. If the name is not altered, the name may be omitted.
- The
namepath parameter refers to the reference property name (ref). Ifrefis specified it overrides the path parameter.
Examples
The following examples show usage scenarios for this service.
Since 10.0
The following examples apply since version 10.0. For previous version please refer to the version box below.
Insert a Property Value
Shows how a property is added in front of an existing property.
The reference property is specified with the URL parameter Sort Key.
{
"name": "New Property's Name",
"value": "The value of the new property.",
"position": "before"
}
Insert a Property with Controls
Besides setting the value, the controls may also be set.
{
"name": "New Property's Name",
"value": "The value of the new property.",
"controls": "hide",
"position": "before"
}
Until 9.x
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.
Therefore the ref property must be set.
Insert a Property Value
Shows how a property is added in front of an existing property (Sort 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"
}
- No labels
