Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionProvides access to a projectdoc document property.
 

Doctypeaddon-componenthide
NameProperty Service / GET
 

Short NameGET
 

Parent
Parent Property
property-nameName
 

Audience
Name List
render-no-hits-as-blanktrue
addon-componentrole
propertyAudience
 

Type

Name List
doctypeaddon-component-type
render-no-hits-as-blanktrue
namesREST Method
propertyType

 


Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 

Iteration

Iteration
value

filled

finished

hide
ExtensionWeb API Extension
Since1.0
 

Path
Parent Property
add-linkfalse
propertyPath
property-namePath
 

Deprecatedhide
Removedhide
Sort Key00100hide
Section
indextrue
show-titlefalse
titleDescription

Use the property service to access a single property. The identifier of the requested document is part of the path as well as the name of the requested property.

Section
titlePath Parameter

All path parameters are required to be specified.

Section
titleid

The unique identifier of the requested projectdoc document is mandatory and specified as a path parameter.

Section
titlename

The name of the requested property is mandatory and specified as a path parameter.

Section
titleresource-mode

Controls how properties are rendered. Valid values are html, value, and storage (default). This parameter refers to the representation returned on the request.

Info Box

The resource modes html and value are read-only. These modes are provided for use cases where the client needs to render the result in a HTML page or as text.

If the user wants to manipulate the content, the storage format is required to be fetched, modified, and pushed back to the server.

 The parameter is available since version 1.1.

...