Document Service / GET

Document Properties Marker

override	false

Short Description Provides access to a projectdoc document.

Doctype addon-component hide

Name Document Service / GET hide

Short Name GET hide

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

Path

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

Deprecated hide

Removed hide

Sort Key 00100 hide

Section

index	true
show-title	false
title	Description

Use the document service to access a single document by its document identifier. The identifier ({id}) of the requested document is part of the path and is identical with the Confluence page identifier.

The result can be requested in different media types.

Media Type	Content Type	Extension
JSON	`application/json`	`.json`
XML	`application/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

title	Parameters

Section

title	id

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

Section

title	expand

Define if properties and/or sections should be expanded. Select from property and section. This parameter refers to the representation returned on the request.

If properties and sections should be expanded, do not use blanks in this value (property,section).

Note Box
This parameter is supported since Web API version 1.1. Prior to this version the value of this parameter is ignored.

Section

title	property-filter

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

The parameter is available since version 1.1.

Section

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

The parameter is available since version 1.1.

Section

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

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

...

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 3

New Version 4

Key

About

Keep up-to-date!

Powered by