Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleRepresentation

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:

  1. replace-or-add - replaces an existing property or - if it does not exist - add it (default)
  2. replace - replaces an existing property
  3. merge - merges the information into an existing property

Since version 3.1 also the following positions are supported:

  1. merge-values - merges the information into an existing property and looks at the property as a list of properties and tries to integrate the given values into the existing list; duplicates are not added
  2. delete-values - merges the information into an existing property and looks at the property as a list of properties and tries to remove values from the list
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.


...