Connectors Reference
Docurain API allows you to create your own documents using template files registered in Docurain and Data for each App and DB.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Render (string outType, string templateName, string X-Docurain-Data-Type, string body) |
Render a form |
|
RenderAsync (string outType, string templateName, string X-Docurain-Data-Type, string body) |
Render a form asynchronously |
|
Get the processing status |
|
|
Get the processing result |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
Summary: Render a form
Description: This API renders a form by specifying the name of a template saved in Docurain beforehand.
Syntax:
Docurain.Render (string outType, string templateName, string X-Docurain-Data-Type, string body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
outType |
string (output format) |
Set the output format: pdf, xls(xlsx), png, jpg, jpg, gif, svg |
True |
|
|
templateName |
string (pre-saved template name) |
Specify the name of the template you have already saved in Docurain. |
True |
|
|
X-Docurain-Data-Type |
string (data format) |
Set the data format : json, csv, tsv |
True |
|
|
body |
string
|
Specify the format of the data in the data format. |
True |
Returns:
Type:string(binary)body
Title: body
Description: Reply to the binary data of the rendered form.
Summary: Render a form asynchronously
Description: API to render a form asynchronously by specifying the name of a template saved in Docurain beforehand.
Syntax:
Docurain.RenderAsync (string outType, string templateName, string X-Docurain-Data-Type, string body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
outType |
string (output format) |
Set the output format: pdf, xls(xlsx), png, jpg, jpg, gif, svg |
True |
|
|
templateName |
string (pre-saved template name) |
Specify the name of the template you have already saved in Docurain. |
True |
|
|
X-Docurain-Data-Type |
string (data format) |
Set the data format : json, csv, tsv |
True |
|
|
body |
string
|
Specify the format of the data in the data format. |
True |
Returns:
Type:RenderAsyncResponse
Summary: Get the processing status
Description: Get the processing status of the specified result ID.
Syntax:
Docurain.GetAsyncStatus (string resultId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
resultId |
string (Result ID to query processing status) |
Specify the result ID returned by RenderAsync. |
True |
Returns:
Summary: Get the processing result
Description: Get the processing result of the specified result ID.
Syntax:
Docurain.GetAsyncResult (string resultId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
resultId |
string (Result ID of the processing result to be acquired.) |
Specify the result ID returned by RenderAsync. |
True |
Returns:
Type:string(binary)body
Title: body
Description: If the process is successful, the binary data of the generated form is returned. If the process fails, JSON with the details of the error is returned.
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Processing status of the specified result ID: PROCESSING:Rendering in progress, FAIL:Failure, SUCCESS:Success |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
resultId |
string
|
ID for querying the processing status of the asynchronous API and obtaining processing results |