projectdoc Toolbox

Add-on to extend projectdoc with an API to access on the web.

projectdoc Toolbox


projectdoc documents provide properties via the Document Properties Marker Macro and (optionally) Document Properties Supplier Macro.

These properties may define and document real configuration data or metadata information. Therefore there are use cases where teams want to access these properties from other information systems.

This extension provides a REST web API to query space properties and document properties.


Representations are rendered in JSON and XML. Queries, supported for projectdoc documents, may also return representations in CSV. Properties for space and document instances are also available in the Java Properties format.

REST Resources

The extension provides one resource to request representations for spaces and one for documents.

This is the list of REST resources provided by the projectdoc Web-API Extension:

Document Resource
Provides access to projectdoc documents via a web API.
Document Services Resource
Provides services for projectdoc documents via a web API.
I18N Resource
Services to access localized information via the I18N services.
Space Resource
Provides access to projectdoc space properties.

REST Services

The extension provides the following services on document and space resources.

Path HTTP Method Short Description
Adds, removes, and applies changes to properties and sections of a projectdoc document.
Creates a new projectdoc document based on a document representation.
Creates a hierarchy of documents based on the posted document.

Accessing the API

There are different approaches to access the web API provided by the projectdoc Toolbox via this extension.

REST API Browser

Use the REST API Browser of Confluence to start using the REST API provided by projectdoc.

The browser is accessible via plugins/servlet/restbrowser. For more information please refer to Using the REST API Browser.


The Bookmarklets Extension allows to integrate calls to the web API into the user's browser.

With bookmarklets services are brought to the fingertips of the users. The organization of bookmarks can be personalized very easily.

The Bookmarklets Extension provides a number of bookmarklets to get started. With the Bookmarklet Editor these bookmarklets can be loaded and installed. The editor also allows to create new bookmarklets.

An overview over projectdoc bookmarklets is available on Bookmarklets List Macro.


There are a lot of tools and programming libraries to use REST APIs.

cURL is one example to integrate information from projectdoc documents into remote information systems.


Logging is controlled by the package identifier

Version Tags

ETags are only supported for Confluence since version 5.10.x and version 1.1 of the web api.

Subordinate Topics

List of Services
Lists all services provided by the Web API Extension.


Related information on using REST APIs (with cURL) to integrate with remote information systems.

REST Login to Confluence with cURL
To access Confluence via its REST API with cURL you typically need to authenticate. Learn how to login with cURL and avoid some common security pitfalls.
Accessing projectdoc Properties with cURL
Learn how to access projectdoc properties via REST API with cURL.
projectdoc Bulk Changes to Documents
The Web API Extension for the projectdoc Toolbox can be employed to make bulk changes to documents. Since there is no safety net, these actions need to be take with care. This tip introduces a way to conduct this task.
Confluence as the Information Hub
Tools from the projectdoc Toolbox to import from and export to other information systems.
Import Resource
Provides services to import information from Maven artifacts into Confluence.

Related products to use with the projectdoc Toobox.

Bookmarklets Extension
Add-on to extend the Toolkit with Bookmarklets. Allows to execute tools via the browser.
History Manager for Confluence
Manage history information in Confluence!
Bookmarklet Editor
The bookmarklets editor is a simple page that allows teams to create their bookmarklets more easily. It also provides access to some standard bookmarklets provided for the projectdoc Toolbox.