Property Service / POST

...

Section

title	Path Parameter

All path parameters are required to be specified.

Section

title	name

The name of the requested property.

projectdoc-box-version

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.

projectdoc-section

title	id

The unique identifier of the requested projectdoc document.

Section

title	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.

Section

title	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.

...

Section

title	Representation

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:

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

projectdoc-box-version

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 name path parameter refers to the reference property name (ref). If ref is specified it overrides the path parameter.

projectdoc-section

title	Examples

The following examples show usage scenarios for this service.

Version Box

since	10.0

The following examples apply since version 10.0. For previous version please refer to the version box below.

Example Box

title	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.

Code Block
{ "name": "New Property's Name", "value": "The value of the new property.", "position": "before" }

Example Box

title	Insert a Property with Controls

Besides setting the value, the controls may also be set.

Code Block
{ "name": "New Property's Name", "value": "The value of the new property.", "controls": "hide", "position": "before" }

Version Box

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.

Example Box

title	Insert a Property Value

Shows how a property is added in front of an existing property (Sort Key in this case).

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

Example Box

title	Insert a Property with Controls

Besides setting the value, the controls may also be set.

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

Section

title	Subordinate Components

Display Table

doctype	addon-component
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 6

New Version 7

Key

About

Keep up-to-date!

Powered by