Encodian — znak
Łącznik "Encodian - Sign" udostępnia obszerną kolekcję akcji ułatwiających tworzenie i zarządzanie procesami podpisywania elektronicznego. Łącznik umożliwia organizacjom automatyzowanie żądań podpisów, usprawnianie przepływów pracy podpisywania dokumentów i integrowanie możliwości podpisywania elektronicznego z istniejącymi procesami biznesowymi i aplikacjami.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Azure regionach Chin - Departament Obrony USA (DoD) |
| Power Apps | Standard | Wszystkie regiony Power Apps z wyjątkiem następujących: - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate - narzędzie do automatyzacji procesów | Standard | Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Pomoc techniczna dla firmy Encodian |
| adres URL | https://support.encodian.com |
| support@encodian.com |
| Metadane łącznika | |
|---|---|
| Publisher | Encodian |
| Witryna internetowa | https://www.encodian.com |
| Zasady ochrony prywatności | https://support.encodian.com/hc/en-gb/articles/360010885513-Privacy-Policy |
| Kategorie | Zawartość i pliki; Kolaboracja |
Znak encodian dla Power Automate
Łącznik "Znak encodian" udostępnia kompleksowy zestaw akcji Power Automate, które umożliwiają tworzenie rozwiązań do podpisywania elektronicznego lub rozszerzanie istniejącego rozwiązania Power Platform z funkcjami podpisywania elektronicznego
Łącznik podpisywania encodian jest obsługiwany przez Power Automate, Azure Logic Apps i Power Apps.
Zarejestruj konto
Do korzystania z łącznika Encodian Sign jest wymagana subskrypcja znaku encodian.
Wypełnij formularz rejestracji , aby zarejestrować się w celu uzyskania 30-dniowej wersji próbnej i uzyskania klucza interfejsu API
Support
Skontaktuj się z pomocą techniczną firmy Encodian , aby poprosić o pomoc
Dokumentacja znaku encodian można znaleźć tutaj
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Udostępnialne |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz omówienie Connectors dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz interfejsu API | securestring | Uzyskiwanie klucza interfejsu API — https://www.encodian.com/apikey/ | Prawda |
| Region | ciąg | Prawda |
Limity ograniczania
| Nazwisko | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
Adresat — wyświetl listę wszystkich
Wyświetla listę wszystkich adresatów z bieżącego obszaru roboczego — https://support.encodian.com/hc/en-gb/articles/26005981080732
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Ogranicza liczbę zwróconych adresatów do określonej wartości, domyślnie to 1000 |
Zwraca
Element dostarczany — dziennik inspekcji pobierania
Pobierz dokument dziennika inspekcji i kod JSON dla koperty — https://support.encodian.com/hc/en-gb/articles/30727796963484
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator koperty
|
envelopeId | string |
Unikatowy identyfikator koperty |
Zwraca
Element dostarczany — pobieranie podpisanych dokumentów
Pobieranie podpisanych dokumentów dla koperty — https://support.encodian.com/hc/en-gb/articles/30727465578396
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator koperty
|
envelopeId | string |
Unikatowy identyfikator kopert |
Zwraca
Koperta — podpisywanie pliku jednokrotnego
Tworzenie koperty dla pojedynczego pliku z jednym etapem — https://support.encodian.com/hc/en-gb/articles/26845003436828
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Title
|
title | True | string |
Ustawianie tytułu koperty |
|
Message
|
message | string |
Ustawianie wiadomości, która ma być udostępniana adresatowi |
|
|
Nadawca
|
sender | True | string |
Adres e-mail nadawcy, który musi być licencjonowanym członkiem obszaru roboczego |
|
Filename
|
fileName | string |
Opcjonalnie — nazwa pliku |
|
|
Plik
|
file | True | byte |
Plik (zawartość pliku) do przesłania do podpisu |
|
Tryb dostarczania
|
deliveryMode | string |
Ustawianie, czy plik powinien być wysyłany do adresatów sekwencyjnie, czy równolegle |
|
|
Tryb wymagania
|
requirementMode | string |
Określ, czy jeden lub wszyscy adresaci są zobowiązani do podpisania dokumentu. Dotyczy tylko sytuacji, w których "Tryb dostarczania" = "Równoległy" |
|
|
Typ
|
type | True | string |
Ustaw typ adresata (osoba podpisowa lub recenzent) |
|
Imię
|
firstName | string |
Ustawianie imienia i nazwiska adresata |
|
|
Nazwisko
|
lastName | string |
Ustawianie nazwiska adresata |
|
|
Adres e-mail
|
emailAddress | True | string |
Ustawianie adresu e-mail adresatów |
|
Order
|
order | integer |
Ustaw kolejność, w jakiej ten odbiorca otrzyma dokument, gdy tryb dostarczania będzie sekwencyjny, jeśli jest pusty lub 0, zamówienie zostanie automatycznie przypisane do następnego dostępnego numeru. |
|
|
Język
|
language | string |
Ustawianie języka adresatów |
|
|
Typ
|
fieldType | True | string |
Ustaw typ pola (Podpis, Tekst, Poczta e-mail itp.) |
|
Nazwa pola
|
fieldName | string |
Ustawianie nazwy pola docelowego w dokumencie |
|
|
Tekst zastępczy
|
placeholderText | string |
Ustaw wartość tekstu zastępczego w dokumencie, aby zastąpić elementem "Pole" określonym |
|
|
Wartość domyślna
|
defaultValue | string |
Ustawianie wartości domyślnej dla pola |
|
|
Wymagane
|
isRequired | boolean |
Ustawianie, czy pole jest wymagane |
|
|
Tylko do odczytu
|
isReadOnly | boolean |
Ustawianie, czy pole jest tylko do odczytu |
|
|
Wygasa w (dni)
|
expiresIn | True | integer |
Ustawianie czasu wygaśnięcia koperty w dniach |
|
Pobierz jako
|
downloadAs | True | string |
Ustaw, czy dokument dostarczany (podpisane dokumenty i certyfikat ukończenia) jest dostarczany jako pojedynczy plik PDF lub oddzielne pliki |
Zwraca
Koperta — podpisywanie pliku jednokrotnego przy użyciu etapów
Tworzenie koperty dla pojedynczego pliku z wieloetapowym zatwierdzeniem/procesem podpisywania — https://support.encodian.com/hc/en-gb/articles/27543439385500
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Title
|
title | True | string |
Ustawianie tytułu koperty |
|
Message
|
message | string |
Ustawianie wiadomości, która ma być udostępniana adresatowi |
|
|
Nadawca
|
sender | True | string |
Adres e-mail nadawcy, który musi być licencjonowanym członkiem obszaru roboczego |
|
Filename
|
fileName | string |
Opcjonalnie — nazwa pliku |
|
|
Plik
|
file | True | byte |
Plik (zawartość pliku) do przesłania do podpisu |
|
Tryb dostarczania
|
deliveryMode | string |
Ustawianie, czy plik powinien być wysyłany do adresatów sekwencyjnie, czy równolegle |
|
|
Tryb wymagania
|
requirementMode | string |
Określ, czy jeden lub wszyscy adresaci są zobowiązani do podpisania dokumentu. Dotyczy tylko sytuacji, w których "Tryb dostarczania" = "Równoległy" |
|
|
Typ
|
type | True | string |
Ustaw typ adresata (osoba podpisowa lub recenzent) |
|
Imię
|
firstName | string |
Ustawianie imienia i nazwiska adresata |
|
|
Nazwisko
|
lastName | string |
Ustawianie nazwiska adresata |
|
|
Adres e-mail
|
emailAddress | True | string |
Ustawianie adresu e-mail adresatów |
|
Order
|
order | integer |
Ustaw kolejność, w jakiej ten odbiorca otrzyma dokument, gdy tryb dostarczania będzie sekwencyjny, jeśli jest pusty lub 0, zamówienie zostanie automatycznie przypisane do następnego dostępnego numeru. |
|
|
Język
|
language | string |
Ustawianie języka adresatów |
|
|
Typ
|
fieldType | True | string |
Ustaw typ pola (Podpis, Tekst, Poczta e-mail itp.) |
|
Nazwa pola
|
fieldName | string |
Ustawianie nazwy pola docelowego w dokumencie |
|
|
Tekst zastępczy
|
placeholderText | string |
Ustaw wartość tekstu zastępczego w dokumencie, aby zastąpić elementem "Pole" określonym |
|
|
Wartość domyślna
|
defaultValue | string |
Ustawianie wartości domyślnej dla pola |
|
|
Wymagane
|
isRequired | boolean |
Ustawianie, czy pole jest wymagane |
|
|
Tylko do odczytu
|
isReadOnly | boolean |
Ustawianie, czy pole jest tylko do odczytu |
|
|
Wygasa w (dni)
|
expiresIn | True | integer |
Ustawianie czasu wygaśnięcia koperty w dniach |
|
Pobierz jako
|
downloadAs | True | string |
Ustaw, czy dokument dostarczany (podpisane dokumenty i certyfikat ukończenia) jest dostarczany jako pojedynczy plik PDF lub oddzielne pliki |
Zwraca
Koperta — podpisywanie wielu plików
Tworzenie koperty dla kolekcji plików z jednym etapem — https://support.encodian.com/hc/en-gb/articles/30727010403868
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Title
|
title | True | string |
Ustawianie nazwy koperty |
|
Message
|
message | string |
Ustawianie wiadomości, która ma być udostępniana adresatowi |
|
|
Nadawca
|
sender | True | string |
Adres e-mail nadawcy, który musi być licencjonowanym członkiem obszaru roboczego |
|
identyfikator
|
inputFileId | True | string |
Unikatowy identyfikator przekazanego pliku używany do mapowania pól na poprawny plik |
|
Filename
|
fileName | True | string |
Nazwa pliku |
|
Plik
|
file | True | byte |
Zawartość pliku |
|
Tryb dostarczania
|
deliveryMode | string |
Ustawianie, czy plik powinien być wysyłany do adresatów sekwencyjnie, czy równolegle |
|
|
Tryb wymagania
|
requirementMode | string |
Określ, czy jeden lub wszyscy adresaci są zobowiązani do podpisania dokumentu. Dotyczy tylko sytuacji, w których "Tryb dostarczania" = "Równoległy" |
|
|
Typ
|
type | True | string |
Ustaw typ adresata (osoba podpisowa lub recenzent) |
|
Imię
|
firstName | string |
Ustawianie imienia i nazwiska adresata |
|
|
Nazwisko
|
lastName | string |
Ustawianie nazwiska adresata |
|
|
Adres e-mail
|
emailAddress | True | string |
Ustawianie adresu e-mail adresatów |
|
Order
|
order | integer |
Ustaw kolejność, w jakiej ten odbiorca otrzyma dokument, gdy tryb dostarczania będzie sekwencyjny, jeśli jest pusty lub 0, zamówienie zostanie automatycznie przypisane do następnego dostępnego numeru. |
|
|
Język
|
language | string |
Ustawianie języka adresatów |
|
|
Typ
|
fieldType | True | string |
Ustaw typ pola (Podpis, Tekst, Poczta e-mail itp.) |
|
Nazwa pola
|
fieldName | string |
Ustawianie nazwy pola docelowego w dokumencie |
|
|
Tekst zastępczy
|
placeholderText | string |
Ustaw wartość tekstu zastępczego w dokumencie, aby zastąpić elementem "Pole" określonym |
|
|
Wartość domyślna
|
defaultValue | string |
Ustawianie wartości domyślnej dla pola |
|
|
Wymagane
|
isRequired | boolean |
Ustawianie, czy pole jest wymagane |
|
|
Tylko do odczytu
|
isReadOnly | boolean |
Ustawianie, czy pole jest tylko do odczytu |
|
|
Identyfikator pliku
|
inputFileId | True | string |
Unikatowy identyfikator pliku używany do mapowania tego pola na jeden z przekazanych plików |
|
Wygasa w (dni)
|
expiresIn | True | integer |
Ustawianie czasu wygaśnięcia koperty w dniach |
|
Pobierz jako
|
downloadAs | True | string |
Ustaw, czy dokument dostarczany (podpisane dokumenty i certyfikat ukończenia) jest dostarczany jako pojedynczy plik PDF lub oddzielne pliki |
Zwraca
Koperta — podpisywanie wielu plików za pomocą etapów
Tworzenie koperty dla kolekcji plików z wieloma etapami zatwierdzania/podpisywania — https://support.encodian.com/hc/en-gb/articles/30727071061532
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Title
|
title | True | string |
Ustawianie nazwy koperty |
|
Message
|
message | string |
Ustawianie wiadomości, która ma być udostępniana adresatowi |
|
|
Nadawca
|
sender | True | string |
Adres e-mail nadawcy, który musi być licencjonowanym członkiem obszaru roboczego |
|
identyfikator
|
inputFileId | True | string |
Unikatowy identyfikator przekazanego pliku używany do mapowania pól na poprawny plik |
|
Filename
|
fileName | True | string |
Nazwa pliku |
|
Plik
|
file | True | byte |
Zawartość pliku |
|
Tryb dostarczania
|
deliveryMode | string |
Ustawianie, czy plik powinien być wysyłany do adresatów sekwencyjnie, czy równolegle |
|
|
Tryb wymagania
|
requirementMode | string |
Określ, czy jeden lub wszyscy adresaci są zobowiązani do podpisania dokumentu. Dotyczy tylko sytuacji, w których "Tryb dostarczania" = "Równoległy" |
|
|
Typ
|
type | True | string |
Ustaw typ adresata (osoba podpisowa lub recenzent) |
|
Imię
|
firstName | string |
Ustawianie imienia i nazwiska adresata |
|
|
Nazwisko
|
lastName | string |
Ustawianie nazwiska adresata |
|
|
Adres e-mail
|
emailAddress | True | string |
Ustawianie adresu e-mail adresatów |
|
Order
|
order | integer |
Ustaw kolejność, w jakiej ten odbiorca otrzyma dokument, gdy tryb dostarczania będzie sekwencyjny, jeśli jest pusty lub 0, zamówienie zostanie automatycznie przypisane do następnego dostępnego numeru. |
|
|
Język
|
language | string |
Ustawianie języka adresatów |
|
|
Typ
|
fieldType | True | string |
Ustaw typ pola (Podpis, Tekst, Poczta e-mail itp.) |
|
Nazwa pola
|
fieldName | string |
Ustawianie nazwy pola docelowego w dokumencie |
|
|
Tekst zastępczy
|
placeholderText | string |
Ustaw wartość tekstu zastępczego w dokumencie, aby zastąpić elementem "Pole" określonym |
|
|
Wartość domyślna
|
defaultValue | string |
Ustawianie wartości domyślnej dla pola |
|
|
Wymagane
|
isRequired | boolean |
Ustawianie, czy pole jest wymagane |
|
|
Tylko do odczytu
|
isReadOnly | boolean |
Ustawianie, czy pole jest tylko do odczytu |
|
|
Identyfikator pliku
|
inputFileId | True | string |
Unikatowy identyfikator pliku używany do mapowania tego pola na jeden z przekazanych plików |
|
Wygasa w (dni)
|
expiresIn | True | integer |
Ustawianie czasu wygaśnięcia koperty w dniach |
|
Pobierz jako
|
downloadAs | True | string |
Ustaw, czy dokument dostarczany (podpisane dokumenty i certyfikat ukończenia) jest dostarczany jako pojedynczy plik PDF lub oddzielne pliki |
Zwraca
Koperta — uzyskiwanie stanu
Pobieranie stanu koperty
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator koperty
|
envelopeId | string |
Unikatowy identyfikator kopert |
Zwraca
Odbiorca — dodaj
Dodaje nowego adresata — https://support.encodian.com/hc/en-gb/articles/25625138389660
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Adres e-mail
|
emailAddress | True | string |
Ustawianie adresu e-mail adresata |
|
Imię
|
firstName | string |
Ustawianie imienia i nazwiska adresata |
|
|
Nazwisko
|
lastName | string |
Ustawianie nazwiska adresata |
|
|
Firma
|
company | string |
Ustawianie firmy odbiorcy |
|
|
Stanowisko
|
jobTitle | string |
Ustawianie stanowiska adresata |
|
|
Numer telefonu
|
phoneNumber | string |
Ustawianie numeru telefonu odbiorcy |
Zwraca
Odbiorca — dodawanie wielu
Dodaje tablicę adresatów — https://support.encodian.com/hc/en-gb/articles/25793665577500
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Adres e-mail
|
emailAddress | True | string |
Ustawianie adresu e-mail adresata |
|
Imię
|
firstName | string |
Ustawianie imienia i nazwiska adresata |
|
|
Nazwisko
|
lastName | string |
Ustawianie nazwiska adresata |
|
|
Firma
|
company | string |
Ustawianie firmy odbiorcy |
|
|
Stanowisko
|
jobTitle | string |
Ustawianie stanowiska adresata |
|
|
Numer telefonu
|
phoneNumber | string |
Ustawianie numeru telefonu odbiorcy |
Zwraca
Odbiorca — pobierz
Pobiera pojedynczego adresata — https://support.encodian.com/hc/en-gb/articles/25877649787036
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Adres e-mail
|
emailAddress | string |
Podaj adres e-mail odbiorcy |
|
|
Identyfikator adresata
|
recipientId | string |
Podaj unikatowy identyfikator odbiorcy |
Zwraca
Odbiorca — usuwanie
Usuwa istniejącego adresata — https://support.encodian.com/hc/en-gb/articles/25698260987292
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Adres e-mail
|
emailAddress | string |
Podaj adres e-mail odbiorcy |
|
|
Identyfikator adresata
|
recipientId | string |
Podaj unikatowy identyfikator odbiorcy |
Zwraca
Wyzwalacze
| Koperta — przy zdarzeniu |
Powiadamia o wystąpieniu zdarzenia koperty |
Koperta — przy zdarzeniu
Powiadamia o wystąpieniu zdarzenia koperty
Parametry
| Nazwisko | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Event
|
event | True | string |
Zdarzenie wyzwalające element WebHook |
Zwraca
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator koperty
|
envelopeUid | string |
Identyfikator koperty |
|
Tytuł koperty
|
envelopeTitle | string |
Tytuł koperty |
|
Stan koperty
|
envelopeStatus | string |
Stan koperty |
|
Typ zdarzenia
|
eventType | string |
Typ zdarzenia |
|
Nazwa nadawcy
|
senderName | string |
Nazwa nadawcy |
|
Adres e-mail nadawcy
|
senderEmail | string |
Adres e-mail nadawcy |
Definicje
DtoRecipient
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Adres e-mail
|
emailAddress | string |
Ustawianie adresu e-mail adresata |
|
Imię
|
firstName | string |
Ustawianie imienia i nazwiska adresata |
|
Nazwisko
|
lastName | string |
Ustawianie nazwiska adresata |
|
Firma
|
company | string |
Ustawianie firmy odbiorcy |
|
Stanowisko
|
jobTitle | string |
Ustawianie stanowiska adresata |
|
Numer telefonu
|
phoneNumber | string |
Ustawianie numeru telefonu odbiorcy |
DtoResponseDownloadAuditTrail
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Filename
|
fileName | string |
Nazwa pliku |
|
Plik
|
file | byte |
Zawartość pliku |
|
Dane inspekcji
|
auditData | string |
Reprezentacja JSON dziennika inspekcji |
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
DtoResponseEnvelopeCreateMultiple
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
|
Identyfikator koperty
|
envelopeId | string |
Unikatowy identyfikator kopert |
|
Created
|
created | date-time |
Data i godzina utworzenia przedgięć |
|
Status
|
status | string |
Stan koperty |
DtoResponseEnvelopeCreateMultipleWithStages
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
|
Identyfikator koperty
|
envelopeId | string |
Unikatowy identyfikator kopert |
|
Created
|
created | date-time |
Data i godzina utworzenia przedgięć |
|
Status
|
status | string |
Stan koperty |
DtoResponseEnvelopeCreateSingle
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator koperty
|
envelopeId | string |
Unikatowy identyfikator kopert |
|
Created
|
created | date-time |
Data i godzina utworzenia koperty |
|
Status
|
status | string |
Stan koperty |
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
DtoResponseEnvelopeCreateSingleWithStages
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator koperty
|
envelopeId | string |
Unikatowy identyfikator kopert |
|
Created
|
created | date-time |
Data i godzina utworzenia koperty |
|
Status
|
status | string |
Stan koperty |
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
DtoResponseEnvelopeDownloadSignedDocuments
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Documents
|
documents | array of SignDocumentArray |
Podpisane pliki |
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
DtoResponseGetEnvelopeStatus
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Status
|
status | string |
Stan koperty |
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
DtoResponseRecipientCreateMultiple
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przetworzone
|
processed | array of string |
Lista adresatów dodana do obszaru roboczego |
|
Nieprzetworzonych
|
unprocessed | object |
Lista adresatów, w tym skojarzony komunikat o błędzie dla wszystkich adresatów, którzy nie mogli zostać dodani |
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
DtoResponseRecipientCreateSingle
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator adresata
|
recipientId | string |
Unikatowy identyfikator odbiorcy |
|
Created
|
created | date-time |
Data i godzina utworzenia adresata |
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
DtoResponseRecipientDeleteSingle
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Usunięto
|
deleted | date-time |
Data i godzina usunięcia adresata |
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
DtoResponseRecipientGetSingle
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator adresata
|
recipientId | string |
Unikatowy identyfikator odbiorcy |
|
Adres e-mail
|
emailAddress | string |
Adres e-mail odbiorcy |
|
Imię
|
firstName | string |
Imię odbiorcy |
|
Nazwisko
|
lastName | string |
Nazwisko odbiorcy |
|
Firma
|
company | string |
Firma odbiorcy |
|
Stanowisko
|
jobTitle | string |
Stanowisko odbiorcy |
|
Numer telefonu
|
phoneNumber | string |
Numer telefonu odbiorcy |
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
DtoResponseRecipientListAll
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Adresatów
|
recipients | array of DtoRecipient |
Kolekcja adresatów w obszarze roboczym |
|
Kod stanu HTTP
|
httpStatusCode | integer |
Kod stanu HTTP dla odpowiedzi |
|
Komunikat o stanie HTTP
|
httpStatusMessage | string |
Komunikat o stanie HTTP dla odpowiedzi |
|
Identyfikator operacji
|
operationId | string |
Unikatowy identyfikator przypisany do tej operacji |
|
Błędy
|
errors | array of string |
Tablica komunikatów o błędach powinna spowodować wystąpienie błędu |
|
Stan operacji
|
operationStatus | string |
Wskazuje, czy operacja została ukończona, została w kolejce, czy zakończyła się niepowodzeniem |
SignDocumentArray
| Nazwisko | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Filename
|
fileName | string |
Nazwa pliku |
|
Plik
|
File | byte |
Zawartość pliku |