CreateDocWithFileFromDocIds
Method : Post
Interface Function
step 1: Getting the document by the "DocIds" and "FromFormAlias".
step 2: Creating a word/excel/pdf file according to the document in step 1 and the document template which code is "TemplateCode".
step 3: Creating a document which belongs to the form "FormAlias" with the initial values from "Doc".
step 4: Binding the file created in step 2 to the doc created in step 3.
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 |
|---|---|---|---|
| FromFormAlias | Yes | String | Form alias, the identity of the form, the form alias of document which document id is "DocIds" |
| ToFormAlias | Yes | String | Form alias, the identity of the form, the form alias of the created doc. |
| FileFieldName | Yes | String | The name of the "FileUpload" control field that will be bound by the created file in step 2 |
| DocIds | Yes | String[] | The document ids, according the DocIds and FromFormAlias to get the input documents |
| 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; |
| Doc | No | Dictionary |
The data that should be saved in the created doc. |
| UserCode | Yes | String | The creator staff code (Required, or you will be unable to edit this document） |
| UserName | Yes | String | The creator name |
Return Data Type(Data)
StatusCode: 200 if success, others if fail.
Info: the value will not be empty if error occurs, it shows the error message.
Data (string): the created document id.
public class ResultMsg
{
public int StatusCode { get; set; }
public string Info { get; set; }
public object Data { get; set; }
}
Input Sample
{
"UserCode" : "##66522552323222",
"UserName" : "Eason",
"FormAlias": "Eason",
"FileFieldName": "File",
"DocIds" : ["7b2e1cb9-5ecd-46e2-abef-494eb11c2554","ab2c1ec3-cba0-4b11-a919-1783ceffdd00"],
"TemplateCode" : "ABC",
"FileName": "report information",
"TransferPdf": true,
"Doc": {
"FieldName_A" : "value-A",
"FieldName_B" : "value-B",
"FieldName_C" : "[{\"Type\":1,\"Count\":1,\"Status\":false}]",
}
}
Return Sample
{
"StatusCode": 200,
"Info": "",
"Data": "cf49a2bc-ee10-455c-9ac2-facf7dcd2a00"
}