Sdílet prostřednictvím

Adobe Acrobat Sign

Adobe je nejdůvěryhodnější službou pro podepisování digitálních dokumentů na světě. Pomocí aplikace Adobe Acrobat Sign můžete ručně transformovat procesy do všech digitálních prostředí. Začleňte do svých oblíbených aplikací funkci Adobe Acrobat Sign, abyste mohli vytvářet, odesílat a monitorovat stav smluv.

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 Podpora aplikace Adobe Acrobat Sign
URL https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
Email support@echosign.zendesk.com
Metadata konektoru
Vydavatel ADOBE INC.
Internetová stránka https://acrobat.adobe.com/us/en/sign.html
Zásady ochrany osobních údajů https://www.adobe.com/privacy/policy.html
Kategorie Internetová stránka

Adobe Acrobat Sign

Adobe je nejdůvěryhodnější službou pro podepisování digitálních dokumentů na světě. Pomocí aplikace Adobe Acrobat Sign můžete ručně transformovat procesy do všech digitálních prostředí. Začleňte do svých oblíbených aplikací funkci Adobe Acrobat Sign, abyste mohli vytvářet, odesílat a monitorovat stav smluv.

Vydavatel: Adobe, Inc.

Požadavky

Vyžaduje se účet Adobe Acrobat Sign.

Jak získat přihlašovací údaje

N/A

Začínáme s konektorem

Uživatelská příručka konektoru https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

Známé problémy a omezení

N/A

Běžné chyby a nápravné prostředky

N/A

časté otázky

Uživatelská příručka konektoru https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

Limity omezování

Name Volání Období obnovení
Volání rozhraní API na připojení 250 60 sekund

Akce

Nahrání dokumentu a získání ID dokumentu

Tato operace nahraje dokument do účtu Adobe Acrobat Sign a vrátí pro něj ID dokumentu. Tento dokument je dočasně uložený ve službě Adobe Acrobat Sign a ID dokumentu lze použít k dalším operacím, jako je vytvoření smlouvy.
Nahrání dokumentu a získání ID dokumentu (staré) [ZASTARALÉ]

Tato operace nahraje dokument do účtu Adobe Acrobat Sign a vrátí pro něj ID dokumentu. Tento dokument je dočasně uložený ve službě Adobe Acrobat Sign a ID dokumentu lze použít k dalším operacím, jako je vytvoření smlouvy.
Načtení podpisové adresy URL

Tato operace načte adresu URL pro stránku elektronického podpisu pro aktuální podepisující osoby smlouvy.
Vytvoření smlouvy z adresy URL dokumentu a odeslání podpisu

Tato operace vytvoří smlouvu z dokumentu nahraného v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.
Vytvoření smlouvy z adresy URL dokumentu a odeslání podpisu (staré) [ZASTARALÉ]

Tato operace vytvoří smlouvu z dokumentu nahraného v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.
Vytvoření smlouvy z nahraného dokumentu a odeslání podpisu

Tato operace vytvoří smlouvu z dokumentu nahraného v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.
Vytvoření smlouvy z nahraného dokumentu a odeslání podpisu (staré) [ZASTARALÉ]

Tato operace vytvoří smlouvu z dokumentu nahraného v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.
Vytvoření smlouvy z obsahu souboru a odeslání podpisu

Tato operace vytvoří smlouvu ze souboru v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.
Vytvoření smlouvy z pracovního postupu a odeslání podpisu

Tato operace vytvoří smlouvu z pracovního postupu v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.
Vytvoření smlouvy ze šablony knihovny a odeslání podpisu

Tato operace vytvoří smlouvu ze šablony uložené v knihovně Adobe Acrobat Sign uživatele a odešle ji k podpisu.
Vytvoření smlouvy ze šablony knihovny a odeslání podpisu (staré) [ZASTARALÉ]

Tato operace vytvoří smlouvu ze šablony uložené v knihovně Adobe Acrobat Sign uživatele a odešle ji k podpisu.
Vytvoření šablony knihovny z adresy URL dokumentu

Tato operace vytvoří šablonu v knihovně Adobe Acrobat Sign z adresy URL dokumentu. Tato šablona slouží k odesílání smluv.
Vytvoření šablony knihovny z adresy URL dokumentu (staré) [ZASTARALÉ]

Tato operace vytvoří šablonu v knihovně Adobe Acrobat Sign z adresy URL dokumentu. Tato šablona slouží k odesílání smluv.
Vytvoření šablony knihovny z nahraného dokumentu

Tato operace vytvoří šablonu v knihovně Adobe Acrobat Sign z nahraného dokumentu. Tuto šablonu použijte k odesílání smluv.
Vytvoření šablony knihovny z nahraného dokumentu (starý) [ZASTARALÉ]

Tato operace vytvoří šablonu v knihovně Adobe Acrobat Sign z nahraného dokumentu. Tuto šablonu použijte k odesílání smluv.
Zrušení smlouvy

Zruší smlouvu identifikovanou id smlouvy v cestě.
Získání adresy URL zobrazení smlouvy

Načte nejnovější adresu URL zobrazení stavu smlouvy.
Získání dat pole formuláře smlouvy (staré) [ZASTARALÉ]

Načte data zadaná do polí interaktivního formuláře smlouvy.
Získání dat pole formuláře smlouvy ve formátu JSON

Načte data zadaná do polí interaktivního formuláře smlouvy.
Získání dat polí formuláře smlouvy ve formátu CSV

Načte data zadaná do polí interaktivního formuláře smlouvy.
Získání dokumentu ze smlouvy

Tato operace načte datový proud souboru konkrétního dokumentu smlouvy.
Získání dokumentu ze smlouvy [ZASTARALÉ]

Tato akce je zastaralá. Místo toho použijte možnost Získat dokument ze smlouvy .

Tato operace načte datový proud souboru konkrétního dokumentu smlouvy.
Získání PDF podepsané smlouvy

Tato operace načte datový proud souboru PDF kombinované nebo podepsané smlouvy. Všimněte si, že datový proud souboru by měl být uložen s názvem souboru končícím .pdf příponou souboru.
Získání PDF podepsané smlouvy [ZASTARALÉ]

Tato akce je zastaralá. Místo toho použijte get a PDF of a signed agreement .

Tato operace načte datový proud souboru PDF kombinované nebo podepsané smlouvy. Všimněte si, že datový proud souboru by měl být uložen s názvem souboru končícím .pdf příponou souboru.
Získání PDF záznamu o auditu smlouvy

Tato operace načte datový proud souboru PDF záznamu auditu smlouvy. Všimněte si, že datový proud souboru by měl být uložen s názvem souboru končícím .pdf příponou souboru.
Získání podrobných informací o pracovním postupu

Tato operace načte podrobné informace o pracovním postupu.
Získání seznamu všech ID dokumentů ze smlouvy

Tato operace načte ID všech dokumentů a podpůrných dokumentů smlouvy.
Získání seznamu všech ID dokumentů ze smlouvy [ZASTARALÉ]

Tato akce je zastaralá. Místo toho použijte možnost Získat seznam všech ID dokumentů ze smlouvy .

Tato operace načte ID všech dokumentů a podpůrných dokumentů smlouvy.
Získání seznamu všech pracovních postupů

Tato operace načte seznam všech pracovních postupů uživatele.
Získání seznamu všech skupin, do nichž uživatel patří

Tato operace načte seznam všech uživatelů skupin, do nichž patří.
Získání seznamu všech smluv

Tato operace načte seznam všech smluv uživatele.
Získání seznamu všech smluv (staré) [ZASTARALÉ]

Tato operace načte seznam všech smluv uživatele.
Získání seznamu všech smluv na základě kritérií hledání

Tato operace vyhledává smlouvy podle kritérií, jako je ID pracovního postupu atd.
Získání seznamu všech webových formulářů

Tato operace načte seznam všech webových formulářů uživatele.
Získání seznamu všech šablon knihoven

Tato operace načte seznam všech dokumentů uložených jako šablony v knihovně Adobe Acrobat Sign uživatele.
Získání seznamu všech šablon knihoven (staré) [ZASTARALÉ]

Tato operace načte seznam všech dokumentů uložených jako šablony v knihovně Adobe Acrobat Sign uživatele.
Získání stavu smlouvy

Tato operace načte všechny aktuální informace smlouvy, například stav.
Získání stavu smlouvy [ZASTARALÉ]

Tato akce je zastaralá. Použijte místo toho stav smlouvy .

Tato operace načte všechny aktuální informace smlouvy, například stav.

Nahrání dokumentu a získání ID dokumentu

ID operace:
CreateTransientDocument_V2

Tato operace nahraje dokument do účtu Adobe Acrobat Sign a vrátí pro něj ID dokumentu. Tento dokument je dočasně uložený ve službě Adobe Acrobat Sign a ID dokumentu lze použít k dalším operacím, jako je vytvoření smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
Název souboru
 File-Name True string

Název dokumentu, který se má nahrát, s příponou
Obsah souboru
 File True contentOnly

Datový proud souboru dokumentu, který se má nahrát
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com

Návraty

JSON obsahující ID nahraného dokumentu

Body
TransientDocumentResponse

Nahrání dokumentu a získání ID dokumentu (staré) [ZASTARALÉ]

ID operace:
CreateTransientDocument

Tato operace nahraje dokument do účtu Adobe Acrobat Sign a vrátí pro něj ID dokumentu. Tento dokument je dočasně uložený ve službě Adobe Acrobat Sign a ID dokumentu lze použít k dalším operacím, jako je vytvoření smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
Název souboru
 File-Name True string

Název dokumentu, který se má nahrát, s příponou
Obsah souboru
 File True contentOnly

Datový proud souboru dokumentu, který se má nahrát

Návraty

JSON obsahující ID nahraného dokumentu

Body
TransientDocumentResponse

Načtení podpisové adresy URL

ID operace:
GetSigningUrls

Tato operace načte adresu URL pro stránku elektronického podpisu pro aktuální podepisující osoby smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy poskytnuté akcí, která vytvoří smlouvu
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com

Návraty

Body
SigningUrlResponse

Vytvoření smlouvy z adresy URL dokumentu a odeslání podpisu

ID operace:
CreateAgreementByUrl_V2

Tato operace vytvoří smlouvu z dokumentu nahraného v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.

Parametry

Name Klíč Vyžadováno Typ Description
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název smlouvy
 name True string

Název smlouvy
URL
 url True string

Veřejně přístupná adresa URL pro načtení obsahu nezpracovaného souboru
Název
 name True string

Původní systémový název odesílaného dokumentu
Typ
 mimeType True string

Typ MIME odkazovaného souboru, např. application/pdf
Typ podpisu
 signatureType True string

Určuje požadovaný typ podpisu – podpis e-podpis nebo zápis.
Email
 email True string

E-mail účastníka
Autentizace
 authenticationMethod string

Výchozí ověřování: e-mail (žádný)
Heslo
 password string

Heslo požadované pro účastníka
Kód země
 countryCode string

Kód země telefonu příjemce vyžadovaný k zobrazení a podepsání dokumentu
Telefon Ne.
 phone string

Telefonní číslo příjemce potřebné k zobrazení a podepsání smlouvy
ID poskytovatele
 providerId string

ID zprostředkovatele brány digitální identity
Objednávka
 order True integer

Index začíná číslem 1, což označuje pozici, ve které se podpisová skupina musí podepsat.
Role
 role True string

Aktuální role sady účastníků (podepisující, schvalovatel atd.).
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).
Message
 message string

Volitelná zpráva příjemcům, kteří požadují svou akci
Typ odeslání
 sendType string

Typ zkušeností používaných odesílatelem k odeslání smlouvy
Email
 email string

E-mail kopie smlouvy
Čas vypršení platnosti
 expirationTime string

Čas, po jehož uplynutí platnost smlouvy vyprší. Příklad: 2020-12-31T23:59:00Z
Externí ID
 externalId string

Libovolná hodnota z vašeho systému
Frekvence připomenutí
 reminderFrequency string

Jak často chcete odesílat připomenutí?
Heslo dokumentu
 openPassword string

Heslo, které se má použít k šifrování podepsané smlouvy PDF
Název
 fieldName string

Název pole
Hodnota
 defaultValue string

Výchozí hodnota pole
Zpoždění přesměrování
 redirectDelay string

Zpoždění (v sekundách) před tím, než se uživatel přesune na stránku úspěchu.
Adresa URL pro přesměrování
 redirectUrl string

Adresa URL pro přesměrování po dokončení procesu podepisování, např. https://adobe.com
Počáteční e-maily
 initEmails string

Řízení e-mailů s oznámeními o událostech inicializace smlouvy
Stát
 state True string

Stát, ve kterém by dohoda měla přistát.

Návraty

JSON obsahující ID nově vytvořené smlouvy

Body
AgreementCreationResponseV6

Vytvoření smlouvy z adresy URL dokumentu a odeslání podpisu (staré) [ZASTARALÉ]

ID operace:
CreateAgreementByUrl

Tato operace vytvoří smlouvu z dokumentu nahraného v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.

Parametry

Name Klíč Vyžadováno Typ Description
Název smlouvy
 name True string

Název smlouvy
URL
 url True string

Veřejně přístupná adresa URL pro načtení dokumentu
Název
 name True string

Název odkazovaného dokumentu s příponou
Typ podpisu
 signatureType True string

Typ podpisu, který chcete požádat – podpis e-podpis nebo zápis
E-mail příjemce
 email True string

E-mail příjemce
Podpisová objednávka příjemce
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce
 recipientSetRole True string

Určení role příjemce
Message
 message string

Volitelná zpráva příjemcům, kteří požadují svou akci
Dny do konečného termínu
 daysUntilSigningDeadline integer

Počet dnů, které zůstávají před vypršením platnosti dokumentu
Frekvence připomenutí
 reminderFrequency string

Jak často chcete odesílat připomenutí?
Heslo dokumentu
 openPassword string

Heslo, které se má použít k šifrování podepsané smlouvy PDF
Adresa URL (2)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (2)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (3)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (3)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (4)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (4)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (5)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (5)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (6)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (6)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (7)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (7)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (8)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (8)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (9)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (9)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (10)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (10)
 name string

Název odkazovaného dokumentu s příponou
E-mail příjemce (2)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (2)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (2)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (3)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (3)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (3)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (4)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (4)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (4)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (5)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (5)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (5)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (6)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (6)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (6)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (7)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (7)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (7)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (8)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (8)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (8)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (9)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (9)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (9)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (10)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (10)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (10)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (11)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (11)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (11)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (12)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (12)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (12)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (13)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (13)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (13)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (14)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (14)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (14)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (15)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (15)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (15)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (16)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (16)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (16)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (17)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (17)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (17)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (18)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (18)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (18)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (19)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (19)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (19)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (20)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (20)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (20)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (21)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (21)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (21)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (22)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (22)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (22)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (23)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (23)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (23)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (24)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (24)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (24)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (25)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (25)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (25)
 recipientSetRole True string

Určení role příjemce
Název pole formuláře (1)
 fieldName string

Název pole
Hodnota pole formuláře (1)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (2)
 fieldName string

Název pole
Hodnota pole formuláře (2)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (3)
 fieldName string

Název pole
Hodnota pole formuláře (3)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (4)
 fieldName string

Název pole
Hodnota pole formuláře (4)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (5)
 fieldName string

Název pole
Hodnota pole formuláře (5)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (6)
 fieldName string

Název pole
Hodnota pole formuláře (6)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (7)
 fieldName string

Název pole
Hodnota pole formuláře (7)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (8)
 fieldName string

Název pole
Hodnota pole formuláře (8)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (9)
 fieldName string

Název pole
Hodnota pole formuláře (9)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (10)
 fieldName string

Název pole
Hodnota pole formuláře (10)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (11)
 fieldName string

Název pole
Hodnota pole formuláře (11)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (12)
 fieldName string

Název pole
Hodnota pole formuláře (12)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (13)
 fieldName string

Název pole
Hodnota pole formuláře (13)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (14)
 fieldName string

Název pole
Hodnota pole formuláře (14)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (15)
 fieldName string

Název pole
Hodnota pole formuláře (15)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (16)
 fieldName string

Název pole
Hodnota pole formuláře (16)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (17)
 fieldName string

Název pole
Hodnota pole formuláře (17)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (18)
 fieldName string

Název pole
Hodnota pole formuláře (18)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (19)
 fieldName string

Název pole
Hodnota pole formuláře (19)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (20)
 fieldName string

Název pole
Hodnota pole formuláře (20)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (21)
 fieldName string

Název pole
Hodnota pole formuláře (21)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (22)
 fieldName string

Název pole
Hodnota pole formuláře (22)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (23)
 fieldName string

Název pole
Hodnota pole formuláře (23)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (24)
 fieldName string

Název pole
Hodnota pole formuláře (24)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (25)
 fieldName string

Název pole
Hodnota pole formuláře (25)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (26)
 fieldName string

Název pole
Hodnota pole formuláře (26)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (27)
 fieldName string

Název pole
Hodnota pole formuláře (27)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (28)
 fieldName string

Název pole
Hodnota pole formuláře (28)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (29)
 fieldName string

Název pole
Hodnota pole formuláře (29)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (30)
 fieldName string

Název pole
Hodnota pole formuláře (30)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (31)
 fieldName string

Název pole
Hodnota pole formuláře (31)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (32)
 fieldName string

Název pole
Hodnota pole formuláře (32)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (33)
 fieldName string

Název pole
Hodnota pole formuláře (33)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (34)
 fieldName string

Název pole
Hodnota pole formuláře (34)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (35)
 fieldName string

Název pole
Hodnota pole formuláře (35)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (36)
 fieldName string

Název pole
Hodnota pole formuláře (36)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (37)
 fieldName string

Název pole
Hodnota pole formuláře (37)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (38)
 fieldName string

Název pole
Hodnota pole formuláře (38)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (39)
 fieldName string

Název pole
Hodnota pole formuláře (39)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (40)
 fieldName string

Název pole
Hodnota pole formuláře (40)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (41)
 fieldName string

Název pole
Hodnota pole formuláře (41)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (42)
 fieldName string

Název pole
Hodnota pole formuláře (42)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (43)
 fieldName string

Název pole
Hodnota pole formuláře (43)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (44)
 fieldName string

Název pole
Hodnota pole formuláře (44)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (45)
 fieldName string

Název pole
Hodnota pole formuláře (45)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (46)
 fieldName string

Název pole
Hodnota pole formuláře (46)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (47)
 fieldName string

Název pole
Hodnota pole formuláře (47)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (48)
 fieldName string

Název pole
Hodnota pole formuláře (48)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (49)
 fieldName string

Název pole
Hodnota pole formuláře (49)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (50)
 fieldName string

Název pole
Hodnota pole formuláře (50)
 defaultValue string

Výchozí hodnota pole

Návraty

JSON obsahující ID nově vytvořené smlouvy

Body
AgreementCreationResponse

Vytvoření smlouvy z nahraného dokumentu a odeslání podpisu

ID operace:
CreateAgreementById_V2

Tato operace vytvoří smlouvu z dokumentu nahraného v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.

Parametry

Name Klíč Vyžadováno Typ Description
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název smlouvy
 name True string

Název smlouvy
ID
 transientDocumentId True string

ID dokumentu přijaté odesláním přechodného dokumentu
Typ podpisu
 signatureType True string

Typ podpisu, který chcete požádat – e-podpis nebo zápis
Email
 email True string

E-mail účastníka
Autentizace
 authenticationMethod string

Výchozí ověřování: e-mail (žádný)
Heslo
 password string

Heslo požadované pro účastníka
Kód země
 countryCode string

Kód země telefonu příjemce vyžadovaný k zobrazení a podepsání dokumentu
Telefon Ne.
 phone string

Telefonní číslo příjemce potřebné k zobrazení a podepsání smlouvy
ID poskytovatele
 providerId string

ID zprostředkovatele brány digitální identity
Objednávka
 order True integer

Index začíná číslem 1, což označuje pozici, ve které se podpisová skupina musí podepsat.
Role
 role True string

Aktuální role sady účastníků (podepisující, schvalovatel atd.).
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).
Message
 message string

Volitelná zpráva příjemcům, kteří požadují svou akci
Typ odeslání
 sendType string

Typ zkušeností používaných odesílatelem k odeslání smlouvy
Email
 email string

E-mail kopie smlouvy
Čas vypršení platnosti
 expirationTime string

Čas, po jehož uplynutí platnost smlouvy vyprší. Příklad: 2020-12-31T23:59:00Z
Externí ID
 externalId string

Libovolná hodnota z vašeho systému
Frekvence připomenutí
 reminderFrequency string

Jak často chcete odesílat připomenutí?
Heslo dokumentu
 openPassword string

Heslo, které se má použít k šifrování podepsané smlouvy PDF
Název
 fieldName string

Název pole
Hodnota
 defaultValue string

Výchozí hodnota pole
Zpoždění přesměrování
 redirectDelay string

Zpoždění (v sekundách) před tím, než se uživatel přesune na stránku úspěchu.
Adresa URL pro přesměrování
 redirectUrl string

Adresa URL pro přesměrování po dokončení procesu podepisování, např. https://adobe.com
Počáteční e-maily
 initEmails string

Řízení e-mailů s oznámeními o událostech inicializace smlouvy
Stát
 state True string

Stát, ve kterém by dohoda měla přistát.

Návraty

JSON obsahující ID nově vytvořené smlouvy

Body
AgreementCreationResponseV6

Vytvoření smlouvy z nahraného dokumentu a odeslání podpisu (staré) [ZASTARALÉ]

ID operace:
CreateAgreementById

Tato operace vytvoří smlouvu z dokumentu nahraného v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.

Parametry

Name Klíč Vyžadováno Typ Description
Název smlouvy
 name True string

Název smlouvy
ID dokumentu
 transientDocumentId True string

ID dokumentu přijaté odesláním dokumentu
Typ podpisu
 signatureType True string

Typ podpisu, který chcete požádat – podpis e-podpis nebo zápis
E-mail příjemce
 email True string

E-mail příjemce
Podpisová objednávka příjemce
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce
 recipientSetRole True string

Určení role příjemce
Message
 message string

Volitelná zpráva příjemcům, kteří požadují svou akci
Dny do konečného termínu
 daysUntilSigningDeadline integer

Počet dnů, které zůstávají před vypršením platnosti dokumentu
Frekvence připomenutí
 reminderFrequency string

Jak často chcete odesílat připomenutí?
Heslo dokumentu
 openPassword string

Heslo, které se má použít k šifrování podepsané smlouvy PDF
ID dokumentu (2)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (3)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (4)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (5)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (6)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (7)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (8)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (9)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (10)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
E-mail příjemce (2)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (2)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (2)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (3)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (3)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (3)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (4)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (4)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (4)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (5)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (5)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (5)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (6)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (6)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (6)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (7)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (7)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (7)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (8)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (8)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (8)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (9)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (9)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (9)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (10)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (10)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (10)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (11)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (11)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (11)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (12)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (12)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (12)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (13)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (13)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (13)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (14)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (14)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (14)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (15)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (15)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (15)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (16)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (16)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (16)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (17)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (17)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (17)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (18)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (18)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (18)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (19)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (19)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (19)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (20)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (20)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (20)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (21)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (21)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (21)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (22)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (22)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (22)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (23)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (23)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (23)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (24)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (24)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (24)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (25)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (25)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (25)
 recipientSetRole True string

Určení role příjemce
Název pole formuláře (1)
 fieldName string

Název pole
Hodnota pole formuláře (1)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (2)
 fieldName string

Název pole
Hodnota pole formuláře (2)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (3)
 fieldName string

Název pole
Hodnota pole formuláře (3)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (4)
 fieldName string

Název pole
Hodnota pole formuláře (4)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (5)
 fieldName string

Název pole
Hodnota pole formuláře (5)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (6)
 fieldName string

Název pole
Hodnota pole formuláře (6)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (7)
 fieldName string

Název pole
Hodnota pole formuláře (7)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (8)
 fieldName string

Název pole
Hodnota pole formuláře (8)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (9)
 fieldName string

Název pole
Hodnota pole formuláře (9)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (10)
 fieldName string

Název pole
Hodnota pole formuláře (10)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (11)
 fieldName string

Název pole
Hodnota pole formuláře (11)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (12)
 fieldName string

Název pole
Hodnota pole formuláře (12)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (13)
 fieldName string

Název pole
Hodnota pole formuláře (13)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (14)
 fieldName string

Název pole
Hodnota pole formuláře (14)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (15)
 fieldName string

Název pole
Hodnota pole formuláře (15)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (16)
 fieldName string

Název pole
Hodnota pole formuláře (16)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (17)
 fieldName string

Název pole
Hodnota pole formuláře (17)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (18)
 fieldName string

Název pole
Hodnota pole formuláře (18)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (19)
 fieldName string

Název pole
Hodnota pole formuláře (19)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (20)
 fieldName string

Název pole
Hodnota pole formuláře (20)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (21)
 fieldName string

Název pole
Hodnota pole formuláře (21)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (22)
 fieldName string

Název pole
Hodnota pole formuláře (22)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (23)
 fieldName string

Název pole
Hodnota pole formuláře (23)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (24)
 fieldName string

Název pole
Hodnota pole formuláře (24)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (25)
 fieldName string

Název pole
Hodnota pole formuláře (25)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (26)
 fieldName string

Název pole
Hodnota pole formuláře (26)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (27)
 fieldName string

Název pole
Hodnota pole formuláře (27)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (28)
 fieldName string

Název pole
Hodnota pole formuláře (28)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (29)
 fieldName string

Název pole
Hodnota pole formuláře (29)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (30)
 fieldName string

Název pole
Hodnota pole formuláře (30)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (31)
 fieldName string

Název pole
Hodnota pole formuláře (31)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (32)
 fieldName string

Název pole
Hodnota pole formuláře (32)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (33)
 fieldName string

Název pole
Hodnota pole formuláře (33)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (34)
 fieldName string

Název pole
Hodnota pole formuláře (34)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (35)
 fieldName string

Název pole
Hodnota pole formuláře (35)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (36)
 fieldName string

Název pole
Hodnota pole formuláře (36)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (37)
 fieldName string

Název pole
Hodnota pole formuláře (37)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (38)
 fieldName string

Název pole
Hodnota pole formuláře (38)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (39)
 fieldName string

Název pole
Hodnota pole formuláře (39)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (40)
 fieldName string

Název pole
Hodnota pole formuláře (40)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (41)
 fieldName string

Název pole
Hodnota pole formuláře (41)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (42)
 fieldName string

Název pole
Hodnota pole formuláře (42)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (43)
 fieldName string

Název pole
Hodnota pole formuláře (43)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (44)
 fieldName string

Název pole
Hodnota pole formuláře (44)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (45)
 fieldName string

Název pole
Hodnota pole formuláře (45)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (46)
 fieldName string

Název pole
Hodnota pole formuláře (46)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (47)
 fieldName string

Název pole
Hodnota pole formuláře (47)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (48)
 fieldName string

Název pole
Hodnota pole formuláře (48)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (49)
 fieldName string

Název pole
Hodnota pole formuláře (49)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (50)
 fieldName string

Název pole
Hodnota pole formuláře (50)
 defaultValue string

Výchozí hodnota pole

Návraty

JSON obsahující ID nově vytvořené smlouvy

Body
AgreementCreationResponse

Vytvoření smlouvy z obsahu souboru a odeslání podpisu

ID operace:
CreateAgreementByFileStream

Tato operace vytvoří smlouvu ze souboru v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.

Parametry

Name Klíč Vyžadováno Typ Description
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název smlouvy
 name True string

Název smlouvy
Název
 fileName True string

Název dokumentu, který se má nahrát, s příponou
Content
 formData True byte

Datový proud souboru dokumentu, který se má nahrát
Typ podpisu
 signatureType True string

Typ podpisu, který chcete požádat – e-podpis nebo zápis
Email
 email True string

E-mail účastníka
Autentizace
 authenticationMethod string

Výchozí ověřování: e-mail (žádný)
Heslo
 password string

Heslo požadované pro účastníka
Kód země
 countryCode string

Kód země telefonu příjemce vyžadovaný k zobrazení a podepsání dokumentu
Telefon Ne.
 phone string

Telefonní číslo příjemce potřebné k zobrazení a podepsání smlouvy
ID poskytovatele
 providerId string

ID zprostředkovatele brány digitální identity
Objednávka
 order True integer

Index začíná číslem 1, což označuje pozici, ve které se podpisová skupina musí podepsat.
Role
 role True string

Aktuální role sady účastníků (podepisující, schvalovatel atd.).
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).
Message
 message string

Volitelná zpráva příjemcům, kteří požadují svou akci
Typ odeslání
 sendType string

Typ zkušeností používaných odesílatelem k odeslání smlouvy
Email
 email string

E-mail kopie smlouvy
Čas vypršení platnosti
 expirationTime string

Čas, po jehož uplynutí platnost smlouvy vyprší. Příklad: 2020-12-31T23:59:00Z
Externí ID
 externalId string

Libovolná hodnota z vašeho systému
Frekvence připomenutí
 reminderFrequency string

Jak často chcete odesílat připomenutí?
Heslo dokumentu
 openPassword string

Heslo, které se má použít k šifrování podepsané smlouvy PDF
Název
 fieldName string

Název pole
Hodnota
 defaultValue string

Výchozí hodnota pole
Zpoždění přesměrování
 redirectDelay string

Zpoždění (v sekundách) před tím, než se uživatel přesune na stránku úspěchu.
Adresa URL pro přesměrování
 redirectUrl string

Adresa URL pro přesměrování po dokončení procesu podepisování, např. https://adobe.com
Počáteční e-maily
 initEmails string

Řízení e-mailů s oznámeními o událostech inicializace smlouvy
Stát
 state True string

Stát, ve kterém by dohoda měla přistát.

Návraty

JSON obsahující ID nově vytvořené smlouvy

Body
AgreementCreationResponseV6

Vytvoření smlouvy z pracovního postupu a odeslání podpisu

ID operace:
CreateAgreementFromWorkflow

Tato operace vytvoří smlouvu z pracovního postupu v aplikaci Adobe Acrobat Sign a odešle ji k podpisu.

Parametry

Name Klíč Vyžadováno Typ Description
V názvu
 x-api-user True string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název nebo ID skupiny
 groupId True string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).
Název nebo ID pracovního postupu
 workflowIdParam True string

V seznamu vyberte vlastní pracovní postup nebo zadejte vlastní ID pracovního postupu.
agreementWorkflowSchema
 agreementWorkflowSchema True dynamic

Podrobnosti pro vybranou událost

Návraty

JSON obsahující ID nově vytvořené smlouvy

Body
AgreementCreationResponseV6

Vytvoření smlouvy ze šablony knihovny a odeslání podpisu

ID operace:
CreateAgreementByTemplate_V2

Tato operace vytvoří smlouvu ze šablony uložené v knihovně Adobe Acrobat Sign uživatele a odešle ji k podpisu.

Parametry

Name Klíč Vyžadováno Typ Description
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název smlouvy
 name True string

Název smlouvy
Template
 libraryDocumentId True string

Volba dokumentu ze šablon uložených v knihovně
Typ podpisu
 signatureType True string

Typ podpisu, který chcete požádat – e-podpis nebo zápis
Email
 email True string

E-mail účastníka
Autentizace
 authenticationMethod string

Výchozí ověřování: e-mail (žádný)
Heslo
 password string

Heslo požadované pro účastníka
Kód země
 countryCode string

Kód země telefonu příjemce vyžadovaný k zobrazení a podepsání dokumentu
Telefon Ne.
 phone string

Telefonní číslo příjemce potřebné k zobrazení a podepsání smlouvy
ID poskytovatele
 providerId string

ID zprostředkovatele brány digitální identity
Objednávka
 order True integer

Index začíná číslem 1, což označuje pozici, ve které se podpisová skupina musí podepsat.
Role
 role True string

Aktuální role sady účastníků (podepisující, schvalovatel atd.).
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).
Message
 message string

Volitelná zpráva příjemcům, kteří požadují svou akci
Typ odeslání
 sendType string

Typ zkušeností používaných odesílatelem k odeslání smlouvy
Email
 email string

E-mail kopie smlouvy
Čas vypršení platnosti
 expirationTime string

Čas, po jehož uplynutí platnost smlouvy vyprší. Příklad: 2020-12-31T23:59:00Z
Externí ID
 externalId string

Libovolná hodnota z vašeho systému
Frekvence připomenutí
 reminderFrequency string

Jak často chcete odesílat připomenutí?
Heslo dokumentu
 openPassword string

Heslo, které se má použít k šifrování podepsané smlouvy PDF
Název
 fieldName string

Název pole
Hodnota
 defaultValue string

Výchozí hodnota pole
Zpoždění přesměrování
 redirectDelay string

Zpoždění (v sekundách) před tím, než se uživatel přesune na stránku úspěchu.
Adresa URL pro přesměrování
 redirectUrl string

Adresa URL pro přesměrování po dokončení procesu podepisování, např. https://adobe.com
Počáteční e-maily
 initEmails string

Řízení e-mailů s oznámeními o událostech inicializace smlouvy
Stát
 state True string

Stát, ve kterém by dohoda měla přistát.

Návraty

JSON obsahující ID nově vytvořené smlouvy

Body
AgreementCreationResponseV6

Vytvoření smlouvy ze šablony knihovny a odeslání podpisu (staré) [ZASTARALÉ]

ID operace:
CreateAgreementByTemplate

Tato operace vytvoří smlouvu ze šablony uložené v knihovně Adobe Acrobat Sign uživatele a odešle ji k podpisu.

Parametry

Name Klíč Vyžadováno Typ Description
Název smlouvy
 name True string

Název smlouvy
Šablona knihovny dokumentů
 libraryDocumentId True string

Volba dokumentu ze šablon uložených v knihovně
Typ podpisu
 signatureType True string

Typ podpisu, který chcete požádat – podpis e-podpis nebo zápis
E-mail příjemce
 email True string

E-mail příjemce
Podpisová objednávka příjemce
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce
 recipientSetRole True string

Určení role příjemce
Message
 message string

Volitelná zpráva příjemcům, kteří požadují svou akci
Dny do konečného termínu
 daysUntilSigningDeadline integer

Počet dnů, které zůstávají před vypršením platnosti dokumentu
Frekvence připomenutí
 reminderFrequency string

Jak často chcete odesílat připomenutí?
Heslo dokumentu
 openPassword string

Heslo, které se má použít k šifrování podepsané smlouvy PDF
Šablona knihovny dokumentů (2)
 libraryDocumentId string

Volba dokumentu ze šablon uložených v knihovně
Šablona knihovny dokumentů (3)
 libraryDocumentId string

Volba dokumentu ze šablon uložených v knihovně
Šablona knihovny dokumentů (4)
 libraryDocumentId string

Volba dokumentu ze šablon uložených v knihovně
Šablona knihovny dokumentů (5)
 libraryDocumentId string

Volba dokumentu ze šablon uložených v knihovně
Šablona knihovny dokumentů (6)
 libraryDocumentId string

Volba dokumentu ze šablon uložených v knihovně
Šablona knihovny dokumentů (7)
 libraryDocumentId string

Volba dokumentu ze šablon uložených v knihovně
Šablona knihovny dokumentů (8)
 libraryDocumentId string

Volba dokumentu ze šablon uložených v knihovně
Šablona knihovny dokumentů (9)
 libraryDocumentId string

Volba dokumentu ze šablon uložených v knihovně
Šablona knihovny dokumentů (10)
 libraryDocumentId string

Volba dokumentu ze šablon uložených v knihovně
E-mail příjemce (2)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (2)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (2)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (3)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (3)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (3)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (4)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (4)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (4)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (5)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (5)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (5)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (6)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (6)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (6)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (7)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (7)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (7)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (8)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (8)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (8)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (9)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (9)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (9)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (10)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (10)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (10)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (11)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (11)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (11)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (12)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (12)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (12)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (13)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (13)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (13)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (14)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (14)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (14)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (15)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (15)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (15)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (16)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (16)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (16)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (17)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (17)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (17)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (18)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (18)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (18)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (19)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (19)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (19)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (20)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (20)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (20)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (21)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (21)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (21)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (22)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (22)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (22)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (23)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (23)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (23)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (24)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (24)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (24)
 recipientSetRole True string

Určení role příjemce
E-mail příjemce (25)
 email True string

E-mail příjemce
Podpisová objednávka příjemce (25)
 signingOrder True integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Role příjemce (25)
 recipientSetRole True string

Určení role příjemce
Název pole formuláře (1)
 fieldName string

Název pole
Hodnota pole formuláře (1)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (2)
 fieldName string

Název pole
Hodnota pole formuláře (2)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (3)
 fieldName string

Název pole
Hodnota pole formuláře (3)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (4)
 fieldName string

Název pole
Hodnota pole formuláře (4)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (5)
 fieldName string

Název pole
Hodnota pole formuláře (5)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (6)
 fieldName string

Název pole
Hodnota pole formuláře (6)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (7)
 fieldName string

Název pole
Hodnota pole formuláře (7)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (8)
 fieldName string

Název pole
Hodnota pole formuláře (8)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (9)
 fieldName string

Název pole
Hodnota pole formuláře (9)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (10)
 fieldName string

Název pole
Hodnota pole formuláře (10)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (11)
 fieldName string

Název pole
Hodnota pole formuláře (11)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (12)
 fieldName string

Název pole
Hodnota pole formuláře (12)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (13)
 fieldName string

Název pole
Hodnota pole formuláře (13)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (14)
 fieldName string

Název pole
Hodnota pole formuláře (14)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (15)
 fieldName string

Název pole
Hodnota pole formuláře (15)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (16)
 fieldName string

Název pole
Hodnota pole formuláře (16)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (17)
 fieldName string

Název pole
Hodnota pole formuláře (17)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (18)
 fieldName string

Název pole
Hodnota pole formuláře (18)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (19)
 fieldName string

Název pole
Hodnota pole formuláře (19)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (20)
 fieldName string

Název pole
Hodnota pole formuláře (20)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (21)
 fieldName string

Název pole
Hodnota pole formuláře (21)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (22)
 fieldName string

Název pole
Hodnota pole formuláře (22)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (23)
 fieldName string

Název pole
Hodnota pole formuláře (23)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (24)
 fieldName string

Název pole
Hodnota pole formuláře (24)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (25)
 fieldName string

Název pole
Hodnota pole formuláře (25)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (26)
 fieldName string

Název pole
Hodnota pole formuláře (26)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (27)
 fieldName string

Název pole
Hodnota pole formuláře (27)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (28)
 fieldName string

Název pole
Hodnota pole formuláře (28)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (29)
 fieldName string

Název pole
Hodnota pole formuláře (29)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (30)
 fieldName string

Název pole
Hodnota pole formuláře (30)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (31)
 fieldName string

Název pole
Hodnota pole formuláře (31)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (32)
 fieldName string

Název pole
Hodnota pole formuláře (32)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (33)
 fieldName string

Název pole
Hodnota pole formuláře (33)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (34)
 fieldName string

Název pole
Hodnota pole formuláře (34)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (35)
 fieldName string

Název pole
Hodnota pole formuláře (35)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (36)
 fieldName string

Název pole
Hodnota pole formuláře (36)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (37)
 fieldName string

Název pole
Hodnota pole formuláře (37)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (38)
 fieldName string

Název pole
Hodnota pole formuláře (38)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (39)
 fieldName string

Název pole
Hodnota pole formuláře (39)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (40)
 fieldName string

Název pole
Hodnota pole formuláře (40)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (41)
 fieldName string

Název pole
Hodnota pole formuláře (41)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (42)
 fieldName string

Název pole
Hodnota pole formuláře (42)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (43)
 fieldName string

Název pole
Hodnota pole formuláře (43)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (44)
 fieldName string

Název pole
Hodnota pole formuláře (44)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (45)
 fieldName string

Název pole
Hodnota pole formuláře (45)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (46)
 fieldName string

Název pole
Hodnota pole formuláře (46)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (47)
 fieldName string

Název pole
Hodnota pole formuláře (47)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (48)
 fieldName string

Název pole
Hodnota pole formuláře (48)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (49)
 fieldName string

Název pole
Hodnota pole formuláře (49)
 defaultValue string

Výchozí hodnota pole
Název pole formuláře (50)
 fieldName string

Název pole
Hodnota pole formuláře (50)
 defaultValue string

Výchozí hodnota pole

Návraty

JSON obsahující ID nově vytvořené smlouvy

Body
AgreementCreationResponse

Vytvoření šablony knihovny z adresy URL dokumentu

ID operace:
CreateLibraryDocumentByUrl_V2

Tato operace vytvoří šablonu v knihovně Adobe Acrobat Sign z adresy URL dokumentu. Tato šablona slouží k odesílání smluv.

Parametry

Name Klíč Vyžadováno Typ Description
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název šablony
 name True string

Název smlouvy sloužící k identifikaci šablony
Typ šablony
 templateTypes True array of string

Seznam jednoho nebo více typů šablon knihovny
Režim sdílení
 sharingMode True string

Určuje, kdo má mít přístup k tomuto dokumentu knihovny.
URL
 url True string

Veřejně přístupná adresa URL pro načtení obsahu nezpracovaného souboru
Název
 name True string

Původní systémový název odesílaného dokumentu
Typ
 mimeType True string

Typ MIME odkazovaného souboru, např. application/pdf
Stav šablony
 state True string

Stav dokumentu knihovny
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).

Návraty

Objekt JSON popisující šablonu knihovny

Body
LibraryDocumentCreationResponseV6

Vytvoření šablony knihovny z adresy URL dokumentu (staré) [ZASTARALÉ]

ID operace:
CreateLibraryDocumentByUrl

Tato operace vytvoří šablonu v knihovně Adobe Acrobat Sign z adresy URL dokumentu. Tato šablona slouží k odesílání smluv.

Parametry

Name Klíč Vyžadováno Typ Description
Název šablony
 name True string

Název smlouvy sloužící k identifikaci šablony
Typ šablony
 libraryTemplateTypes True string

Seznam jednoho nebo více typů šablon knihovny
Sdílet s
 librarySharingMode True string

Určuje, kdo má mít přístup k tomuto dokumentu knihovny.
URL
 url True string

Veřejně přístupná adresa URL pro načtení dokumentu
Název
 name True string

Název odkazovaného dokumentu s příponou
Adresa URL (2)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (2)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (3)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (3)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (4)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (4)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (5)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (5)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (6)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (6)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (7)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (7)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (8)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (8)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (9)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (9)
 name string

Název odkazovaného dokumentu s příponou
Adresa URL (10)
 url string

Veřejně přístupná adresa URL pro načtení dokumentu
Název (10)
 name string

Název odkazovaného dokumentu s příponou

Návraty

Objekt JSON popisující šablonu knihovny

Body
LibraryDocumentCreationResponse

Vytvoření šablony knihovny z nahraného dokumentu

ID operace:
CreateLibraryDocumentById_V2

Tato operace vytvoří šablonu v knihovně Adobe Acrobat Sign z nahraného dokumentu. Tuto šablonu použijte k odesílání smluv.

Parametry

Name Klíč Vyžadováno Typ Description
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název šablony
 name True string

Název smlouvy sloužící k identifikaci šablony
Typ šablony
 templateTypes True array of string

Seznam jednoho nebo více typů šablon knihovny
Režim sdílení
 sharingMode True string

Určuje, kdo má mít přístup k tomuto dokumentu knihovny.
ID
 transientDocumentId True string

ID dokumentu přijaté odesláním přechodného dokumentu
Stav šablony
 state True string

Stav dokumentu knihovny
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).

Návraty

Objekt JSON popisující šablonu knihovny

Body
LibraryDocumentCreationResponseV6

Vytvoření šablony knihovny z nahraného dokumentu (starý) [ZASTARALÉ]

ID operace:
CreateLibraryDocumentById

Tato operace vytvoří šablonu v knihovně Adobe Acrobat Sign z nahraného dokumentu. Tuto šablonu použijte k odesílání smluv.

Parametry

Name Klíč Vyžadováno Typ Description
Název šablony
 name True string

Název smlouvy sloužící k identifikaci šablony
Typ šablony
 libraryTemplateTypes True string

Seznam jednoho nebo více typů šablon knihovny
Sdílet s
 librarySharingMode True string

Určuje, kdo má mít přístup k tomuto dokumentu knihovny.
ID dokumentu
 transientDocumentId True string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (2)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (3)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (4)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (5)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (6)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (7)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (8)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (9)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu
ID dokumentu (10)
 transientDocumentId string

ID dokumentu přijaté odesláním dokumentu

Návraty

Objekt JSON popisující šablonu knihovny

Body
LibraryDocumentCreationResponse

Zrušení smlouvy

ID operace:
CancelAgreement

Zruší smlouvu identifikovanou id smlouvy v cestě.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, která má být zrušena.
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Stav oddělení
 state string

Stát, ve kterém by dohoda měla přistát.
Comment
 comment string

Volitelný komentář popisující důvod zrušení příjemcům.
Ostatní
 notifyOthers boolean

Jestli chcete, aby příjemci byli upozorněni nebo ne.

Získání adresy URL zobrazení smlouvy

ID operace:
PostAgreementViews

Načte nejnovější adresu URL zobrazení stavu smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, jejíž informace jsou potřeba
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název zobrazení
 name True string

Název požadovaného zobrazení smlouvy
Automatické přihlášení
 autoLoginUser boolean

Pokud je hodnota true, vrácená adresa URL se automaticky přihlásí uživatele.
Bez příznaku Chrome
 noChrome boolean

Pokud je hodnota true, vložená stránka se zobrazí bez záhlaví nebo zápatí.
Nadřazený rámec
 frameParent string

Čárkami oddělený seznam adres URL domény, ve kterých můžou být adresy URL iframed

Návraty

Seznam zobrazení smluv

Body
AgreementViews

Získání dat pole formuláře smlouvy (staré) [ZASTARALÉ]

ID operace:
GetAgreementFormFieldData

Načte data zadaná do polí interaktivního formuláře smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, jejíž informace jsou potřeba

Návraty

response
file

Získání dat pole formuláře smlouvy ve formátu JSON

ID operace:
GetAgreementFormFieldData_V3

Načte data zadaná do polí interaktivního formuláře smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, jejíž informace jsou potřeba
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com

Návraty

Obsah dat formuláře

Obsah dat formuláře
object

Získání dat polí formuláře smlouvy ve formátu CSV

ID operace:
GetAgreementFormFieldData_V2

Načte data zadaná do polí interaktivního formuláře smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, jejíž informace jsou potřeba
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com

Návraty

Obsah dat formuláře

Obsah dat formuláře
binary

Získání dokumentu ze smlouvy

ID operace:
GetDocument_V2

Tato operace načte datový proud souboru konkrétního dokumentu smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, jejíž dokument je nutný
ID dokumentu
 documentId True string

ID dokumentu konkrétního dokumentu smlouvy
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com

Návraty

Datový proud souboru dokumentu

response
DocumentResponse

Získání dokumentu ze smlouvy [ZASTARALÉ]

ID operace:
GetDocument

Tato akce je zastaralá. Místo toho použijte možnost Získat dokument ze smlouvy .

Tato operace načte datový proud souboru konkrétního dokumentu smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, jejíž dokument je nutný
ID dokumentu
 documentId True string

ID dokumentu konkrétního dokumentu smlouvy

Návraty

Datový proud souboru dokumentu

response
DocumentResponse

Získání PDF podepsané smlouvy

ID operace:
GetCombinedDocument_V2

Tato operace načte datový proud souboru PDF kombinované nebo podepsané smlouvy. Všimněte si, že datový proud souboru by měl být uložen s názvem souboru končícím .pdf příponou souboru.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy poskytnuté akcí, která vytvoří smlouvu
Připojit podpůrné dokumenty?
 attachSupportingDocuments boolean

Pokud ano, připojte podpůrné dokumenty k podepsané smlouvě PDF.
Připojit sestavu auditu?
 attachAuditReport boolean

Pokud ano, připojte k podepsané smlouvě PDF zprávu o auditu.
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com

Návraty

Datový proud souboru dokumentu

response
CombinedDocumentResponse

Získání PDF podepsané smlouvy [ZASTARALÉ]

ID operace:
GetCombinedDocument

Tato akce je zastaralá. Místo toho použijte get a PDF of a signed agreement .

Tato operace načte datový proud souboru PDF kombinované nebo podepsané smlouvy. Všimněte si, že datový proud souboru by měl být uložen s názvem souboru končícím .pdf příponou souboru.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy poskytnuté akcí, která vytvoří smlouvu
Připojit podpůrné dokumenty?
 attachSupportingDocuments boolean

Pokud ano, připojte podpůrné dokumenty k podepsané smlouvě PDF.
Připojit sestavu auditu?
 auditReport boolean

Pokud ano, připojte k podepsané smlouvě PDF zprávu o auditu.

Návraty

Datový proud souboru dokumentu

response
CombinedDocumentResponse

Získání PDF záznamu o auditu smlouvy

ID operace:
GetAgreementAuditTrail

Tato operace načte datový proud souboru PDF záznamu auditu smlouvy. Všimněte si, že datový proud souboru by měl být uložen s názvem souboru končícím .pdf příponou souboru.

Parametry

Name Klíč Vyžadováno Typ Description
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
ID smlouvy
 agreementId True string

ID smlouvy, jejíž informace jsou potřeba

Návraty

Stream souboru záznamu auditu smlouvy

response
AgreementAuditTrailResponse

Získání podrobných informací o pracovním postupu

ID operace:
GetWorkflowInfo

Tato operace načte podrobné informace o pracovním postupu.

Parametry

Name Klíč Vyžadováno Typ Description
ID pracovního postupu
 workflowId True string

ID pracovního postupu, jehož informace jsou potřeba
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).

Návraty

JSON, který obsahuje podrobné informace o pracovním postupu

Body
WorkflowDescriptionV6

Získání seznamu všech ID dokumentů ze smlouvy

ID operace:
GetAllDocumentsofAnAgreement_V2

Tato operace načte ID všech dokumentů a podpůrných dokumentů smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, jejíž dokumenty jsou potřeba
Podpůrné dokumenty – typ obsahu
 supportingDocumentContentFormat string

Typ obsahu podpůrných dokumentů smlouvy
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com

Návraty

JSON, který obsahuje objekty pole dokumentů i podpůrných dokumentů

Body
AgreementDocumentsV6

Získání seznamu všech ID dokumentů ze smlouvy [ZASTARALÉ]

ID operace:
GetAllDocumentsofAnAgreement

Tato akce je zastaralá. Místo toho použijte možnost Získat seznam všech ID dokumentů ze smlouvy .

Tato operace načte ID všech dokumentů a podpůrných dokumentů smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, jejíž dokumenty jsou potřeba
Podpůrné dokumenty – typ obsahu
 supportingDocumentContentFormat string

Typ obsahu podpůrných dokumentů smlouvy

Návraty

JSON, který obsahuje objekty pole dokumentů i podpůrných dokumentů

Body
AgreementDocuments

Získání seznamu všech pracovních postupů

ID operace:
GetAllWorkflows

Tato operace načte seznam všech pracovních postupů uživatele.

Parametry

Name Klíč Vyžadováno Typ Description
Zahrnout pracovní postupy konceptu
 includeDraftWorkflows boolean

Zahrnout koncepty pracovních postupů
Zahrnout neaktivní pracovní postupy
 includeInactiveWorkflows boolean

Zahrnutí neaktivních pracovních postupů
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).

Návraty

JSON obsahující objekt pole pracovního postupu uživatele

Body
userWorkflowListV6

Získání seznamu všech skupin, do nichž uživatel patří

ID operace:
GetAllUserGroups

Tato operace načte seznam všech uživatelů skupin, do nichž patří.

Parametry

Name Klíč Vyžadováno Typ Description
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
ID uživatele
 userId True string

Pokud chcete získat výsledek pro autorizovaného uživatele, může být ID uživatele nahrazeno "já" bez uvozovek.

Návraty

JSON, který obsahuje seznam skupin pro daného uživatele

Body
UserGroupsInfoV6

Získání seznamu všech smluv

ID operace:
GetAllAgreements_V2

Tato operace načte seznam všech smluv uživatele.

Parametry

Name Klíč Vyžadováno Typ Description
Cursor
 cursor string

Používá se k procházení stránek. Pokud není zadaný, vrátí první stránku.
Velikost stránky
 pageSize integer

Počet položek na stránce odpovědi Ve výchozím nastavení: 100; Max: 10000
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).

Návraty

JSON, který obsahuje objekt pole se smlouvou uživatele

Body
userAgreementListV6

Získání seznamu všech smluv (staré) [ZASTARALÉ]

ID operace:
GetAllAgreements

Tato operace načte seznam všech smluv uživatele.

Návraty

JSON, který obsahuje objekt pole se smlouvou uživatele

Body
UserAgreements

Získání seznamu všech smluv na základě kritérií hledání

ID operace:
SearchAgreements

Tato operace vyhledává smlouvy podle kritérií, jako je ID pracovního postupu atd.

Parametry

Name Klíč Vyžadováno Typ Description
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).
Název nebo ID pracovního postupu
 workflowId string

V seznamu vyberte vlastní pracovní postup nebo zadejte vlastní ID pracovního postupu.
Vytvořeno po
 gt string

Minimální povolené datum a čas. Příklad: 2020-12-31T23:59:00Z
Vytvořeno před
 lt string

Maximální povolené datum a čas. Příklad: 2023-12-31T23:59:00Z
Velikost stránky
 pageSize integer

Počet položek na stránce odpovědi Ve výchozím nastavení: 50; Max: 500
Počáteční index
 startIndex integer

Vrátí se 0 první řádek (posun) výsledků hledání.

Návraty

JSON, který obsahuje objekt pole se smlouvou uživatele

Body
userAgreementListV6

Získání seznamu všech webových formulářů

ID operace:
GetAllWebForms

Tato operace načte seznam všech webových formulářů uživatele.

Parametry

Name Klíč Vyžadováno Typ Description
Cursor
 cursor string

Používá se k procházení stránek. Pokud není zadaný, vrátí první stránku.
Velikost stránky
 pageSize integer

Počet položek na stránce odpovědi Ve výchozím nastavení: 100; Max: 10000
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).

Návraty

Json obsahující objekt pole webového formuláře uživatele

Body
userWidgetListV6

Získání seznamu všech šablon knihoven

ID operace:
GetLibraryDocuments_V2

Tato operace načte seznam všech dokumentů uložených jako šablony v knihovně Adobe Acrobat Sign uživatele.

Parametry

Name Klíč Vyžadováno Typ Description
Cursor
 cursor string

Používá se k procházení stránek. Pokud není zadaný, vrátí první stránku.
Velikost stránky
 pageSize integer

Počet položek na stránce odpovědi Ve výchozím nastavení: 100; Max: 10000
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com
Název nebo ID skupiny
 groupId string

ID skupiny. Chcete-li použít toto pole – musí být vybráno pole In The Name Of (Název).

Návraty

JSON, který obsahuje objekt pole šablony knihovny

Body
LibraryDocuments

Získání seznamu všech šablon knihoven (staré) [ZASTARALÉ]

ID operace:
GetLibraryDocuments

Tato operace načte seznam všech dokumentů uložených jako šablony v knihovně Adobe Acrobat Sign uživatele.

Návraty

JSON, který obsahuje objekt pole šablony knihovny

Body
DocumentLibraryItems

Získání stavu smlouvy

ID operace:
GetAgreementInfo_V2

Tato operace načte všechny aktuální informace smlouvy, například stav.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, jejíž informace jsou potřeba
V názvu
 x-api-user string

E-mail volajícího rozhraní API ve formátu: e-mail:adobesignuser@domain.com

Návraty

Kompletní podrobnosti smlouvy

Body
AgreementInfoV6

Získání stavu smlouvy [ZASTARALÉ]

ID operace:
GetAgreementInfo

Tato akce je zastaralá. Použijte místo toho stav smlouvy .

Tato operace načte všechny aktuální informace smlouvy, například stav.

Parametry

Name Klíč Vyžadováno Typ Description
ID smlouvy
 agreementId True string

ID smlouvy, jejíž informace jsou potřeba

Návraty

Úplné podrobnosti o smlouvě

Body
AgreementInfo

Aktivační události

Když dojde k události

Aktivuje nový tok, když dojde k události. Zahrnuje všechny události smlouvy, mega sign a webového formuláře.
Když dojde k události skupiny

Aktivuje nový tok, když dojde k události skupiny. Zahrnuje všechny události smlouvy, mega sign a webového formuláře.
Když dojde k události smlouvy s webovým formulářem

Aktivuje nový tok, když dojde k události smlouvy webového formuláře. Popisuje nejběžnější události smlouvy, jako je vytváření, dokončování atd.
Když se změní stav smlouvy

Aktivuje nový tok, když se změní stav smlouvy. Popisuje nejběžnější události smlouvy, jako je vytváření, dokončování atd.
Po úspěšném dokončení pracovního postupu smlouvy

Aktivuje nový tok po úspěšném dokončení pracovního postupu smlouvy.
Při odeslání smlouvy účastníkovi

Aktivuje nový tok, když se účastníkovi odešle smlouva.
Při vytvoření nové smlouvy

Aktivuje nový tok při vytvoření nové smlouvy.

Když dojde k události

ID operace:
CreateWebhookGeneric

Aktivuje nový tok, když dojde k události. Zahrnuje všechny události smlouvy, mega sign a webového formuláře.

Parametry

Name Klíč Vyžadováno Typ Description
Název
 name True string

Název triggeru
Scope
 scope True string

Rozsah triggeru
Typ prostředku
 resourceType string

Zadejte pouze tehdy, když je "Obor" je "Konkrétní prostředek". Vyberte typ prostředku, pro který se má tok aktivovat.
ID zdroje
 resourceId string

Zadejte pouze tehdy, když je "Obor" je "Konkrétní prostředek". Zadejte smlouvu, megaznam nebo webový formulář nebo ID skupiny, pro které se má tok aktivovat.
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Události, pro které se má tok aktivovat
Zahrnout informace o smlouvě?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o smlouvě?
Zahrnout informace o účastníkovi smlouvy?
 includeParticipantsInfo boolean

Mají být informace o účastníkovi smlouvy odeslány v oznámení?
Zahrnout informace o dokumentu smlouvy?
 includeDocumentsInfo boolean

Mají být informace o dokumentu smlouvy odeslány v oznámení?
Zahrnout informace o podepsaném dokumentu smlouvy?
 includeSignedDocuments boolean

Má být v oznámení odeslána konečná kopie podepsaného dokumentu při dokončení smlouvy?
Zahrnout informace o megasignu?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o znaménku mega?
Zahrnout informace o webovém formuláři?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o webovém formuláři?
Zahrnout informace o účastníkovi webového formuláře?
 includeParticipantsInfo boolean

Mají být informace o účastníkovi webového formuláře odeslány v oznámení?
Zahrnout informace o dokumentech webového formuláře?
 includeDocumentsInfo boolean

Mají být informace o dokumentu webového formuláře odeslány v oznámení?

Návraty

Body
WebhookPayloadGeneric

Když dojde k události skupiny

ID operace:
CreateWebhookForGroupEvent

Aktivuje nový tok, když dojde k události skupiny. Zahrnuje všechny události smlouvy, mega sign a webového formuláře.

Parametry

Name Klíč Vyžadováno Typ Description
Název
 name True string

Název triggeru
Název nebo ID skupiny
 resourceId string

ID skupiny
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Události, pro které se má tok aktivovat
Zahrnout informace o smlouvě?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o smlouvě?
Zahrnout informace o účastníkovi smlouvy?
 includeParticipantsInfo boolean

Mají být informace o účastníkovi smlouvy odeslány v oznámení?
Zahrnout informace o dokumentu smlouvy?
 includeDocumentsInfo boolean

Mají být informace o dokumentu smlouvy odeslány v oznámení?
Zahrnout informace o podepsaném dokumentu smlouvy?
 includeSignedDocuments boolean

Má být v oznámení odeslána konečná kopie podepsaného dokumentu při dokončení smlouvy?
Zahrnout informace o megasignu?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o znaménku mega?
Zahrnout informace o webovém formuláři?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o webovém formuláři?
Zahrnout informace o účastníkovi webového formuláře?
 includeParticipantsInfo boolean

Mají být informace o účastníkovi webového formuláře odeslány v oznámení?
Zahrnout informace o dokumentech webového formuláře?
 includeDocumentsInfo boolean

Mají být informace o dokumentu webového formuláře odeslány v oznámení?

Návraty

Body
GroupWebhookEventPayload

Když dojde k události smlouvy s webovým formulářem

ID operace:
CreateWebhookForWebFormAgreementEvent

Aktivuje nový tok, když dojde k události smlouvy webového formuláře. Popisuje nejběžnější události smlouvy, jako je vytváření, dokončování atd.

Parametry

Name Klíč Vyžadováno Typ Description
Název
 name True string

Název triggeru
Velikost stránky webových formulářů
 pageSize integer

Vyberte počet webových formulářů, které se mají zobrazit v rozevíracím seznamu.
Název nebo ID webového formuláře
 resourceId True string

Ze seznamu vyberte webový formulář nebo zadejte ID webového formuláře.
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Události, pro které se má tok aktivovat
Zahrnout informace o smlouvě?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o smlouvě?
Zahrnout informace o účastníkovi smlouvy?
 includeParticipantsInfo boolean

Mají být informace o účastníkovi smlouvy odeslány v oznámení?
Zahrnout informace o dokumentu smlouvy?
 includeDocumentsInfo boolean

Mají být informace o dokumentu smlouvy odeslány v oznámení?
Zahrnout informace o podepsaném dokumentu smlouvy?
 includeSignedDocuments boolean

Má být odeslána konečná kopie podepsaného dokumentu v oznámení o dokončení smlouvy?

Návraty

Body
WebFormWebhookAgreementEventPayload

Když se změní stav smlouvy

ID operace:
CreateWebhookForAgreementStatusUpdated

Aktivuje nový tok, když se změní stav smlouvy. Popisuje nejběžnější události smlouvy, jako je vytváření, dokončování atd.

Parametry

Name Klíč Vyžadováno Typ Description
Název
 name True string

Název triggeru
Scope
 scope True string

Rozsah triggeru
Název/ID smlouvy
 resourceId string

Zadejte pouze tehdy, když je "Obor" "Konkrétní smlouva". Ze seznamu vyberte smlouvu nebo zadejte ID smlouvy.
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Události, pro které se má tok aktivovat
Zahrnout informace o smlouvě?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o smlouvě?
Zahrnout informace o účastníkovi smlouvy?
 includeParticipantsInfo boolean

Mají být informace o účastníkovi smlouvy odeslány v oznámení?
Zahrnout informace o dokumentu smlouvy?
 includeDocumentsInfo boolean

Mají být informace o dokumentu smlouvy odeslány v oznámení?
Zahrnout informace o podepsaném dokumentu smlouvy?
 includeSignedDocuments boolean

Má být odeslána konečná kopie podepsaného dokumentu v oznámení o dokončení smlouvy?

Návraty

Body
WebhookPayloadWithSignedDocumentForStatusChange

Po úspěšném dokončení pracovního postupu smlouvy

ID operace:
CreateWebhookForAgreementSignedEvent

Aktivuje nový tok po úspěšném dokončení pracovního postupu smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
Název
 name True string

Název triggeru
Scope
 scope True string

Rozsah triggeru
Název/ID smlouvy
 resourceId string

Zadejte pouze tehdy, když je "Obor" "Konkrétní smlouva". Ze seznamu vyberte smlouvu nebo zadejte ID smlouvy.
Subscription
 webhookSubscriptionEvents True array of string

Události, pro které se má tok aktivovat
Zahrnout informace o smlouvě?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o smlouvě?
Zahrnout informace o účastníkovi smlouvy?
 includeParticipantsInfo boolean

Mají být informace o účastníkovi smlouvy odeslány v oznámení?
Zahrnout informace o dokumentu smlouvy?
 includeDocumentsInfo boolean

Mají být informace o dokumentu smlouvy odeslány v oznámení?
Zahrnout informace o podepsaném dokumentu smlouvy?
 includeSignedDocuments boolean

Má být v oznámení odeslána konečná kopie podepsaného dokumentu při dokončení smlouvy?

Návraty

Body
WebhookPayloadWithSignedDocument

Při odeslání smlouvy účastníkovi

ID operace:
CreateWebhookForAgreementSignatureRequestedEvent

Aktivuje nový tok, když se účastníkovi odešle smlouva.

Parametry

Name Klíč Vyžadováno Typ Description
Název
 name True string

Název triggeru
Scope
 scope True string

Rozsah triggeru
Název/ID smlouvy
 resourceId string

Zadejte pouze tehdy, když je "Obor" "Konkrétní smlouva". Ze seznamu vyberte smlouvu nebo zadejte ID smlouvy.
Subscription
 webhookSubscriptionEvents True array of string

Události, pro které se má tok aktivovat
Zahrnout informace o smlouvě?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o smlouvě?
Zahrnout informace o účastníkovi smlouvy?
 includeParticipantsInfo boolean

Mají být informace o účastníkovi smlouvy odeslány v oznámení?
Zahrnout informace o dokumentu smlouvy?
 includeDocumentsInfo boolean

Mají být informace o dokumentu smlouvy odeslány v oznámení?

Návraty

Body
WebhookPayload

Při vytvoření nové smlouvy

ID operace:
CreateWebhookForAgreementCreatedEvent

Aktivuje nový tok při vytvoření nové smlouvy.

Parametry

Name Klíč Vyžadováno Typ Description
Název
 name True string

Název triggeru
Scope
 scope True string

Rozsah triggeru
Subscription
 webhookSubscriptionEvents True array of string

Události, pro které se má tok aktivovat
Zahrnout informace o smlouvě?
 includeDetailedInfo boolean

Mají být v oznámení odeslány podrobné informace o smlouvě?
Zahrnout informace o účastníkovi smlouvy?
 includeParticipantsInfo boolean

Mají být informace o účastníkovi smlouvy odeslány v oznámení?

Návraty

Body
WebhookPayloadWithoutNextParticipantSet

Definice

AgreementCreationResponse

JSON obsahující ID nově vytvořené smlouvy

Name Cesta Typ Description
ID smlouvy
 agreementId string

Jedinečné ID smlouvy, které lze použít k dotazování stavu a stažení podepsaných dokumentů

AgreementCreationResponseV6

JSON obsahující ID nově vytvořené smlouvy

Name Cesta Typ Description
ID smlouvy
 id string

Jedinečné ID smlouvy, které lze použít k dotazování stavu a stažení podepsaných dokumentů

Dokumenty smlouvy

JSON, který obsahuje objekty pole dokumentů i podpůrných dokumentů

Name Cesta Typ Description
Documents
 documents array of Document

Seznam objektů představujících dokumenty
Podklady
 supportingDocuments array of SupportingDocument

Seznam podpůrných dokumentů Tato hodnota se vrátí pouze v případě, že ve smlouvě existují nějaké podpůrné dokumenty.

AgreementDocumentsV6

JSON, který obsahuje objekty pole dokumentů i podpůrných dokumentů

Name Cesta Typ Description
Documents
 documents array of DocumentV6

Seznam objektů představujících dokumenty
Podklady
 supportingDocuments array of SupportingDocumentV6

Seznam podpůrných dokumentů Tato hodnota se vrátí pouze v případě, že ve smlouvě existují nějaké podpůrné dokumenty.

Info o smlouvě

Úplné podrobnosti o smlouvě

Name Cesta Typ Description
ID smlouvy
 agreementId string

Jedinečné ID, které lze použít k jednoznačné identifikaci smlouvy
Events
 events array of DocumentHistoryEvent

Seřazený seznam událostí v záznamu auditu tohoto dokumentu
Datum vypršení platnosti
 expiration date

Datum, po kterém už není možné smlouvu podepsat
Nejnovější ID verze
 latestVersionId string

Jedinečné ID, které jednoznačně identifikuje aktuální verzi smlouvy
Message
 message string

Zpráva přidružená ke smlouvě, kterou odesílatel poskytl
Název smlouvy
 name string

Jméno smlouvy určené odesílatelem
Sady dalších účastníků
 nextParticipantSetInfos array of NextParticipantSetInfo

Informace o tom, kdo musí jednat dál pro tuto smlouvu
Sady účastníků
 participantSetInfos array of ParticipantSetInfo

Informace o všech sadách účastníků tohoto dokumentu
Typ podpisu
 signatureType string

Určuje požadovaný typ podpisu – podpis e-podpis nebo zápis.
Ochrana dokumentu
 securityOptions string

Informace o zabezpečení dokumentu, který určuje, jestli se k zobrazení a podepsání hesla vyžaduje heslo
Stav
 status string

Aktuální stav smlouvy

AgreementInfoV6

Kompletní podrobnosti smlouvy

Name Cesta Typ Description
ID smlouvy
 id string

Jedinečné ID, které lze použít k jednoznačné identifikaci smlouvy
Datum vytvoření
 createdDate date

Datum vytvoření smlouvy
Zpoždění prvního připomenutí
 firstReminderDelay integer

Celé číslo, které určuje zpoždění v hodinách před odesláním prvního připomenutí.
Frekvence připomenutí
 reminderFrequency string

Jak často chcete odesílat připomenutí?
Datum vypršení platnosti
 expiration date

Datum, po kterém už není možné smlouvu podepsat
Locale
 locale string

Národní prostředí přidružené k této smlouvě – například en_US nebo fr_FR
Message
 message string

Zpráva přidružená ke smlouvě, kterou odesílatel poskytl
Název smlouvy
 name string

Jméno smlouvy určené odesílatelem
Viditelnost dokumentu?
 documentVisibilityEnabled boolean

Je povolená viditelnost dokumentu?
Sady účastníků
 participantSetsInfo array of ParticipantSetInfoV6

Informace o všech sadách účastníků tohoto dokumentu
Typ podpisu
 signatureType string

Určuje požadovaný typ podpisu – podpis e-podpis nebo zápis.
Možnosti zabezpečení
 securityOptions string

Informace o zabezpečení dokumentu, který určuje, jestli se k zobrazení a podepsání hesla vyžaduje heslo
Stav
 status string

Aktuální stav smlouvy
E-mail odesílatele
 senderEmail string

E-mail odesílatele
ID pracovního postupu
 workflowId string

ID vlastního pracovního postupu, který definuje cestu směrování smlouvy.
Ccs
 ccs array of CcInfo

Seznam jednoho nebo více řadičů CCS, které se zkopírují v transakci smlouvy.
ID skupiny
 groupId string

Jedinečný identifikátor skupiny, do které smlouva patří.

CombinedDocumentResponse

Datový proud souboru dokumentu

Datový proud souboru dokumentu

Obsah souboru
binary

AgreementAuditTrailResponse

Stream souboru záznamu auditu smlouvy

Stream souboru záznamu auditu smlouvy

Obsah záznamu auditu smlouvy
binary

DisplayUserInfo

Name Cesta Typ Description
Společnost
 company string

Zobrazí název společnosti uživatele, pokud je k dispozici.
Email
 email string

Zobrazí e-mail uživatele.
Jméno a příjmení
 fullName string

Zobrazí celé jméno uživatele, pokud je k dispozici.

DisplayUserSetInfo

Name Cesta Typ Description
Zobrazit informace o sadě uživatelů
 displayUserSetMemberInfos array of DisplayUserInfo

Zobrazí informace o sadě uživatelů.
Zobrazovat jméno sady uživatelů
 displayUserSetName string

Dokument

Informace o dokumentu

Name Cesta Typ Description
ID dokumentu
 documentId string

Jedinečné ID dokumentu
Typ MIME
 mimeType string

Typ MIME dokumentu
Název
 name string

Název dokumentu
Num Pages
 numPages integer

Počet stránek v dokumentu

DocumentV6

Informace o dokumentu

Name Cesta Typ Description
ID dokumentu
 id string

Jedinečné ID dokumentu
Typ MIME
 mimeType string

Typ MIME dokumentu
Název
 name string

Název dokumentu
Num Pages
 numPages integer

Počet stránek v dokumentu

DocumentHistoryEvent

Name Cesta Typ Description
Iniciátor událostí
 actingUserEmail string

E-mailová adresa uživatele, který událost inicioval
Datum události
 date date

Datum události auditu
Popis události
 description string

Popis události auditu
E-mail účastníka
 participantEmail string

E-mailová adresa uživatele, který událost inicioval
Typ události
 type string

Typ události smlouvy

DocumentLibraryItem

Name Cesta Typ Description
ID šablony knihovny
 libraryDocumentId string

Jedinečné ID dokumentu knihovny použitého při odesílání dokumentu, který se má podepsat
Typy šablon knihovny
 libraryTemplateTypes array of string

Seznam jednoho nebo více typů šablon knihovny
Datum změny
 modifiedDate date

Den poslední změny šablony knihovny
Název šablony knihovny
 name string

Název šablony knihovny
Režim sdílení šablon
 scope string

Rozsah viditelnosti šablony knihovny

DocumentLibraryItems

JSON, který obsahuje objekt pole šablony knihovny

Name Cesta Typ Description
Seznam šablon knihoven
 libraryDocumentList array of DocumentLibraryItem

Seznam položek šablony knihovny

DocumentResponse

Datový proud souboru dokumentu

Datový proud souboru dokumentu

Obsah souboru
binary

LibraryDocumentCreationResponse

Objekt JSON popisující šablonu knihovny

Name Cesta Typ Description
ID šablony knihovny
 libraryDocumentId string

Jedinečné ID, které lze použít k odkazu na šablonu knihovny

NextParticipantInfo

Name Cesta Typ Description
Email
 email string

E-mailová adresa dalšího účastníka
Název
 name string

Jméno dalšího účastníka, pokud je k dispozici
Čekání od
 waitingSince date

Datum, od kterého dokument čeká na provedení akce účastníka

NextParticipantSetInfo

Name Cesta Typ Description
Další účastník nastavil informace o členech
 nextParticipantSetMemberInfos array of NextParticipantInfo

Informace o členech sady dalších účastníků

Informace o účastníkech

Name Cesta Typ Description
Společnost
 company string

Společnost účastníka, pokud je k dispozici
Email
 email string

E-mailová adresa účastníka
Název
 name string

Jméno účastníka, pokud je k dispozici
ID účastníka
 participantId string

Jedinečné ID účastníka
Možnosti zabezpečení
 securityOptions array of string

Možnosti zabezpečení, které platí pro účastníka
Title
 title string

Název účastníka, pokud je k dispozici

ParticipantSetInfo

Name Cesta Typ Description
ID sady účastníků
 participantSetId string

Jedinečné ID sady účastníků
Informace o členech sady účastníků
 participantSetMemberInfos array of ParticipantInfo

Informace o členech sady příjemců
Soukromá zpráva
 privateMessage string

Soukromá zpráva pro účastníky v sadě
Role
 roles array of string

Aktuální role sady účastníků. Sada účastníků může mít jednu nebo více rolí.
securityOptions
 securityOptions array of string

Možnosti zabezpečení, které platí pro účastníka
Podpisová objednávka
 signingOrder integer

Index začíná číslem 1, který říká pořadí, ve kterém se tento příjemce podepíše.
Stav nastavení účastníka
 status string

Účastník nastavil stav s ohledem na dokument.

ParticipantSetInfoV6

Name Cesta Typ Description
Informace o členech sady účastníků
 memberInfos array of MemberInfosV6

Informace o členech sady příjemců
Objednávka
 order integer

Index označující pozici, ve které se podpisová skupina musí podepsat.
Role
 role string

Aktuální role sady účastníků (podepisující, schvalovatel atd.).
Jméno sady účastníků
 name string

Název sady účastníků
Nastavení soukromého messsage účastníka
 privateMessage string

Soukromá zpráva pro účastníky v sadě
Nastavení viditelných stránek účastníků
 visiblePages array of string

Stránky, které jsou viditelné pro sadu účastníků

MemberInfosV6

Name Cesta Typ Description
Email
 email string

E-mail účastníka
Autentizace
 securityOption.authenticationMethod string

Výchozí ověřování: e-mail (žádný)
Heslo
 securityOption.password string

Heslo požadované pro účastníka
Kód země
 securityOption.phoneInfo.countryCode string

Kód země telefonu příjemce vyžadovaný k zobrazení a podepsání dokumentu
Telefon Ne.
 securityOption.phoneInfo.phone string

Telefonní číslo příjemce potřebné k zobrazení a podepsání smlouvy
ID poskytovatele
 securityOption.digAuthInfo.providerId string

ID zprostředkovatele brány digitální identity

Podpisová adresa

Name Cesta Typ Description
E-mail pro přihlašovací adresu URL
 email string

E-mailová adresa podepisující osoby přidružené k této podepisující adrese URL
Podepsat adresu URL
 esignUrl string

Adresa URL podepisující osoby přidružené k této podpisové adrese URL

SigningUrlResponse

Name Cesta Typ Description
Pole adres URL pro sady podepisující osoby
 signingUrlSetInfos array of SigningUrlSetInfo

Pole adres URL pro sady podepisující osoby zahrnuté v této smlouvě

SigningUrlSetInfo

Name Cesta Typ Description
- Pole podpisových adres URL
 signingUrls array of SigningUrl

Pole adres URL pro aktuální sadu podepisující osoby
– Název sady podpisových adres URL
 signingUrlSetName string

Název aktuální sady podepisující osoby

Podpůrný dokument

Informace o podpůrném dokumentu

Name Cesta Typ Description
Název podpůrného dokumentu
 displayLabel string

Zobrazovaný název podpůrného dokumentu
Název pole podpůrného dokumentu
 fieldName string

Název pole podpůrného dokumentu
Typ MIME podpůrného dokumentu
 mimeType string

Typ MIME podpůrného dokumentu
Podpůrné stránky dokumentů
 numPages integer

Počet stránek v podpůrném dokumentu
ID podpůrného dokumentu
 supportingDocumentId string

Jedinečné ID představující podpůrný dokument

PodporaDocumentV6

Informace o podpůrném dokumentu

Name Cesta Typ Description
Název podpůrného dokumentu
 displayLabel string

Zobrazovaný název podpůrného dokumentu
Název pole podpůrného dokumentu
 fieldName string

Název pole podpůrného dokumentu
Typ MIME podpůrného dokumentu
 mimeType string

Typ MIME podpůrného dokumentu
Podpůrné stránky dokumentů
 numPages integer

Počet stránek v podpůrném dokumentu
ID podpůrného dokumentu
 id string

Jedinečné ID představující podpůrný dokument

TransientDocumentResponse

JSON obsahující ID nahraného dokumentu

Name Cesta Typ Description
ID dokumentu
 transientDocumentId string

ID dokumentu nahraného dokumentu

UserAgreement

Name Cesta Typ Description
ID smlouvy
 agreementId string

Jedinečné ID, které lze použít k jednoznačné identifikaci smlouvy
Zobrazení informací o sadě uživatelů
 displayUserSetInfos array of DisplayUserSetInfo

Nejrelevavantnější aktuální uživatel nastavený pro smlouvu. Obvykle se jedná o další podepisující osoby, pokud je smlouva od aktuálního uživatele nebo odesílatele, pokud byla přijata od jiného uživatele.
Zobrazit datum
 displayDate date

Datum zobrazení smlouvy
Podpis
 esign boolean

True if this is an e-sign document
Nejnovější ID verze
 latestVersionId string

ID verze, které jednoznačně identifikuje aktuální verzi smlouvy
Název
 name string

Název smlouvy
Stav
 status string

Aktuální stav smlouvy

UserAgreements

JSON, který obsahuje objekt pole se smlouvou uživatele

Name Cesta Typ Description
Seznam smluv
 userAgreementList array of UserAgreement

Pole položek smlouvy

UserAgreementV6

Name Cesta Typ Description
Zobrazení informací o sadě uživatelů
 displayParticipantSetInfos array of DisplayUserSetInfo

Nejrelevavantnější aktuální uživatel nastavený pro smlouvu. Obvykle se jedná o další podepisující osoby, pokud je smlouva od aktuálního uživatele nebo odesílatele, pokud byla přijata od jiného uživatele.
Zobrazit datum
 displayDate string

Datum zobrazení smlouvy
Podpis
 esign boolean

True if this is an e-sign document
Skrytý
 hidden boolean

True if agreement is hidden for the user
ID skupiny
 groupId string

Jedinečný identifikátor skupiny
Nejnovější ID verze
 latestVersionId string

ID verze, které jednoznačně identifikuje aktuální verzi smlouvy
Název
 name string

Název smlouvy
Nadřazené ID
 parentId string

Nadřazené ID podřízeného megaSign nebo původní ID instance smlouvy s webovým formulářem
ID smlouvy
 id string

Jedinečný identifikátor smlouvy
Stav
 status string

Aktuální stav smlouvy
Typ
 type string

Druh dohody

userAgreementListV6

JSON, který obsahuje objekt pole se smlouvou uživatele

Name Cesta Typ Description
page
 page page

Informace o stránkování pro navigaci v odpovědi
Seznam smluv
 userAgreementList array of UserAgreementV6

Pole položek smlouvy

page

Informace o stránkování pro navigaci v odpovědi

Name Cesta Typ Description
nextCursor
 nextCursor string

Slouží k přechodu na další stránku. Pokud se nevrátí, nebudou k dispozici žádné další stránky.

WebhookPayload

Name Cesta Typ Description
Event
 event string

Událost, ke které došlo u prostředku.
Datum události
 eventDate date

Datum události. Formát by byl rrrr-MM-dd'T'HH:mm:ssZ. Například například 2016-02-25T18:46:19Z představuje čas UTC.
Typ prostředku události
 eventResourceType string

Prostředek, na kterém došlo k události.
Nadřazený typ smlouvy
 eventResourceParentType string

Informace o prostředku, ze kterého se smlouva vytvoří. Možné hodnoty: Webový formulář nebo megaznam
Nadřazené ID smlouvy
 eventResourceParentId string

Jedinečné ID prostředku, ze kterého se tato smlouva vytvoří
Role účastníka události
 participantRole string

Role účastníka události.
ID účastníka události
 participantUserId string

ID účastníka události.
E-mail účastníka události
 participantUserEmail string

E-mail účastníka události
ID uživatele, který se chová událostí
 actingUserId string

ID uživatele, který událost vytvořil.
E-mail uživatele, který se chytá událostmi
 actingUserEmail string

E-mail uživatele, který událost vytvořil.
IP adresa uživatele, která se chová událostí
 actingUserIpAddress string

IP adresa uživatele, který událost vytvořil
Událost iniciující ID uživatele
 initiatingUserId string

ID uživatele, který událost inicioval jménem hereckého uživatele.
Událost iniciující e-mail uživatele
 initiatingUserEmail string

E-mail uživatele, který událost inicioval jménem hereckého uživatele.
Uživatelé s příslušnými oznámeními
 webhookNotificationApplicableUsers array of ApplicableUsers

Seznam uživatelů, pro které se toto oznámení vztahuje
Agreement
 agreement WebhookAgreementInfo

Úplné informace o smlouvě

ApplicableUsers

Informace ouživatelch

Name Cesta Typ Description
ID uživatele použitelného pro oznámení
 id string

Jedinečné ID uživatele, pro kterého se toto oznámení vztahuje
E-mail pro příslušného uživatele s oznámením
 email string

E-mail uživatele, pro kterého se toto oznámení vztahuje
Role uživatele s příslušnými oznámeními
 role string

Role uživatele v pracovním postupu, pro kterého se toto oznámení vygeneruje
Je použitelná datová část Uživatele
 payloadApplicable boolean

Zda jsou data uvedená v tomto oznámení použitelná pro tohoto uživatele, nebo ne

WebhookPayloadWithoutNextParticipantSet

Name Cesta Typ Description
Event
 event string

Událost, ke které došlo u prostředku.
Datum události
 eventDate date

Datum události. Formát by byl rrrr-MM-dd'T'HH:mm:ssZ. Například například 2016-02-25T18:46:19Z představuje čas UTC.
Typ prostředku události
 eventResourceType string

Prostředek, na kterém došlo k události.
Nadřazený typ smlouvy
 eventResourceParentType string

Informace o prostředku, ze kterého se smlouva vytvoří. Možné hodnoty: Webový formulář nebo megaznam
Nadřazené ID smlouvy
 eventResourceParentId string

Jedinečné ID prostředku, ze kterého se tato smlouva vytvoří
ID účastníka události
 participantUserId string

ID účastníka události.
E-mail účastníka události
 participantUserEmail string

E-mail účastníka události
ID uživatele, který se chová událostí
 actingUserId string

ID uživatele, který událost vytvořil.
E-mail uživatele, který se chytá událostmi
 actingUserEmail string

E-mail uživatele, který událost vytvořil.
IP adresa uživatele, která se chová událostí
 actingUserIpAddress string

IP adresa uživatele, který událost vytvořil
Událost iniciující ID uživatele
 initiatingUserId string

ID uživatele, který událost inicioval jménem uživatele
Událost iniciující e-mail uživatele
 initiatingUserEmail string

E-mail uživatele, který událost inicioval jménem hereckého uživatele.
Uživatelé s příslušnými oznámeními
 webhookNotificationApplicableUsers array of ApplicableUsers

Seznam uživatelů, pro které se toto oznámení vztahuje
Agreement
 agreement WebhookAgreementInfoWithoutNextParticipantSet

Úplné informace o smlouvě

WebhookPayloadWithSignedDocumentForStatusChange

Name Cesta Typ Description
Event
 event string

Událost, ke které došlo u prostředku.
Datum události
 eventDate date

Datum události. Formát by byl rrrr-MM-dd'T'HH:mm:ssZ. Například například 2016-02-25T18:46:19Z představuje čas UTC.
Dílčí událost
 subEvent string

Dílčí událost, ke které došlo u prostředku.
Nadřazený typ smlouvy
 eventResourceParentType string

Informace o prostředku, ze kterého se smlouva vytvoří. Možné hodnoty: Webový formulář nebo megaznam
Nadřazené ID smlouvy
 eventResourceParentId string

Jedinečné ID prostředku, ze kterého se tato smlouva vytvoří
ID účastníka události
 participantUserId string

ID účastníka události.
E-mail účastníka události
 participantUserEmail string

E-mail účastníka události
ID uživatele, který se chová událostí
 actingUserId string

ID uživatele, který událost vytvořil.
E-mail uživatele, který se chytá událostmi
 actingUserEmail string

E-mail uživatele, který událost vytvořil.
IP adresa uživatele, která se chová událostí
 actingUserIpAddress string

IP adresa uživatele, který událost vytvořil
Typ akce
 actionType string

Akce, pro kterou došlo k události.
Událost iniciující ID uživatele
 initiatingUserId string

ID uživatele, který událost inicioval jménem uživatele
Událost iniciující e-mail uživatele
 initiatingUserEmail string

E-mail uživatele, který událost inicioval jménem hereckého uživatele.
Typ prostředku události
 eventResourceType string

Prostředek, na kterém došlo k události.
Role účastníka události
 participantRole string

Role účastníka události.
Uživatelé s příslušnými oznámeními
 webhookNotificationApplicableUsers array of ApplicableUsers

Seznam uživatelů, pro které se toto oznámení vztahuje
Agreement
 agreement WebhookAgreementInfoWithSignedDocument

Úplné informace o smlouvě

WebhookPayloadWithSignedDocument

Name Cesta Typ Description
Event
 event string

Událost, ke které došlo u prostředku.
Datum události
 eventDate date

Datum události. Formát by byl rrrr-MM-dd'T'HH:mm:ssZ. Například například 2016-02-25T18:46:19Z představuje čas UTC.
Nadřazený typ smlouvy
 eventResourceParentType string

Informace o prostředku, ze kterého se smlouva vytvoří. Možné hodnoty: Webový formulář nebo megaznam
Nadřazené ID smlouvy
 eventResourceParentId string

Jedinečné ID prostředku, ze kterého se tato smlouva vytvoří
Typ prostředku události
 eventResourceType string

Prostředek, na kterém došlo k události.
Role účastníka události
 participantRole string

Role účastníka události.
ID účastníka události
 participantUserId string

ID účastníka události.
E-mail účastníka události
 participantUserEmail string

E-mail účastníka události
ID uživatele, který se chová událostí
 actingUserId string

ID uživatele, který událost vytvořil.
E-mail uživatele, který se chytá událostmi
 actingUserEmail string

E-mail uživatele, který událost vytvořil.
IP adresa uživatele, která se chová událostí
 actingUserIpAddress string

IP adresa uživatele, který událost vytvořil
Událost iniciující ID uživatele
 initiatingUserId string

ID uživatele, který událost inicioval jménem uživatele
Událost iniciující e-mail uživatele
 initiatingUserEmail string

E-mail uživatele, který událost inicioval jménem hereckého uživatele.
Uživatelé s příslušnými oznámeními
 webhookNotificationApplicableUsers array of ApplicableUsers

Seznam uživatelů, pro které se toto oznámení vztahuje
Agreement
 agreement WebhookAgreementInfoWithSignedDocument

Úplné informace o smlouvě

WebhookPayloadGeneric

Name Cesta Typ Description
Event
 event string

Událost, ke které došlo u prostředku.
Datum události
 eventDate date

Datum události. Formát by byl rrrr-MM-dd'T'HH:mm:ssZ. Například například 2016-02-25T18:46:19Z představuje čas UTC.
Dílčí událost
 subEvent string

Dílčí událost, ke které došlo u prostředku.
Nadřazený typ smlouvy
 eventResourceParentType string

Informace o prostředku, ze kterého se smlouva vytvoří. Možné hodnoty: Webový formulář nebo megaznam
Nadřazené ID smlouvy
 eventResourceParentId string

Jedinečné ID prostředku, ze kterého se tato smlouva vytvoří
Typ prostředku události
 eventResourceType string

Prostředek, na kterém došlo k události.
Role účastníka události
 participantRole string

Role účastníka události.
ID účastníka události
 participantUserId string

ID účastníka události.
E-mail účastníka události
 participantUserEmail string

E-mail účastníka události
ID uživatele, který se chová událostí
 actingUserId string

ID uživatele, který událost vytvořil.
E-mail uživatele, který se chytá událostmi
 actingUserEmail string

E-mail uživatele, který událost vytvořil.
Událost iniciující ID uživatele
 initiatingUserId string

ID uživatele, který událost inicioval jménem uživatele
Událost iniciující e-mail uživatele
 initiatingUserEmail string

E-mail uživatele, který událost inicioval jménem hereckého uživatele.
Typ akce
 actionType string

Akce, pro kterou došlo k události.
IP adresa uživatele, která se chová událostí
 actingUserIpAddress string

IP adresa uživatele, který událost vytvořil
Uživatelé s příslušnými oznámeními
 webhookNotificationApplicableUsers array of ApplicableUsers

Seznam uživatelů, pro které se toto oznámení vztahuje
Agreement
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Úplné informace o smlouvě
Mega znaménko
 megaSign WebhookMegaSignInfo

Úplné informace o znaménku mega
Webový formulář
 widget WebhookWidgetInfo

Úplné informace o webovém formuláři

WebFormWebhookAgreementEventPayload

Name Cesta Typ Description
Event
 event string

Událost smlouvy, ke které došlo ve webovém formuláři.
Datum události
 eventDate date

Datum události. Formát by byl rrrr-MM-dd'T'HH:mm:ssZ. Například například 2016-02-25T18:46:19Z představuje čas UTC.
Dílčí událost
 subEvent string

Dílčí událost, ke které došlo ve webovém formuláři.
Nadřazený typ smlouvy – webový formulář
 eventResourceParentType string

Hodnota označující, že smlouva se vytvoří z webového formuláře.
ID webového formuláře
 eventResourceParentId string

Jedinečné ID webového formuláře, ze kterého se tato smlouva vytvoří
Typ prostředku události – smlouva
 eventResourceType string

Prostředek, na kterém došlo k události.
Role účastníka události
 participantRole string

Role účastníka události.
ID účastníka události
 participantUserId string

ID účastníka události.
E-mail účastníka události
 participantUserEmail string

E-mail účastníka události
ID uživatele, který se chová událostí
 actingUserId string

ID uživatele, který událost vytvořil.
E-mail uživatele, který se chytá událostmi
 actingUserEmail string

E-mail uživatele, který událost vytvořil.
Událost iniciující ID uživatele
 initiatingUserId string

ID uživatele, který událost inicioval jménem uživatele
Událost iniciující e-mail uživatele
 initiatingUserEmail string

E-mail uživatele, který událost inicioval jménem hereckého uživatele.
Typ akce
 actionType string

Akce, pro kterou došlo k události.
IP adresa uživatele, která se chová událostí
 actingUserIpAddress string

IP adresa uživatele, který událost vytvořil
Uživatelé s příslušnými oznámeními
 webhookNotificationApplicableUsers array of ApplicableUsers

Seznam uživatelů, pro které se toto oznámení vztahuje
Agreement
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Úplné informace o smlouvě

GroupWebhookEventPayload

Name Cesta Typ Description
Event
 event string

Událost, ke které došlo pro skupinu.
Datum události
 eventDate date

Datum události. Formát by byl rrrr-MM-dd'T'HH:mm:ssZ. Například například 2016-02-25T18:46:19Z představuje čas UTC.
Dílčí událost
 subEvent string

Dílčí událost, ke které došlo pro skupinu.
Nadřazený typ smlouvy – webový formulář
 eventResourceParentType string

Informace o skupině, ze které je vytvořena smlouva.
ID webového formuláře
 eventResourceParentId string

Jedinečné ID skupiny, ze které se tato smlouva vytvoří
Typ prostředku události – smlouva
 eventResourceType string

Skupina, pro kterou došlo k události.
Role účastníka události
 participantRole string

Role účastníka události.
ID účastníka události
 participantUserId string

ID účastníka události.
E-mail účastníka události
 participantUserEmail string

E-mail účastníka události
ID uživatele, který se chová událostí
 actingUserId string

ID uživatele, který událost vytvořil.
E-mail uživatele, který se chytá událostmi
 actingUserEmail string

E-mail uživatele, který událost vytvořil.
Událost iniciující ID uživatele
 initiatingUserId string

ID uživatele, který událost inicioval jménem uživatele
Událost iniciující e-mail uživatele
 initiatingUserEmail string

E-mail uživatele, který událost inicioval jménem hereckého uživatele.
Typ akce
 actionType string

Akce, pro kterou došlo k události.
IP adresa uživatele, která se chová událostí
 actingUserIpAddress string

IP adresa uživatele, který událost vytvořil
Uživatelé s příslušnými oznámeními
 webhookNotificationApplicableUsers array of ApplicableUsers

Seznam uživatelů, pro které se toto oznámení vztahuje
Agreement
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Úplné informace o smlouvě
Mega znaménko
 megaSign WebhookMegaSignInfo

Úplné informace o znaménku mega
Webový formulář
 widget WebhookWidgetInfo

Úplné informace o webovém formuláři

WebhookAgreementInfo

Úplné informace o smlouvě

Name Cesta Typ Description
ID
 id string

Jedinečné ID smlouvy
Název
 name string

Název smlouvy
Typ podpisu
 signatureType string

Určuje požadovaný typ podpisu – podpis e-podpis nebo zápis.
Stav
 status string

Aktuální stav smlouvy
Ccs
 ccs array of CcInfo

Seznam jednoho nebo více řadičů CCS, které se zkopírují v transakci smlouvy.
Datum vytvoření
 createdDate date

Datum vytvoření smlouvy
Čas vypršení platnosti
 expirationTime string

Čas, po jehož uplynutí platnost smlouvy vyprší a musí být podepsána před ní
Externí ID
 externalId.id string

Libovolná hodnota z vašeho systému, která se dá zadat při odesílání a pak později vrácená nebo dotazovaná.
Externí skupina
 externalId.group string

Libovolná hodnota z vašeho systému, která se dá zadat při odesílání a pak později vrácená nebo dotazovaná.
Zpoždění prvního připomenutí
 firstReminderDelay integer

Celé číslo, které určuje zpoždění v hodinách před odesláním prvního připomenutí.
Locale
 locale string

Národní prostředí přidružené k této smlouvě
Message
 message string

Nepovinná zpráva účastníkům s popisem toho, co se odesílá nebo proč se vyžaduje jejich podpis
Frekvence připomenutí
 reminderFrequency string

Volitelný parametr, který nastavuje, jak často chcete účastníkům odesílat připomenutí. Pokud není zadaný, použije se výchozí frekvence nastavená pro účet.
E-mail odesílatele
 senderEmail string

E-mail odesílatele smlouvy
Je povolené ukládání do trezoru?
 vaultingInfo.enabled boolean

U účtů nastavených pro trezor dokumentů a možnost povolit každou smlouvu určuje, jestli má být dokument trezorován.
Viditelnost dokumentu?
 documentVisibilityEnabled boolean

Je povolená viditelnost dokumentů.
ID pracovního postupu
 workflowId string

ID vlastního pracovního postupu, který definuje cestu směrování smlouvy.
Adresa URL přesměrování znaménka po podpisu
 postSignOption.redirectUrl string

Veřejně přístupná adresa URL, na kterou se uživatel odešle po úspěšném dokončení procesu podepisování
Sady účastníků
 participantSetsInfo.participantSets array of WebhookParticipantSets

Účastník nastaví informace.
Sady dalších účastníků
 participantSetsInfo.nextParticipantSets array of WebhookParticipantSets

Další účastník nastaví informace.
Documents
 documentsInfo.documents array of WebhookDocument

Seznam objektů představujících dokumenty
Podklady
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

Seznam podpůrných dokumentů

WebhookAgreementInfoWithoutNextParticipantSet

Úplné informace o smlouvě

Name Cesta Typ Description
ID
 id string

Jedinečné ID smlouvy
Název
 name string

Název smlouvy
Typ podpisu
 signatureType string

Určuje požadovaný typ podpisu – podpis e-podpis nebo zápis.
Stav
 status string

Aktuální stav smlouvy
Ccs
 ccs array of CcInfo

Seznam jednoho nebo více řadičů CCS, které se zkopírují v transakci smlouvy.
Datum vytvoření
 createdDate date

Datum vytvoření smlouvy
Viditelnost dokumentu?
 documentVisibilityEnabled boolean

Je povolená viditelnost dokumentů.
Čas vypršení platnosti
 expirationTime string

Čas, po jehož uplynutí platnost smlouvy vyprší a musí být podepsána před ní
Externí ID
 externalId.id string

Libovolná hodnota z vašeho systému, která se dá zadat při odesílání a pak později vrácená nebo dotazovaná.
Externí skupina
 externalId.group string

Libovolná hodnota z vašeho systému, která se dá zadat při odesílání a pak později vrácená nebo dotazovaná.
Zpoždění prvního připomenutí
 firstReminderDelay integer

Celé číslo, které určuje zpoždění v hodinách před odesláním prvního připomenutí.
Locale
 locale string

Národní prostředí přidružené k této smlouvě
Message
 message string

Nepovinná zpráva účastníkům s popisem toho, co se odesílá nebo proč se vyžaduje jejich podpis
Frekvence připomenutí
 reminderFrequency string

Volitelný parametr, který nastavuje, jak často chcete účastníkům odesílat připomenutí. Pokud není zadaný, použije se výchozí frekvence nastavená pro účet.
E-mail odesílatele
 senderEmail string

E-mail odesílatele smlouvy
Je povolené ukládání do trezoru?
 vaultingInfo.enabled boolean

U účtů nastavených pro trezor dokumentů a možnost povolit každou smlouvu určuje, jestli má být dokument trezorován.
Adresa URL přesměrování znaménka po podpisu
 postSignOption.redirectUrl string

Veřejně přístupná adresa URL, na kterou se uživatel odešle po úspěšném dokončení procesu podepisování
ID pracovního postupu
 workflowId string

ID vlastního pracovního postupu, který definuje cestu směrování smlouvy.
Sady účastníků
 participantSetsInfo.participantSets array of WebhookParticipantSets

Účastník nastaví informace.

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Úplné informace o smlouvě

Name Cesta Typ Description
ID
 id string

Jedinečné ID smlouvy
Název
 name string

Název smlouvy
Typ podpisu
 signatureType string

Určuje požadovaný typ podpisu – podpis e-podpis nebo zápis.
Stav
 status string

Aktuální stav smlouvy
Ccs
 ccs array of CcInfo

Seznam jednoho nebo více řadičů CCS, které se zkopírují v transakci smlouvy.
Datum vytvoření
 createdDate date

Datum vytvoření smlouvy
Čas vypršení platnosti
 expirationTime string

Čas, po jehož uplynutí platnost smlouvy vyprší a musí být podepsána před ní
Externí ID
 externalId.id string

Libovolná hodnota z vašeho systému, která se dá zadat při odesílání a pak později vrácená nebo dotazovaná.
Externí skupina
 externalId.group string

Libovolná hodnota z vašeho systému, která se dá zadat při odesílání a pak později vrácená nebo dotazovaná.
Zpoždění prvního připomenutí
 firstReminderDelay integer

Celé číslo, které určuje zpoždění v hodinách před odesláním prvního připomenutí.
Locale
 locale string

Národní prostředí přidružené k této smlouvě
Message
 message string

Nepovinná zpráva účastníkům s popisem toho, co se odesílá nebo proč se vyžaduje jejich podpis
Frekvence připomenutí
 reminderFrequency string

Volitelný parametr, který nastavuje, jak často chcete účastníkům odesílat připomenutí. Pokud není zadaný, použije se výchozí frekvence nastavená pro účet.
Adresa URL přesměrování znaménka po podpisu
 postSignOption.redirectUrl string

Veřejně přístupná adresa URL, na kterou se uživatel odešle po úspěšném dokončení procesu podepisování
ID pracovního postupu
 workflowId string

ID vlastního pracovního postupu, který definuje cestu směrování smlouvy.
E-mail odesílatele
 senderEmail string

E-mail odesílatele smlouvy
Viditelnost dokumentu?
 documentVisibilityEnabled boolean

Je povolená viditelnost dokumentů.
Je povolené ukládání do trezoru?
 vaultingInfo.enabled boolean

U účtů nastavených pro trezor dokumentů a možnost povolit každou smlouvu určuje, jestli má být dokument trezorován.
Sady účastníků
 participantSetsInfo.participantSets array of WebhookParticipantSets

Účastník nastaví informace.
Sady dalších účastníků
 participantSetsInfo.nextParticipantSets array of WebhookParticipantSets

Další účastník nastaví informace.
Documents
 documentsInfo.documents array of WebhookDocument

Seznam objektů představujících dokumenty
Podklady
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

Seznam podpůrných dokumentů, které jsou vráceny pouze v případě, že v dohodě existují nějaké podpůrné dokumenty.
Informace o podepsaném dokumentu
 signedDocumentInfo.document string

Řetězec s kódováním base64 podepsaného dokumentu

WebhookAgreementInfoWithSignedDocument

Úplné informace o smlouvě

Name Cesta Typ Description
ID
 id string

Jedinečné ID smlouvy
Název
 name string

Název smlouvy
Typ podpisu
 signatureType string

Určuje požadovaný typ podpisu – podpis e-podpis nebo zápis.
Stav
 status string

Aktuální stav smlouvy
Ccs
 ccs array of CcInfo

Seznam jednoho nebo více řadičů CCS, které budou zkopírovány v transakci smlouvy
Datum vytvoření
 createdDate date

Datum vytvoření smlouvy
Viditelnost dokumentu?
 documentVisibilityEnabled boolean

Je povolená viditelnost dokumentů.
Čas vypršení platnosti
 expirationTime string

Čas, po jehož uplynutí platnost smlouvy vyprší a musí být podepsána před ní
Externí ID
 externalId.id string

Libovolná hodnota z vašeho systému, která se dá zadat při odesílání a pak později vrácená nebo dotazovaná.
Externí skupina
 externalId.group string

Libovolná hodnota z vašeho systému, která se dá zadat při odesílání a pak později vrácená nebo dotazovaná.
Zpoždění prvního připomenutí
 firstReminderDelay integer

Celé číslo, které určuje zpoždění v hodinách před odesláním prvního připomenutí.
Locale
 locale string

Národní prostředí přidružené k této smlouvě
Message
 message string

Nepovinná zpráva účastníkům s popisem toho, co se odesílá nebo proč se vyžaduje jejich podpis
Frekvence připomenutí
 reminderFrequency string

Volitelný parametr, který nastavuje, jak často chcete účastníkům odesílat připomenutí. Pokud není zadaný, použije se výchozí frekvence nastavená pro účet.
E-mail odesílatele
 senderEmail string

E-mail odesílatele smlouvy
Je povolené ukládání do trezoru?
 vaultingInfo.enabled boolean

U účtů nastavených pro trezor dokumentů a možnost povolit každou smlouvu určuje, jestli má být dokument trezorován.
Adresa URL přesměrování znaménka po podpisu
 postSignOption.redirectUrl string

Veřejně přístupná adresa URL, na kterou se uživatel odešle po úspěšném dokončení procesu podepisování
ID pracovního postupu
 workflowId string

ID vlastního pracovního postupu, který definuje cestu směrování smlouvy.
Sady účastníků
 participantSetsInfo.participantSets array of WebhookParticipantSets

Účastník nastaví informace.
Documents
 documentsInfo.documents array of WebhookDocument

Seznam objektů představujících dokumenty
Podklady
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

Seznam podpůrných dokumentů, které jsou vráceny pouze v případě, že v dohodě existují nějaké podpůrné dokumenty.
Informace o podepsaném dokumentu
 signedDocumentInfo.document string

Řetězec s kódováním base64 podepsaného dokumentu

WebhookMegaSignInfo

Úplné informace o znaménku mega

Name Cesta Typ Description
ID
 id string

Jedinečné ID megasignu
Název
 name string

Název megasignu
Stav
 status string

Stav megasignu
Ccs
 ccs array of MegaSignCcInfo

Seznam jedné nebo více e-mailových adres, které chcete zkopírovat na tomto megasignu.
Externí ID
 externalId.id string

Libovolná hodnota z vašeho systému, která se dá zadat při odesílání a pak později vrácená nebo dotazovaná.
Zpoždění prvního připomenutí
 firstReminderDelay integer

Celé číslo, které určuje zpoždění v hodinách před odesláním prvního připomenutí.
Locale
 locale string

Národní prostředí přidružené k této smlouvě
Message
 message string

Nepovinná zpráva účastníkům s popisem toho, co se odesílá nebo proč se vyžaduje jejich podpis
Adresa URL přesměrování znaménka po podpisu
 postSignOption.redirectUrl string

Veřejně přístupná adresa URL, na kterou se uživatel odešle po úspěšném dokončení procesu podepisování
E-mail odesílatele
 senderEmail string

E-mail megasign creatoru
Typ podpisu
 signatureType string

Určuje požadovaný typ podpisu – podpis e-podpis nebo zápis.
Je povolené ukládání do trezoru?
 vaultingInfo.enabled boolean

U účtů nastavených pro trezor dokumentů a možnost povolit každou smlouvu určuje, jestli má být dokument trezorován.
Informace o souboru podřízených smluv
 childAgreementsInfo.fileInfo MegaSignChildAgreementsFileInfo

Informace o souboru obsahující informace o megaSignu pro každou podřízenou smlouvu

WebhookWidgetInfo

Úplné informace o webovém formuláři

Name Cesta Typ Description
ID
 id string

Jedinečné ID webového formuláře
Název
 name string

Název webového formuláře
Stav
 status string

Stav webového formuláře
Informace o selhání ověřování
 authFailureInfo AuthFailureWidgetRedirectionInfo

Adresa URL a přidružené vlastnosti chybové stránky, po které se nedaří ověřit podepisující webovou stránku
Ccs
 ccs array of WidgetCcInfo

Seznam jedné nebo více e-mailových adres, které chcete zkopírovat do tohoto webového formuláře.
Datum vytvoření
 createdDate date

Datum vytvoření webového formuláře
Informace o dokončení
 completionInfo WidgetCompletionRedirectionInfo

Adresa URL a přidružené vlastnosti stránky úspěchu, na které se podepisující webový formulář provede po provedení požadované akce ve webovém formuláři.
E-mail pro tvůrce
 creatorEmail string

E-mail autora webového formuláře
Je povolené ukládání do trezoru?
 vaultingInfo.enabled boolean

U účtů nastavených pro trezor dokumentů a možnost povolit každou smlouvu určuje, jestli má být dokument trezorován.
Další informace o sadách účastníků
 participantSetsInfo.additionalParticipantSets array of WidgetParticipantSetInfo

Seznam všech účastníků ve webovém formuláři s výjimkou podepisujícího webového formuláře
Role nastavení prvního účastníka
 participantSetsInfo.widgetParticipantSet.role string

Role, kterou převzali všichni účastníci v sadě (podepisující, schvalovatel atd.)
Pořadí nastavení prvního účastníka
 participantSetsInfo.widgetParticipantSet.order integer

Index označující sekvenční podpisovou skupinu (určenou pro hybridní směrování)
Documents
 documentsInfo.documents array of WidgetWebhookDocument

Seznam objektů představujících dokumenty

AuthFailureWidgetRedirectionInfo

Adresa URL a přidružené vlastnosti chybové stránky, po které se nedaří ověřit podepisující webovou stránku

Name Cesta Typ Description
Zpoždění přesměrování selhání ověřování
 delay integer

Zpoždění (v sekundách) před tím, než se uživatel přesune na výslednou stránku
Deframe přesměrování selhání ověřování
 deframe boolean

Pokud je deframe nepravda, výsledná stránka se zobrazí uvnitř rámce webového formuláře.
Adresa URL pro přesměrování selhání ověřování
 url string

Veřejně přístupná adresa URL, na kterou se uživatel odešle po úspěšném dokončení webového formuláře

WidgetCompletionRedirectionInfo

Adresa URL a přidružené vlastnosti stránky úspěchu, na které se podepisující webový formulář provede po provedení požadované akce ve webovém formuláři.

Name Cesta Typ Description
Zpoždění přesměrování dokončení
 delay integer

Zpoždění (v sekundách) před tím, než se uživatel přesune na výslednou stránku
Zrušení rámce přesměrování dokončení
 deframe boolean

Pokud je deframe nepravda, výsledná stránka se zobrazí uvnitř rámce webového formuláře.
Adresa URL pro přesměrování dokončení
 url string

Veřejně přístupná adresa URL, na kterou se uživatel odešle po úspěšném dokončení webového formuláře

WebhookParticipantSets

Name Cesta Typ Description
Informace o členech
 memberInfos array of MemberInfos

Informace o členech účastníků
Objednávka
 order integer

Index označující pozici, ve které se podpisová skupina musí podepsat.
Role
 role string

Role, kterou převzali všichni účastníci v sadě (podepisující, schvalovatel atd.)
Stav
 status string

Aktuální stav smlouvy z pohledu uživatele
ID
 id string

ID sady účastníků
Název
 name string

Název sady účastníků
Soukromá zpráva
 privateMessage string

Soukromá zpráva pro účastníky v sadě

MegaSignChildAgreementsFileInfo

Informace o souboru obsahující informace o megaSignu pro každou podřízenou smlouvu

Name Cesta Typ Description
ID souboru podřízených smluv
 childAgreementsInfoFileId string

ID souboru obsahující informace o existující podřízené AgreementsInfo megaSign.

WidgetWebhookDocument

Informace o dokumentu webového formuláře

Name Cesta Typ Description
ID
 id string

Jedinečné ID dokumentu
Název
 name string

Název dokumentu

WebhookDocument

Informace o dokumentu dohody

Name Cesta Typ Description
ID
 id string

Jedinečné ID dokumentu
Název
 name string

Název dokumentu

WebhookSupportingDocument

Informace o podpůrném dokumentu

Name Cesta Typ Description
Název
 displayLabel string

Zobrazovaný název podpůrného dokumentu
Název pole
 fieldName string

Název pole podpůrného dokumentu
ID
 id string

Jedinečné ID představující podpůrný dokument

WidgetCcInfo

Informace o kopii webového formuláře

Name Cesta Typ Description
Email
 email string

E-mail účastníka kopie webového formuláře

MegaSignCcInfo

Informace o kopii megaznamu

Name Cesta Typ Description
Email
 email string

E-mail účastníka kopie megasignu

CcInfo

Informace o kopii dohody

Name Cesta Typ Description
Email
 email string

E-mail kopie smlouvy
Označení
 label string

Popisek seznamu KOPIE vrácený v popisu pracovního postupu
Viditelné stránky
 visiblePages array of string

Stránky, které jsou viditelné v kopie

WidgetParticipantSetInfo

Name Cesta Typ Description
Role
 role string

Role, kterou převzali všichni účastníci v sadě (podepisující, schvalovatel atd.)
ID
 id string

Jedinečný identifikátor sady účastníků
Informace o členech
 memberInfos array of MemberInfos

Informace o členech účastníka
Objednávka
 order integer

Index označující sekvenční podpisovou skupinu (určenou pro hybridní směrování)

MemberInfos

Name Cesta Typ Description
ID
 id string

Jedinečné ID účastníka
Email
 email string

E-mail účastníka
Společnost
 company string

Společnost účastníka
Název
 name string

Jméno účastníka
Soukromá zpráva
 privateMessage string

Soukromá zpráva účastníka
Stav
 status string

Stav účastníka

LibraryDocumentCreationResponseV6

Objekt JSON popisující šablonu knihovny

Name Cesta Typ Description
ID šablony knihovny
 id string

Jedinečné ID, které lze použít k odkazu na šablonu knihovny

LibraryDocument

Name Cesta Typ Description
ID šablony knihovny
 id string

Jedinečný identifikátor, který se používá k odkazu na šablonu knihovny
Skrytý
 hidden boolean

Hodnota True, pokud je dokument knihovny skrytý
Typy šablon
 templateTypes array of string

Seznam jednoho nebo více typů šablon knihovny
Datum změny
 modifiedDate date

Den poslední změny šablony knihovny
Název šablony knihovny
 name string

Název šablony knihovny
Režim sdílení šablon
 sharingMode string

Rozsah viditelnosti šablony knihovny
E-mail pro tvůrce
 creatorEmail string

E-mailová adresa tvůrce dokumentů knihovny
ID skupiny
 groupId string

Jedinečný identifikátor skupiny, do které šablona knihovny patří.
Stav
 status string

Stav dokumentu knihovny

Dokumenty knihovny

JSON, který obsahuje objekt pole šablony knihovny

Name Cesta Typ Description
page
 page page

Informace o stránkování pro navigaci v odpovědi
Seznam šablon knihoven
 libraryDocumentList array of LibraryDocument

Seznam položek šablony knihovny

UserWidgetV6

Name Cesta Typ Description
ID webového formuláře
 id string

Jedinečný identifikátor webového formuláře
Datum změny
 modifiedDate string

Datum poslední změny webového formuláře
Skrytý
 hidden boolean

True if agreement is hidden for the user
ID skupiny
 groupId string

Jedinečný identifikátor skupiny
Název
 name string

Název webového formuláře
Stav
 status string

Stav webového formuláře
URL
 url string

Hostovaná adresa URL webového formuláře
JavaScript
 javascript string

Vložený javascriptový kód webového formuláře

userWidgetListV6

Json obsahující objekt pole webového formuláře uživatele

Name Cesta Typ Description
page
 page page

Informace o stránkování pro navigaci v odpovědi
Seznam webových formulářů
 userWidgetList array of UserWidgetV6

Pole položek webového formuláře

UserWorkflowV6

Name Cesta Typ Description
ID pracovního postupu
 id string

Jedinečný identifikátor pracovního postupu
Description
 description string

Popis uvedený pro tento pracovní postup v době jejího vytvoření
Datum vytvoření
 created string

Datum, kdy byl pracovní postup vytvořen. Formát by byl rrrr-MM-dd'T'HH:mm:ssZ
Datum změny
 modified string

Datum, kdy byl pracovní postup změněn. Formát by byl rrrr-MM-dd'T'HH:mm:ssZ
Název
 name string

Název pracovního postupu
Zobrazovaný název
 displayName string

Zobrazovaný název pracovního postupu
Stav
 status string

Stav pracovního postupu
Scope
 scope string

Obor pracovního postupu
ID původce
 originatorId string

Počáteční původce pracovního postupu
ID Oboru
 scopeId string

Identifikátor oboru. V současné době platí jenom pro obor GROUP a hodnota bude groupId.

userWorkflowListV6

JSON obsahující objekt pole pracovního postupu uživatele

Name Cesta Typ Description
Seznam pracovních postupů
 userWorkflowList array of UserWorkflowV6

Pole položek pracovního postupu

WorkflowDefaultParamsV6

JSON, který obsahuje výchozí objekt parametrů pracovního postupu

Name Cesta Typ Description
Výchozí hodnota
 defaultValue string

Výchozí hodnota pole, pokud není zadaný vstup pro toto pole a toto pole je povinné
Upravitelné
 editable boolean

Určuje, zda je možné upravit aktuální pole. Pokud je upravitelný atribut pro toto pole false, toto pole by nemělo být zadané v žádosti o vytvoření smlouvy a výchozí hodnota tohoto pole bude použita při vytváření smlouvy.
Povinné
 required boolean

Bez ohledu na to, jestli je toto pole povinné nebo volitelné
Viditelný
 visible boolean

Zda je aktuální pole viditelné nebo ne. Pokud je viditelný atribut pro toto pole false, toto pole by nemělo být viditelné v uživatelském rozhraní pro vytvoření smlouvy pomocí tohoto pracovního postupu pro uživatele.

CCsListInfoDescriptionV6

JSON, který obsahuje podrobné informace o pracovním postupu

Name Cesta Typ Description
Výchozí hodnoty
 defaultValues array of string

Pole výchozíchech
Upravitelné
 editable boolean

Určuje, zda je možné upravit aktuální pole. Pokud je upravitelný atribut pro toto pole false, toto pole by nemělo být zadané v žádosti o vytvoření smlouvy a výchozí hodnota tohoto pole bude použita při vytváření smlouvy.
Označení
 label string

Zobrazovaný text pro uživatele pracovního postupu, který lze použít pro aktuální seznam kopie
Maximální počet položek KOPIE
 maxListCount integer

Maximální počet položek povolených v aktuálním seznamu KOPIE
Minimální počet položek kopie
 minListCount integer

Minimální povolený počet položek v aktuálním seznamu KOPIE
Název seznamu KOPIE
 name string

Název aktuálního seznamu KOPIE
Povinné
 required boolean

Bez ohledu na to, jestli je toto pole povinné nebo volitelné
Viditelný
 visible boolean

Zda je aktuální pole viditelné nebo ne. Pokud je viditelný atribut pro toto pole false, toto pole by se nemělo zobrazovat na stránce pro vytvoření smlouvy pomocí tohoto pracovního postupu.

ExpirationFieldInfoDescriptionV6

JSON, který obsahuje informace o vypršení platnosti

Name Cesta Typ Description
Výchozí hodnota
 defaultValue string

Výchozí hodnota pole, pokud není zadaný vstup pro toto pole a toto pole je povinné
Upravitelné
 editable boolean

Určuje, zda je možné upravit aktuální pole. Pokud je upravitelný atribut pro toto pole false, toto pole by nemělo být zadané v žádosti o vytvoření smlouvy a výchozí hodnota tohoto pole bude použita při vytváření smlouvy.
Maximální počet dnů vypršení platnosti smlouvy
 maxDays integer

Maximální počet dnů pro vypršení platnosti smlouvy
Povinné
 required boolean

Bez ohledu na to, jestli je toto pole povinné nebo volitelné
Viditelný
 visible boolean

Zda je aktuální pole viditelné nebo ne. Pokud je viditelný atribut pro toto pole false, toto pole by se nemělo zobrazovat na stránce pro vytvoření smlouvy pomocí tohoto pracovního postupu.

FileInfosDescriptionV6

JSON, který obsahuje informace o souborech

Name Cesta Typ Description
Označení
 label string

Zobrazit popisek tohoto pole pro externí uživatele
Název
 name string

Název elementu fileInfo
Povinné
 required boolean

Bez ohledu na to, jestli je toto pole povinné nebo volitelné
Dokumenty knihovny pracovních postupů
 workflowLibraryDocumentSelectorList array of WorkflowLibraryDocumentV6

Seznam dokumentů knihovny pracovních postupů, ze kterých lze vybrat jeden dokument knihovny pracovních postupů s tímto objektem fileInfo

WorkflowLibraryDocumentV6

JSON, který obsahuje informace o dokumentu knihovny pracovních postupů

Name Cesta Typ Description
Označení
 label string

Zobrazovaný text pro tento formulář pro uživatele pracovního postupu
Datum změny
 modifiedDate string

Datum poslední změny dokumentu knihovny. Formát by byl rrrr-MM-dd'T'HH:mm:ssZ. Například například 2016-02-25T18:46:19Z představuje čas UTC.
Režim sdílení
 sharingMode string

Určuje, kdo má mít přístup k tomuto dokumentu knihovny. Globální sdílení je operace s omezeným přístupem.
Typy šablon
 templateTypes array of

Seznam jednoho nebo více typů šablon knihovny
ID dokumentu knihovny pracovních postupů
 workflowLibDoc string

ID dokumentu knihovny pracovních postupů, který lze zadat jako vstupní soubor v žádosti o vytvoření vlastní smlouvy pracovního postupu

LocaleFieldInfoDescriptionV6

Json, který obsahuje podrobné informace o národním prostředí pracovního postupu

Name Cesta Typ Description
Dostupná národní prostředí
 availableLocales array of string

Která národní prostředí je možné pro tento pracovní postup zvolit
Výchozí hodnota
 defaultValue string

Výchozí hodnota pole, pokud není zadaný vstup pro toto pole a toto pole je povinné
Upravitelné
 editable boolean

Určuje, zda je možné upravit aktuální pole. Pokud je upravitelný atribut pro toto pole false, toto pole by nemělo být zadané v žádosti o vytvoření smlouvy a výchozí hodnota tohoto pole bude použita při vytváření smlouvy.
Povinné
 required boolean

Bez ohledu na to, jestli je toto pole povinné nebo volitelné
Viditelný
 visible boolean

Zda je aktuální pole viditelné nebo ne. Pokud je viditelný atribut pro toto pole false, toto pole by nemělo být viditelné v uživatelském rozhraní pro vytvoření smlouvy pomocí tohoto pracovního postupu pro uživatele.

MergeFieldInfoDescriptionV6

JSON, který obsahuje podrobné informace o slučovacím poli

Name Cesta Typ Description
Výchozí hodnota
 defaultValue string

Výchozí hodnota pole, pokud není zadaný vstup pro toto pole a toto pole je povinné
Zobrazovaný název
 displayName string

Zobrazovaný text, který lze zobrazit pro toto vlastní pole
Upravitelné
 editable boolean

Určuje, zda je možné upravit aktuální pole. Pokud je upravitelný atribut pro toto pole false, toto pole by nemělo být zadané v žádosti o vytvoření smlouvy a výchozí hodnota tohoto pole bude použita při vytváření smlouvy.
Název vlastního pole
 fieldName string

Název vlastního pole v tomto pracovním postupu
Povinné
 required boolean

Bez ohledu na to, jestli je toto pole povinné nebo volitelné
Viditelný
 visible boolean

Zda má být aktuální pole viditelné na stránce pro vytvoření smlouvy. Pokud je viditelný atribut pro toto pole false, toto pole by se nemělo zobrazovat na stránce pro vytvoření smlouvy pomocí tohoto pracovního postupu.

PasswordFieldInfoDescriptionV6

JSON, který obsahuje podrobné informace o hesle

Name Cesta Typ Description
Heslo
 defaultValue string

Výchozí hodnota pole s informacemi o hesle
Upravitelné
 editable boolean

Určuje, zda je možné upravit aktuální pole. Pokud je upravitelný atribut pro toto pole false, toto pole by nemělo být zadané v žádosti o vytvoření smlouvy a výchozí hodnota tohoto pole bude použita při vytváření smlouvy.
Označení
 label string

Popisek pole s heslem
Název
 name string

Pole Název hesla
Povinné
 required boolean

Bez ohledu na to, jestli je toto pole povinné nebo volitelné
Viditelný
 visible boolean

Jestli je na stránce pro vytvoření smlouvy viditelné pole s informacemi o hesle

RecipientsListInfoDescriptionV6

Json obsahující podrobné informace o seznamu příjemců

Name Cesta Typ Description
Povolit odesílatele
 allowSender boolean

Jestli je odesílatel povolený jako příjemce
Povolit odesílatele
 allowfax boolean

Jestli je fax povolený, nebo ne
Metoda ověřování
 authenticationMethod string

Metoda ověřování pro aktuální seznam příjemců, která má přístup k zobrazení a podepsání dokumentu,
Výchozí hodnota e-mailu nebo faxu
 defaultValue string

Výchozí e-mail nebo faxové číslo
Upravitelné
 editable boolean

Určuje, zda je možné upravit aktuální pole. Pokud je upravitelný atribut pro toto pole false, toto pole by nemělo být zadané v žádosti o vytvoření smlouvy a výchozí hodnota tohoto pole bude použita při vytváření smlouvy.
Označení
 label string

Zobrazovaný text pro uživatele pracovního postupu, který lze použít pro aktuální seznam příjemců
Maximální počet příjemců
 maxListCount integer

Maximální povolený počet položek v aktuálním seznamu příjemců
Minimální příjemci
 minListCount integer

Minimální počet položek povolených v aktuálním seznamu příjemců
Jméno seznamu informací o příjemci
 name string

Název aktuálního seznamu informací o příjemci
Role účastníka
 role string

Aktuální role účastníka
Viditelný
 visible boolean

Zda je aktuální pole viditelné. Pokud je viditelný atribut pro toto pole false, toto pole by se nemělo zobrazovat v uživatelském rozhraní pro vytvoření smlouvy pomocí tohoto pracovního postupu pro uživatele.

WorkflowDescriptionV6

JSON, který obsahuje podrobné informace o pracovním postupu

Name Cesta Typ Description
agreementNameInfo
 agreementNameInfo WorkflowDefaultParamsV6

JSON, který obsahuje výchozí objekt parametrů pracovního postupu
authoringInfo
 authoringInfo WorkflowDefaultParamsV6

JSON, který obsahuje výchozí objekt parametrů pracovního postupu
Informace o seznamu kopie
 ccsListInfo array of CCsListInfoDescriptionV6

Informace o vstupním poli seznamu KOPIE v žádosti o vytvoření smlouvy
Datum vytvoření pracovního postupu
 created string

Den vytvoření pracovního postupu
Popis pracovního postupu
 description string

Popis uvedený pro tento pracovní postup v době jejího vytvoření
Zobrazovaný název pracovního postupu
 displayName string

Zobrazovaný název pracovního postupu
expirationInfo
 expirationInfo ExpirationFieldInfoDescriptionV6

JSON, který obsahuje informace o vypršení platnosti
Informace o souborech
 fileInfos array of FileInfosDescriptionV6

Informace o vstupním poli informací o souboru v žádosti o vytvoření smlouvy
localeInfo
 localeInfo LocaleFieldInfoDescriptionV6

Json, který obsahuje podrobné informace o národním prostředí pracovního postupu
Informace o slučovacích polích
 mergeFieldsInfo array of MergeFieldInfoDescriptionV6

Informace o vstupním poli vlastních informací v žádosti o vytvoření smlouvy
messageInfo
 messageInfo WorkflowDefaultParamsV6

JSON, který obsahuje výchozí objekt parametrů pracovního postupu
Datum změny
 modified string

Den poslední změny pracovního postupu
Název pracovního postupu
 name string

Název pracovního postupu
passwordInfo
 passwordInfo PasswordFieldInfoDescriptionV6

JSON, který obsahuje podrobné informace o hesle
Informace o seznamu příjemců
 recipientsListInfo array of RecipientsListInfoDescriptionV6

Informace o vstupním poli informací o recepients v žádosti o vytvoření smlouvy
Obor pracovního postupu
 scope string

Obor pracovního postupu
Stav pracovního postupu
 status string

Stav pracovního postupu
ID původce pracovního postupu
 originatorId string

Počáteční původce pracovního postupu
ID oboru pracovního postupu
 scopeId string

Identifikátor oboru. V současné době platí jenom pro obor GROUP a hodnota bude groupId.

BooleanSettingInfoV6

Name Cesta Typ Description
Hodnota
 value boolean

Hodnota nastavení
Zděděný
 inherited boolean

Hodnota True, pokud je nastavení zděděno ze skupiny nebo hodnoty účtu

SettingsInfoV6

Name Cesta Typ Description
libaryDocumentCreationVisible
 libaryDocumentCreationVisible BooleanSettingInfoV6
sendRestrictedToWorkflows
 sendRestrictedToWorkflows BooleanSettingInfoV6
userCanSend
 userCanSend BooleanSettingInfoV6
widgetCreationVisible
 widgetCreationVisible BooleanSettingInfoV6

UserGroupInfoV6

Name Cesta Typ Description
ID skupiny
 id string

Jedinečný identifikátor skupiny
Je správce skupiny
 isGroupAdmin boolean

Hodnota True, pokud je uživatel správcem skupiny
Je primární skupina
 isPrimaryGroup boolean

Hodnota True, pokud je skupina primární skupinou uživatele
Stav
 status string

Stav členství ve skupině
Datum vytvoření
 createdDate date

Datum vytvoření skupiny
Název skupiny
 name string

Název skupiny
nastavení
 settings SettingsInfoV6

UserGroupsInfoV6

JSON, který obsahuje seznam skupin pro daného uživatele

Name Cesta Typ Description
Seznam skupin uživatelů
 groupInfoList array of UserGroupInfoV6

Pole položek s informacemi o skupině uživatelů

Zobrazení smlouvy

Seznam zobrazení smluv

Name Cesta Typ Description
Seznam zobrazení smlouvy
 agreementViewList array of AgreementView

Zobrazení smluv

AgreementView

Název požadovaného zobrazení a požadované konfigurace

Name Cesta Typ Description
Zobrazit adresu URL
 url string

Adresa URL umístění prostředku
Vložený kód
 embeddedCode string

Vložený kód adresy URL prostředku
Vypršení platnosti
 expiration string

Vypršení platnosti adresy URL uživatele
Je aktuální zobrazení
 isCurrent boolean

True, pokud toto zobrazení je aktuální zobrazení

binární

Toto je základní datový typ Binary.

objekt

Toto je typ "object".

soubor

Toto je základní datový typ "file".