Dokumenty Plumsail
Konektor Plumsail Documents umožňuje nastavit automatizované generování a převod dokumentů. Konektor poskytuje širokou škálu akcí pro manipulaci s dokumenty PDF a formuláři PDF. Vytvářejte dokumenty ze šablon, převádějte na PDF, rozdělujte a slučujte soubory PDF, zamkněte je, čtěte formuláře PDF a další – všechno, co potřebujete k automatizaci dokumentů v jednom konektoru. Další informace najdete na adrese https://plumsail.com/documents
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Standard | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Standard | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Support |
| URL | https://plumsail.com |
| support@plumsail.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | Plumsail |
| Internetová stránka | https://plumsail.com |
| Zásady ochrany osobních údajů | https://plumsail.com/privacy-policy/ |
| Kategorie | Produktivita; Obsah a soubory |
Generování dokumentů v Microsoft Power Automate, Azure Logic Apps nebo PowerApps
Registrace účtu
Nejprve musíte zaregistrovat Plumsail Account. Tento účet slouží ke správě produktů Plumsail Documents, Plumsail Actions a Plumsail Forms.
Je lepší použít aktivní e-mailovou adresu. Předplatné bude propojeno s touto adresou.
Pokud už účet máte, stačí se přihlásit k account.plumsail.com.
Generování klíče rozhraní API
Musíte přejít do části Klíče rozhraní API a kliknout na Přidat nový.
Jakmile vytvoříte klíč rozhraní API, uvidíte klíč přímo ve sloupci Tajný kód. Název klíče můžete také změnit tak, že na něj kliknete ve sloupci Název:
Vytvořte tolik klíčů, kolik potřebujete, například pro použití s různými účty Power Automate (Microsoft Flow). Pokud už klíč nepotřebujete, můžete ho odstranit, ujistěte se, že se klíč už nepoužívá.
Teď ho můžete zkopírovat a použít v:
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| výchozí | Parametry pro vytvoření připojení | Všechny oblasti | Sdíletelný |
Výchozí
Použitelné: Všechny oblasti
Parametry pro vytvoření připojení
Toto připojení je možné sdílet. Pokud se power app sdílí s jiným uživatelem, sdílí se i připojení. Další informace najdete v přehledu konektorů pro aplikace plátna – Power Apps | Microsoft Docs
| Název | Typ | Description | Povinné |
|---|---|---|---|
| klíč rozhraní API | securestring | Vytvoření klíče rozhraní API v account.plumsail.com | Pravdivé |
| Umístění datacentra | řetězec |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 1200 | 60 sekund |
Akce
Analýza sdíleného svazku clusteru
Parsování CSV funguje jako Parsovat JSON, ale pro soubory CSV. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#parse-csv
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu CSV
|
content | True | byte |
Obsah dokumentu CSV |
|
Oddělovač
|
delimiter | string |
Oddělovač sloupců (ve výchozím nastavení je to jenom čárka) |
|
|
Locale
|
locale | string |
Národní prostředí, které se použije v dokumentu |
|
|
Omezení
|
limit | integer |
Vrátí první "n" řádků. |
|
|
Headers
|
headers | True | string |
Čárkami oddělený seznam záhlaví ve stejném pořadí jako sloupce CSV |
|
Přeskočit první řádek
|
skipFirstLine | boolean |
Pokud má váš sdílený svazek clusteru záhlaví jako první řádek, vyberte Ano. |
Návraty
Extrahovat archiv
Extrahujte soubory z archivu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Archivní soubor
|
fileContent | byte |
Obsah archivního souboru |
|
|
Zahrnout složky
|
includeFolders | boolean |
Pokud budou extrahovány soubory true obsažené ve složkách. |
|
|
Heslo
|
password | string |
Archivovat heslo |
Návraty
Extrakce textu z dokumentu PDF
Extrahování textu z PDF přebírá dokument PDF a extrahuje text do formátu Raw nebo HTML. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#extract-text-from-pdf-document
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Nezpracovaný obsah dokumentu PDF |
|
Úvodní stránka
|
startPage | integer |
První stránka pro zahájení extrakce (1) |
|
|
Koncová stránka
|
endPage | integer |
Poslední stránka, která se má extrahovat (včetně) |
|
|
Typ výsledku
|
resultType | string |
Nezpracované nebo HTML |
|
|
Heslo
|
password | string |
Heslo k dešifrování dokumentu |
Návraty
Komprimovat dokument PDF
Pokud je to možné, komprimujte velikost dokumentu PDF a optimalizujte ho. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#compress-pdf-document
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Nezpracovaný obsah dokumentu PDF |
|
Bezeztrátové režimy
|
losslessMode | string |
Při zakázání komprimuje soubor PDF efektivněji, ale s mírnou ztrátou kvality obrázku. |
|
|
Heslo
|
password | string |
Heslo k otevření souboru PDF |
Návraty
- Výsledný soubor
- binary
Nahrazení regulárního výrazu
Nahrazení regulárního výrazu nahradí všechny řetězce, které odpovídají vzoru regulárního výrazu, zadaným náhradním řetězcem v zadaném vstupním řetězci. K otestování výrazů doporučujeme použít Regex Hero. Podporuje stejnou syntaxi jako akce. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-replace
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Vzor
|
pattern | True | string |
Vzor regulárního výrazu |
|
Text
|
text | True | string |
Řetězec pro hledání shod |
|
Replacement
|
replacement | string |
Náhradní řetězec |
Návraty
- Body
- StringResultResponse
Převod csv do Excelu
Převeďte soubor CSV na excelový soubor (XLSX). Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#csv-to-excel
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu CSV
|
content | True | byte |
Obsah dokumentu CSV |
|
Oddělovač
|
delimiter | string |
Oddělovač sloupců (ve výchozím nastavení je to jenom čárka) |
|
|
Locale
|
locale | string |
Národní prostředí, které se použije v dokumentu |
|
|
Omezení
|
limit | integer |
Vrátí první "n" řádků. |
|
|
Použití prvního řádku jako záhlaví
|
hasHeaderRecords | boolean |
Pokud je nastavená hodnota Ano, záhlaví se načtou z prvního řádku. |
|
|
Název sloupce CSV nebo index
|
csvColumnIndexOrName | True | string |
Název sloupce CSV nebo index sloupce (1, 2 atd.) |
|
Typ sloupce XLSX
|
xlsxColumnType | string |
Optional. Typ sloupce (ShortDateTime, TwoDecimal atd.) |
|
|
Název sloupce XLSX
|
xlsxColumnName | string |
Optional. Přejmenování sloupce CSV na tento název |
Návraty
- Výsledný soubor
- binary
Převod DOKUMENTU na DOCX
Převeďte dokument na soubory DOCX. Tato akce provede dokument DOC a převede ho na DOCX. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-doc-to-docx
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Obsah dokumentu, který by se měl převést |
Návraty
- Výsledný soubor
- binary
Převod FORMÁTU JSON na Excel
Převeďte JSON na excelový soubor (XLSX). Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#json-to-excel
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah souboru JSON
|
content | byte |
Optional. Obsah souboru JSON |
|
|
JSON Data
|
jsonData | string |
Optional. Zpracování dat JSON |
|
|
Locale
|
locale | string |
Národní prostředí, které se použije v dokumentu |
|
|
Cesta k poli JSON
|
pathToJsonArray | string |
Tečkovaná cesta k poli ve formátu JSON Např.: "data" nebo "prop1.prop2.prop3" |
|
|
Vlastnost JSON
|
jsonProperty | True | string |
Název vlastnosti JSON |
|
Typ sloupce XLSX
|
xlsxColumnType | string |
Optional. Typ sloupce (ShortDateTime, TwoDecimal atd.) |
|
|
Název sloupce XLSX
|
xlsxColumnName | string |
Optional. Přejmenování vlastnosti JSON na tento název |
Návraty
- Výsledný soubor
- binary
Převod HTML na DOCX
Převeďte HTML na dokument DOCX. Tato akce provede kód HTML, vykreslí ho a převede na dokument DOCX. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-docx
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah souboru
|
fileContent | binary |
Binární obsah souboru HTML pro převod na DOCX |
|
|
HTML Data
|
rawHtml | string |
Data HTML pro převod na DOCX |
|
|
HTML URL
|
htmlUrl | string |
Adresa URL webové stránky, která se má převést na DOCX |
|
|
Papíru
|
paperSize | string |
Může to být A4,A5 atd. |
|
|
Orientace
|
orientation | string |
Na výšku nebo na šířku |
|
|
Dekódování KÓDU HTML
|
decodeHtml | boolean |
Zda má být kód HTML dekódován před převodem |
|
|
Okraje
|
margins | string |
Okraje stránky v po. Syntaxe je stejná jako v šabloně stylů CSS. Příklad: 25 50 75 100. |
Návraty
Převod JSON na CSV
Převeďte JSON na soubor CSV. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#json-to-csv
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah souboru JSON
|
content | byte |
Optional. Obsah souboru JSON |
|
|
JSON Data
|
jsonData | string |
Optional. Zpracování dat JSON |
|
|
Locale
|
locale | string |
Národní prostředí, které se použije v dokumentu |
|
|
Cesta k poli JSON
|
pathToJsonArray | string |
Tečkovaná cesta k poli ve formátu JSON Např.: "data" nebo "prop1.prop2.prop3" |
|
|
Oddělovač
|
delimiter | string |
Oddělovač sloupců ve sdíleném svazku clusteru Výchozí hodnota je čárka. |
Návraty
- Výsledný soubor
- binary
Převod PPT na PPTX
Převeďte PPT na soubory PPTX. Tato akce provede dokument PPT a převede ho na PPTX. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-ppt-to-pptx
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Obsah dokumentu, který by se měl převést |
Návraty
- Výsledný soubor
- binary
Převod PPTX na PDF
Převeďte PPTX na soubory PDF. Tato akce provede dokument PPTX a převede ho na PDF. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pptx-to-pdf
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Obsah dokumentu, který by se měl převést |
Návraty
- Výsledný soubor
- binary
Převod XLS na XLSX
Převede XLS na soubory XLSX. Tato akce provede dokument XLS a převede ho na XLSX. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xls-to-xlsx
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Obsah dokumentu, který by se měl převést |
Návraty
- Výsledný soubor
- binary
Převod XLSX na PDF
Převeďte XLSX na soubory PDF. Tato akce provede dokument XLSX a převede ho na PDF. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xlsx-to-pdf
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Obsah dokumentu, který by se měl převést |
Návraty
- Výsledný soubor
- binary
Převést DOCX na PDF
Převeďte DOCX na soubory PDF. Tato akce provede dokument DOCX a převede ho na PDF. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-docx-to-pdf
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Obsah dokumentu, který by se měl převést |
Návraty
Převést e-mail na PDF
Převeďte zadaný e-mail na soubor PDF. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-email-to-pdf
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah e-mailu
|
documentContent | True | byte |
Obsah e-mailu, který by se měl převést |
|
Sloučit přílohy
|
mergeAttachments | True | boolean |
Zda se mají přílohy převést na PDF a zahrnout do výstupního souboru |
Návraty
- Výsledný soubor
- binary
Převést HTML na PDF
Převeďte HTML na soubor PDF. Tato akce provede kód HTML, vykreslí ho a převede na dokument PDF. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-pdf
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Zdrojový kód HTML
|
html | True | string |
Kód HTML, který by se měl převést na PDF |
|
Motor
|
engine | string |
Převodní modul |
|
|
Papíru
|
size | string |
Může to být A4,A5 atd. |
|
|
Orientace
|
orientation | string |
Na výšku nebo na šířku |
|
|
Okraje
|
margins | string |
Okraje stránky. Syntaxe je stejná jako v šabloně stylů CSS. Příklad: 25 50 75 100. |
|
|
Hlavička HTML
|
headerHtml | string |
Kód HTML, který by se měl přidat jako hlavička |
|
|
Zápatí HTML
|
footerHtml | string |
Kód HTML, který by se měl přidat jako zápatí |
Návraty
Převést na PDF
Převeďte zadaný soubor na soubor PDF. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-to-pdf
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Obsah dokumentu, který by se měl převést |
|
Jméno souboru
|
filename | True | string |
Úplný název souboru, který se má převést. Zahrnutí přípony souboru |
Návraty
- Výsledný soubor
- binary
Převést obrázky do PDF
Pořídí obrázky a převede je na dokument PDF.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jeden obrázek na stránku
|
imagePerPage | boolean |
Pokud nechcete, aby byl každý obrázek na samostatné stránce, vyberte Ne. Výchozí hodnota je Ano. |
|
|
Obsah obrázku
|
imageContent | True | array of byte |
Nezpracovaný obsah obrázku |
Návraty
- Výsledný soubor
- binary
Převést PDF na obrázek
Převeďte PDF na obrázek. Tato akce provede dokument PDF a převede ho na Obrázek (jpeg, png, gif, bmp atd.). Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Nezpracovaný obsah dokumentu PDF |
|
Předpona názvu souboru
|
filenamePrefix | string |
Optional. Výstupní soubory budou mít tuto předponu následovanou číslem indexu pro název. |
|
|
Úvodní stránka
|
startPage | integer |
První stránka pro zahájení extrakce (1) |
|
|
Koncová stránka
|
endPage | integer |
Poslední stránka, která se má extrahovat (včetně) |
|
|
Stránky
|
pages | string |
Čísla stránek pro extrakci oddělená čísly ";" (extrahují se pouze tyto stránky) |
|
|
Formát obrázku
|
format | string |
Formát výsledného obrázku |
|
|
DPI
|
dpi | integer |
Rozlišení výsledného obrázku |
|
|
Heslo
|
password | string |
Heslo k dešifrování dokumentu |
Návraty
Převést PDF na obrázek (zastaralé) [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte možnost Převést PDF na obrázek .
Převeďte PDF na obrázek. Tato akce provede dokument PDF a převede ho na Obrázek (jpeg, png, gif, bmp atd.). Dokumentace – https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image (zastaralé)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Nezpracovaný obsah dokumentu PDF |
|
Úvodní stránka
|
startPage | integer |
První stránka pro zahájení extrakce (1) |
|
|
Koncová stránka
|
endPage | integer |
Poslední stránka, která se má extrahovat (včetně) |
|
|
Stránky
|
pages | string |
Čísla stránek pro extrakci oddělená čísly ";" (extrahují se pouze tyto stránky) |
|
|
Formát obrázku
|
format | string |
Formát výsledného obrázku |
|
|
DPI
|
dpi | integer |
Rozlišení výsledného obrázku |
|
|
Heslo
|
password | string |
Heslo k dešifrování dokumentu |
Návraty
Přidání vodoznaku do PDF
Přidejte vodoznak do PDF jako text, obrázek nebo PDF. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#add-watermark-to-pdf
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Typ
|
type | True | string |
Typ vodoznaku |
|
žádost
|
request | True | dynamic |
Návraty
Rozdělení PDF (zastaralé) [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte Split PDF .
Vezme dokument PDF a rozdělí ho (zastaralé)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Nezpracovaný obsah dokumentu PDF |
|
Úvodní stránka
|
startPage | integer |
První stránka, která se má začít rozdělit (na základě 1) |
|
|
Koncová stránka
|
endPage | integer |
Poslední stránka, která se má rozdělit (včetně) |
|
|
Rozdělit na stránku
|
splitAtPage | integer |
Počet stránek na oddíl |
|
|
Heslo
|
password | string |
Heslo k dešifrování dokumentu |
Návraty
Rozdělit PDF
Split PDF vezme dokument PDF a rozdělí ho. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#split-pdf
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Typ rozdělení
|
type | True | string |
Jak rozdělit soubor |
|
žádost
|
request | True | dynamic |
Návraty
Shoda regulárních výrazů
Shoda regulárních výrazů vyhledá vstupní řetězec pro všechny výskyty regulárního výrazu a vrátí všechny shody. K otestování výrazů doporučujeme použít Regex Hero. Podporuje stejnou syntaxi jako akce. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-match
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Vzor
|
pattern | True | string |
Vzor regulárního výrazu |
|
Text
|
text | True | string |
Řetězec pro hledání shod |
Návraty
Sloučení PDF (zastaralé) [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte možnost Sloučit všechny soubory do PDF .
Sloučení PDF vezme pole dokumentů PDF a sloučí ho do jednoho. Dokumentace – https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-pdf (zastaralé)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Content
|
documentsContents | True | array of binary |
Pole nezpracovaného obsahu dokumentů PDF |
Návraty
- Výsledný soubor
- binary
Sloučení souborů DOCX
Sloučení souborů DOCX vezme pole dokumentů Docx a sloučí je do jednoho souboru. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-docx-files
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Content
|
documentsContents | True | array of binary |
Pole nezpracovaného obsahu dokumentů Docx |
|
Použití záhlaví a zápatí
|
applyHeaderAndFooter | True | boolean |
Použije záhlaví a zápatí z prvního dokumentu na všechny ostatní. |
Návraty
Sloučení souborů XLSX
Sloučení souborů XLSX vezme pole dokumentů Xlsx a sloučí je do jednoho souboru. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-xlsx-files
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Content
|
documentsContents | True | array of binary |
Pole nezpracovaného obsahu dokumentů Xlsx |
Návraty
Sloučení všech souborů do PDF
Převede a sloučí více souborů do jednoho dokumentu PDF. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-any-files-into-pdf
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jméno souboru
|
fileName | True | string |
Název souboru včetně přípony |
|
Obsah souboru
|
content | True | binary |
Obsah souboru |
|
Generování záložek
|
generateBookmarks | boolean |
Vygenerování záložky pro každý sloučený soubor |
|
|
Zachování záložek
|
preserveBookmarks | boolean |
Zachování záložek z každého sloučeného PDF |
Návraty
- Výsledný soubor
- binary
Spuštění procesu generování dokumentů pomocí kódu JSON
Spuštění procesu generování dokumentů vyplní šablonu DOCX, XLSX, PPTX nebo PDF související s vybraným procesem daty JSON. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html##start-process-json
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název procesu
|
processId | True | string |
Název procesu, který se má spustit |
|
|
object |
Návraty
- Výsledný soubor
- binary
Test regulárního výrazu
Test regulárního výrazu určuje, zda regulární výraz zadaný v konstruktoru Regex najde shodu v zadaném vstupním řetězci. K otestování výrazů doporučujeme použít Regex Hero. Podporuje stejnou syntaxi jako akce. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-test
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Vzor
|
pattern | True | string |
Vzor regulárního výrazu |
|
Text
|
text | True | string |
Řetězec pro hledání shod |
Návraty
Vyplnění formuláře PDF
Vyplněním formuláře PDF vyplníte PDF ze zadaných dat. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-in-pdf-form
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Nezpracovaný obsah dokumentu PDF |
|
Data JSON
|
jsonData | True | object |
Data, která budou použita k vyplnění formuláře |
|
Zamknout pole formuláře
|
lockFormFields | boolean |
Zakázání úprav polí po jejich vyplnění |
|
|
Heslo
|
password | string |
Heslo k otevření souboru PDF |
Návraty
Vyplnění slučovacích polí v dokumentu DOCX
Vyplňování slučovacích polí v dokumentu DOCX přebírá dokument DOCX slučovacími poli a nahrazuje je zadanými daty. Klíče v datovém objektu by měly být stejné jako názvy MergeFields (blok Express) v dokumentu. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-merge-fields-in-docx-document
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu DOCX
|
docxDocument | True | byte |
Nezpracovaný obsah šablony dokumentu docx Názvy MergeField by měly být stejné jako klíče v datech šablony. |
|
Data šablony
|
data | True | object |
Data JSON, která by se měla použít u šablony |
Návraty
Vytvoření dokumentu ze šablony DOCX
Vytvořte dokument ze šablony DOCX. Další informace: https://plumsail.com/docs/documents/v1.x/document-generation/docx/index.html
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Soubor šablony
|
documentContent | True | binary |
Obsah šablony |
|
Data šablony
|
data | True | object |
Data JSON, která by se měla použít u šablony |
|
Typ výstupu dokumentu
|
outputType | True | string |
Požadovaný typ dokumentu |
|
Locale
|
locale | string |
Národní prostředí, které se použije v dokumentu |
|
|
Časové pásmo
|
timezone | string |
Časové pásmo dokumentu |
|
|
Šablonový engine
|
engine | string |
Modul, který zpracuje šablonu |
Návraty
- Výsledný soubor
- binary
Vytvoření dokumentu ze šablony PPTX
Vytvořte dokument ze šablony PPTX. Další informace: https://plumsail.com/docs/documents/v1.x/document-generation/pptx/index.html
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Soubor šablony
|
documentContent | True | binary |
Obsah šablony |
|
Data šablony
|
data | True | object |
Data JSON, která by se měla použít u šablony |
|
Typ výstupu dokumentu
|
outputType | True | string |
Požadovaný typ dokumentu |
|
Locale
|
locale | string |
Národní prostředí, které se použije v dokumentu |
|
|
Časové pásmo
|
timezone | string |
Časové pásmo dokumentu |
Návraty
Vytvoření dokumentu ze šablony XLSX
Vytvořte dokument ze šablony XLSX. Další informace: https://plumsail.com/docs/documents/v1.x/document-generation/xlsx/index.html
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Soubor šablony
|
documentContent | True | binary |
Obsah šablony |
|
Data šablony
|
data | True | object |
Data JSON, která by se měla použít u šablony |
|
Typ výstupu dokumentu
|
outputType | True | string |
Požadovaný typ dokumentu |
|
Locale
|
locale | string |
Národní prostředí, které se použije v dokumentu |
|
|
Časové pásmo
|
timezone | string |
Časové pásmo dokumentu |
Návraty
- Výsledný soubor
- binary
Vytvoření KÓDU HTML ze šablony
Create HTML přebírá vstupní řetězec šablony HTML nebo soubor a nahrazuje speciální {{Tokens}} zadanými daty. Pro šablony interně používáme architekturu Mustache. Další informace o šablonách v dokumentaci k Mustache: http://mustache.github.io/mustache.5.html. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#create-html-from-template
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Zdrojový kód HTML
|
html | True | byte |
Textová šablona HTML nebo šablona souboru HTML |
|
Data šablony
|
data | True | object |
Data JSON, která by se měla použít u šablony |
|
Locale
|
locale | string |
Národní prostředí, které se použije v dokumentu |
|
|
Časové pásmo
|
timezone | string |
Časové pásmo dokumentu |
Návraty
Vytvořit archiv
Komprimuje a přidává soubory do archivu ZIP.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název souboru
|
fileName | True | string |
Název archivu bez přípony souboru |
|
Název souboru
|
fileName | string |
Název souboru včetně přípony souboru |
|
|
Obsah souboru
|
content | binary |
Obsah dokumentu |
|
|
Heslo
|
password | string |
Archivovat heslo |
Návraty
Zahájení procesu generování dokumentů
Spuštění procesu generování dokumentů vyplní šablonu DOCX, XLSX, PPTX nebo PDF související s vybraným procesem daty JSON. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#start-document-generation-process
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název procesu
|
processId | True | string |
Název procesu, který se má spustit |
|
data
|
data | True | dynamic |
Návraty
- Výsledný soubor
- binary
Zamknout dokument PDF
Ochrana dokumentu PDF přidává do souborů PDF hesla, kopírování, tisk a další ochrany. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#protect-pdf-document
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Nezpracovaný obsah dokumentu PDF |
|
Povolit tisk
|
allowPrinting | True | boolean |
Ochrana souboru PDF před tiskem |
|
Povolit úpravy
|
allowModification | True | boolean |
Ochrana souboru PDF před úpravami |
|
Povolení extrakce dat
|
allowExtract | True | boolean |
Umožňuje extrakci textu, obrázků a dalších médií ze souboru PDF. |
|
Povolení přidávání poznámek
|
allowAnnotate | True | boolean |
Umožňuje anotace (např. komentáře, vyplňování formuláře, podepisování) souboru PDF. |
|
Heslo vlastníka PDF
|
newOwnerPassword | string |
Sem zadejte volitelné heslo vlastníka. Toto heslo lze použít k zakázání omezení dokumentu. |
|
|
Heslo uživatele PDF
|
newUserPassword | string |
Sem zadejte volitelné uživatelské heslo. Pokaždé, když uživatel otevře PDF, bude požádán o toto heslo. Pokud nechcete, aby se zobrazila výzva k zadání hesla, nechte toto pole prázdné. |
|
|
Heslo
|
password | string |
Heslo k dešifrování dokumentu |
Návraty
Získat formulář z PDF
Získat formulář z PDF vrátí vyplnitelná data formuláře z PDF jako JSON. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-form-from-pdf
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Nezpracovaný obsah dokumentu PDF |
|
Heslo
|
password | string |
Heslo k dešifrování dokumentu |
Návraty
- response
- object
Získání informací o ochraně PDF
Získání informací o ochraně PDF vrátí informace o tom, zda je dokument chráněn heslem. Dokumentace- https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-pdf-protection-information
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Obsah dokumentu
|
documentContent | True | byte |
Nezpracovaný obsah dokumentu PDF |
Návraty
Získání informací o profilu
Získat informace o profilu vrátí informace o aktuálním uživateli a licenci.
Návraty
- Body
- ProfileInfo
Aktivační události
| Proces byl dokončen. |
Vytvoří webhook, který se spustí po dokončení procesu. |
Proces byl dokončen.
Vytvoří webhook, který se spustí po dokončení procesu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název procesu
|
processId | True | string |
Název procesu, který po dokončení aktivuje tok |
Návraty
Definice
ApplyHtmlTemplateResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Kód HTML výsledku
|
htmlResult | string |
Nezpracovaný výsledek HTML |
BooleanResultResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
IsSuccess
|
isSuccess | boolean |
DocumentContentWithFilenameResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Jméno souboru
|
filename | string |
Název souboru |
|
Obsah souboru
|
fileContent | byte |
Obsah souboru |
DocumentProcessingResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Výsledný soubor
|
fileContent | byte |
Výsledek jako soubor |
DocumentsArrayResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Výsledné soubory
|
resultFilesContents | array of byte |
Pole nezpracovaného obsahu výsledných souborů |
DocumentsWithFilenamesResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Výsledné soubory
|
resultFiles | array of DocumentContentWithFilenameResponse |
Pole nezpracovaného obsahu výsledných souborů s jejich názvy souborů |
GetPdfProtectionInfoResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
isPasswordProtected
|
isPasswordProtected | boolean |
LicenseInfo
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
typ
|
type | integer | |
|
kredity
|
credits | integer | |
|
additionalCredits
|
additionalCredits | integer | |
|
datum vypršení platnosti
|
expirationDate | date-time |
ProfileInfo
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
název
|
name | string | |
|
e-mail
|
string | ||
|
licenseStatus
|
licenseStatus | string | |
|
teamName
|
teamName | string | |
|
licenseInfo
|
licenseInfo | LicenseInfo | |
|
shortUserId
|
shortUserId | string |
StringResultResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Result
|
result | string |
binární
Toto je základní datový typ Binary.
objekt
Toto je typ "object".