Path Parameter

All path parameters are required to be specified.

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:

1. before - insert the new property before the referenced (ref) property
2. after- insert the new property after the referenced (ref) property
3. first - insert the new property at the first position
4. last - 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.

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.

{
  "value": "The value of the new property.",
  "position": "before",
  "ref": "Sort Key"
}

{
  "value": "The value of the new property.",
  "controls": "hide",
  "position": "before",
  "ref": "Sort Key"
}