Lex Power Sign (Preview)
Lex Persona je evropský poskytovatel důvěryhodných služeb nabízející řadu řešení elektronického podpisu. S Lex Enterprise máte přístup ke všem úrovním podpisu eIDAS spolu s velkým počtem metod ověřování podepisující osoby. Vaše podpisové knihy jsou vložené do digitálních pracovních postupů. Automatizujte propojení mezi Lex Enterprise a všemi vašimi nástroji, abyste eliminovali opakované úkoly, získali efektivitu a urychlili vaši firmu.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – 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 Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Podpora pro Lex Persona |
| URL | https://support.lex-persona.com |
| support@lex-persona.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | Lex Persona |
| Internetová stránka | https://www.lex-persona.com |
| Zásady ochrany osobních údajů | https://www.lex-persona.com/politique-de-confidentialite/ |
| Kategorie | Umělá inteligence; Internetová stránka |
Lex Persona je evropský poskytovatel důvěryhodných služeb nabízející řadu řešení elektronického podpisu. Pomocí tohoto konektoru můžete snadno přidat funkci elektronického podpisu do aplikace založené na Microsoftu (webová aplikace založená na PowerAppu, .NET, Dynamics...) a prostředí (Outlook, SharePoint, Teams...). Konektor je podporován naším manažerem pracovních postupů Lex Enterprise. Můžete vytvořit pracovní postupy elektronkového podpisu složené z různých typů kroků, které se můžou spouštět v sekvenci nebo paralelně. Konektor podporuje všechny úrovně podpisu eIDAS a nabízí širokou škálu metod ověřování podepisující osoby (OTP, SSO, France Connect, Identité Numérique La Poste, hardwarové tokeny...)
Požadavky
Abyste mohli pokračovat, budete muset mít následující:
- Předplatné Lex Enterprise. Testování pomocí zkušebního plánu
Požadavky na prostředí:
- Plán Microsoft Power Apps nebo Power Automate s funkcí vlastního konektoru
- Nástroje rozhraní příkazového řádku Power Platform
Jak získat přihlašovací údaje
Pokud chcete získat předplatné Lex Enteprise nebo účet v našich zkušebních systémech, obraťte se na naše obchodní zástupce commercial@lex-persona.com .
Připojte se k portálu Lex Enterprise pomocí svého účtu a vygenerujte klíč rozhraní API.
Začínáme s konektorem
Nejprve vytvořte připojení pro konektor. Nastavte metodu ověřování na klíč rozhraní API, zadejte klíč rozhraní API (Bearer act_XXXXXXX) a určete, že klíč rozhraní API musí být umístěn v hlavičce Autrorization volání rozhraní API.
Postup vytvoření jednoduchého pracovního postupu podpisu je následující:
- hned po tiggeru načtěte připojené ID uživatele Lex Enterprise (toto ID je potřeba k vytvoření pracovního postupu) pomocí akce Načíst mě .
- stránky pro vyjádření souhlasu hledání se stránkami souhlasu vyhledávání action_. Pomocí textového parametru můžete prohledávat stránky souhlasu podle názvu (stránky souhlasu definují úroveň podpisu a jsou předem nakonfigurované ve vašem prostředí Lex Enterprise).
- vytvořte pracovní postup podpisu pomocí akce Vytvořit pracovní postup . V tomto kroku musíte zadat informace podepisující osoby.
- profily hledání s akcí Profily podpisů hledání. Textový parametr můžete použít k vyhledávání profilů podpisů podle názvu (profily podpisů řídí některé aspekty chování stránek souhlasu. Vynucení posouvání podepisující osoby do dolní části dokumentu před podpisem, například)
- Načtení dokumentu z vašeho prostředí (Sharepoint, Outlook, OneDrive...)
- přidání dokumentu do pracovního postupu pomocí akce Vytvořit část , nastavení parametru createDocument na true
- spusťte pracovní postup akcí Aktualizovat pracovní postup a nastavte stav pracovního postupu tak, aby se spustil.
Upozorňujeme: Konektor je ve výchozím nastavení spárovaný s naším zkušebním serverem. Pokud chcete konektor spárovat s vlastním tenantem, musíte změnit adresu URL hostitele v definici zabezpečení konektoru nebo v souboru apiDefinitions.json:
- "host": "yourtenant.lexpersona.com",
Známé problémy a omezení
Akce Vytvořit dokument přijímá seznam částí dokumentu v datové části. Pokud však zadáte více částí, zohlední se pouze první část (důvodem je chyba v našem rozhraní API. Opraví se v příští verzi konektoru.
Pokud tedy chcete do pracovního postupu přidat více dokumentů, je nutné provést volání Create part s parametrem createDocument nastaveným na true pro každý dokument.
Běžné chyby a nápravné prostředky
V případě selhání volání rozhraní API obsahuje odpověď volání rozhraní API komplexní chybovou zprávu, která se zobrazí v historii spuštění konektoru. Zpráva obsahuje také ID protokolu, takže pokud potřebujete další informace o chybě, můžete se připojit k portálu Lex Enteprise a podívat se na soubor protokolu serveru. Alternativley, můžete nastavit požadavek Postman pro prohledávání našich protokolů serverů (plase projděte si dokumentaci: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
Nejběžnější kódy chyb HTTP vrácené naším rozhraním API jsou následující:
- Chyba 400 – Chybný požadavek V žádosti paylod je něco špatného. Informace o příčině chyby najdete v protokolu.
- Chyba 401 – Neautorizováno Yo nemá přístupová práva k provedení této operace. Kontrola přístupových práv uživatele Lex Persona
- Chyba 403 – Zakázáno Váš klíč rozhraní API je invlaid nebo zakázaný.
- Chyba 404 – Nenalezena. V adrese URL požadavku došlo k chybě.
Další podrobnosti o možných kódech chyb volání jednotlivých rozhraní API najdete v naší dokumentaci.https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html
časté otázky
Jaké jsou formáty dokumentů podporované konektorem
Dokumenty, které můžete odeslat k podpisu, můžou obsahovat formáty PDF, docx, pptx a xlsx. Konektor v případě potřeby převede dokumenty do pdf a podpisy budou mít formát PAdES.
Je také možné podepsat dokumenty XML. V tomto případě se nepoužije žádný převod a podpisy budou mít formát XAdES.
Je také možné nahrát soubory ZIP. Konektor rozbalí archiv a přidá každý dokument do pracovního postupu.
Můžete také přidat přílohy do pracovních postupů podpisů. Příloha není podepsaná a může mít libovolný formát.
Může mít dokument více podepisujících
Ano. Počet podepisujících členů dokumentu je neomezený.
Je možné podepsat více dokumentů najednou.
Ano. Do pracovního postupu můžete přidat více dokumentů a všechny dokumenty budou podepsány současně. Všimněte si však, že v tomto případě bude sada dokumentů porotě propojena a že systém vytvoří jedinečný soubor důkazů.
Můžete také vytvořit mutlpiple workglows coantaining stejného podepisujícího. V okamžiku podpisu se podepisujícímu zobrazí seznam dokumentů a podepisující bude mít možnost vybrat dokumenty, které podepisuje. V tomto případě budou dokumenty porotě nezávislé, pro každý dokument se vytvoří soubor důkazů.
Je možné podepsat dokument offline.
Ne. Pro přístup ke stránkám souhlasu je potřeba připojení intenetu.
Je možné posílat podpisy podepisujícím uživatelům automaticky.
Ano. Můžete nakonfigurovat období připomenutí a maximální počet připomenutí, která se mají odeslat.
Je možné upravit již spuštěný pracovní postup podpisu.
Ano. Před jakýmkoli podpisem můžete v pracovním postupu změnit cokoli. Po prvním podpisu není možné upravit dokumenty, ale přesto můžete upravit kroky pracovního postupu.
Jaká je doba platnosti jednorázových hesel
Doba platnosti jednorázových hesel je dvě minuty (počítání se zobrazí na stránkách souhlasu).
Je možné ověřit platnost elektronického podpisu.
Podokno Podpisy aplikace Adobe Acrobat můžete použít ke kontrole platnosti podpisů obsažených v dokumentu PDF. Případně můžete použít webovou službu pro ověření důvěryhodného podpisu (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation například).
Co jsou podmínky ukládání dokumentů Lex Persona
Ve výchozím nastavení uchováváme dokumenty, které jsou důkazem souborů na našich serverech. Tou můžete kdykoli vyhledávat a stahovat dokumenty. V případě požadavku však můžeme vaše dokumenty z našich serverů priodicky odstranit.
Uchovává lex Persona tokeny časových razítek.
Ne. Neuchovávají se tokeny časových razítek. V případě potřeby můžete tyto tokeny extracxtovat z podepsaných dokumentů.
Existuje lhůta pro zrušení podepsaného dokumentu.
Ano. Výběr závisí na právních podmínkách, které se vztahují na dokument.
Je možné zrušit pracovní postup podpisu.
Ano. Uživatel authoriezd může kdykoli zrušit spuštěný pracovní postup podpisu. Nebude vytvořen žádný soubor vyřazení a pokud byl dokument již podepsán jedním nebo mnoha podepisujícími znaménkami, budou ho vyprázdněny.
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| výchozí | Parametry pro vytvoření připojení | Všechny oblasti | Nesdílitelné |
Výchozí
Použitelné: Všechny oblasti
Parametry pro vytvoření připojení
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| Klíč rozhraní API | securestring | Klíč rozhraní API pro toto rozhraní API | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Aktualizace dokumentu |
Aktualizace dokumentu |
| Aktualizace profilu podpisu |
Aktualizace profilu podpisu |
| Aktualizace rozložení metadat |
Aktualizace rozložení metadat |
| Aktualizovat kontakt |
Úprava existujících kontaktních údajů |
| Aktualizovat pracovní postup |
Aktualizace pracovního postupu |
| Hledání dokumentů |
Hledání dokumentů |
| Hledání kontaktů |
Hledání kontaktů |
| Načtení adresy URL stránky constent |
Vytvoření a načtení adresy URL stránky souhlasu pro příjemce |
| Načtení dokumentu |
Načtení dokumentu |
| Načtení kontaktu |
Načtení kontaktních informací z ID kontaktu |
| Načtení mapování metadat |
Načtení mapování metadat zadaného tenanta |
| Načtení pracovního postupu |
Načtení pracovního postupu z ID pracovního postupu |
| Načtení profilu podpisu |
Načtení profilu podpisu |
| Načtení rozložení metadat |
Načtení rozložení pracovního postupu |
| Načtení stránky souhlasu |
Načtení informací o stránce souhlasu z ID stránky souhlasu |
| Načíst mě |
Načtení připojeného ID uživatele |
| Odstranit dokument |
Odstranění dokumentu |
| Odstranit kontakt |
Odebrání kontaktu ze seznamu contek aktuálního uživatele |
| Odstranit pracovní postup |
Odstranění pracovního postupu |
| Pracovní postupy vyhledávání |
Pracovní postupy vyhledávání |
| Profily podpisů vyhledávání |
Profily podpisů vyhledávání |
| Rozložení metadat vyhledávání |
Rozložení pracovních postupů vyhledávání |
| Stažení dokumentů pracovního postupu |
Stažení dokumentů pracovního postupu |
| Stažení souboru důkazů |
Stažení souboru důkazů pracovního postupu |
| Stránky souhlasu vyhledávání |
Stránky souhlasu vyhledávání |
| Vytvoření dokumentu |
Vytvoření dokumentu z předem vytvořených částí |
| Vytvoření pracovního postupu |
Vytvoření pracovního postupu |
| Vytvoření profilu podpisu |
Vytvoření profilu podpisu |
| Vytvoření rozložení metadat |
Vytvoření rozložení metadat |
| Vytvořit část |
Vytvoření části dokumentu |
| Vytvoří kontakt. |
Přidání kontaktu do seznamu kontaktů aktuálního uživatele |
Aktualizace dokumentu
Aktualizace dokumentu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
|
signatureProfileId
|
signatureProfileId | string |
Profil podpisu, který se má použít k tomuto dokumentu |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagePage
|
imagePage | float |
imagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
Návraty
- Body
- document
Aktualizace profilu podpisu
Aktualizace profilu podpisu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID profilu podpisu
|
spId | True | string |
ID profilu podpisu |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
|
Je výchozí
|
isDefault | string |
Nastaví tento profil podpisu jako výchozí. |
|
|
Je zakázané.
|
isDisabled | string |
Zakázat tento profil podpisu |
|
|
Název
|
name | string |
Název profilu podpisu |
|
|
Typ podpisu
|
signatureType | string |
pades,xadesDetached,xadesDetachedManifest,cades,helios |
|
|
Vynucení posouvání do dolní části dokumentu
|
forceScrollDocument | boolean |
Vynucení posouvání podepisující osoby do dolní části dokumentu |
|
|
Režim viditelného podpisu
|
pdfVisibleSignatureMode | string |
Režim viditelného podpisu (povolený, zakázaný, noImage) |
|
|
Text podpisu
|
pdfSignatureImageText | string |
Text zobrazený na panelech podpisů |
|
|
Barva textu podpisu
|
pdfSignatureImageTextColor | string |
Barva textu zobrazeného v oblasti singatures |
|
|
Velikost textu podpisu
|
pdfSignatureImageTextSize | number |
Velikost textu zobrazeného na panelech singaturami |
Návraty
- Body
- signatureProfile
Aktualizace rozložení metadat
Aktualizace rozložení metadat
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID nájemce
|
layoutId | True | string |
ID rozložení |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
|
Název
|
name | True | string |
Název rozložení |
|
Je zakázaný.
|
isDisabled | boolean |
Pokud je nastavená hodnota true, bude rozložení zakázané. |
|
|
štěrbina
|
slot | string |
Položka metadat (data1 až data8) |
|
|
výchozí
|
default | string |
Výchozí hodnota metadat v tomto rozložení |
|
|
optional
|
optional | boolean |
Pokud je hodnota true, zadání hodnoty není povinné. |
|
|
jen pro čtení
|
readonly | boolean |
Wether hodnota může být přepsána |
|
|
zapamatovatLastValue
|
rememberLastValue | boolean |
Pokud je nastavená hodnota true, hodnota se zachová napříč pracovními postupy. |
Návraty
Rozložení metadat
- Body
- layout
Aktualizovat kontakt
Úprava existujících kontaktních údajů
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID kontaktu
|
contactId | True | string |
ID kontaktu |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
|
E-mail kontaktu
|
string |
E-mail kontaktu |
||
|
Telefonní číslo kontaktu
|
phoneNumber | string |
Telefonní číslo kontaktu |
|
|
Jméno kontaktu
|
firstName | string |
Jméno kontaktu |
|
|
Příjmení kontaktu
|
lastName | string |
Příjmení kontaktu |
|
|
Země kontaktu
|
country | string |
Země kontaktu |
Návraty
- Body
- contact
Aktualizovat pracovní postup
Aktualizace pracovního postupu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID pracovního postupu
|
workflowId | True | string |
ID pracovního postupu, který se má aktualizovat |
|
Typ obsahu
|
Content-Type | string |
Typ obsahu |
|
|
ID uživatele
|
userId | string |
ID vlastníka pracovního postupu |
|
|
Název
|
name | string |
Název pracovního postupu |
|
|
Description
|
description | string |
Popis pracovního postupu |
|
|
identifikační číslo
|
id | string |
ID kroku |
|
|
stepType
|
stepType | string |
podpis nebo schválení |
|
|
consentPageId
|
consentPageId | True | string |
ID stránky souhlasu (úroveň podpisu) přidružené k tomuto příjemci |
|
e-mail
|
True | string |
e-mail příjemce |
|
|
userId
|
userId | string |
odkazování na uživatele LE místo vytvoření příjemce za běhu |
|
|
telefonní číslo
|
phoneNumber | string |
číslo mobilního telefonu uživatele reicpient |
|
|
křestní jméno
|
firstName | string |
jméno příjemce |
|
|
lastName
|
lastName | string |
příjmení příjemce |
|
|
země
|
country | string |
kód země příjemce |
|
|
preferredLocale
|
preferredLocale | string |
Kód národního prostředí příjemce |
|
|
organizationId
|
organizationId | string |
ID organizace LE příjemce |
|
|
requiredRecipients
|
requiredRecipients | number |
minimální počet podepisujících osob, které musí podepsat, aby mohli provést další krok |
|
|
validityPeriod
|
validityPeriod | number |
doba platnosti kroku |
|
|
inviteperiod
|
inviteperiod | number |
frekvence připomenutí podpisu |
|
|
maxInvites
|
maxInvites | number |
maximální počet připomenutí podpisu |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
řídí doručení podepsaného dokumentu podepisujícím |
|
|
allowComments
|
allowComments | boolean |
povolí nebo zakáže komentáře k tomuto kroku. |
|
|
hideAttachments
|
hideAttachments | boolean |
řídí zobrazení příloh podepisujících |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
řídí zobrazení ostatních podepisujících uživatelů podepisující osoby. |
|
|
Oznámené události
|
notifiedEvents | array of string |
Oznámení událostí pracovního postupu |
|
|
userId
|
userId | string |
ID uživatele Sledovací proces |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Události pracovního postupu, které budou upozorněny na tohoto sledovacího procesu |
|
|
e-mail
|
string |
|
||
|
Stav pracovního postupu
|
workflowStatus | string |
Aktuální stav pracovního postupu |
|
|
data1
|
data1 | string |
první metadata |
|
|
data2
|
data2 | string |
druhá metadata |
|
|
data3
|
data3 | string |
třetí metadata |
|
|
data4
|
data4 | string |
čtvrtá metadata |
|
|
data5
|
data5 | string |
pátá metadata |
|
|
data6
|
data6 | string |
šestá metadata |
|
|
data7
|
data7 | string |
sedmá metadata |
|
|
data8
|
data8 | string |
metadata heighth |
Návraty
- Body
- workflow
Hledání dokumentů
Hledání dokumentů
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hledat text
|
text | string |
Hledat text |
|
|
Rozložení metadat hledání
|
items.layoutId | string |
Hledání podle rozložení metadat |
|
|
Skupina hledání
|
items.groupId | string |
Hledání podle skupiny uživatelů |
|
|
Hledat uživatele
|
items.userId | string |
Hledat podle vlastníka |
|
|
ID pracovního postupu hledání
|
items.workflowId | string |
Hledat podle ID pracovního postupu |
|
|
Název pracovního postupu hledání
|
items.workflowName | string |
Hledat podle názvu pracovního postupu |
|
|
Metadata vyhledávání 1
|
items.data1 | string |
Hledání podle hodnoty metadat 1 |
|
|
Metadata hledání 2
|
items.data2 | string |
Hledání podle hodnoty metadat 2 |
|
|
Metadata hledání 3
|
items.data3 | string |
Hledání podle hodnoty metadat 3 |
|
|
Metadata vyhledávání 4
|
items.data4 | string |
Hledání podle hodnoty metadat 4 |
|
|
Metadata vyhledávání 5
|
items.data5 | string |
Hledání podle hodnoty metadat 5 |
|
|
Metadata vyhledávání 6
|
items.data6 | string |
Hledání podle hodnoty metadat 6 |
|
|
Metadata vyhledávání 7
|
items.data7 | string |
Hledání podle hodnoty metadat 7 |
|
|
Metadata hledání 8
|
items.data8 | string |
Hledání podle hodnoty metadat 8 |
|
|
Profil hledaného podpisu
|
items.signatureProfileId | string |
Hledat podle profilu podpisu |
|
|
Datum vytvoření hledání
|
items.created | string |
Hledat podle data vytvoření |
|
|
Datum aktualizace hledání
|
items.updated | string |
Hledat podle data poslední aktualizace |
|
|
Seřadit podle
|
sortBy | string |
Pole použité k seřazení výsledku hledání |
|
|
Řazení
|
sortOrder | string |
Směr řazení |
|
|
Položky na stránku
|
itemsPerPage | string |
Počet položek na stránku v odpovědi |
|
|
Index stránky
|
pageIndex | string |
Index vrácené stránky |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
items
|
items | documents |
Hledání kontaktů
Hledání kontaktů
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hledat text
|
text | string |
Hledat podle textu |
|
|
Hledat v e-mailu
|
items.email | string |
Hledat podle e-mailu |
|
|
Hledat telefonní číslo
|
items.phoneNumber | string |
Hledat podle telefonního čísla |
|
|
Hledat jméno
|
items.fisrtName | string |
Hledat podle jména |
|
|
Hledat příjmení
|
items.lastName | string |
Hledat podle příjmení |
|
|
Země hledání
|
items.country | string |
Hledat podle země |
|
|
Položky na stránku
|
itemsPerPage | number |
Počet položek na stránku v odpovědi |
|
|
Index stránky
|
pageIndex | number |
Index vrácené stránky |
Návraty
- Body
- contacts
Načtení adresy URL stránky constent
Vytvoření a načtení adresy URL stránky souhlasu pro příjemce
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID pracovního postupu
|
workflowId | True | string |
ID pracovního postupu |
|
E-mail příjemce
|
recipientEmail | string |
E-mail příslušného příjemce |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Adresa URL stránky souhlasu pro příslušného příjemce
|
inviteUrl | string |
Adresa URL stránky souhlasu pro příslušného příjemce |
Načtení dokumentu
Načtení dokumentu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
Návraty
- Body
- document
Načtení kontaktu
Načtení kontaktních informací z ID kontaktu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID kontaktu
|
contactId | True | string |
ID kontaktu |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
Návraty
- Body
- contact
Načtení mapování metadat
Načtení mapování metadat zadaného tenanta
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID nájemce
|
tenantId | True | string |
ID tenanta |
Návraty
- Body
- dataMapping
Načtení pracovního postupu
Načtení pracovního postupu z ID pracovního postupu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID pracovního postupu
|
workflowId | True | string |
ID pracovního postupu |
Návraty
- Body
- workflow
Načtení profilu podpisu
Načtení profilu podpisu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID profilu podpisu
|
spId | True | string |
ID profilu podpisu |
Návraty
- Body
- signatureProfile
Načtení rozložení metadat
Načtení rozložení pracovního postupu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID rozložení
|
layoutId | True | string |
ID rozložení |
Návraty
Rozložení metadat
- Body
- layout
Načtení stránky souhlasu
Načtení informací o stránce souhlasu z ID stránky souhlasu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID stránky souhlasu
|
cpId | True | string |
ID stránky souhlasu |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
Návraty
- Body
- consentPage
Načíst mě
Odstranit dokument
Odstranění dokumentu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
Návraty
- Body
- document
Odstranit kontakt
Odebrání kontaktu ze seznamu contek aktuálního uživatele
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID kontaktu
|
contactId | True | string |
ID kontaktu |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
Návraty
- Body
- contact
Odstranit pracovní postup
Odstranění pracovního postupu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID pracovního postupu
|
workflowId | True | string |
ID pracovního postupu k odstranění |
Návraty
- Body
- workflow
Pracovní postupy vyhledávání
Pracovní postupy vyhledávání
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Přijmout
|
Accept | string |
Přijmout |
|
|
Hledat text
|
text | string |
Hledat text |
|
|
Rozložení metadat hledání
|
items.layoutId | string |
Hledání podle rozložení metadat |
|
|
Šablona hledání
|
items.templateId | string |
Hledání podle šablony pracovního postupu |
|
|
Skupina hledání
|
items.groupId | string |
Hledání podle skupiny uživatelů |
|
|
Hledat uživatele
|
items.userId | string |
Hledat podle vlastníka |
|
|
Hledat v e-mailu
|
items.email | string |
Hledání podle e-mailu vlastníka |
|
|
Hledat jméno
|
items.firstname | string |
Hledat podle křestní jména vlastníka |
|
|
Hledat příjmení
|
items.lastname | string |
Hledat podle příjmení vlastníka |
|
|
Stav hledání
|
items.workflowStatus | string |
Hledání podle stavu pracovního postupu |
|
|
Metadata vyhledávání 1
|
items.data1 | string |
Hledání podle hodnoty metadat 1 |
|
|
Metadata hledání 2
|
items.data2 | string |
Hledání podle hodnoty metadat 2 |
|
|
Metadata hledání 3
|
items.data3 | string |
Hledání podle hodnoty metadat 3 |
|
|
Metadata vyhledávání 4
|
items.data4 | string |
Hledání podle hodnoty metadat 4 |
|
|
Metadata vyhledávání 5
|
items.data5 | string |
Hledání podle hodnoty metadat 5 |
|
|
Metadata vyhledávání 6
|
items.data6 | string |
Hledání podle hodnoty metadat 6 |
|
|
Metadata vyhledávání 7
|
items.data7 | string |
Hledání podle hodnoty metadat 7 |
|
|
Metadata hledání 8
|
items.data8 | string |
Hledání podle hodnoty metadat 8 |
|
|
Datum vytvoření hledání
|
items.created | string |
Hledat podle data vytvoření |
|
|
Datum aktualizace hledání
|
items.updated | string |
Hledat podle data poslední aktualizace |
|
|
Počáteční datum hledání
|
items.started | string |
Hledat podle počátečního data |
|
|
Seřadit podle
|
sortBy | string |
Pole použité k seřazení výsledku hledání |
|
|
Řazení
|
sortOrder | string |
Směr řazení |
|
|
Položky na stránku
|
itemsPerPage | string |
Počet položek na stránku v odpovědi |
|
|
Index stránky
|
pageIndex | string |
Index vrácené stránky |
Návraty
- Body
- workflows
Profily podpisů vyhledávání
Profily podpisů vyhledávání
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hledat text
|
text | string |
Hledat text |
|
|
Výchozí nastavení hledání
|
items.isDefault | string |
Vyhledání výchozích profilů podpisů |
|
|
Hledání zakázáno
|
items.isDisabled | string |
Hledání zakázaných profilů podpisů |
|
|
Vyhledat název
|
items.name | string |
Hledání podle názvu profilu podpisu |
|
|
Hledat v dokumentu. Zadejte
|
items.documentType | string |
Hledání podle typu dokumentu |
|
|
Typ podpisu hledání
|
items.signatureType | string |
Hledat podle typu podpisu |
|
|
Datum vytvoření hledání
|
items.created | string |
Hledat podle data vytvoření |
|
|
Datum aktualizace hledání
|
items.updated | string |
Hledat podle data poslední aktualizace |
|
|
Seřadit podle
|
sortBy | string |
Pole použité k seřazení výsledku hledání |
|
|
Řazení
|
sortOrder | string |
Směr řazení |
|
|
Položky na stránku
|
itemsPerPage | string |
Počet položek na stránku v odpovědi |
|
|
Index stránky
|
pageIndex | string |
Index vrácené stránky |
Návraty
- Body
- signatureProfiles
Rozložení metadat vyhledávání
Rozložení pracovních postupů vyhledávání
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hledat text
|
text | string |
Hledat text |
|
|
Hledání zakázáno
|
items.isDisabled | string |
Hledání zakázaných rozložení |
|
|
Vyhledat název
|
items.name | string |
Hledání podle názvu rozložení |
|
|
Metadata vyhledávání
|
items.dataConfigurations.slot | string |
Hledání podle přítomnosti metadat |
|
|
Datum vytvoření hledání
|
items.created | string |
Hledat podle data vytvoření |
|
|
Datum aktualizace hledání
|
items.updated | string |
Hledat podle data poslední aktualizace |
|
|
Seřadit podle
|
sortBy | string |
Pole použité k seřazení výsledku hledání |
|
|
Řazení
|
sortOrder | string |
Směr řazení |
|
|
Položky na stránku
|
itemsPerPage | string |
Počet položek na stránku v odpovědi |
|
|
Index stránky
|
pageIndex | string |
Index vrácené stránky |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
items
|
items | layouts |
Stažení dokumentů pracovního postupu
Stažení dokumentů pracovního postupu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID pracovního postupu
|
workflowId | True | string |
ID pracovního postupu |
Návraty
- response
- binary
Stažení souboru důkazů
Stažení souboru důkazů pracovního postupu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID pracovního postupu
|
workflowId | True | string |
ID pracovního postupu |
|
Přijmout
|
Accept | True | string |
Přijmout |
Návraty
- response
- binary
Stránky souhlasu vyhledávání
Stránky souhlasu vyhledávání
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hledat text
|
text | string |
Hledat text |
|
|
Výchozí nastavení hledání
|
items.isDefault | string |
Vyhledání výchozí stránky pro vyjádření souhlasu |
|
|
Hledání zakázáno
|
items.isDisabled | string |
Vyhledání zakázaných stránek se souhlasem |
|
|
Vyhledat název
|
items.name | string |
Hledat podle názvu stránky souhlasu |
|
|
Typ kroku hledání
|
items.stepType | string |
Hledání podle typu kroku |
|
|
Hledat ID klienta
|
items.clientId | string |
Hledat podle ID klienta |
|
|
Datum vytvoření hledání
|
items.created | string |
Hledat podle data vytvoření |
|
|
Datum aktualizace hledání
|
items.updated | string |
Hledat podle data poslední aktualizace |
|
|
Seřadit podle
|
sortBy | string |
Pole, podle kterého se má výsledky hledání seřadit |
|
|
Řazení
|
sortOrder | string |
Směr řazení |
|
|
Položky na stránku
|
itemsPerPage | string |
Počet položek na stránku v odpovědi |
|
|
Index stránky
|
pageIndex | string |
Index vrácené stránky |
Návraty
- Body
- consentPages
Vytvoření dokumentu
Vytvoření dokumentu z předem vytvořených částí
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID pracovního postupu
|
workflowId | True | string |
ID dotčeného pracovního postupu |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
|
typ obsahu
|
contentType | string |
typ obsahu |
|
|
filename
|
filename | string |
filename |
|
|
hodnota hash
|
hash | string |
hodnota hash |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
Profil podpisu pro tento dokument |
Návraty
- Body
- document
Vytvoření pracovního postupu
Vytvoření pracovního postupu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID uživatele
|
userId | True | string |
ID uživatele vlastníka pracovního postupu |
|
Typ obsahu
|
Content-Type | string |
Typ obsahu |
|
|
Název
|
name | True | string |
Název pracovního postupu |
|
Description
|
description | string |
Popis pracovního postupu |
|
|
identifikační číslo
|
id | string |
ID kroku |
|
|
stepType
|
stepType | string |
podpis nebo schválení |
|
|
consentPageId
|
consentPageId | True | string |
ID stránky souhlasu (úroveň podpisu) přidružené k tomuto příjemci |
|
e-mail
|
True | string |
e-mail příjemce |
|
|
userId
|
userId | string |
odkazování na uživatele LE místo vytvoření příjemce za běhu |
|
|
telefonní číslo
|
phoneNumber | string |
číslo mobilního telefonu uživatele reicpient |
|
|
křestní jméno
|
firstName | string |
jméno příjemce |
|
|
lastName
|
lastName | string |
příjmení příjemce |
|
|
země
|
country | string |
kód země příjemce |
|
|
preferredLocale
|
preferredLocale | string |
Kód národního prostředí příjemce |
|
|
organizationId
|
organizationId | string |
ID organizace LE příjemce |
|
|
requiredRecipients
|
requiredRecipients | number |
minimální počet podepisujících osob, které musí podepsat, aby mohli provést další krok |
|
|
validityPeriod
|
validityPeriod | number |
doba platnosti kroku |
|
|
inviteperiod
|
inviteperiod | number |
frekvence připomenutí podpisu |
|
|
maxInvites
|
maxInvites | number |
maximální počet připomenutí podpisu |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
řídí doručení podepsaného dokumentu podepisujícím |
|
|
allowComments
|
allowComments | boolean |
povolí nebo zakáže komentáře k tomuto kroku. |
|
|
hideAttachments
|
hideAttachments | boolean |
řídí zobrazení příloh podepisujících |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
řídí zobrazení ostatních podepisujících uživatelů podepisující osoby. |
|
|
Oznámené události
|
notifiedEvents | array of string |
Oznámení událostí pracovního postupu |
|
|
userId
|
userId | string |
ID uživatele sledovacího nástroje |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Události pracovního postupu, které budou upozorněny na tohoto sledovacího procesu |
|
|
e-mail
|
string |
E-mail sledovacího poradce |
||
|
ID šablony
|
templateId | string |
ID šablony, ze které pracovní postup odvozuje |
|
|
ID rozložení
|
layoutId | string |
Rozložení metadat používané pracovním plánem |
|
|
data1
|
data1 | string |
První metadata |
|
|
data2
|
data2 | string |
Druhá metadata |
|
|
data3
|
data3 | string |
Třetí metadata |
|
|
data4
|
data4 | string |
Čtvrtá metadata |
|
|
data5
|
data5 | string |
Pátá metadata |
|
|
data6
|
data6 | string |
Šestá metadata |
|
|
data7
|
data7 | string |
Sedmá metadata |
|
|
data8
|
data8 | string |
Metadata heighth |
Návraty
- Body
- workflow
Vytvoření profilu podpisu
Vytvoření profilu podpisu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID nájemce
|
tenantId | True | string |
ID tenanta |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
|
Je výchozí
|
isDefault | True | string |
Nastaví tento profil podpisu jako výchozí. |
|
Je zakázané.
|
isDisabled | string |
Zakázat tento profil podpisu |
|
|
Název
|
name | True | string |
Název profilu podpisu |
|
Typ dokumentu
|
documentType | True | string |
pdf, xml, word, excel, powerpoint, jiné |
|
Typ podpisu
|
signatureType | True | string |
pades,xadesDetached,xadesDetachedManifest,cades,helios |
|
Vynucení posouvání do dolní části dokumentu
|
forceScrollDocument | True | boolean |
Vynucení posouvání podepisující osoby do dolní části dokumentu |
|
Režim viditelného podpisu
|
pdfVisibleSignatureMode | string |
Režim viditelného podpisu (povolený, zakázaný, noImage) |
|
|
Text podpisu
|
pdfSignatureImageText | string |
Text zobrazený na panelech podpisů |
|
|
Barva textu podpisu
|
pdfSignatureImageTextColor | string |
Barva textu zobrazeného v oblasti singatures |
|
|
Velikost textu podpisu
|
pdfSignatureImageTextSize | number |
Velikost textu zobrazeného na panelech singaturami |
Návraty
- Body
- signatureProfile
Vytvoření rozložení metadat
Vytvoření rozložení metadat
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID nájemce
|
tenantId | True | string |
ID rozložení |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
|
Název
|
name | True | string |
Název rozložení |
|
Je zakázaný.
|
isDisabled | boolean |
Pokud je nastavená hodnota true, bude rozložení zakázané. |
|
|
štěrbina
|
slot | string |
Položka metadat (data1 až data8) |
|
|
výchozí
|
default | string |
Výchozí hodnota metadat v tomto rozložení |
|
|
optional
|
optional | boolean |
Pokud je hodnota true, zadání hodnoty není povinné. |
|
|
jen pro čtení
|
readonly | boolean |
Wether hodnota může být přepsána |
|
|
zapamatovatLastValue
|
rememberLastValue | boolean |
Pokud je nastavená hodnota true, hodnota se zachová napříč pracovními postupy. |
Návraty
Rozložení metadat
- Body
- layout
Vytvořit část
Vytvoření části dokumentu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID pracovního postupu
|
workflowId | True | string |
ID dotčeného pracovního postupu |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
|
Cotent Disposition
|
Content-Disposition | True | string |
Content-Dispotion |
|
Vytvořit dokument
|
createDocuments | string |
Vytvoření dokumentu z této části |
|
|
Ignorovat přílohy
|
ignoreAttachments | string |
Přílohy budou ignorovány. |
|
|
ID profilu podpisu
|
signatureProfileId | string |
Část považována za přílohu, pokud je vynechána |
|
|
Rozepnout
|
unzip | string |
Rozbalení souborů |
|
|
Pdf do PdfA
|
pdf2pdfa | string |
Převod pdf na pdf/A |
|
|
Dokument
|
document | True | binary |
Nahraná data souboru |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
dokumenty
|
documents | array of document |
Vytvořené dokumenty |
|
ignoredAttachments
|
ignoredAttachments | integer |
ignoredAttachments |
|
části
|
parts | array of part |
části |
Vytvoří kontakt.
Přidání kontaktu do seznamu kontaktů aktuálního uživatele
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID uživatele
|
userId | True | string |
Uživatel, kterému kontakt patří |
|
Typ obsahu
|
Content-Type | True | string |
Typ obsahu |
|
Kontaktní e-mail
|
True | string |
Kontaktní e-mail |
|
|
Telefonní číslo contatct
|
phoneNumber | string |
telefonní číslo |
|
|
Jméno kontaktu
|
firstName | True | string |
křestní jméno |
|
Příjmení kontaktu
|
lastName | True | string |
lastName |
|
Kontaktní země
|
country | string |
země |
Návraty
- Body
- contact
Definice
consentPage
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
Umožňuje používání organizací. |
|
authenticateUser
|
authenticateUser | boolean |
Ukládá ověřování podepisující osoby. |
|
clientId
|
clientId | string |
ID klienta |
|
vytvořil
|
created | number |
Datum vytvoření |
|
emUrl
|
emUrl | string |
Adresa URL vedoucího evidence |
|
hideDownloads
|
hideDownloads | boolean |
Odkazy ke stažení dokumentů se na stránkách souhlasu nezobrazují |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Skryje kódy QR na stránkách constent |
|
identifikační číslo
|
id | string |
ID stránky souhlasu |
|
isCountryRequired
|
isCountryRequired | boolean |
Je země povinná v přihlašovacích údajích. |
|
isDisabled
|
isDisabled | boolean |
Stránka se souhlasem je zakázaná. |
|
logoResourceId
|
logoResourceId | string |
ID prostředku s logem stránky souhlasu |
|
název
|
name | string |
Název stránky souhlasu |
|
primaryColor
|
primaryColor | string |
Primární barva stránky souhlasu |
|
secondaryColor
|
secondaryColor | string |
Sekundární barva stránky souhlasu |
|
sharedPassphrase
|
sharedPassphrase | string |
Sdílené přístupové heslo |
|
režim podepisování
|
signing mode | string |
Režim podepisování (místní nebo server) |
|
stepType
|
stepType | string |
typ kroku (podpis nebo schválení) |
|
tenantId
|
tenantId | string |
ID nájemce |
|
tsaUrl
|
tsaUrl | string |
Adresa URL autority časového razítka |
|
aktualizovaný
|
updated | number |
Datum poslední změny |
|
verifyEmail
|
verifyEmail | boolean |
Pokud je nastavená na tue, podepisující osoby dostanou OTPs e-mailem. |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
Pokud je nastavená hodnota true, podepisující osoby obdrží OTPs podle textových zpráv. |
consentPages
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
celkem položek
|
totalItems | integer |
celkem položek |
kontakt
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
země
|
country | string |
Kontaktní země |
|
vytvořil
|
created | integer |
Datum vytvoření kontaktu |
|
e-mail
|
string |
Kontaktní e-mail |
|
|
křestní jméno
|
firstName | string |
Jméno kontaktu |
|
identifikační číslo
|
id | string |
ID kontaktu |
|
lastName
|
lastName | string |
Jméno posledního kontaktu |
|
název
|
name | string |
Jméno kontaktu (jméno + příjmení)) |
|
telefonní číslo
|
phoneNumber | string |
Kontaktní telefonní číslo |
|
tenantId
|
tenantId | string |
ID nájemce |
|
aktualizovaný
|
updated | integer |
Datum poslední změny kontaktu |
|
userId
|
userId | string |
ID vlastníka kontaktu |
contacts
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
celkem položek
|
totalItems | integer |
celkem položek |
dataMapping
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
popis
|
data1.description | string |
Popis metadat |
|
název
|
data1.name | string |
Název metadat |
|
vzor
|
data1.pattern | string |
Model metadat |
|
options
|
data1.options | array of object |
options |
|
value
|
data1.options.value | string |
Hodnota metadat |
|
typ
|
data1.type | string |
typ |
|
popis
|
data2.description | string |
Popis metadat |
|
název
|
data2.name | string |
Název metadat |
|
vzor
|
data2.pattern | string |
Model metadat |
|
options
|
data2.options | array of object |
options |
|
value
|
data2.options.value | string |
Hodnota metadat |
|
typ
|
data2.type | string |
typ |
|
popis
|
data3.description | string |
Popis metadat |
|
název
|
data3.name | string |
Název metadat |
|
vzor
|
data3.pattern | string |
Model metadat |
|
options
|
data3.options | array of object |
options |
|
value
|
data3.options.value | string |
Hodnota metadat |
|
typ
|
data3.type | string |
typ |
|
popis
|
data4.description | string |
Popis metadat |
|
název
|
data4.name | string |
Název metadat |
|
vzor
|
data4.pattern | string |
Model metadat |
|
options
|
data4.options | array of object |
options |
|
value
|
data4.options.value | string |
Hodnota metadat |
|
typ
|
data4.type | string |
typ |
|
popis
|
data5.description | string |
Popis metadat |
|
název
|
data5.name | string |
Název metadat |
|
vzor
|
data5.pattern | string |
Model metadat |
|
options
|
data5.options | array of object |
options |
|
value
|
data5.options.value | string |
Hodnota metadat |
|
typ
|
data5.type | string |
typ |
|
popis
|
data6.description | string |
Popis metadat |
|
název
|
data6.name | string |
Název metadat |
|
vzor
|
data6.pattern | string |
Model metadat |
|
options
|
data6.options | array of object |
options |
|
value
|
data6.options.value | string |
Hodnota metadat |
|
typ
|
data6.type | string |
typ |
|
popis
|
data7.description | string |
Popis metadat |
|
název
|
data7.name | string |
Název metadat |
|
vzor
|
data7.pattern | string |
Model metadat |
|
options
|
data7.options | array of object |
options |
|
value
|
data7.options.value | string |
Hodnota metadat |
|
typ
|
data7.type | string |
typ |
|
popis
|
data8.description | string |
Popis metadat |
|
název
|
data8.name | string |
Název metadat |
|
vzor
|
data8.pattern | string |
Model metadat |
|
options
|
data8.options | array of object |
options |
|
value
|
data8.options.value | string |
Hodnota metadat |
|
typ
|
data8.type | string |
typ |
dokument
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
vytvořil
|
created | integer |
Datum vytvoření |
|
groupId
|
groupId | string |
ID skupiny vlastníka dokumentu |
|
identifikační číslo
|
id | string |
ID dokumentu |
|
části
|
parts | array of part |
části |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
ID profilu podpisu dokumentu |
|
tenantId
|
tenantId | string |
ID tenanta |
|
aktualizovaný
|
updated | integer |
Datum poslední změny |
|
userId
|
userId | string |
ID uživatele vlastníka dokumentu |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Seznam skupin povolených k zobrazení dokumentu |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
Seznam uživatelů, kteří umožňují zobrazit dokument |
|
workflowId
|
workflowId | string |
ID pracovního postupu, do kterého dokument patří |
|
Název pracovního postupu
|
workflowName | string |
Název pracovního postupu, do kterého dokument patří |
dokumenty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
celkem položek
|
totalItems | integer |
celkem položek |
rozložení
Rozložení metadat
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
vytvořil
|
created | number |
Datum vytvoření |
|
identifikační číslo
|
id | string |
ID rozložení |
|
isDisabled
|
isDisabled | boolean |
Pokud je nastavená hodnota true, rozložení bylo odstraněno. |
|
název
|
name | string |
Název rozložení |
|
tenantId
|
tenantId | string |
ID tenanta |
|
aktualizovaný
|
updated | number |
Datum poslední změny |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
štěrbina
|
dataConfigurations.slot | string |
Položka metadat (data1 až data8) |
|
výchozí
|
dataConfigurations.default | string |
Výchozí hodnota metadat v tomto rozložení |
|
optional
|
dataConfigurations.optional | boolean |
Pokud je hodnota true, zadání hodnoty pro tato metadata není povinné. |
|
jen pro čtení
|
dataConfigurations.readonly | boolean |
Wether hodnota může být přepsána |
|
zapamatovatLastValue
|
dataConfigurations.rememberLastValue | boolean |
Pokud je nastavená hodnota true, hodnota se zachová napříč pracovními postupy. |
nákresy
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
items
|
items | array of object | |
|
vytvořil
|
items.created | number |
Datum vytvoření |
|
dataConfigurations
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
Počet položek na stránku |
|
pageIndex
|
pageIndex | number |
Index vrácené stránky |
|
celkem položek
|
totalItems | number |
Celkový počet položek dotčených žádostí |
part
Část dokumentu
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
typ obsahu
|
contentType | string |
typ obsahu |
|
filename
|
filename | string |
filename |
|
hodnota hash
|
hash | string |
hodnota hash |
|
size
|
size | integer |
size |
pdfSigField
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagePage
|
imagePage | float |
imagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
vytvořil
|
created | number |
Datum vytvoření |
|
documentType
|
documentType | string |
Typ dokumentů |
|
forceScrollDocument
|
forceScrollDocument | boolean |
Vynucení posouvání podepisující osoby do dolní části dokumentu |
|
identifikační číslo
|
id | string |
ID profilu podpisu |
|
isDefault
|
isDefault | boolean |
Nastaví tento profil podpisu jako výchozí. |
|
isDisabled
|
isDisabled | boolean |
Zakázat tento profil podpisu |
|
název
|
name | string |
Název profilu podpisu |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
Text zobrazený na panelech podpisů |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
Barva textu zobrazeného v oblasti singatures |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Velikost textu zobrazeného na panelech singaturami |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Režim viditelného podpisu (povolený, zakázaný, noImage) |
|
Typ podpisu
|
signatureType | string |
pades, xadesDetached, xadesDetachedManifest, cades, helios |
|
tenantId
|
tenantId | string |
ID nájemce |
|
aktualizovaný
|
updated | number |
Datum poslední změny |
signatureProfiles
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
Počet položek na stránku |
|
pageIndex
|
pageIndex | number |
Index vrácené stránky |
|
celkem položek
|
totalItems | number |
Celkový počet položek dotčených žádostí |
uživatel
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
approveAllowed
|
approveAllowed | boolean |
Pokud je nastavená hodnota true, může uživatel schvalovat dokumenty. |
|
země
|
country | string |
Země uživatele |
|
vytvořil
|
created | integer |
Datum vytvoření |
|
e-mail
|
string |
E-mail uživatele |
|
|
křestní jméno
|
firstName | string |
Jméno uživatele |
|
groupId
|
groupId | string |
ID skupiny uživatele |
|
identifikační číslo
|
id | string |
Id uživatele |
|
isDisabled
|
isDisabled | boolean |
Pokud je hodnota true, uživatel je zakázaný. |
|
lastLogin
|
lastLogin | integer |
Datum posledního přihlášení uživatele |
|
lastName
|
lastName | string |
Příjmení uživatele |
|
název
|
name | string |
Jméno (jméno a příjmení) uživatele |
|
organizationTitles
|
organizationTitles | array of |
Funtions uživatele v jeho organizacích |
|
telefonní číslo
|
phoneNumber | string |
Telefonní číslo uživatele |
|
SignAllowed
|
signAllowed | boolean |
Pokud je nastavená hodnota true, může uživatel podepsat dokumenty. |
|
předmět
|
subject | string |
Interní kód podkectu uživatele |
|
tenantId
|
tenantId | string |
ID tenanta |
|
aktualizovaný
|
updated | integer |
Datum poslední změny |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Seznam skupin, ve kterých může uživatel fungovat jako pozorovatel |
pracovní postup
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
vytvořil
|
created | integer |
vytvořil |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
data1
|
data1 | string |
Metadata 1 |
|
data2
|
data2 | string |
Metadata 2 |
|
data3
|
data3 | string |
Metadata 3 |
|
data4
|
data4 | string |
Metadata 4 |
|
data5
|
data5 | string |
Metadata 5 |
|
data6
|
data6 | string |
Metadata 6 |
|
data7
|
data7 | string |
Metadata 7 |
|
data8
|
data8 | string |
Metadata 8 |
|
popis
|
description | string |
Popis pracovního postupu |
|
e-mail
|
string |
E-mail vlastníka pracovního postupu |
|
|
křestní jméno
|
firstName | string |
Jméno vlastníka pracovního postupu |
|
groupId
|
groupId | string |
ID skupiny vlastníka pracovního postupu |
|
identifikační číslo
|
id | string |
ID pracovního postupu |
|
lastName
|
lastName | string |
Příjmení vlastníka pracovního postupu |
|
layoutId
|
layoutId | string |
ID rozložení metadat pracovního postupu |
|
protokoly
|
logs | array of |
Zaznamenává položky wokflow. |
|
název
|
name | string |
Jméno (jméno a příjmení) vlastníka pracovního postupu |
|
notifiedEvents
|
notifiedEvents | array of string |
Lis of events notified by the workflow |
|
pokrok
|
progress | integer |
Průběh pracovního postupu v procentech |
|
steps
|
steps | array of object |
steps |
|
allowComments
|
steps.allowComments | boolean |
Povolí nebo zakáže interaktivní komentáře ara povolené v kroku. |
|
hideAttachments
|
steps.hideAttachments | boolean |
Řídí zobrazení příloh podepisujících |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
Řídí zobrazení ostatních podepisujících uživatelů podepisující osoby. |
|
identifikační číslo
|
steps.id | string |
ID kroku |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
isFinished
|
steps.isFinished | boolean |
isFinished |
|
jeZahájeno
|
steps.isStarted | boolean |
jeZahájeno |
|
protokoly
|
steps.logs | array of |
protokoly |
|
maxInvites
|
steps.maxInvites | integer |
maxInvites |
|
recipients
|
steps.recipients | array of object |
recipients |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
země
|
steps.recipients.country | string |
země |
|
e-mail
|
steps.recipients.email | string |
|
|
křestní jméno
|
steps.recipients.firstName | string |
křestní jméno |
|
lastName
|
steps.recipients.lastName | string |
lastName |
|
telefonní číslo
|
steps.recipients.phoneNumber | string |
telefonní číslo |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredRecipients
|
steps.requiredRecipients | integer |
requiredRecipients |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
validityPeriod
|
steps.validityPeriod | integer |
validityPeriod |
|
tenantId
|
tenantId | string |
tenantId |
|
aktualizovaný
|
updated | integer |
aktualizovaný |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Seznam skupin, ve kterých můžou uživatelé fungovat jako pozorovatelé |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
e-mail
|
watchers.email | string |
|
|
notifiedEvents
|
watchers.notifiedEvents | array of string |
notifiedEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
celkem položek
|
totalItems | integer |
celkem položek |
binární
Toto je základní datový typ Binary.