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.
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 Services Resource
- Provides services for projectdoc documents via a web API.
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
ETags are only supported for Confluence since version 5.10.x and version 1.1 of the web api.