AgileApps Support Wiki Pre Release

Difference between revisions of "REST API:document Resource"

From AgileApps Support Wiki
imported>Aeric
m (Text replace - '<tt><nowiki>https://{domain}/networking' to '<tt>{{platformURL}}')
imported>Aeric
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
Access stored [[Documents]] using the [[REST API]].
Access stored documents using the [[REST API]].


:''Learn more:'' REST API [[REST API#Conventions and Considerations|Conventions and Considerations]].
:''Learn more:'' REST API [[REST API#Conventions and Considerations|Conventions and Considerations]].
Line 8: Line 8:
;Method:GET
;Method:GET
   
   
;URI:<tt>{{platformURL}}/rest/document/{documentId}</nowiki></tt>
;URI:<tt>{{platformURL}}/rest/document/{documentId}</tt>


;Response:
;Response:
:* If the URL references an image, or some other file type the browser knows how to handle, it is displayed.
:* Document content, as multi-part data.
:* If it is a document, the browser initiates a download.
<noinclude>
<noinclude>


[[Category:REST API|document Resource]]
[[Category:REST API|document Resource]]
</noinclude>
</noinclude>

Latest revision as of 20:56, 25 June 2013

Access stored documents using the REST API.

Learn more: REST API Conventions and Considerations.

Get a Document

Access a stored document.

Method
GET
URI
https://{yourDomain}/networking/rest/document/{documentId}
Response
  • Document content, as multi-part data.