Section Service / PATCH

Document Properties Marker

override	false

Short Description Updates and renames a section of a projectdoc document.

Doctype addon-component hide

Name Section Service / PATCH

Short Name PATCH

Parent

Parent Property

property-name	Name

Audience

Name List

render-no-hits-as-blank	true
addon-component	role
property	Audience

Type

Name List

doctype	addon-component-type
render-no-hits-as-blank	true
property	Type

Subject

Name List

doctype	subject
property	Subject

Tags

Tag List

property	Tags

Iteration


value	filled

hide

Since 1.1

Path

 Parent Property
add-link false
property Path
property-name Path

Deprecated hide

Removed hide

Sort Key 00300 hide

Section

index	true
show-title	false
title	Description

Updates and renames a section of a projectdoc document.

Warning Box
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!

If your environment does not support the HTTP PATCH method try to use the patch resource at projectdoc/1/patch/document/{id}/section/{name} as a workaround.

Sections do not track modification date and ETag. Therefore the returned information refers to the enclosing document. ETags are only supported on Confluence platforms version 5.10 and later.

Section

title	Path Parameter

All path parameters are required to be specified.

Section

title	id

The unique identifier of the requested projectdoc document.

Section

title	name

The title or identifier of the requested section.

Section

title	Representation

The format of the representation to post to the URL may be XML or JSON.

Note that the title of the document will be overridden by the title or id specified in the URL as path parameter name.

Warning Box

Section titles do not need to be unique. Although it is not recommended to have sections the the same title, the service does not reject to create one.

The API currently does not provide means to select sections with non-unique names.

Positioning of a document is specified with the position and ref elements of the representation.

Section

title	title

The value of the title is the new title for the section.

If no title is specified, the old title is not changed.

Transclusion

taget-heading-level	*
document	Section Service / POST
ids	content

Section

title	ref

While it is technically possible to specify the ref parameter, it has no function for patching a section. Therefore the result for using this parameter is not specified.

Note Box
This parameter should not be used for the current version of this service.

Section

title	position

The only valid position is replace which is the default.

Note Box
This parameter should not be used for the current version of this service.

Section

title	Subordinate Components

Display Table

doctype	addon-component
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

Section

required-permissions	write-access
title	Notes

Section

title	References

Section

title	Resources

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 2

New Version 3

Key

About

Keep up-to-date!

Powered by