Connectors Reference

Plumsail Documents

Generate documents from DOCX, XLSX, PPTX, HTML templates, and populate fillable PDF forms. Automate your contracts, invoices, reports, tickets, and more. Find more information at site https://plumsail.com/documents

 

Status: Production

Tier: Standard

Version: v1

 

Actions:

Name

Summary

FlowV1DocumentsFlowSchemaAddWatermarkToPdfPost (string type)

AddWatermarkToPdfSchema

FlowV1DocumentsFlowSchemaRegExpMatchPost (string pattern)

RegexMatchSchema

FlowV1DocumentsFlowSchemaParseCsvPost (string headers)

ParseCsv

FlowV1ProcessesFlowSchemaGetProcessesPost ()

GetProcessesSchema

FlowV1DocumentsJobsApplyDocxTemplatePost (ApplyDocxTemplateRequest request)

Create DOCX document from template

FlowV1DocumentsJobsApplyXlsxTemplatePost (ApplyXlsxTemplateRequest request)

Create XLSX document from template

FlowV1DocumentsJobsApplyDocxPost (MergeFieldsTemplateRequest request)

Fill merge fields in DOCX document

FlowV1DocumentsJobsApplyHtmlPost (ApplyHtmlFlowTemplateRequest request)

Create HTML from template

FlowV1DocumentsJobsApplyPptxPost (ApplyPptxTemplateRequest request)

Create PPTX document from template

FlowV1DocumentsJobsHtml2PdfPost (Html2PdfFlowRequest request)

Convert HTML to PDF

FlowV1DocumentsJobsDocx2PdfPost (Docx2PdfRequest request)

Convert DOCX to PDF

FlowV1DocumentsJobsXslx2PdfPost (Xlsx2PdfRequest request)

Convert XLSX to PDF

FlowV1DocumentsJobsPptx2PdfPost (Pptx2PdfRequest request)

Convert PPTX to PDF

FlowV1DocumentsJobsDoc2DocxPost (Doc2DocxRequest request)

Convert DOC to DOCX

FlowV1DocumentsJobsXls2XlsxPost (Xls2XlsxRequest request)

Convert XLS to XLSX

FlowV1DocumentsJobsPpt2PptxPost (Ppt2PptxRequest request)

Convert PPT to PPTX

FlowV1DocumentsJobsSplitPdfPost (SplitPdfRequest request)

Split PDF

FlowV1DocumentsJobsMergePdfPost (MergePdfRequest request)

Merge PDF

FlowV1DocumentsJobsExtractTextFromPdfPost (Pdf2TextRequest request)

Extract text from PDF document

FlowV1DocumentsJobsPdf2ImagePost (Pdf2ImageRequest request)

Convert PDF to Image

FlowV1DocumentsJobsFillInPdfFormPost (FillInPdfFormRequest request)

Fill in PDF Form

FlowV1DocumentsJobsGetPdfFormPost (GetPdfFormRequest request)

Get Form from PDF

FlowV1DocumentsJobsProtectPdfPost (ProtectPdfRequest request)

Protect PDF document

FlowV1DocumentsJobsAddWatermarkToPdfPost (string type, FlowV1DocumentsJobsAddWatermarkToPdfPostParameterRequest request)

Add a watermark to PDF

FlowV1DocumentsJobsMergeDocxPost (MergeDocxRequest request)

Merge Docx

FlowV1DocumentsJobsParseCsvPost (ParseCsvFlowRequest request)

Parse CSV

FlowV1DocumentsJobsCsv2XlsxPost (Csv2XlsxRequest request)

Csv to Excel

FlowV1DocumentsJobsRegExpMatchPost (RegExpMatchRequest request)

Regular Expression Match

FlowV1DocumentsJobsRegExpReplacePost (RegExpReplaceRequest request)

Regular Expression Replace

FlowV1DocumentsJobsRegExpTestPost (RegExpTestRequest request)

Regular Expression Test

FlowV1ProcessesFlowJobsExecuteProcessPost (string processId, FlowV1ProcessesFlowJobsExecuteProcessPostParameterJsonContent jsonContent)

Start document generation process

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

ApplyDocxTemplateRequest

 

ApplyHtmlFlowTemplateRequest

 

ApplyHtmlTemplateResponse

 

ApplyPptxTemplateRequest

 

ApplyXlsxTemplateRequest

 

BooleanResultResponse

 

Csv2XlsxRequest

 

Doc2DocxRequest

 

DocumentProcessingResponse

 

DocumentsArrayResponse

 

Docx2PdfRequest

 

FillInPdfFormRequest

 

FlowV1DocumentsJobsAddWatermarkToPdfPostParameterRequest

 

FlowV1DocumentsJobsGetPdfFormPostResponse

 

FlowV1ProcessesFlowJobsExecuteProcessPostParameterJsonContent

 

GetPdfFormRequest

 

Html2PdfFlowRequest

 

MergeDocxRequest

 

MergeFieldsTemplateRequest

 

MergePdfRequest

 

ParseCsvFlowRequest

 

ParseCsvSchemaResponse

 

Pdf2ImageRequest

 

Pdf2TextRequest

 

Ppt2PptxRequest

 

Pptx2PdfRequest

 

ProtectPdfRequest

 

RegExpMatchRequest

 

RegExpMatchSchemaResponseClass

 

RegExpReplaceRequest

 

RegExpTestRequest

 

SplitPdfRequest

 

StringResultResponse

 

Xls2XlsxRequest

 

Xlsx2PdfRequest

 

 

Actions:

FlowV1DocumentsFlowSchemaAddWatermarkToPdfPost

Summary: AddWatermarkToPdfSchema

Description: System

 

Syntax:

PlumsailDocuments.FlowV1DocumentsFlowSchemaAddWatermarkToPdfPost (string type)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Type)Values: [Text, Image, Pdf]

The type of the watermark

True

 

Returns:

 

FlowV1DocumentsFlowSchemaRegExpMatchPost

Summary: RegexMatchSchema

Description: System

 

Syntax:

PlumsailDocuments.FlowV1DocumentsFlowSchemaRegExpMatchPost (string pattern)

 

Parameters:

Name

Type

Summary

Required

Related Action

pattern

string

(Pattern)

pattern

True

 

Returns:

 

FlowV1DocumentsFlowSchemaParseCsvPost

Summary: ParseCsv

Description: System

 

Syntax:

PlumsailDocuments.FlowV1DocumentsFlowSchemaParseCsvPost (string headers)

 

Parameters:

Name

Type

Summary

Required

Related Action

headers

string

 

 

True

 

Returns:

 

FlowV1ProcessesFlowSchemaGetProcessesPost

Summary: GetProcessesSchema

Description: System

 

Syntax:

PlumsailDocuments.FlowV1ProcessesFlowSchemaGetProcessesPost ()

 

Returns:

 

FlowV1DocumentsJobsApplyDocxTemplatePost

Summary: Create DOCX document from template

Description: Created Word DOCX document from template. More information: https://plumsail.com/docs/actions/v1.x/document-generation/docx/index.html

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsApplyDocxTemplatePost (ApplyDocxTemplateRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

ApplyDocxTemplateRequest

 

 

True

 

Returns:

          Type:string(binary)Result file

Title: Result file

 

FlowV1DocumentsJobsApplyXlsxTemplatePost

Summary: Create XLSX document from template

Description: Created Excel XLSX document from template. More information:  https://plumsail.com/docs/actions/v1.x/document-generation/xlsx/index.html

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsApplyXlsxTemplatePost (ApplyXlsxTemplateRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

ApplyXlsxTemplateRequest

 

 

True

 

Returns:

          Type:string(binary)Result file

Title: Result file

 

FlowV1DocumentsJobsApplyDocxPost

Summary: Fill merge fields in DOCX document

Description: It takes a DOCX document with merge fields and replaces them by specified data. The keys in data object should be the same as names of MergeFields (Express block) in document

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsApplyDocxPost (MergeFieldsTemplateRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

MergeFieldsTemplateRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsApplyHtmlPost

Summary: Create HTML from template

Description: It takes input HTML template string or file and replaces special {{Tokens}} by specified data. We use Mustache framework for templates internally. More information about templates in Mustache docs: http://mustache.github.io/mustache.5.html

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsApplyHtmlPost (ApplyHtmlFlowTemplateRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

ApplyHtmlFlowTemplateRequest

 

 

True

 

Returns:

          Type:ApplyHtmlTemplateResponse

 

FlowV1DocumentsJobsApplyPptxPost

Summary: Create PPTX document from template

Description: Created PowerPoint PPTX document from template.

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsApplyPptxPost (ApplyPptxTemplateRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

ApplyPptxTemplateRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsHtml2PdfPost

Summary: Convert HTML to PDF

Description: It takes HTML markup, renders it and converts to PDF document

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsHtml2PdfPost (Html2PdfFlowRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Html2PdfFlowRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsDocx2PdfPost

Summary: Convert DOCX to PDF

Description: It takes DOCX document and converts it to PDF

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsDocx2PdfPost (Docx2PdfRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Docx2PdfRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsXslx2PdfPost

Summary: Convert XLSX to PDF

Description: It takes XLSX document and converts it to PDF

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsXslx2PdfPost (Xlsx2PdfRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Xlsx2PdfRequest

 

 

True

 

Returns:

          Type:string(binary)Result file

Title: Result file

 

FlowV1DocumentsJobsPptx2PdfPost

Summary: Convert PPTX to PDF

Description: It takes PPTX document and converts it to PDF

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsPptx2PdfPost (Pptx2PdfRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Pptx2PdfRequest

 

 

True

 

Returns:

          Type:string(binary)Result file

Title: Result file

 

FlowV1DocumentsJobsDoc2DocxPost

Summary: Convert DOC to DOCX

Description: It takes DOC document and converts it to DOCX

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsDoc2DocxPost (Doc2DocxRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Doc2DocxRequest

 

 

True

 

Returns:

          Type:string(binary)Result file

Title: Result file

 

FlowV1DocumentsJobsXls2XlsxPost

Summary: Convert XLS to XLSX

Description: It takes XLS document and converts it to XLSX

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsXls2XlsxPost (Xls2XlsxRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Xls2XlsxRequest

 

 

True

 

Returns:

          Type:string(binary)Result file

Title: Result file

 

FlowV1DocumentsJobsPpt2PptxPost

Summary: Convert PPT to PPTX

Description: It takes PPT document and converts it to PPTX

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsPpt2PptxPost (Ppt2PptxRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Ppt2PptxRequest

 

 

True

 

Returns:

          Type:string(binary)Result file

Title: Result file

 

FlowV1DocumentsJobsSplitPdfPost

Summary: Split PDF

Description: It takes PDF document and split it

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsSplitPdfPost (SplitPdfRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

SplitPdfRequest

 

 

True

 

Returns:

          Type:DocumentsArrayResponse

 

FlowV1DocumentsJobsMergePdfPost

Summary: Merge PDF

Description: It takes an array of PDF documents and merge it

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsMergePdfPost (MergePdfRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

MergePdfRequest

 

 

True

 

Returns:

          Type:string(binary)Result file

Title: Result file

 

FlowV1DocumentsJobsExtractTextFromPdfPost

Summary: Extract text from PDF document

Description: It takes PDF document and extracts text to Raw or HTML format

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsExtractTextFromPdfPost (Pdf2TextRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Pdf2TextRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsPdf2ImagePost

Summary: Convert PDF to Image

Description: It takes PDF document and converts it to Image (jpeg, png, gif, bmp)

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsPdf2ImagePost (Pdf2ImageRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Pdf2ImageRequest

 

 

True

 

Returns:

          Type:DocumentsArrayResponse

 

FlowV1DocumentsJobsFillInPdfFormPost

Summary: Fill in PDF Form

Description: Filling out PDF form by provided data

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsFillInPdfFormPost (FillInPdfFormRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

FillInPdfFormRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsGetPdfFormPost

Summary: Get Form from PDF

Description: Returns fillable form data from PDF as JSON

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsGetPdfFormPost (GetPdfFormRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

GetPdfFormRequest

 

 

True

 

Returns:

          Type:FlowV1DocumentsJobsGetPdfFormPostResponse

 

FlowV1DocumentsJobsProtectPdfPost

Summary: Protect PDF document

Description: Adds passwords, copy-, printing-, and other protections to PDF file

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsProtectPdfPost (ProtectPdfRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

ProtectPdfRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsAddWatermarkToPdfPost

Summary: Add a watermark to PDF

Description: Adds a text watermark to PDF

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsAddWatermarkToPdfPost (string type, FlowV1DocumentsJobsAddWatermarkToPdfPostParameterRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Type)Values: [Text, Image, Pdf]

The type of the watermark

True

request

FlowV1DocumentsJobsAddWatermarkToPdfPostParameterRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsMergeDocxPost

Summary: Merge Docx

Description: It takes an array of Docx documents and merge it into single file

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsMergeDocxPost (MergeDocxRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

MergeDocxRequest

 

 

True

 

Returns:

          Type:DocumentProcessingResponse

 

FlowV1DocumentsJobsParseCsvPost

Summary: Parse CSV

Description: It works like Parse JSON but for CSV file

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsParseCsvPost (ParseCsvFlowRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

ParseCsvFlowRequest

 

 

True

 

Returns:

          Type:ParseCsvSchemaResponse

 

FlowV1DocumentsJobsCsv2XlsxPost

Summary: Csv to Excel

Description: Converts CSV file to Excel

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsCsv2XlsxPost (Csv2XlsxRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

Csv2XlsxRequest

 

 

True

 

Returns:

          Type:string(binary)Result file

Title: Result file

 

FlowV1DocumentsJobsRegExpMatchPost

Summary: Regular Expression Match

Description: Searches an input string for all occurrences of a regular expression and returns all the matches. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsRegExpMatchPost (RegExpMatchRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

RegExpMatchRequest

 

 

True

 

Returns:

          Type:RegExpMatchSchemaResponseClass

 

FlowV1DocumentsJobsRegExpReplacePost

Summary: Regular Expression Replace

Description: In a specified input string, replaces all strings that match a regular expression pattern with a specified replacement string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsRegExpReplacePost (RegExpReplaceRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

RegExpReplaceRequest

 

 

True

 

Returns:

          Type:StringResultResponse

 

FlowV1DocumentsJobsRegExpTestPost

Summary: Regular Expression Test

Description: Indicates whether the regular expression specified in the Regex constructor finds a match in a specified input string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions

 

Syntax:

PlumsailDocuments.FlowV1DocumentsJobsRegExpTestPost (RegExpTestRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

RegExpTestRequest

 

 

True

 

Returns:

          Type:BooleanResultResponse

 

FlowV1ProcessesFlowJobsExecuteProcessPost

Summary: Start document generation process

Description: Fill a template related to the selected process with the JSON data

 

Syntax:

PlumsailDocuments.FlowV1ProcessesFlowJobsExecuteProcessPost (string processId, FlowV1ProcessesFlowJobsExecuteProcessPostParameterJsonContent jsonContent)

 

Parameters:

Name

Type

Summary

Required

Related Action

processId

string

(Process name)

The name of process to be started

True

FlowV1ProcessesFlowSchemaGetProcessesPost

jsonContent

FlowV1ProcessesFlowJobsExecuteProcessPostParameterJsonContent

 

 

True

 

Returns:

          Type:string(binary)Result file

Title: Result file

 


 

ApplyDocxTemplateRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(binary)

Template file

Content of the template

data

string

Template data

JSON data that should be applied to the template

locale

string

Locale

The locale that will be applyed to the document  Values: [aa, aa-DJ, aa-ER, aa-ET, af, af-NA, af-ZA, agq, agq-CM, ak, ak-GH, am, am-ET, ar, ar-001, ar-AE, ar-BH, ar-DJ, ar-DZ, ar-EG, ar-ER, ar-IL, ar-IQ, ar-JO, ar-KM, ar-KW, ar-LB, ar-LY, ar-MA, ar-MR, ar-OM, ar-PS, ar-QA, ar-SA, ar-SD, ar-SO, ar-SS, ar-SY, ar-TD, ar-TN, ar-YE, arn, arn-CL, as, as-IN, asa, asa-TZ, ast, ast-ES, az, az-Cyrl, az-Cyrl-AZ, az-Latn, az-Latn-AZ, ba, ba-RU, bas, bas-CM, be, be-BY, bem, bem-ZM, bez, bez-TZ, bg, bg-BG, bin, bin-NG, bm, bm-Latn, bm-Latn-ML, bn, bn-BD, bn-IN, bo, bo-CN, bo-IN, br, br-FR, brx, brx-IN, bs, bs-Cyrl, bs-Cyrl-BA, bs-Latn, bs-Latn-BA, byn, byn-ER, ca, ca-AD, ca-ES, ca-ES-valencia, ca-FR, ca-IT, ce, ce-RU, cgg, cgg-UG, chr, chr-Cher, chr-Cher-US, co, co-FR, cs, cs-CZ, cu, cu-RU, cy, cy-GB, da, da-DK, da-GL, dav, dav-KE, de, de-AT, de-BE, de-CH, de-DE, de-IT, de-LI, de-LU, dje, dje-NE, dsb, dsb-DE, dua, dua-CM, dv, dv-MV, dyo, dyo-SN, dz, dz-BT, ebu, ebu-KE, ee, ee-GH, ee-TG, el, el-CY, el-GR, en, en-001, en-029, en-150, en-AG, en-AI, en-AS, en-AT, en-AU, en-BB, en-BE, en-BI, en-BM, en-BS, en-BW, en-BZ, en-CA, en-CC, en-CH, en-CK, en-CM, en-CX, en-CY, en-DE, en-DK, en-DM, en-ER, en-FI, en-FJ, en-FK, en-FM, en-GB, en-GD, en-GG, en-GH, en-GI, en-GM, en-GU, en-GY, en-HK, en-ID, en-IE, en-IL, en-IM, en-IN, en-IO, en-JE, en-JM, en-KE, en-KI, en-KN, en-KY, en-LC, en-LR, en-LS, en-MG, en-MH, en-MO, en-MP, en-MS, en-MT, en-MU, en-MW, en-MY, en-NA, en-NF, en-NG, en-NL, en-NR, en-NU, en-NZ, en-PG, en-PH, en-PK, en-PN, en-PR, en-PW, en-RW, en-SB, en-SC, en-SD, en-SE, en-SG, en-SH, en-SI, en-SL, en-SS, en-SX, en-SZ, en-TC, en-TK, en-TO, en-TT, en-TV, en-TZ, en-UG, en-UM, en-US, en-VC, en-VG, en-VI, en-VU, en-WS, en-ZA, en-ZM, en-ZW, eo, eo-001, es, es-419, es-AR, es-BO, es-BR, es-BZ, es-CL, es-CO, es-CR, es-CU, es-DO, es-EC, es-ES, es-GQ, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PH, es-PR, es-PY, es-SV, es-US, es-UY, es-VE, et, et-EE, eu, eu-ES, ewo, ewo-CM, fa, fa-IR, ff, ff-CM, ff-GN, ff-Latn, ff-Latn-SN, ff-MR, ff-NG, fi, fi-FI, fil, fil-PH, fo, fo-DK, fo-FO, fr, fr-029, fr-BE, fr-BF, fr-BI, fr-BJ, fr-BL, fr-CA, fr-CD, fr-CF, fr-CG, fr-CH, fr-CI, fr-CM, fr-DJ, fr-DZ, fr-FR, fr-GA, fr-GF, fr-GN, fr-GP, fr-GQ, fr-HT, fr-KM, fr-LU, fr-MA, fr-MC, fr-MF, fr-MG, fr-ML, fr-MQ, fr-MR, fr-MU, fr-NC, fr-NE, fr-PF, fr-PM, fr-RE, fr-RW, fr-SC, fr-SN, fr-SY, fr-TD, fr-TG, fr-TN, fr-VU, fr-WF, fr-YT, fur, fur-IT, fy, fy-NL, ga, ga-IE, gd, gd-GB, gl, gl-ES, gn, gn-PY, gsw, gsw-CH, gsw-FR, gsw-LI, gu, gu-IN, guz, guz-KE, gv, gv-IM, ha, ha-Latn, ha-Latn-GH, ha-Latn-NE, ha-Latn-NG, haw, haw-US, he, he-IL, hi, hi-IN, hr, hr-BA, hr-HR, hsb, hsb-DE, hu, hu-HU, hy, hy-AM, ia, ia-001, ia-FR, ibb, ibb-NG, id, id-ID, ig, ig-NG, ii, ii-CN, is, is-IS, it, it-CH, it-IT, it-SM, it-VA, iu, iu-Cans, iu-Cans-CA, iu-Latn, iu-Latn-CA, ja, ja-JP, jgo, jgo-CM, jmc, jmc-TZ, jv, jv-Java, jv-Java-ID, jv-Latn, jv-Latn-ID, ka, ka-GE, kab, kab-DZ, kam, kam-KE, kde, kde-TZ, kea, kea-CV, khq, khq-ML, ki, ki-KE, kk, kk-KZ, kkj, kkj-CM, kl, kl-GL, kln, kln-KE, km, km-KH, kn, kn-IN, ko, ko-KP, ko-KR, kok, kok-IN, kr, kr-NG, ks, ks-Arab, ks-Arab-IN, ks-Deva, ks-Deva-IN, ksb, ksb-TZ, ksf, ksf-CM, ksh, ksh-DE, ku, ku-Arab, ku-Arab-IQ, ku-Arab-IR, kw, kw-GB, ky, ky-KG, la, la-001, lag, lag-TZ, lb, lb-LU, lg, lg-UG, lkt, lkt-US, ln, ln-AO, ln-CD, ln-CF, ln-CG, lo, lo-LA, lrc, lrc-IQ, lrc-IR, lt, lt-LT, lu, lu-CD, luo, luo-KE, luy, luy-KE, lv, lv-LV, mas, mas-KE, mas-TZ, mer, mer-KE, mfe, mfe-MU, mg, mg-MG, mgh, mgh-MZ, mgo, mgo-CM, mi, mi-NZ, mk, mk-MK, ml, ml-IN, mn, mn-Cyrl, mn-MN, mn-Mong, mn-Mong-CN, mn-Mong-MN, mni, mni-IN, moh, moh-CA, mr, mr-IN, ms, ms-BN, ms-MY, ms-SG, mt, mt-MT, mua, mua-CM, my, my-MM, mzn, mzn-IR, naq, naq-NA, nb, nb-NO, nb-SJ, nd, nd-ZW, nds, nds-DE, nds-NL, ne, ne-IN, ne-NP, nl, nl-AW, nl-BE, nl-BQ, nl-CW, nl-NL, nl-SR, nl-SX, nmg, nmg-CM, nn, nn-NO, nnh, nnh-CM, no, nqo, nqo-GN, nr, nr-ZA, nso, nso-ZA, nus, nus-SS, nyn, nyn-UG, oc, oc-FR, om, om-ET, om-KE, or, or-IN, os, os-GE, os-RU, pa, pa-Arab, pa-Arab-PK, pa-Guru, pa-IN, pap, pap-029, pl, pl-PL, prg, prg-001, prs, prs-AF, ps, ps-AF, pt, pt-AO, pt-BR, pt-CH, pt-CV, pt-GQ, pt-GW, pt-LU, pt-MO, pt-MZ, pt-PT, pt-ST, pt-TL, quc, quc-Latn, quc-Latn-GT, quz, quz-BO, quz-EC, quz-PE, rm, rm-CH, rn, rn-BI, ro, ro-MD, ro-RO, rof, rof-TZ, ru, ru-BY, ru-KG, ru-KZ, ru-MD, ru-RU, ru-UA, rw, rw-RW, rwk, rwk-TZ, sa, sa-IN, sah, sah-RU, saq, saq-KE, sbp, sbp-TZ, sd, sd-Arab, sd-Arab-PK, sd-Deva, sd-Deva-IN, se, se-FI, se-NO, se-SE, seh, seh-MZ, ses, ses-ML, sg, sg-CF, shi, shi-Latn, shi-Latn-MA, shi-Tfng, shi-Tfng-MA, si, si-LK, sk, sk-SK, sl, sl-SI, sma, sma-NO, sma-SE, smj, smj-NO, smj-SE, smn, smn-FI, sms, sms-FI, sn, sn-Latn, sn-Latn-ZW, so, so-DJ, so-ET, so-KE, so-SO, sq, sq-AL, sq-MK, sq-XK, sr, sr-Cyrl, sr-Cyrl-BA, sr-Cyrl-ME, sr-Cyrl-RS, sr-Cyrl-XK, sr-Latn, sr-Latn-BA, sr-Latn-ME, sr-Latn-RS, sr-Latn-XK, ss, ss-SZ, ss-ZA, ssy, ssy-ER, st, st-LS, st-ZA, sv, sv-AX, sv-FI, sv-SE, sw, sw-CD, sw-KE, sw-TZ, sw-UG, syr, syr-SY, ta, ta-IN, ta-LK, ta-MY, ta-SG, te, te-IN, teo, teo-KE, teo-UG, tg, tg-Cyrl, tg-Cyrl-TJ, th, th-TH, ti, ti-ER, ti-ET, tig, tig-ER, tk, tk-TM, tn, tn-BW, tn-ZA, to, to-TO, tr, tr-CY, tr-TR, ts, ts-ZA, tt, tt-RU, twq, twq-NE, tzm, tzm-Arab, tzm-Arab-MA, tzm-Latn, tzm-Latn-DZ, tzm-Latn-MA, tzm-Tfng, tzm-Tfng-MA, ug, ug-CN, uk, uk-UA, ur, ur-IN, ur-PK, uz, uz-Arab, uz-Arab-AF, uz-Cyrl, uz-Cyrl-UZ, uz-Latn, uz-Latn-UZ, vai, vai-Latn, vai-Latn-LR, vai-Vaii, vai-Vaii-LR, ve, ve-ZA, vi, vi-VN, vo, vo-001, vun, vun-TZ, wae, wae-CH, wal, wal-ET, wo, wo-SN, xh, xh-ZA, xog, xog-UG, yav, yav-CM, yi, yi-001, yo, yo-BJ, yo-NG, zgh, zgh-Tfng, zgh-Tfng-MA, zh, zh-CN, zh-Hans, zh-Hans-HK, zh-Hans-MO, zh-Hant, zh-HK, zh-MO, zh-SG, zh-TW, zu, zu-ZA, zh-CHS, zh-CHT]


 

ApplyHtmlFlowTemplateRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

html

string(byte)

Source HTML

Text HTML template or HTML file template

data

string

Template data

JSON data that should be applied to the template

locale

string

Locale

The locale that will be applyed to the document  Values: [aa, aa-DJ, aa-ER, aa-ET, af, af-NA, af-ZA, agq, agq-CM, ak, ak-GH, am, am-ET, ar, ar-001, ar-AE, ar-BH, ar-DJ, ar-DZ, ar-EG, ar-ER, ar-IL, ar-IQ, ar-JO, ar-KM, ar-KW, ar-LB, ar-LY, ar-MA, ar-MR, ar-OM, ar-PS, ar-QA, ar-SA, ar-SD, ar-SO, ar-SS, ar-SY, ar-TD, ar-TN, ar-YE, arn, arn-CL, as, as-IN, asa, asa-TZ, ast, ast-ES, az, az-Cyrl, az-Cyrl-AZ, az-Latn, az-Latn-AZ, ba, ba-RU, bas, bas-CM, be, be-BY, bem, bem-ZM, bez, bez-TZ, bg, bg-BG, bin, bin-NG, bm, bm-Latn, bm-Latn-ML, bn, bn-BD, bn-IN, bo, bo-CN, bo-IN, br, br-FR, brx, brx-IN, bs, bs-Cyrl, bs-Cyrl-BA, bs-Latn, bs-Latn-BA, byn, byn-ER, ca, ca-AD, ca-ES, ca-ES-valencia, ca-FR, ca-IT, ce, ce-RU, cgg, cgg-UG, chr, chr-Cher, chr-Cher-US, co, co-FR, cs, cs-CZ, cu, cu-RU, cy, cy-GB, da, da-DK, da-GL, dav, dav-KE, de, de-AT, de-BE, de-CH, de-DE, de-IT, de-LI, de-LU, dje, dje-NE, dsb, dsb-DE, dua, dua-CM, dv, dv-MV, dyo, dyo-SN, dz, dz-BT, ebu, ebu-KE, ee, ee-GH, ee-TG, el, el-CY, el-GR, en, en-001, en-029, en-150, en-AG, en-AI, en-AS, en-AT, en-AU, en-BB, en-BE, en-BI, en-BM, en-BS, en-BW, en-BZ, en-CA, en-CC, en-CH, en-CK, en-CM, en-CX, en-CY, en-DE, en-DK, en-DM, en-ER, en-FI, en-FJ, en-FK, en-FM, en-GB, en-GD, en-GG, en-GH, en-GI, en-GM, en-GU, en-GY, en-HK, en-ID, en-IE, en-IL, en-IM, en-IN, en-IO, en-JE, en-JM, en-KE, en-KI, en-KN, en-KY, en-LC, en-LR, en-LS, en-MG, en-MH, en-MO, en-MP, en-MS, en-MT, en-MU, en-MW, en-MY, en-NA, en-NF, en-NG, en-NL, en-NR, en-NU, en-NZ, en-PG, en-PH, en-PK, en-PN, en-PR, en-PW, en-RW, en-SB, en-SC, en-SD, en-SE, en-SG, en-SH, en-SI, en-SL, en-SS, en-SX, en-SZ, en-TC, en-TK, en-TO, en-TT, en-TV, en-TZ, en-UG, en-UM, en-US, en-VC, en-VG, en-VI, en-VU, en-WS, en-ZA, en-ZM, en-ZW, eo, eo-001, es, es-419, es-AR, es-BO, es-BR, es-BZ, es-CL, es-CO, es-CR, es-CU, es-DO, es-EC, es-ES, es-GQ, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PH, es-PR, es-PY, es-SV, es-US, es-UY, es-VE, et, et-EE, eu, eu-ES, ewo, ewo-CM, fa, fa-IR, ff, ff-CM, ff-GN, ff-Latn, ff-Latn-SN, ff-MR, ff-NG, fi, fi-FI, fil, fil-PH, fo, fo-DK, fo-FO, fr, fr-029, fr-BE, fr-BF, fr-BI, fr-BJ, fr-BL, fr-CA, fr-CD, fr-CF, fr-CG, fr-CH, fr-CI, fr-CM, fr-DJ, fr-DZ, fr-FR, fr-GA, fr-GF, fr-GN, fr-GP, fr-GQ, fr-HT, fr-KM, fr-LU, fr-MA, fr-MC, fr-MF, fr-MG, fr-ML, fr-MQ, fr-MR, fr-MU, fr-NC, fr-NE, fr-PF, fr-PM, fr-RE, fr-RW, fr-SC, fr-SN, fr-SY, fr-TD, fr-TG, fr-TN, fr-VU, fr-WF, fr-YT, fur, fur-IT, fy, fy-NL, ga, ga-IE, gd, gd-GB, gl, gl-ES, gn, gn-PY, gsw, gsw-CH, gsw-FR, gsw-LI, gu, gu-IN, guz, guz-KE, gv, gv-IM, ha, ha-Latn, ha-Latn-GH, ha-Latn-NE, ha-Latn-NG, haw, haw-US, he, he-IL, hi, hi-IN, hr, hr-BA, hr-HR, hsb, hsb-DE, hu, hu-HU, hy, hy-AM, ia, ia-001, ia-FR, ibb, ibb-NG, id, id-ID, ig, ig-NG, ii, ii-CN, is, is-IS, it, it-CH, it-IT, it-SM, it-VA, iu, iu-Cans, iu-Cans-CA, iu-Latn, iu-Latn-CA, ja, ja-JP, jgo, jgo-CM, jmc, jmc-TZ, jv, jv-Java, jv-Java-ID, jv-Latn, jv-Latn-ID, ka, ka-GE, kab, kab-DZ, kam, kam-KE, kde, kde-TZ, kea, kea-CV, khq, khq-ML, ki, ki-KE, kk, kk-KZ, kkj, kkj-CM, kl, kl-GL, kln, kln-KE, km, km-KH, kn, kn-IN, ko, ko-KP, ko-KR, kok, kok-IN, kr, kr-NG, ks, ks-Arab, ks-Arab-IN, ks-Deva, ks-Deva-IN, ksb, ksb-TZ, ksf, ksf-CM, ksh, ksh-DE, ku, ku-Arab, ku-Arab-IQ, ku-Arab-IR, kw, kw-GB, ky, ky-KG, la, la-001, lag, lag-TZ, lb, lb-LU, lg, lg-UG, lkt, lkt-US, ln, ln-AO, ln-CD, ln-CF, ln-CG, lo, lo-LA, lrc, lrc-IQ, lrc-IR, lt, lt-LT, lu, lu-CD, luo, luo-KE, luy, luy-KE, lv, lv-LV, mas, mas-KE, mas-TZ, mer, mer-KE, mfe, mfe-MU, mg, mg-MG, mgh, mgh-MZ, mgo, mgo-CM, mi, mi-NZ, mk, mk-MK, ml, ml-IN, mn, mn-Cyrl, mn-MN, mn-Mong, mn-Mong-CN, mn-Mong-MN, mni, mni-IN, moh, moh-CA, mr, mr-IN, ms, ms-BN, ms-MY, ms-SG, mt, mt-MT, mua, mua-CM, my, my-MM, mzn, mzn-IR, naq, naq-NA, nb, nb-NO, nb-SJ, nd, nd-ZW, nds, nds-DE, nds-NL, ne, ne-IN, ne-NP, nl, nl-AW, nl-BE, nl-BQ, nl-CW, nl-NL, nl-SR, nl-SX, nmg, nmg-CM, nn, nn-NO, nnh, nnh-CM, no, nqo, nqo-GN, nr, nr-ZA, nso, nso-ZA, nus, nus-SS, nyn, nyn-UG, oc, oc-FR, om, om-ET, om-KE, or, or-IN, os, os-GE, os-RU, pa, pa-Arab, pa-Arab-PK, pa-Guru, pa-IN, pap, pap-029, pl, pl-PL, prg, prg-001, prs, prs-AF, ps, ps-AF, pt, pt-AO, pt-BR, pt-CH, pt-CV, pt-GQ, pt-GW, pt-LU, pt-MO, pt-MZ, pt-PT, pt-ST, pt-TL, quc, quc-Latn, quc-Latn-GT, quz, quz-BO, quz-EC, quz-PE, rm, rm-CH, rn, rn-BI, ro, ro-MD, ro-RO, rof, rof-TZ, ru, ru-BY, ru-KG, ru-KZ, ru-MD, ru-RU, ru-UA, rw, rw-RW, rwk, rwk-TZ, sa, sa-IN, sah, sah-RU, saq, saq-KE, sbp, sbp-TZ, sd, sd-Arab, sd-Arab-PK, sd-Deva, sd-Deva-IN, se, se-FI, se-NO, se-SE, seh, seh-MZ, ses, ses-ML, sg, sg-CF, shi, shi-Latn, shi-Latn-MA, shi-Tfng, shi-Tfng-MA, si, si-LK, sk, sk-SK, sl, sl-SI, sma, sma-NO, sma-SE, smj, smj-NO, smj-SE, smn, smn-FI, sms, sms-FI, sn, sn-Latn, sn-Latn-ZW, so, so-DJ, so-ET, so-KE, so-SO, sq, sq-AL, sq-MK, sq-XK, sr, sr-Cyrl, sr-Cyrl-BA, sr-Cyrl-ME, sr-Cyrl-RS, sr-Cyrl-XK, sr-Latn, sr-Latn-BA, sr-Latn-ME, sr-Latn-RS, sr-Latn-XK, ss, ss-SZ, ss-ZA, ssy, ssy-ER, st, st-LS, st-ZA, sv, sv-AX, sv-FI, sv-SE, sw, sw-CD, sw-KE, sw-TZ, sw-UG, syr, syr-SY, ta, ta-IN, ta-LK, ta-MY, ta-SG, te, te-IN, teo, teo-KE, teo-UG, tg, tg-Cyrl, tg-Cyrl-TJ, th, th-TH, ti, ti-ER, ti-ET, tig, tig-ER, tk, tk-TM, tn, tn-BW, tn-ZA, to, to-TO, tr, tr-CY, tr-TR, ts, ts-ZA, tt, tt-RU, twq, twq-NE, tzm, tzm-Arab, tzm-Arab-MA, tzm-Latn, tzm-Latn-DZ, tzm-Latn-MA, tzm-Tfng, tzm-Tfng-MA, ug, ug-CN, uk, uk-UA, ur, ur-IN, ur-PK, uz, uz-Arab, uz-Arab-AF, uz-Cyrl, uz-Cyrl-UZ, uz-Latn, uz-Latn-UZ, vai, vai-Latn, vai-Latn-LR, vai-Vaii, vai-Vaii-LR, ve, ve-ZA, vi, vi-VN, vo, vo-001, vun, vun-TZ, wae, wae-CH, wal, wal-ET, wo, wo-SN, xh, xh-ZA, xog, xog-UG, yav, yav-CM, yi, yi-001, yo, yo-BJ, yo-NG, zgh, zgh-Tfng, zgh-Tfng-MA, zh, zh-CN, zh-Hans, zh-Hans-HK, zh-Hans-MO, zh-Hant, zh-HK, zh-MO, zh-SG, zh-TW, zu, zu-ZA, zh-CHS, zh-CHT]


 

ApplyHtmlTemplateResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

htmlResult

string

Result HTML

Raw HTML result


 

ApplyPptxTemplateRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(binary)

Template file

Content of the template

data

string

Template data

JSON data that should be applied to the template

locale

string

Locale

The locale that will be applyed to the document  Values: [aa, aa-DJ, aa-ER, aa-ET, af, af-NA, af-ZA, agq, agq-CM, ak, ak-GH, am, am-ET, ar, ar-001, ar-AE, ar-BH, ar-DJ, ar-DZ, ar-EG, ar-ER, ar-IL, ar-IQ, ar-JO, ar-KM, ar-KW, ar-LB, ar-LY, ar-MA, ar-MR, ar-OM, ar-PS, ar-QA, ar-SA, ar-SD, ar-SO, ar-SS, ar-SY, ar-TD, ar-TN, ar-YE, arn, arn-CL, as, as-IN, asa, asa-TZ, ast, ast-ES, az, az-Cyrl, az-Cyrl-AZ, az-Latn, az-Latn-AZ, ba, ba-RU, bas, bas-CM, be, be-BY, bem, bem-ZM, bez, bez-TZ, bg, bg-BG, bin, bin-NG, bm, bm-Latn, bm-Latn-ML, bn, bn-BD, bn-IN, bo, bo-CN, bo-IN, br, br-FR, brx, brx-IN, bs, bs-Cyrl, bs-Cyrl-BA, bs-Latn, bs-Latn-BA, byn, byn-ER, ca, ca-AD, ca-ES, ca-ES-valencia, ca-FR, ca-IT, ce, ce-RU, cgg, cgg-UG, chr, chr-Cher, chr-Cher-US, co, co-FR, cs, cs-CZ, cu, cu-RU, cy, cy-GB, da, da-DK, da-GL, dav, dav-KE, de, de-AT, de-BE, de-CH, de-DE, de-IT, de-LI, de-LU, dje, dje-NE, dsb, dsb-DE, dua, dua-CM, dv, dv-MV, dyo, dyo-SN, dz, dz-BT, ebu, ebu-KE, ee, ee-GH, ee-TG, el, el-CY, el-GR, en, en-001, en-029, en-150, en-AG, en-AI, en-AS, en-AT, en-AU, en-BB, en-BE, en-BI, en-BM, en-BS, en-BW, en-BZ, en-CA, en-CC, en-CH, en-CK, en-CM, en-CX, en-CY, en-DE, en-DK, en-DM, en-ER, en-FI, en-FJ, en-FK, en-FM, en-GB, en-GD, en-GG, en-GH, en-GI, en-GM, en-GU, en-GY, en-HK, en-ID, en-IE, en-IL, en-IM, en-IN, en-IO, en-JE, en-JM, en-KE, en-KI, en-KN, en-KY, en-LC, en-LR, en-LS, en-MG, en-MH, en-MO, en-MP, en-MS, en-MT, en-MU, en-MW, en-MY, en-NA, en-NF, en-NG, en-NL, en-NR, en-NU, en-NZ, en-PG, en-PH, en-PK, en-PN, en-PR, en-PW, en-RW, en-SB, en-SC, en-SD, en-SE, en-SG, en-SH, en-SI, en-SL, en-SS, en-SX, en-SZ, en-TC, en-TK, en-TO, en-TT, en-TV, en-TZ, en-UG, en-UM, en-US, en-VC, en-VG, en-VI, en-VU, en-WS, en-ZA, en-ZM, en-ZW, eo, eo-001, es, es-419, es-AR, es-BO, es-BR, es-BZ, es-CL, es-CO, es-CR, es-CU, es-DO, es-EC, es-ES, es-GQ, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PH, es-PR, es-PY, es-SV, es-US, es-UY, es-VE, et, et-EE, eu, eu-ES, ewo, ewo-CM, fa, fa-IR, ff, ff-CM, ff-GN, ff-Latn, ff-Latn-SN, ff-MR, ff-NG, fi, fi-FI, fil, fil-PH, fo, fo-DK, fo-FO, fr, fr-029, fr-BE, fr-BF, fr-BI, fr-BJ, fr-BL, fr-CA, fr-CD, fr-CF, fr-CG, fr-CH, fr-CI, fr-CM, fr-DJ, fr-DZ, fr-FR, fr-GA, fr-GF, fr-GN, fr-GP, fr-GQ, fr-HT, fr-KM, fr-LU, fr-MA, fr-MC, fr-MF, fr-MG, fr-ML, fr-MQ, fr-MR, fr-MU, fr-NC, fr-NE, fr-PF, fr-PM, fr-RE, fr-RW, fr-SC, fr-SN, fr-SY, fr-TD, fr-TG, fr-TN, fr-VU, fr-WF, fr-YT, fur, fur-IT, fy, fy-NL, ga, ga-IE, gd, gd-GB, gl, gl-ES, gn, gn-PY, gsw, gsw-CH, gsw-FR, gsw-LI, gu, gu-IN, guz, guz-KE, gv, gv-IM, ha, ha-Latn, ha-Latn-GH, ha-Latn-NE, ha-Latn-NG, haw, haw-US, he, he-IL, hi, hi-IN, hr, hr-BA, hr-HR, hsb, hsb-DE, hu, hu-HU, hy, hy-AM, ia, ia-001, ia-FR, ibb, ibb-NG, id, id-ID, ig, ig-NG, ii, ii-CN, is, is-IS, it, it-CH, it-IT, it-SM, it-VA, iu, iu-Cans, iu-Cans-CA, iu-Latn, iu-Latn-CA, ja, ja-JP, jgo, jgo-CM, jmc, jmc-TZ, jv, jv-Java, jv-Java-ID, jv-Latn, jv-Latn-ID, ka, ka-GE, kab, kab-DZ, kam, kam-KE, kde, kde-TZ, kea, kea-CV, khq, khq-ML, ki, ki-KE, kk, kk-KZ, kkj, kkj-CM, kl, kl-GL, kln, kln-KE, km, km-KH, kn, kn-IN, ko, ko-KP, ko-KR, kok, kok-IN, kr, kr-NG, ks, ks-Arab, ks-Arab-IN, ks-Deva, ks-Deva-IN, ksb, ksb-TZ, ksf, ksf-CM, ksh, ksh-DE, ku, ku-Arab, ku-Arab-IQ, ku-Arab-IR, kw, kw-GB, ky, ky-KG, la, la-001, lag, lag-TZ, lb, lb-LU, lg, lg-UG, lkt, lkt-US, ln, ln-AO, ln-CD, ln-CF, ln-CG, lo, lo-LA, lrc, lrc-IQ, lrc-IR, lt, lt-LT, lu, lu-CD, luo, luo-KE, luy, luy-KE, lv, lv-LV, mas, mas-KE, mas-TZ, mer, mer-KE, mfe, mfe-MU, mg, mg-MG, mgh, mgh-MZ, mgo, mgo-CM, mi, mi-NZ, mk, mk-MK, ml, ml-IN, mn, mn-Cyrl, mn-MN, mn-Mong, mn-Mong-CN, mn-Mong-MN, mni, mni-IN, moh, moh-CA, mr, mr-IN, ms, ms-BN, ms-MY, ms-SG, mt, mt-MT, mua, mua-CM, my, my-MM, mzn, mzn-IR, naq, naq-NA, nb, nb-NO, nb-SJ, nd, nd-ZW, nds, nds-DE, nds-NL, ne, ne-IN, ne-NP, nl, nl-AW, nl-BE, nl-BQ, nl-CW, nl-NL, nl-SR, nl-SX, nmg, nmg-CM, nn, nn-NO, nnh, nnh-CM, no, nqo, nqo-GN, nr, nr-ZA, nso, nso-ZA, nus, nus-SS, nyn, nyn-UG, oc, oc-FR, om, om-ET, om-KE, or, or-IN, os, os-GE, os-RU, pa, pa-Arab, pa-Arab-PK, pa-Guru, pa-IN, pap, pap-029, pl, pl-PL, prg, prg-001, prs, prs-AF, ps, ps-AF, pt, pt-AO, pt-BR, pt-CH, pt-CV, pt-GQ, pt-GW, pt-LU, pt-MO, pt-MZ, pt-PT, pt-ST, pt-TL, quc, quc-Latn, quc-Latn-GT, quz, quz-BO, quz-EC, quz-PE, rm, rm-CH, rn, rn-BI, ro, ro-MD, ro-RO, rof, rof-TZ, ru, ru-BY, ru-KG, ru-KZ, ru-MD, ru-RU, ru-UA, rw, rw-RW, rwk, rwk-TZ, sa, sa-IN, sah, sah-RU, saq, saq-KE, sbp, sbp-TZ, sd, sd-Arab, sd-Arab-PK, sd-Deva, sd-Deva-IN, se, se-FI, se-NO, se-SE, seh, seh-MZ, ses, ses-ML, sg, sg-CF, shi, shi-Latn, shi-Latn-MA, shi-Tfng, shi-Tfng-MA, si, si-LK, sk, sk-SK, sl, sl-SI, sma, sma-NO, sma-SE, smj, smj-NO, smj-SE, smn, smn-FI, sms, sms-FI, sn, sn-Latn, sn-Latn-ZW, so, so-DJ, so-ET, so-KE, so-SO, sq, sq-AL, sq-MK, sq-XK, sr, sr-Cyrl, sr-Cyrl-BA, sr-Cyrl-ME, sr-Cyrl-RS, sr-Cyrl-XK, sr-Latn, sr-Latn-BA, sr-Latn-ME, sr-Latn-RS, sr-Latn-XK, ss, ss-SZ, ss-ZA, ssy, ssy-ER, st, st-LS, st-ZA, sv, sv-AX, sv-FI, sv-SE, sw, sw-CD, sw-KE, sw-TZ, sw-UG, syr, syr-SY, ta, ta-IN, ta-LK, ta-MY, ta-SG, te, te-IN, teo, teo-KE, teo-UG, tg, tg-Cyrl, tg-Cyrl-TJ, th, th-TH, ti, ti-ER, ti-ET, tig, tig-ER, tk, tk-TM, tn, tn-BW, tn-ZA, to, to-TO, tr, tr-CY, tr-TR, ts, ts-ZA, tt, tt-RU, twq, twq-NE, tzm, tzm-Arab, tzm-Arab-MA, tzm-Latn, tzm-Latn-DZ, tzm-Latn-MA, tzm-Tfng, tzm-Tfng-MA, ug, ug-CN, uk, uk-UA, ur, ur-IN, ur-PK, uz, uz-Arab, uz-Arab-AF, uz-Cyrl, uz-Cyrl-UZ, uz-Latn, uz-Latn-UZ, vai, vai-Latn, vai-Latn-LR, vai-Vaii, vai-Vaii-LR, ve, ve-ZA, vi, vi-VN, vo, vo-001, vun, vun-TZ, wae, wae-CH, wal, wal-ET, wo, wo-SN, xh, xh-ZA, xog, xog-UG, yav, yav-CM, yi, yi-001, yo, yo-BJ, yo-NG, zgh, zgh-Tfng, zgh-Tfng-MA, zh, zh-CN, zh-Hans, zh-Hans-HK, zh-Hans-MO, zh-Hant, zh-HK, zh-MO, zh-SG, zh-TW, zu, zu-ZA, zh-CHS, zh-CHT]


 

ApplyXlsxTemplateRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(binary)

Template file

Content of the template

data

string

Template data

JSON data that should be applied to the template

locale

string

Locale

The locale that will be applyed to the document  Values: [aa, aa-DJ, aa-ER, aa-ET, af, af-NA, af-ZA, agq, agq-CM, ak, ak-GH, am, am-ET, ar, ar-001, ar-AE, ar-BH, ar-DJ, ar-DZ, ar-EG, ar-ER, ar-IL, ar-IQ, ar-JO, ar-KM, ar-KW, ar-LB, ar-LY, ar-MA, ar-MR, ar-OM, ar-PS, ar-QA, ar-SA, ar-SD, ar-SO, ar-SS, ar-SY, ar-TD, ar-TN, ar-YE, arn, arn-CL, as, as-IN, asa, asa-TZ, ast, ast-ES, az, az-Cyrl, az-Cyrl-AZ, az-Latn, az-Latn-AZ, ba, ba-RU, bas, bas-CM, be, be-BY, bem, bem-ZM, bez, bez-TZ, bg, bg-BG, bin, bin-NG, bm, bm-Latn, bm-Latn-ML, bn, bn-BD, bn-IN, bo, bo-CN, bo-IN, br, br-FR, brx, brx-IN, bs, bs-Cyrl, bs-Cyrl-BA, bs-Latn, bs-Latn-BA, byn, byn-ER, ca, ca-AD, ca-ES, ca-ES-valencia, ca-FR, ca-IT, ce, ce-RU, cgg, cgg-UG, chr, chr-Cher, chr-Cher-US, co, co-FR, cs, cs-CZ, cu, cu-RU, cy, cy-GB, da, da-DK, da-GL, dav, dav-KE, de, de-AT, de-BE, de-CH, de-DE, de-IT, de-LI, de-LU, dje, dje-NE, dsb, dsb-DE, dua, dua-CM, dv, dv-MV, dyo, dyo-SN, dz, dz-BT, ebu, ebu-KE, ee, ee-GH, ee-TG, el, el-CY, el-GR, en, en-001, en-029, en-150, en-AG, en-AI, en-AS, en-AT, en-AU, en-BB, en-BE, en-BI, en-BM, en-BS, en-BW, en-BZ, en-CA, en-CC, en-CH, en-CK, en-CM, en-CX, en-CY, en-DE, en-DK, en-DM, en-ER, en-FI, en-FJ, en-FK, en-FM, en-GB, en-GD, en-GG, en-GH, en-GI, en-GM, en-GU, en-GY, en-HK, en-ID, en-IE, en-IL, en-IM, en-IN, en-IO, en-JE, en-JM, en-KE, en-KI, en-KN, en-KY, en-LC, en-LR, en-LS, en-MG, en-MH, en-MO, en-MP, en-MS, en-MT, en-MU, en-MW, en-MY, en-NA, en-NF, en-NG, en-NL, en-NR, en-NU, en-NZ, en-PG, en-PH, en-PK, en-PN, en-PR, en-PW, en-RW, en-SB, en-SC, en-SD, en-SE, en-SG, en-SH, en-SI, en-SL, en-SS, en-SX, en-SZ, en-TC, en-TK, en-TO, en-TT, en-TV, en-TZ, en-UG, en-UM, en-US, en-VC, en-VG, en-VI, en-VU, en-WS, en-ZA, en-ZM, en-ZW, eo, eo-001, es, es-419, es-AR, es-BO, es-BR, es-BZ, es-CL, es-CO, es-CR, es-CU, es-DO, es-EC, es-ES, es-GQ, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PH, es-PR, es-PY, es-SV, es-US, es-UY, es-VE, et, et-EE, eu, eu-ES, ewo, ewo-CM, fa, fa-IR, ff, ff-CM, ff-GN, ff-Latn, ff-Latn-SN, ff-MR, ff-NG, fi, fi-FI, fil, fil-PH, fo, fo-DK, fo-FO, fr, fr-029, fr-BE, fr-BF, fr-BI, fr-BJ, fr-BL, fr-CA, fr-CD, fr-CF, fr-CG, fr-CH, fr-CI, fr-CM, fr-DJ, fr-DZ, fr-FR, fr-GA, fr-GF, fr-GN, fr-GP, fr-GQ, fr-HT, fr-KM, fr-LU, fr-MA, fr-MC, fr-MF, fr-MG, fr-ML, fr-MQ, fr-MR, fr-MU, fr-NC, fr-NE, fr-PF, fr-PM, fr-RE, fr-RW, fr-SC, fr-SN, fr-SY, fr-TD, fr-TG, fr-TN, fr-VU, fr-WF, fr-YT, fur, fur-IT, fy, fy-NL, ga, ga-IE, gd, gd-GB, gl, gl-ES, gn, gn-PY, gsw, gsw-CH, gsw-FR, gsw-LI, gu, gu-IN, guz, guz-KE, gv, gv-IM, ha, ha-Latn, ha-Latn-GH, ha-Latn-NE, ha-Latn-NG, haw, haw-US, he, he-IL, hi, hi-IN, hr, hr-BA, hr-HR, hsb, hsb-DE, hu, hu-HU, hy, hy-AM, ia, ia-001, ia-FR, ibb, ibb-NG, id, id-ID, ig, ig-NG, ii, ii-CN, is, is-IS, it, it-CH, it-IT, it-SM, it-VA, iu, iu-Cans, iu-Cans-CA, iu-Latn, iu-Latn-CA, ja, ja-JP, jgo, jgo-CM, jmc, jmc-TZ, jv, jv-Java, jv-Java-ID, jv-Latn, jv-Latn-ID, ka, ka-GE, kab, kab-DZ, kam, kam-KE, kde, kde-TZ, kea, kea-CV, khq, khq-ML, ki, ki-KE, kk, kk-KZ, kkj, kkj-CM, kl, kl-GL, kln, kln-KE, km, km-KH, kn, kn-IN, ko, ko-KP, ko-KR, kok, kok-IN, kr, kr-NG, ks, ks-Arab, ks-Arab-IN, ks-Deva, ks-Deva-IN, ksb, ksb-TZ, ksf, ksf-CM, ksh, ksh-DE, ku, ku-Arab, ku-Arab-IQ, ku-Arab-IR, kw, kw-GB, ky, ky-KG, la, la-001, lag, lag-TZ, lb, lb-LU, lg, lg-UG, lkt, lkt-US, ln, ln-AO, ln-CD, ln-CF, ln-CG, lo, lo-LA, lrc, lrc-IQ, lrc-IR, lt, lt-LT, lu, lu-CD, luo, luo-KE, luy, luy-KE, lv, lv-LV, mas, mas-KE, mas-TZ, mer, mer-KE, mfe, mfe-MU, mg, mg-MG, mgh, mgh-MZ, mgo, mgo-CM, mi, mi-NZ, mk, mk-MK, ml, ml-IN, mn, mn-Cyrl, mn-MN, mn-Mong, mn-Mong-CN, mn-Mong-MN, mni, mni-IN, moh, moh-CA, mr, mr-IN, ms, ms-BN, ms-MY, ms-SG, mt, mt-MT, mua, mua-CM, my, my-MM, mzn, mzn-IR, naq, naq-NA, nb, nb-NO, nb-SJ, nd, nd-ZW, nds, nds-DE, nds-NL, ne, ne-IN, ne-NP, nl, nl-AW, nl-BE, nl-BQ, nl-CW, nl-NL, nl-SR, nl-SX, nmg, nmg-CM, nn, nn-NO, nnh, nnh-CM, no, nqo, nqo-GN, nr, nr-ZA, nso, nso-ZA, nus, nus-SS, nyn, nyn-UG, oc, oc-FR, om, om-ET, om-KE, or, or-IN, os, os-GE, os-RU, pa, pa-Arab, pa-Arab-PK, pa-Guru, pa-IN, pap, pap-029, pl, pl-PL, prg, prg-001, prs, prs-AF, ps, ps-AF, pt, pt-AO, pt-BR, pt-CH, pt-CV, pt-GQ, pt-GW, pt-LU, pt-MO, pt-MZ, pt-PT, pt-ST, pt-TL, quc, quc-Latn, quc-Latn-GT, quz, quz-BO, quz-EC, quz-PE, rm, rm-CH, rn, rn-BI, ro, ro-MD, ro-RO, rof, rof-TZ, ru, ru-BY, ru-KG, ru-KZ, ru-MD, ru-RU, ru-UA, rw, rw-RW, rwk, rwk-TZ, sa, sa-IN, sah, sah-RU, saq, saq-KE, sbp, sbp-TZ, sd, sd-Arab, sd-Arab-PK, sd-Deva, sd-Deva-IN, se, se-FI, se-NO, se-SE, seh, seh-MZ, ses, ses-ML, sg, sg-CF, shi, shi-Latn, shi-Latn-MA, shi-Tfng, shi-Tfng-MA, si, si-LK, sk, sk-SK, sl, sl-SI, sma, sma-NO, sma-SE, smj, smj-NO, smj-SE, smn, smn-FI, sms, sms-FI, sn, sn-Latn, sn-Latn-ZW, so, so-DJ, so-ET, so-KE, so-SO, sq, sq-AL, sq-MK, sq-XK, sr, sr-Cyrl, sr-Cyrl-BA, sr-Cyrl-ME, sr-Cyrl-RS, sr-Cyrl-XK, sr-Latn, sr-Latn-BA, sr-Latn-ME, sr-Latn-RS, sr-Latn-XK, ss, ss-SZ, ss-ZA, ssy, ssy-ER, st, st-LS, st-ZA, sv, sv-AX, sv-FI, sv-SE, sw, sw-CD, sw-KE, sw-TZ, sw-UG, syr, syr-SY, ta, ta-IN, ta-LK, ta-MY, ta-SG, te, te-IN, teo, teo-KE, teo-UG, tg, tg-Cyrl, tg-Cyrl-TJ, th, th-TH, ti, ti-ER, ti-ET, tig, tig-ER, tk, tk-TM, tn, tn-BW, tn-ZA, to, to-TO, tr, tr-CY, tr-TR, ts, ts-ZA, tt, tt-RU, twq, twq-NE, tzm, tzm-Arab, tzm-Arab-MA, tzm-Latn, tzm-Latn-DZ, tzm-Latn-MA, tzm-Tfng, tzm-Tfng-MA, ug, ug-CN, uk, uk-UA, ur, ur-IN, ur-PK, uz, uz-Arab, uz-Arab-AF, uz-Cyrl, uz-Cyrl-UZ, uz-Latn, uz-Latn-UZ, vai, vai-Latn, vai-Latn-LR, vai-Vaii, vai-Vaii-LR, ve, ve-ZA, vi, vi-VN, vo, vo-001, vun, vun-TZ, wae, wae-CH, wal, wal-ET, wo, wo-SN, xh, xh-ZA, xog, xog-UG, yav, yav-CM, yi, yi-001, yo, yo-BJ, yo-NG, zgh, zgh-Tfng, zgh-Tfng-MA, zh, zh-CN, zh-Hans, zh-Hans-HK, zh-Hans-MO, zh-Hant, zh-HK, zh-MO, zh-SG, zh-TW, zu, zu-ZA, zh-CHS, zh-CHT]


 

BooleanResultResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

isSuccess

boolean

IsSuccess

 


 

Csv2XlsxRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

content

string(byte)

Content of CSV document

Content of CSV document

delimiter

string

Delimiter

Delimiter of columns (by default it is just comma)  Values: [Comma, Semicolon, Tab]

hasHeaderRecords

boolean

Use first line as headers

If set as "true" when headers will be read from a first line.


 

Doc2DocxRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Document content

Content of document that should be converted


 

DocumentProcessingResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

fileContent

string(byte)

Result file

The result as a file


 

DocumentsArrayResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

resultFilesContents

array of (string(byte))

Result files

The array of raw content of result files


 

Docx2PdfRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Document content

Content of document that should be converted


 

FillInPdfFormRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Content of the PDF document

Raw content of PDF document

jsonData

string

JSON data

The data that will be used to fill out the form

lockFormFields

boolean

Lock form fields

Disable fields editing after filling them


 

FlowV1DocumentsJobsAddWatermarkToPdfPostParameterRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

FlowV1DocumentsJobsGetPdfFormPostResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

FlowV1ProcessesFlowJobsExecuteProcessPostParameterJsonContent

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetPdfFormRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Content of the PDF document

Raw content of PDF document

password

string

Password

Password to decrypt document


 

Html2PdfFlowRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

html

string

Source HTML

HTML markup that should be converted to PDF

headerHtml

string

Header HTML

HTML markup that should be added as a header

footerHtml

string

Footer HTML

HTML markup that should be added as a footer

size

string

Paper Size

Can be A4,A5 etc...  Values: [A4, Letter, LetterSmall, Tabloid, Ledger, Legal, Statement, Executive, A2, A3, A4Small, A5, B4, B5]

orientation

string

Orientation

Portrait vs Landscape  Values: [Portrait, Landscape]

margins

string

Margins

The page margins. The syntax is the same as in CSS. Example: 25 50 75 100.


 

MergeDocxRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentsContents

array of (string(binary))

Content

The array of raw content of Docx documents


 

MergeFieldsTemplateRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

docxDocument

string(byte)

DOCX document content

Raw content of docx document template. MergeField names should be the same as keys in template data

data

string

Template data

JSON data that should be applied to the template


 

MergePdfRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentsContents

array of (string(binary))

Content

The array of raw content of PDF documents


 

ParseCsvFlowRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

content

string(byte)

Content of CSV document

Content of CSV document

headers

string

Headers

Comma separated list of headers in the same order as CSV columns

delimiter

string

Delimiter

Delimiter of columns (by default it is just comma)  Values: [Comma, Semicolon, Tab]

skipFirstLine

boolean

Skip first line

Select "Yes" if your CSV has headers as a first line.


 

ParseCsvSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Pdf2ImageRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Content of the PDF document

Raw content of PDF document

startPage

integer(int32)

Start Page

The first page to start extraction (1 based)

endPage

integer(int32)

End Page

The last page to extract (inclusive)

pages

string

Pages

Page numbers for extraction separated by ';' (only this pages will be extracted)

format

string

Image Format

The format of the result image  Values: [Jpeg, Png, Gif, Bmp]

dpi

integer(int32)

DPI

The resolution of the result image

password

string

Password

Password to decrypt document


 

Pdf2TextRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Content of the PDF document

Raw content of PDF document

startPage

integer(int32)

Start Page

The first page to start extraction (1 based)

endPage

integer(int32)

End Page

The last page to extract (inclusive)

resultType

string

Result Type

Raw or HTML  Values: [Raw, HTML]

password

string

Password

Password to decrypt document


 

Ppt2PptxRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Document content

Content of document that should be converted


 

Pptx2PdfRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Document content

Content of document that should be converted


 

ProtectPdfRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Content of the PDF document

Raw content of PDF document

allowPrinting

boolean

Enable printing

Protect the PDF file from being printed out

allowModification

boolean

Enable modification

Protect the PDF file from being edited

allowExtract

boolean

Enable extract data

Allows extraction of text, images, and other media from the PDF file

allowAnnotate

boolean

Enable annotate

Allows annotation (e.g. comments, form fill-in, signing) of the PDF file

newOwnerPassword

string

PDF owner password

Enter an optional owner password here. This password can be used to disable document restrictions

newUserPassword

string

PDF user password

Enter an optional user password here. Each time an user opens the PDF he will be asked for this password. If you do not want a password prompt then leave this field blank

password

string

Password

Password to decrypt document


 

RegExpMatchRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

pattern

string

Pattern

Regular expression pattern

text

string

Text

String to search for matches


 

RegExpMatchSchemaResponseClass

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

RegExpReplaceRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

replacement

string

Replacement

Replacement string

pattern

string

Pattern

Regular expression pattern

text

string

Text

String to search for matches


 

RegExpTestRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

pattern

string

Pattern

Regular expression pattern

text

string

Text

String to search for matches


 

SplitPdfRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Content of the PDF document

Raw content of PDF document

startPage

integer(int32)

Start Page

The first page to start split (1 based)

endPage

integer(int32)

End Page

The last page to split (inclusive)

splitAtPage

integer(int32)

Split At Page

Number of pages per partition

password

string

Password

Password to decrypt document


 

StringResultResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

result

string

Result

 


 

Xls2XlsxRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Document content

Content of document that should be converted


 

Xlsx2PdfRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentContent

string(byte)

Document content

Content of document that should be converted