DownloadFileFromDocIds
Method : Post
Interface Function
step 1: Getting the documents by the "DocIds" and "FormAlias".
step 2: Creating a word/excel/pdf file according to the returned documents in step 1 and the document template which code is "TemplateCode", then return the file stream to client.
note: this API is generally used when the template is a word file with a table, or excel file..
Request Parameter
Parameter | Required | Type | Remarks |
---|---|---|---|
FormAlias | Yes | String | Form alias, the identity of the form |
DocIds | Yes | String[] | The document ids, according the DocIds and FormAlias to get the input document |
TemplateCode | Yes | String | Word/Excel file template code |
FileName | No | String | Generated file name, if it's null, it will be assigned by the value of the file name of the corresponding template. |
TransferPdf | No | Bool | true:the generated file format is PDF; false:the generated file format is same with the corresponding template's file format; |
Return Data Type
Stream: the binary stream.
Input Sample
{
"FormAlias": "Eason",
"DocIds" : ["7b2e1cb9-5ecd-46e2-abef-494eb11c2554"],
"TemplateCode" : "ABC",
"FileName": "report information",
"TransferPdf": true
}