We’ve extended REST API with an ability to generate Word/PDF documents.

Document Method

This method allows you to generate Word/PDF document for selected records from a table given either their ids. The order the records matches the order ids are passed in.

Parameters

  • table: the singular name of the table or its alias as returned by the Describe (Application) method. Please note that this parameter is embedded into the URL before the method name.
  • document: the name of the document or its alias as returned by the Describe (Table). Please note that this parameter is embedded into the URL before the method name. 
  • id: the value of internal record id. Can appear multiple times. You cannot render the document for more than 500 records at once.

Request

GET https://www.teamdesk.net/secure/api/v2/{appid}/{table}/{document}/document?params

Render document for Id and Text column from records with id 156 and 157

GET https://www.teamdesk.net/secure/api/v2/21995/Test/SampleDoc/document?id=156&id=157

Response

Generated document file. Output format (DOCX or PDF) matches document settings defined in the database.

Author
Slava Shynderov
Date
Share