Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionProvides access to projectdoc space information.
 

Doctypeaddon-componenthide
NameSpace
 

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 Service
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.0hide
Path

Display Property Reference
append-text/{key}
property-nameParent
referred-property-namePath
appendtrue


HTTP Method
 
GET
Deprecatedhide
Removedhide
Sort Keyhide
Section
indextrue
show-titlefalse
titleDescription

The service returns a representation of a space, including space properties.

Pass in the key of the space to access space properties provided by this and its delegate spaces.

The result can be requested in different media types.

Media TypeContent TypeExtension
JSONapplication/json.json
XMLapplication/xml.xml
Java
Properties
text/x-java-properties.properties

Specify the content type with the accept HTTP header or add the extension to the request URL.

Section
titlePath Parameter

The following path parameter is required to be specified.

Section
titlekey

The key of the space whose properties are requested.

The following query parameter is optional.

Section
titleproperty-filter

A regular expression to match property names of the space in the result set. Only properties with matching names will be returned as properties of the space.

The parameter is available since version 1.1.

Section
indextrue
titleRelated Components
Display Table
render-modedefinition
where$<Parent>=[Space Resource]

...