projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 4

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 5

changes.mady.by.user Robert Reiner

Saved on

Key

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

Doctypeaddon-componenthide
NameSection 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
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 section to retrieve its title and body.

The identifier of the requested document is part of the path as well as the name of the requested section.

Section
titlePath Parameter
Section
titleid

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

Section
titlename

The title or identifier of the requested section is mandatory and specified as a path parameter.

Section
titleresource-mode

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

 

Info Box

The resource mode html is read-only. It provided for use cases where the client needs to render the result in a HTML page.

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.

...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH