The format of the representation to post to the URL may be XML or JSON. Here is the basic structure in JSON: | Code Block |
|---|
{
"name": "",
"value": "",
"controls": "",
"position": ""
} |
Only the following position values are allowed: | Position | Since | Description |
|---|
replace-or-add | 1.0 | Replaces an existing property or - if it does not exist - add it (default). | replace | 1.0 | Replaces an existing property. | merge | 1.0 | Merges the information into an existing property. Property value and property controls of the existing property are only overridden if the new value is not empty. | merge-values | 3.1 | Merges the information into an existing property. Looking at the property as a list of values the service integrates the given values into the existing list. Duplicates are not added. | delete-values | 3.1 | Merges the information into an existing property. Looking at the property as a list of values the service removes all values provided in the given list. | replace-values | 46.0 | Merges the information into an existing property. Removes all values and replaces them with the new ones. In contrast to replace this position will keep the structure of the value untouched. So the values are replaced inside a macro. The macro is not replaced by the values. |
For the list postion values (position ends with -values) values the following macros are supported: - Name List Macro (Names parameter)
- Tag List Macro (Names parameter)
- Name Body List Macro (body)
- Tag Body List Macro (body)
- Parent Property Macro (Parent Doctype parameter)
| Caution Box |
|---|
If you use replace and you do not specify a value for controls, the property controls will be overridden with blank. Typically you would use merge to only set the value. |
| 
