You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
Provides read access to a projectdoc document section.
Use the property service to access a single section to retrieve its title and body.
The identifier of the requested document is part of the path as well as the name of the requested section.
Path Parameter
id
The unique identifier of the requested projectdoc document is mandatory and specified as a path parameter.
name
The title or identifier of the requested section is mandatory and specified as a path parameter.
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.
Example Responses
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<section document-id="41877608">
<document-url>https://www.smartics.eu/confluence/x/aAB-Ag</document-url>
<title>Summary</title>
<content>
<span>
<img
height="400"
src="https://www.smartics.eu/confluence/download/attachments/41877608/image2016-5-24%2019%3A42%3A54.png?version=1&modificationDate=1464341943000&api=v2" />
</span>
<p>
Use the
<a href="https://marketplace.atlassian.com/plugins/com.atlassian.labs.rest-api-browser/server/overview">REST API Browser</a>
of Confluence to start using the REST API provided by projectdoc.
</p>
<p>
The browser is accessible via
<code>plugins/servlet/restbrowser</code>
. For more information please refer to
<a href="https://developer.atlassian.com/docs/developer-tools/using-the-rest-api-browser">Using the REST API Browser</a>
.
</p>
<p>
<span>
<img
src="https://www.smartics.eu/confluence/download/attachments/41877608/image2016-5-29%2013%3A2%3A41.png?version=1&modificationDate=1464519761188&api=v2" />
</span>
</p>
</content>
</section>
JSON
{
"title": "Summary",
"content": "<?xml version=\"1.0\" encoding=\"UTF-16\"?><content><span><img height=\"400\" src=\"https://www.smartics.eu/confluence/download/attachments/41877608/image2016-5-24%2019%3A42%3A54.png?version=1&modificationDate=1464341943000&api=v2\"/></span><p>Use the <a href=\"https://marketplace.atlassian.com/plugins/com.atlassian.labs.rest-api-browser/server/overview\">REST API Browser</a> of Confluence to start using the REST API provided by projectdoc.</p><p>The browser is accessible via <code>plugins/servlet/restbrowser</code>. For more information please refer to <a href=\"https://developer.atlassian.com/docs/developer-tools/using-the-rest-api-browser\">Using the REST API Browser</a>.</p><p><span><img src=\"https://www.smartics.eu/confluence/download/attachments/41877608/image2016-5-29%2013%3A2%3A41.png?version=1&modificationDate=1464519761188&api=v2\"/></span></p></content>",
"document-id": 41877608,
"document-url": "https://www.smartics.eu/confluence/x/aAB-Ag"
}
