Rest Documents¶
Listing documents¶
Returns a paginated list of documents for the project with the given id or identifier.
Parameters:
offset: skip this number of documents in the response (optional)limit: number of documents per page (optional)
Examples:
GET /projects/foo/documents.xml GET /projects/foo/documents.json GET /projects/foo/documents.xml?offset=0&limit=100
Showing a document¶
Parameters:
include: fetch associated data (optional). Possible value:attachments
Examples:
Creating a document¶
Parameters:
document: a hash of the document attributes:titledescriptioncategory_idcustom_fields
Attachments can be added when creating a document, see Attaching files.
Returns 201 Created on success.
Updating a document¶
Parameters:
Same as document creation.
Attachments can be added when updating a document, see Attaching files.
Returns 204 No Content on success.
Deleting a document¶
Returns 204 No Content on success.
The existing view_documents, add_documents, edit_documents and delete_documents permissions are applied.