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

Compare with Current View Page History

Version 1 Next »

projectdoc Toolbox

Provides access to a projectdoc document.

Since
1.0

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 TypeContent TypeExtension
JSONapplication/json.json
XMLapplication/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.

Parameters

id

The unique identifier of the projectdoc document.

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

 

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

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.

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.

  • No labels