Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Document clean process
Document Properties Marker
overridefalse
Short DescriptionCreates a new projectdoc document based on a doctypedocument representation. 
Doctypeaddon-componenthide
NameDocuments Service / POSThide
Short NamePOSThide
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.1 
Path
Parent Property
add-linkfalse
propertyPath
property-namePath
 
Deprecatedhide
Removedhide
Sort Key00200hide
Section
indextrue
show-titlefalse
titleDescription

Creates a new projectdoc document based on a doctypedocument representation.

Transclusion
documentPlease Backup your Data first!
idsSummary

Section
titleParametersRepresentation

The following parameters allow to control the creation of a projectdoc documentrepresentation is posted to the REST service and requires the following form.

projectdoc-box-section
titledoctype
caution

Since version 4.0 this service requires to post a document with properties and optional sections. Properties must contain a doctype, a name (will be uses as the title of the document), and a short descriptionThe name of the doctype.

The name of the new projectdoc document.

The title of the page is set to the name of the
projectdoc-section
titlename
Note Box
transclusion-macro
documentDocuments Service / PATCH
idsdocument-representation

Section
titleParameters

The following parameters allow to control the creation of a projectdoc document.

The short description for the new projectdoc document.
projectdoc-content-sectionmarker
titleidshort-description
parameter-list
Section
titlespace-key

The key to the space where the new document will be stored.

Section
titlelocation

The location within the space that defines the parent page.

Either provide

  • the title of the page (not the name of the document),
  • the page identifier surrounded by curly braces (e.g.{123456}, the value of  space-key  is not taken into account in this case), or
  • the keyword {homepage} (to store the document to the doctype's homepage).

If the page title starts with a curly brace ({) and ends with one (}), you need to escape it with a backslash ( \) as in \{My Page Title}.

Section
titleexpand

Define if properties and/or sections should be expanded. Select from property and section. If both a specified, separate the two values by a single comma (no spaces).

This parameter refers to the representation returned on the request.

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.

Section
titlenavigation

Control the response information according to links to properties and section. Per default no links are rendered. Use none to suppress all links, all to render all links. Use property and section to identify the links you want to have rendered. Use the comma as separator.

The amount of links may provide much header data. So much so that it exceeds the standard 8k Bytes that is allowed by standard installations.

The parameter is available since version 1.3.1.

Section
titleSubordinate Components
Display Table
doctypeaddon-component
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...