Certinal eSign (Preview)
Certinal eSign umožňuje podnikům bezpečně odesílat, podepisovat a spravovat dokumenty pomocí globálně kompatibilních eSignatur. Certinal je navržený pro regulovaná odvětví, poskytuje sledování pracovních postupů v reálném čase, záznamy auditu kontroly proti manipulaci a bezproblémovou automatizaci. Pomocí podpisu Certinal eSign můžete v pracovních postupech digitalizovat schválení, zrychlit procesy a zajistit právně platné podpisy v rámci 70 zemí a více.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Nápověda a podpora |
| URL | https://www.certinal.com/department/esignature-for-support |
| tech-support@certinal.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | Certinal Inc. |
| Internetová stránka | https://www.certinal.com/ |
| Zásady ochrany osobních údajů | https://www.certinal.com/privacy-policy |
| Kategorie | Produktivita; Správa podniku |
Certinal eSign
Přehled
Certinal eSign poskytuje bezpečné a vyhovující pracovní postupy eSignature a eConsent pro globální podniky – odesílání, podepisování, sledování a správa dokumentů přímo z Power Automate.
Požadavky
Abyste mohli použít trigger konektoru, musíte mít účet správce Certinal. Pokud chcete v této integraci použít trigger konektoru, musí být v nastavení správce certinal povolený Power Connector.
Jak získat přihlašovací údaje
Certinal používá k ověřování služeb klíč rozhraní API. Klíč rozhraní API musíte vygenerovat z účtu správce Certinal.
Podporované operace
Konektor podporuje následující operace:
Získání podrobností o transakci
Získání podrobností o transakci podle ID transakce
Stáhnout dokumenty pro transakci
Stažení dokumentů pro dané ID transakce
Vytvoření transakce
Vytvoření transakce
Vytvoření transakce pomocí šablony
Vytvoření transakce pomocí daného ID šablony
Seznam uživatelů
Seznam uživatelů
Získání podrobností o uživateli
Získání podrobností o uživateli pro dané ID uživatele
Vytvoření uživatele
Vytvoření uživatele
Podporované triggery
Konektor podporuje následující triggery:
Při změně stavu transakce
Registrace zpětného volání pro konkrétní událost transakce
Dokumenty rozhraní API:
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
Nápověda a podpora
https://esign.certinal.com/esign/certinal-docs/help-support
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| výchozí | Parametry pro vytvoření připojení | Všechny oblasti | Nesdílitelné |
Výchozí
Použitelné: Všechny oblasti
Parametry pro vytvoření připojení
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| Klíč rozhraní API | securestring | Klíč rozhraní API pro toto rozhraní API | Pravdivé |
| Koncový bod základního rozhraní API | řetězec | Základní adresa URL koncového bodu rozhraní API (např. api.certinal.com) | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Seznam uživatelů |
Seznam uživatelů |
| Smazat předplatné |
Smazat předplatné |
| Stáhnout dokumenty pro transakci |
Stažení dokumentů pro dané ID transakce |
| Vytvoření transakce |
Vytvoření transakce |
| Vytvoření transakce pomocí šablony |
Vytvoření transakce pomocí daného ID šablony |
| Vytvoření uživatele |
Vytvoření uživatele |
| Získání podrobností o transakci |
Získání podrobností o transakci podle ID transakce |
| Získání podrobností o uživateli |
Získání podrobností o uživateli pro dané ID uživatele |
Seznam uživatelů
Seznam uživatelů
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo stránky
|
pageNo | True | integer | |
|
Počet záznamů na stránku
|
perPageRecords | True | integer |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Časová značka
|
timestamp | integer |
Časová značka |
|
Kód stavu
|
statusCode | integer |
Kód stavu |
|
Message
|
message | string |
Message |
|
Celkový počet záznamů
|
data.totalRecords | integer |
total records |
|
Total Pages
|
data.totalPages | integer |
Total Pages |
|
Záznamy na stránku
|
data.perPageRecords | integer |
Záznamy na stránku |
|
Číslo stránky
|
data.pageNo | integer |
Číslo stránky |
|
Záznamy
|
data.records | array of object |
Záznamy uživatelů |
|
Křestní jméno
|
data.records.firstName | string |
Křestní jméno |
|
Příjmení
|
data.records.lastName | string |
Příjmení |
|
Společnost
|
data.records.company | string |
Společnost |
|
Časové pásmo
|
data.records.timezone | string |
Časové pásmo |
|
Jazyk
|
data.records.language | string |
Jazyk |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
Název pracovní pozice
|
data.records.jobTitle | string |
Název pracovní pozice |
|
Telefonní číslo
|
data.records.phoneNumber | string |
Telefonní číslo |
|
Kód země
|
data.records.phoneCountryCode | string |
Kód země |
|
Seznam rolí
|
data.records.roles | array of string |
Seznam rolí |
|
Je konečná pošta zakázaná?
|
data.records.finalMailDisabled | boolean |
Je konečná pošta zakázaná? |
|
Je pošta připomenutí zakázaná?
|
data.records.reminderMailDisabled | boolean |
Je pošta připomenutí zakázaná? |
|
Je pošta odesílatele zakázaná?
|
data.records.senderMailDisabled | boolean |
Je pošta odesílatele zakázaná? |
|
Je uživatel integrace?
|
data.records.integrationUser | boolean |
Je uživatel integrace? |
|
Oslovení
|
data.records.salutation | string |
Oslovení |
|
Je aktivní
|
data.records.active | boolean |
Je aktivní |
|
identifikační číslo
|
data.records.id | string |
identifikační číslo |
|
E-mailová adresa
|
data.records.emailAddress | string |
E-mailová adresa |
Smazat předplatné
Smazat předplatné
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID webhooku
|
webhookId | True | string |
Jedinečný identifikátor předplatného webhooku k odstranění |
Stáhnout dokumenty pro transakci
Stažení dokumentů pro dané ID transakce
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID transakce
|
transactionId | True | string |
Jedinečné ID transakce |
|
Typ dokladu
|
documentType | True | string |
Typ dokumentu ke stažení |
Návraty
- response
- file
Vytvoření transakce
Vytvoření transakce
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název transakce
|
name | True | string |
Název transakce |
|
Message
|
message | string |
Zpráva pro všechny účastníky e-mail. |
|
|
Adresa URL zpětného volání
|
url | string |
Adresa URL zpětného volání |
|
|
Události transakcí
|
transactionEvents | array of string |
Události transakcí |
|
|
Události účastníků
|
participantEvents | array of string |
Události účastníků |
|
|
Stav transakce
|
status | string |
Stav transakce |
|
|
Externí ID
|
externalId | string |
Externí ID |
|
|
Vyprší v časovém razítku.
|
expiresAtTimestamp | string |
Platnost transakce vyprší v časovém razítku |
|
|
Připomenout z časového razítka
|
remindFromTimestamp | string |
Připomenout z časového razítka |
|
|
Frekvence připomenutí
|
reminderFrequency | integer |
Frekvence připomenutí |
|
|
Výchozí pole
|
default | boolean |
Výchozí pole bloku podpisu |
|
|
Posloupnost účastníků
|
sequence | integer |
Sekvence |
|
|
Role
|
role | string |
Role |
|
|
Název
|
name | string |
Jméno kandidáta |
|
|
E-mailová adresa
|
emailAddress | string |
E-mailová adresa kandidáta |
|
|
Jazyk
|
language | string |
Jazyk |
|
|
Režim ověřování
|
authenticationMode | string |
Režim ověřování |
|
|
Hodnota režimu ověřování
|
authenticationModeValue | string |
Hodnota režimu ověřování |
|
|
Kanály doručování
|
deliveryChannels | array of string |
Kanály doručování |
|
|
ID pole
|
fieldId | string |
ID pole |
|
|
Stránky
|
pages | array of string |
Stránky |
|
|
ID dokumentu
|
documentId | string |
ID dokumentu |
|
|
Šířka pole
|
width | float |
Šířka pole |
|
|
Výška pole
|
height | float |
Výška pole |
|
|
Nástrojová nápověda
|
tooltip | string |
Nástrojová nápověda |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Počet řádků textové oblasti
|
textareaLineCount | string |
Počet řádků textové oblasti |
|
|
Název pole
|
fieldName | string |
Název pole |
|
|
Pozice X
|
xposition | float |
Pozice X pole |
|
|
Pozice Y
|
yposition | float |
Pozice Y pole |
|
|
Je požadováno?
|
required | boolean |
Jedná se o povinné pole? |
|
|
Je jen pro čtení?
|
readOnly | boolean |
Jedná se o pole Jen pro čtení? |
|
|
Textové pole
|
textarea | boolean |
Textové pole |
|
|
Nahoře dole
|
topBottom | boolean |
Nahoře dole |
|
|
Vertikální
|
vertical | boolean |
Vertikální |
|
|
ID skupiny rádia
|
radioGroupId | string |
ID skupiny rádia |
|
|
Výchozí hodnota
|
defaultValue | string |
Výchozí hodnota |
|
|
Hodnota
|
value | string |
Hodnota |
|
|
Zobrazit popisek
|
displayLabel | string |
Zobrazit popisek |
|
|
Název
|
name | string |
Název |
|
|
E-mailová adresa
|
emailAddress | string |
E-mailová adresa |
|
|
Jazyk
|
language | string |
Jazyk |
|
|
ID dokumentu
|
id | string |
ID dokumentu |
|
|
Sekvence
|
sequence | integer |
Sekvence |
|
|
Je deletable?
|
deletable | boolean |
Je deletable? |
|
|
Je soukromé
|
private | boolean |
Je soukromé |
|
|
Hodnota pole
|
value | string |
Hodnota pole |
|
|
Název pole
|
fieldName | string |
Název pole |
|
|
Code
|
code | string |
Code |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Časová značka
|
timestamp | integer |
Časová značka |
|
Kód stavu
|
statusCode | integer |
Kód stavu |
|
Message
|
message | string |
Message |
|
ID transakce
|
data.transactionId | string |
ID transakce |
Vytvoření transakce pomocí šablony
Vytvoření transakce pomocí daného ID šablony
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název transakce
|
name | string |
Název transakce |
|
|
Stav transakce
|
status | string |
Stav transakce |
|
|
Externí ID
|
externalId | string |
Externí ID |
|
|
ID šablony
|
templateId | string |
ID šablony |
|
|
ID sekundární šablony
|
secondaryTemplateIds | array of string |
ID sekundární šablony |
|
|
Message
|
message | string |
Zpráva pro všechny účastníky e-mail. |
|
|
Adresa URL zpětného volání
|
url | string |
Adresa URL zpětného volání |
|
|
Události transakcí
|
transactionEvents | array of string |
Události transakcí |
|
|
Události účastníků
|
participantEvents | array of string |
Události účastníků |
|
|
Posloupnost účastníků
|
sequence | integer |
Sekvence |
|
|
Role
|
role | string |
Role |
|
|
Je automatický proces?
|
autoProcess | boolean |
Je automatický proces? |
|
|
Název pole
|
fieldName | string |
Název pole |
|
|
Hodnota pole
|
value | string |
Hodnota pole |
|
|
Název
|
name | string |
Jméno kandidáta |
|
|
E-mailová adresa
|
emailAddress | string |
E-mailová adresa kandidáta |
|
|
Message
|
message | string |
Message |
|
|
Jazyk
|
language | string |
Jazyk |
|
|
Kanály doručování
|
deliveryChannels | array of string |
Kanály doručování |
|
|
Vlastní text SMS
|
customSMSBody | string |
Vlastní text SMS |
|
|
Název
|
name | string |
Název |
|
|
Message
|
message | string |
Message |
|
|
Je požadováno?
|
required | boolean |
Je požadováno? |
|
|
Název
|
name | string |
Název |
|
|
E-mailová adresa
|
emailAddress | string |
E-mailová adresa |
|
|
Jazyk
|
language | string |
Jazyk |
|
|
Hodnota pole
|
value | string |
Hodnota pole |
|
|
Název pole
|
fieldName | string |
Název pole |
|
|
Code
|
code | string |
Code |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Časová značka
|
timestamp | integer |
Časová značka |
|
Kód stavu
|
statusCode | integer |
Kód stavu |
|
Message
|
message | string |
Message |
|
ID transakce
|
data.transactionId | string |
ID transakce |
Vytvoření uživatele
Vytvoření uživatele
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
E-mailová adresa
|
emailAddress | string |
E-mailová adresa |
|
|
Křestní jméno
|
firstName | string |
Křestní jméno |
|
|
Příjmení
|
lastName | string |
Příjmení |
|
|
Společnost
|
company | string |
Společnost |
|
|
Časové pásmo
|
timezone | string |
Časové pásmo |
|
|
Jazyk
|
language | string |
Jazyk |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Oslovení
|
salutation | string |
Oslovení |
|
|
Název pracovní pozice
|
jobTitle | string |
Název pracovní pozice |
|
|
Telefonní číslo
|
phoneNumber | string |
Telefonní číslo |
|
|
Kód země
|
phoneCountryCode | string |
Kód země |
|
|
Seznam rolí
|
roles | array of string |
Seznam rolí |
|
|
Je konečná pošta zakázaná?
|
finalMailDisabled | boolean |
Je konečná pošta zakázaná? |
|
|
Je pošta připomenutí zakázaná?
|
reminderMailDisabled | boolean |
Je pošta připomenutí zakázaná? |
|
|
Je pošta odesílatele zakázaná?
|
senderMailDisabled | boolean |
Je pošta odesílatele zakázaná? |
|
|
Je uživatel integrace?
|
integrationUser | boolean |
Je uživatel integrace? |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Časová značka
|
timestamp | integer |
Časová značka |
|
Kód stavu
|
statusCode | integer |
Kód stavu |
|
Message
|
message | string |
Message |
|
ID uživatele
|
data.user_id | string |
ID uživatele |
Získání podrobností o transakci
Získání podrobností o transakci podle ID transakce
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID transakce
|
transactionId | True | string |
Jedinečné ID transakce |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Časová značka
|
timestamp | integer |
Časová značka |
|
Kód stavu
|
statusCode | integer |
Kód stavu |
|
Message
|
message | string |
Message |
|
Název transakce
|
data.name | string |
Název transakce |
|
Stav transakce
|
data.status | string |
Stav transakce |
|
ID transakce
|
data.transactionId | string |
ID transakce |
|
Message
|
data.mail.message | string |
Zpráva pro všechny účastníky e-mail. |
|
Datum poslední aktualizace
|
data.lastUpdatedDate | string |
Datum poslední aktualizace |
|
Datum vytvoření
|
data.createdDate | string |
Datum vytvoření |
|
ID uživatele
|
data.createdBy.id | string |
Vytvořil(a) ID uživatele |
|
Uživatelské jméno
|
data.createdBy.username | string |
Vytvořil(a) uživatelské jméno |
|
E-mailová adresa
|
data.createdBy.emailAddress | string |
Vytvořeno e-mailovou adresou |
|
Datum odeslání
|
data.sentDate | string |
Datum odeslání |
|
ID uživatele
|
data.lastActionPerformedBy.userId | string |
ID uživatele |
|
Uživatelské jméno
|
data.lastActionPerformedBy.userName | string |
Uživatelské jméno |
|
E-mailová adresa
|
data.lastActionPerformedBy.emailAddress | string |
E-mailová adresa |
|
ID kandidáta
|
data.lastActionPerformedBy.candidateId | string |
ID kandidáta |
|
ID účastníka
|
data.lastActionPerformedBy.participantId | string |
ID účastníka |
|
Vyprší v časovém razítku.
|
data.expiryAndReminders.expiresAtTimestamp | string |
Platnost transakce vyprší v časovém razítku |
|
Dny vypršení platnosti
|
data.expiryAndReminders.expiryDays | integer |
Dny vypršení platnosti |
|
Připomenout z dnů připomenutí
|
data.expiryAndReminders.remindFromReminderDays | integer |
Připomenout z dnů připomenutí |
|
Připomenout z času připomenutí
|
data.expiryAndReminders.remindFromReminderTime | string |
Připomenout z času připomenutí |
|
Frekvence připomenutí
|
data.expiryAndReminders.reminderFrequency | integer |
Frekvence připomenutí |
|
Účastníci
|
data.participants | array of object |
Účastníci |
|
ID účastníka
|
data.participants.id | string |
ID účastníka |
|
Stav účastníka
|
data.participants.status | string |
Stav účastníka |
|
Datum poslední aktualizace
|
data.participants.lastUpdatedDate | string |
Datum poslední aktualizace |
|
Datum vytvoření
|
data.participants.createdDate | string |
Datum vytvoření |
|
Posloupnost účastníků
|
data.participants.sequence | integer |
Sekvence |
|
Role
|
data.participants.role | string |
Role |
|
Metoda podepisování
|
data.participants.signingMethodDTO | array of string |
Podrobnosti metody podepisování |
|
Odesláno uživatelem
|
data.participants.submittedBys | array of object |
Odesláno podle podrobností uživatele |
|
ID uživatele
|
data.participants.submittedBys.userId | string |
Odesláno podle ID uživatele |
|
Uživatelské jméno
|
data.participants.submittedBys.userName | string |
Odesláno jménem uživatele |
|
E-mailová adresa
|
data.participants.submittedBys.emailAddress | string |
Odesláno e-mailovou adresou uživatele |
|
ID kandidáta
|
data.participants.submittedBys.candidateId | string |
ID kandidáta |
|
kandidáti
|
data.participants.candidates | array of object |
kandidáti |
|
ID kandidáta
|
data.participants.candidates.id | string |
ID kandidáta |
|
Název
|
data.participants.candidates.name | string |
Jméno kandidáta |
|
E-mailová adresa
|
data.participants.candidates.emailAddress | string |
E-mailová adresa kandidáta |
|
Jazyk
|
data.participants.candidates.language | string |
Jazyk |
|
Typ
|
data.participants.candidates.type | string |
Typ |
|
Činnost
|
data.participants.candidates.action | string |
Činnost |
|
Datum akce
|
data.participants.candidates.actionDate | string |
Datum akce |
|
Datum vytvoření
|
data.participants.candidates.createdDate | string |
Datum vytvoření |
|
Hodnota režimu ověřování
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Hodnota režimu ověřování |
|
podrobnosti metody podepisování
|
data.participants.candidates.signingMethodDTO | array of string |
podrobnosti metody podepisování |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Kanály doručování
|
data.participants.candidates.deliveryChannels | array of string |
Kanály doručování |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
identifikační číslo
|
data.participants.fields.id | string |
identifikační číslo |
|
Datum poslední aktualizace
|
data.participants.fields.lastUpdatedDate | string |
Datum poslední aktualizace |
|
Datum vytvoření
|
data.participants.fields.createdDate | string |
Datum vytvoření |
|
ID pole
|
data.participants.fields.fieldId | string |
ID pole |
|
Číslo stránky
|
data.participants.fields.pageNo | integer |
Číslo stránky |
|
ID dokumentu
|
data.participants.fields.documentId | string |
ID dokumentu |
|
Šířka pole
|
data.participants.fields.width | float |
Šířka pole |
|
Výška pole
|
data.participants.fields.height | float |
Výška pole |
|
Nástrojová nápověda
|
data.participants.fields.tooltip | string |
Nástrojová nápověda |
|
Hodnota
|
data.participants.fields.value | string |
Hodnota |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Zobrazit popisek
|
data.participants.fields.displayLabel | string |
Zobrazit popisek |
|
Typ propojení
|
data.participants.fields.linkType | string |
Typ propojení |
|
ID rádia
|
data.participants.fields.radioId | integer |
ID rádia |
|
ID skupiny rádia
|
data.participants.fields.radioGroupId | string |
ID skupiny rádia |
|
ID zaškrtávacího políčka
|
data.participants.fields.checkboxId | integer |
ID zaškrtávacího políčka |
|
Název pole
|
data.participants.fields.fieldName | string |
Název pole |
|
Pozice X
|
data.participants.fields.xposition | float |
Pozice X pole |
|
Pozice Y
|
data.participants.fields.yposition | float |
Pozice Y pole |
|
Je požadováno?
|
data.participants.fields.required | boolean |
Jedná se o povinné pole? |
|
Je jen pro čtení?
|
data.participants.fields.readOnly | boolean |
Jedná se o pole Jen pro čtení? |
|
Textové pole
|
data.participants.fields.textarea | boolean |
Textové pole |
|
Vertikální
|
data.participants.fields.vertical | boolean |
Vertikální |
|
Nahoře dole
|
data.participants.fields.topBottom | boolean |
Nahoře dole |
|
Výchozí hodnota
|
data.participants.fields.defaultValue | string |
Výchozí hodnota |
|
Formát
|
data.participants.signatureBlock.format | array of object |
Formát |
|
identifikační číslo
|
data.participants.signatureBlock.format.id | string |
identifikační číslo |
|
Sekvence
|
data.participants.signatureBlock.format.sequence | integer |
Sekvence |
|
Je požadováno?
|
data.participants.signatureBlock.format.required | boolean |
Je požadováno? |
|
Výchozí
|
data.participants.signatureBlock.default | boolean |
Výchozí |
|
Povolit delegáta
|
data.participants.enableDelegate | boolean |
Povolit delegáta |
|
Automatický proces
|
data.participants.autoProcess | boolean |
Automatický proces |
|
Uživatelé cc
|
data.ccUsers | array of object |
Uživatelé cc |
|
Název
|
data.ccUsers.name | string |
Název |
|
E-mailová adresa
|
data.ccUsers.emailAddress | string |
E-mailová adresa |
|
Jazyk
|
data.ccUsers.language | string |
Jazyk |
|
Documents
|
data.documents | array of object |
Documents |
|
ID dokumentu
|
data.documents.id | string |
ID dokumentu |
|
Sekvence
|
data.documents.sequence | integer |
Sekvence |
|
Název souboru
|
data.documents.fileName | string |
Název souboru |
|
Počet stránek
|
data.documents.pageCount | integer |
Počet stránek |
|
Je deletable?
|
data.documents.deletable | boolean |
Je deletable? |
|
Je soukromé
|
data.documents.private | boolean |
Je soukromé |
|
Vlastní pole
|
data.customFields | array of object |
Vlastní pole |
|
ID vlastního pole
|
data.customFields.customFieldId | string |
ID vlastního pole |
|
Hodnota pole
|
data.customFields.value | string |
Hodnota pole |
|
Název pole
|
data.customFields.fieldName | string |
Název pole |
|
Typ pole
|
data.customFields.fieldType | string |
Typ pole |
|
Odběry oznámení
|
data.notificationSubscriptions | array of |
Odběry oznámení |
|
tags
|
data.tags | array of |
tags |
|
Další dokumenty
|
data.additionalDocuments | array of object |
Další dokumenty |
|
identifikační číslo
|
data.additionalDocuments.id | string |
identifikační číslo |
|
Název souboru
|
data.additionalDocuments.fileName | string |
Název souboru |
|
Typ
|
data.additionalDocuments.type | string |
Typ |
|
ID kandidáta
|
data.additionalDocuments.candidateId | string |
ID kandidáta |
|
Samostatné smlouvy
|
data.separateAgreements | boolean |
Samostatné smlouvy |
Získání podrobností o uživateli
Získání podrobností o uživateli pro dané ID uživatele
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID uživatele
|
userId | True | string |
Jedinečné ID uživatele |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Časová značka
|
timestamp | integer |
Časová značka |
|
Kód stavu
|
statusCode | integer |
Kód stavu |
|
Message
|
message | string |
Message |
|
Křestní jméno
|
data.firstName | string |
Křestní jméno |
|
Příjmení
|
data.lastName | string |
Příjmení |
|
Společnost
|
data.company | string |
Společnost |
|
Časové pásmo
|
data.timezone | string |
Časové pásmo |
|
Jazyk
|
data.language | string |
Jazyk |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
Název pracovní pozice
|
data.jobTitle | string |
Název pracovní pozice |
|
Telefonní číslo
|
data.phoneNumber | string |
Telefonní číslo |
|
Kód země
|
data.phoneCountryCode | string |
Kód země |
|
Seznam rolí
|
data.roles | array of string |
Seznam rolí |
|
Je konečná pošta zakázaná?
|
data.finalMailDisabled | boolean |
Je konečná pošta zakázaná? |
|
Je pošta připomenutí zakázaná?
|
data.reminderMailDisabled | boolean |
Je pošta připomenutí zakázaná? |
|
Je pošta odesílatele zakázaná?
|
data.senderMailDisabled | boolean |
Je pošta odesílatele zakázaná? |
|
Je uživatel integrace?
|
data.integrationUser | boolean |
Je uživatel integrace? |
|
Oslovení
|
data.salutation | string |
Oslovení |
|
Je aktivní
|
data.active | boolean |
Je aktivní |
|
identifikační číslo
|
data.id | string |
identifikační číslo |
|
E-mailová adresa
|
data.emailAddress | string |
E-mailová adresa |
Aktivační události
| Při změně stavu transakce |
Registrace zpětného volání pro konkrétní událost transakce |
Při změně stavu transakce
Registrace zpětného volání pro konkrétní událost transakce
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Typ události
|
eventType | True | array |
Typ události transakce, pro který se má zaregistrovat |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Časová značka
|
timestamp | integer |
Časová značka |
|
Kód stavu
|
statusCode | integer |
Kód stavu |
|
Message
|
message | string |
Message |
|
Název transakce
|
data.name | string |
Název transakce |
|
Stav transakce
|
data.status | string |
Stav transakce |
|
ID transakce
|
data.transactionId | string |
ID transakce |
|
Message
|
data.mail.message | string |
Zpráva pro všechny účastníky e-mail. |
|
Datum poslední aktualizace
|
data.lastUpdatedDate | string |
Datum poslední aktualizace |
|
Datum vytvoření
|
data.createdDate | string |
Datum vytvoření |
|
ID uživatele
|
data.createdBy.id | string |
Vytvořil(a) ID uživatele |
|
Uživatelské jméno
|
data.createdBy.username | string |
Vytvořil(a) uživatelské jméno |
|
E-mailová adresa
|
data.createdBy.emailAddress | string |
Vytvořeno e-mailovou adresou |
|
Datum odeslání
|
data.sentDate | string |
Datum odeslání |
|
ID uživatele
|
data.lastActionPerformedBy.userId | string |
ID uživatele |
|
Uživatelské jméno
|
data.lastActionPerformedBy.userName | string |
Uživatelské jméno |
|
E-mailová adresa
|
data.lastActionPerformedBy.emailAddress | string |
E-mailová adresa |
|
ID kandidáta
|
data.lastActionPerformedBy.candidateId | string |
ID kandidáta |
|
ID účastníka
|
data.lastActionPerformedBy.participantId | string |
ID účastníka |
|
Vyprší v časovém razítku.
|
data.expiryAndReminders.expiresAtTimestamp | string |
Platnost transakce vyprší v časovém razítku |
|
Dny vypršení platnosti
|
data.expiryAndReminders.expiryDays | integer |
Dny vypršení platnosti |
|
Připomenout z dnů připomenutí
|
data.expiryAndReminders.remindFromReminderDays | integer |
Připomenout z dnů připomenutí |
|
Připomenout z času připomenutí
|
data.expiryAndReminders.remindFromReminderTime | string |
Připomenout z času připomenutí |
|
Frekvence připomenutí
|
data.expiryAndReminders.reminderFrequency | integer |
Frekvence připomenutí |
|
Účastníci
|
data.participants | array of object |
Účastníci |
|
ID účastníka
|
data.participants.id | string |
ID účastníka |
|
Stav účastníka
|
data.participants.status | string |
Stav účastníka |
|
Datum poslední aktualizace
|
data.participants.lastUpdatedDate | string |
Datum poslední aktualizace |
|
Datum vytvoření
|
data.participants.createdDate | string |
Datum vytvoření |
|
Posloupnost účastníků
|
data.participants.sequence | integer |
Sekvence |
|
Role
|
data.participants.role | string |
Role |
|
Metoda podepisování
|
data.participants.signingMethodDTO | array of string |
Podrobnosti metody podepisování |
|
Odesláno uživatelem
|
data.participants.submittedBys | array of object |
Odesláno podle podrobností uživatele |
|
ID uživatele
|
data.participants.submittedBys.userId | string |
Odesláno podle ID uživatele |
|
Uživatelské jméno
|
data.participants.submittedBys.userName | string |
Odesláno jménem uživatele |
|
E-mailová adresa
|
data.participants.submittedBys.emailAddress | string |
Odesláno e-mailovou adresou uživatele |
|
ID kandidáta
|
data.participants.submittedBys.candidateId | string |
ID kandidáta |
|
kandidáti
|
data.participants.candidates | array of object |
kandidáti |
|
ID kandidáta
|
data.participants.candidates.id | string |
ID kandidáta |
|
Název
|
data.participants.candidates.name | string |
Jméno kandidáta |
|
E-mailová adresa
|
data.participants.candidates.emailAddress | string |
E-mailová adresa kandidáta |
|
Jazyk
|
data.participants.candidates.language | string |
Jazyk |
|
Typ
|
data.participants.candidates.type | string |
Typ |
|
Činnost
|
data.participants.candidates.action | string |
Činnost |
|
Datum akce
|
data.participants.candidates.actionDate | string |
Datum akce |
|
Datum vytvoření
|
data.participants.candidates.createdDate | string |
Datum vytvoření |
|
Hodnota režimu ověřování
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Hodnota režimu ověřování |
|
podrobnosti metody podepisování
|
data.participants.candidates.signingMethodDTO | array of string |
podrobnosti metody podepisování |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Kanály doručování
|
data.participants.candidates.deliveryChannels | array of string |
Kanály doručování |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
identifikační číslo
|
data.participants.fields.id | string |
identifikační číslo |
|
Datum poslední aktualizace
|
data.participants.fields.lastUpdatedDate | string |
Datum poslední aktualizace |
|
Datum vytvoření
|
data.participants.fields.createdDate | string |
Datum vytvoření |
|
ID pole
|
data.participants.fields.fieldId | string |
ID pole |
|
Číslo stránky
|
data.participants.fields.pageNo | integer |
Číslo stránky |
|
ID dokumentu
|
data.participants.fields.documentId | string |
ID dokumentu |
|
Šířka pole
|
data.participants.fields.width | float |
Šířka pole |
|
Výška pole
|
data.participants.fields.height | float |
Výška pole |
|
Nástrojová nápověda
|
data.participants.fields.tooltip | string |
Nástrojová nápověda |
|
Hodnota
|
data.participants.fields.value | string |
Hodnota |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Zobrazit popisek
|
data.participants.fields.displayLabel | string |
Zobrazit popisek |
|
Typ propojení
|
data.participants.fields.linkType | string |
Typ propojení |
|
ID rádia
|
data.participants.fields.radioId | integer |
ID rádia |
|
ID skupiny rádia
|
data.participants.fields.radioGroupId | string |
ID skupiny rádia |
|
ID zaškrtávacího políčka
|
data.participants.fields.checkboxId | integer |
ID zaškrtávacího políčka |
|
Název pole
|
data.participants.fields.fieldName | string |
Název pole |
|
Pozice X
|
data.participants.fields.xposition | float |
Pozice X pole |
|
Pozice Y
|
data.participants.fields.yposition | float |
Pozice Y pole |
|
Je požadováno?
|
data.participants.fields.required | boolean |
Jedná se o povinné pole? |
|
Je jen pro čtení?
|
data.participants.fields.readOnly | boolean |
Jedná se o pole Jen pro čtení? |
|
Textové pole
|
data.participants.fields.textarea | boolean |
Textové pole |
|
Vertikální
|
data.participants.fields.vertical | boolean |
Vertikální |
|
Nahoře dole
|
data.participants.fields.topBottom | boolean |
Nahoře dole |
|
Výchozí hodnota
|
data.participants.fields.defaultValue | string |
Výchozí hodnota |
|
Formát
|
data.participants.signatureBlock.format | array of object |
Formát |
|
identifikační číslo
|
data.participants.signatureBlock.format.id | string |
identifikační číslo |
|
Sekvence
|
data.participants.signatureBlock.format.sequence | integer |
Sekvence |
|
Je požadováno?
|
data.participants.signatureBlock.format.required | boolean |
Je požadováno? |
|
Výchozí
|
data.participants.signatureBlock.default | boolean |
Výchozí |
|
Povolit delegáta
|
data.participants.enableDelegate | boolean |
Povolit delegáta |
|
Automatický proces
|
data.participants.autoProcess | boolean |
Automatický proces |
|
Uživatelé cc
|
data.ccUsers | array of object |
Uživatelé cc |
|
Název
|
data.ccUsers.name | string |
Název |
|
E-mailová adresa
|
data.ccUsers.emailAddress | string |
E-mailová adresa |
|
Jazyk
|
data.ccUsers.language | string |
Jazyk |
|
Documents
|
data.documents | array of object |
Documents |
|
ID dokumentu
|
data.documents.id | string |
ID dokumentu |
|
Sekvence
|
data.documents.sequence | integer |
Sekvence |
|
Název souboru
|
data.documents.fileName | string |
Název souboru |
|
Počet stránek
|
data.documents.pageCount | integer |
Počet stránek |
|
Je deletable?
|
data.documents.deletable | boolean |
Je deletable? |
|
Je soukromé
|
data.documents.private | boolean |
Je soukromé |
|
Vlastní pole
|
data.customFields | array of object |
Vlastní pole |
|
ID vlastního pole
|
data.customFields.customFieldId | string |
ID vlastního pole |
|
Hodnota pole
|
data.customFields.value | string |
Hodnota pole |
|
Název pole
|
data.customFields.fieldName | string |
Název pole |
|
Typ pole
|
data.customFields.fieldType | string |
Typ pole |
|
Odběry oznámení
|
data.notificationSubscriptions | array of |
Odběry oznámení |
|
tags
|
data.tags | array of |
tags |
|
Další dokumenty
|
data.additionalDocuments | array of object |
Další dokumenty |
|
identifikační číslo
|
data.additionalDocuments.id | string |
identifikační číslo |
|
Název souboru
|
data.additionalDocuments.fileName | string |
Název souboru |
|
Typ
|
data.additionalDocuments.type | string |
Typ |
|
ID kandidáta
|
data.additionalDocuments.candidateId | string |
ID kandidáta |
|
Samostatné smlouvy
|
data.separateAgreements | boolean |
Samostatné smlouvy |
Definice
soubor
Toto je základní datový typ "file".