Services

The list of REST services provided by the Web API Extension.

Path	HTTP Methods	Short Description
`rest/projectdoc/1/document`	GET, POST, and PATCH	Supports queries on projectdoc documents, patching projectdoc documents, and creating new documents.
`rest/projectdoc/1/document/{id}`	GET, PATCH, and DELETE	Provides access to a projectdoc document.
`rest/projectdoc/1/document/{id}/property/{name}`	GET, POST, DELETE, and PATCH	Provides access to a projectdoc document property.
`rest/projectdoc/1/document/{id}/section/{name}`	GET, POST, PATCH, and DELETE	Provides access to a projectdoc document section.
`rest/projectdoc/1/service/cleanup`	POST	Runs a projectdoc cleanup on the referenced document.
`rest/projectdoc/1/space/{key}`	GET	Provides access to projectdoc space information.
`rest/projectdoc/1/space/{key}/property/{name}`	GET	Provides access to a single space property.

HTTP Methods

The list of REST services listed by their HTTP methods provided by the Web API Extension.

Path	HTTP Method	Short Description
`rest/projectdoc/1/document`	GET	Supports queries on projectdoc documents.
`rest/projectdoc/1/document`	PATCH	Adds, removes, and applies changes to properties and sections of a projectdoc document.
`rest/projectdoc/1/document`	POST	Creates a new projectdoc document based on a document representation.
`rest/projectdoc/1/document/{id}`	DELETE	Deletes the referenced projectdoc document.
`rest/projectdoc/1/document/{id}`	GET	Provides access to a projectdoc document.
`rest/projectdoc/1/document/{id}`	PATCH	Updates projectdoc documents.
`rest/projectdoc/1/document/{id}/property/{name}`	DELETE	Deletes a document property.
`rest/projectdoc/1/document/{id}/property/{name}`	GET	Provides access to a projectdoc document property.
`rest/projectdoc/1/document/{id}/property/{name}`	PATCH	Updates and renames a document property.
`rest/projectdoc/1/document/{id}/property/{name}`	POST	Adds a property to a document.
`rest/projectdoc/1/document/{id}/section/{name}`	DELETE	Deletes a section from a projectdoc document.
`rest/projectdoc/1/document/{id}/section/{name}`	GET	Provides read access to a projectdoc document section.
`rest/projectdoc/1/document/{id}/section/{name}`	PATCH	Updates and renames a section of a projectdoc document.
`rest/projectdoc/1/document/{id}/section/{name}`	POST	Adds a section to a projectdoc document.
`rest/projectdoc/1/i18n/map`	GET	Generate a resource bundle with translations for a given set of keys.
`rest/projectdoc/1/service/csv-document`	POST	Runs an update on a single projectdoc document based on an uploaded file. The information will patch the existing document or create a new one if the document does not exist.
`rest/projectdoc/1/service/csv-table`	POST	Runs a bulk update based on a uploaded file. The information will patch existing files and create new ones.
`rest/projectdoc/1/service/document-create-facade`	POST	Creates a new projectdoc document based on a doctype, name, and short description.
`rest/projectdoc/1/service/document-create-hierarchy`	POST	Creates a hierarchy of documents based on the posted document.

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

Services

HTTP Methods

About

Keep up-to-date!

Powered by