Provides access to a projectdoc document.
- Parent
- Type
- Extension
- Since
- 1.0
- Path
rest/projectdoc/1/document/{id}
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 Type | Content Type | Extension |
|---|---|---|
| JSON | application/json | .json |
| XML | application/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
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.
navigation
Control the response information according to links to properties and section. Per default no links are rendered. Use none to suppress all links, all to render all links. Use property and section to identify the links you want to have rendered. Use the comma as separator.
The amount of links may provide much header data. So much so that it exceeds the standard 8k Bytes that is allowed by standard installations.
The parameter is available since version 1.3.1.