projectdoc Toolbox

Supports queries on projectdoc documents, patching projectdoc documents, and creating new documents.

Name: Documents
Parent: Document Resource
Type: REST Service
Extension: Web API Extension
Path: rest/projectdoc/1/document

The documents service allows to run queries to fetch document identifiers and information from projectdoc documents.

Since version 1.1 of the Web API this service also allows to create new documents based on a doctype and to patch projectdoc documents.

Write to Supplier

Since version 1.2 of the projectdoc Web API Extension properties can also be written to the Document Properties Supplier Macro.

Updating existing properties checks for properties defined in any projectdoc macro. New properties, without a reference to an existing property, are written to the Document Properties Marker Macro per default.

HTTP Methods

HTTP Method	Since	Short Description
GET	1.0	Supports queries on projectdoc documents.
POST	1.1	Creates a new projectdoc document based on a document representation.
PATCH	1.1	Adds, removes, and applies changes to properties and sections of a projectdoc document.

Related Components

Document: Provides access to a projectdoc document.
Property: Provides access to a projectdoc document property.
Section: Provides access to a projectdoc document section.

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

HTTP Methods

Related Components

About

Keep up-to-date!

Powered by