Versions Compared

Key

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

...

Section
titlePath Parameter

All path parameters are required to be specified.

Section
titlename

The name of the requested property.

Section
titleid

The unique identifier of the requested projectdoc document.

Section
titlenamenew-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.

Section
titlecomment

 The optional comment for the version. If no new version is created, the current comment is overridden.

The parameter is available since version 1.2The name of the requested property.

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": "",
  "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.

...