You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

projectdoc Toolbox

Creates a new projectdoc document based on a doctype.

Type
Since
1.1

Creates a new projectdoc document based on a doctype.

Backup your Data!

 

There is no undo!

It is strongly recommended to run commands only on backed-up instances!

Make a backup of your data before starting to work with this API! Consider to run your experiments on a copy of the production data!

Parameters

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

doctype

The name of the doctype.

name

The name of the new projectdoc document.

 

The title of the page is set to the name of the document.

short-description

The short description for the new projectdoc document.

space-key

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

location

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

expand

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.

resource-mode

Controls how properties are rendered. Valid values are html, value, and storage  (default).

This parameter refers to the representation returned on the request.

navigation

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.

  • No labels