Foxit eSign (wersja zapoznawcza)

Foxit eSign to rozwiązanie do podpisu elektronicznego, które umożliwia wysyłanie, podpisywanie i zarządzanie dokumentami w trybie online — eliminując konieczność drukowania, skanowania lub wysyłania wiadomości e-mail. Przekaż dokument, zdefiniuj pola podpisu i wyślij go do adresatów, aby szybko i legalnie wiązać eSignatures.

Ten łącznik jest dostępny w następujących produktach i regionach:

Service	Class	Regions
Copilot Studio	Premium	Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - 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 Government regionów - Azure regionach Chin - Departament Obrony USA (DoD)
Power Apps	Premium	Wszystkie regiony Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Power Automate - narzędzie do automatyzacji procesów	Premium	Wszystkie regiony Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)

Kontakt
Name	Obsługa protokołu Foxit eSign
adres URL	https://www.foxit.com
Email	api@foxit.com

Metadane łącznika
Publisher	Foxit Software Inc.
Witryna internetowa	https://www.foxit.com/esign-pdf/
Zasady ochrony prywatności	https://www.foxit.com/company/privacy-policy.html
Kategorie	Produktywność; Zawartość i pliki

Foxit eSign

Foxit eSign to rozwiązanie do podpisu elektronicznego klasy korporacyjnej, które umożliwia firmom wysyłanie, podpisywanie i zarządzanie legalnie wiążącymi dokumentami w trybie online — eliminując konieczność drukowania, skanowania lub wysyłania wiadomości e-mail. Przekaż dokument, zdefiniuj pola podpisu i wyślij go do adresatów w celu uzyskania szybkich, bezpiecznych podpisów eSignature. Foxit eSign jest w pełni zgodny z głównymi przepisami dotyczącymi podpisu elektronicznego, w tym ESIGN i UETA, używa szyfrowania do ochrony dokumentów przesyłanych i magazynowanych oraz obsługuje uwierzytelnianie wieloskładnikowe, aby zapewnić, że tylko autoryzowani osoby podpisające mogą uzyskiwać dostęp do dokumentów i podpisywać je.

Łącznik Foxit eSign dla Microsoft Power Automate umożliwia zautomatyzowanie pełnego przepływu pracy podpisywania dokumentów — od tworzenia kopert i wysyłania ich do podpisu, śledzenia stanu, pobierania ukończonych dokumentów, zarządzania szablonami i wyzwalania akcji podrzędnych po wystąpieniu zdarzeń koperty.

Publisher: Foxit Corporation

Wymagania wstępne

Aby korzystać z tego łącznika, potrzebne są następujące elementy:

Plan Microsoft Power Apps lub Power Automate z dostępem do łącznika niestandardowego lub łącznika w warstwie Premium
Konto Foxit eSign — utwórz je tutaj
Dostęp do interfejsu API włączony na koncie foxit eSign (zobacz Uzyskiwanie poświadczeń poniżej)

Uzyskiwanie poświadczeń

Utwórz konto foxit eSign , jeśli jeszcze go nie masz.
Skontaktuj się z zespołem foxit sales, aby poprosić o włączenie dostępu interfejsu API na Twoim koncie. Po zatwierdzeniu dostęp do interfejsu API zostanie aktywowany na Twoim koncie.
W Power Automate wyszukaj ciąg Foxit eSign na liście łączników i wybierz pozycję Utwórz połączenie.
Nastąpi przekierowanie do strony logowania foxit eSign. Zaloguj się przy użyciu poświadczeń programu Foxit eSign, aby autoryzować połączenie.
Po autoryzacji połączenie jest gotowe do użycia w przepływach.

Wprowadzenie

Po utworzeniu połączenia możesz rozpocząć tworzenie przepływów przy użyciu łącznika Foxit eSign:

Wyzwalacze umożliwiają automatyczne uruchamianie przepływu po wystąpieniu zdarzenia koperty (np. po podpisaniu wszystkich stron).
Użyj akcji , aby tworzyć koperty, wysyłać przypomnienia o podpisach, pobierać ukończone dokumenty, zarządzać szablonami i nie tylko.
Połącz ze sobą wiele akcji — na przykład utwórz kopertę na podstawie szablonu, poczekaj na w pełni wykonany wyzwalacz, a następnie pobierz podpisany dokument i zapisz go w SharePoint.

Obsługiwane wyzwalacze

Trigger	Description
Po wysłaniu koperty	Uruchamia się, gdy koperta jest wysyłana do adresatów. Wymaga ustawienia Poziom elementu webhook na konto.
Po wyświetleniu koperty	Uruchamia się po otwarciu adresata i wyświetleniu koperty.
Gdy koperta jest podpisana	Uruchamia się, gdy odbiorca podpisuje kopertę.
Po anulowaniu koperty	Uruchamia się, gdy koperta zostanie anulowana przez odbiorcę lub nadawcę.
Gdy koperta jest w pełni wykonana	Wystrzeliwuje, gdy wszyscy adresaci podpisali i koperta jest w pełni ukończona.
Po usunięciu koperty	Uruchamia się po usunięciu koperty.

Obsługiwane akcje

Koperty

Action	Description
Tworzenie koperty na podstawie adresu URL	Tworzy i wysyła kopertę przy użyciu publicznie dostępnego adresu URL pdf.
Tworzenie koperty na podstawie base64	Tworzy i wysyła kopertę przy użyciu dokumentu PDF zakodowanego w formacie Base64.
Tworzenie koperty na podstawie szablonu	Tworzy i wysyła kopertę z istniejącego szablonu foxit eSign.
Pobieranie szczegółów koperty	Pobiera pełne szczegóły i bieżący stan koperty.
Pobieranie identyfikatorów kopert	Pobiera listę identyfikatorów kopert na podstawie kryteriów filtrowania.
Wysyłanie przypomnienia o podpisie	Wysyła powiadomienie z przypomnieniem do oczekujących osób podpisujących kopertę.
Pobieranie plików kopert	Pobiera wszystkie podpisane dokumenty w kopercie jako plik zip.
Pobierz plik PDF z pojedynczym dokumentem	Pobiera pojedynczy dokument z koperty jako plik PDF.
Przenoszenie kopert do Kosza	Przenosi co najmniej jedną kopertę do kosza.
Anuluj kopertę	Anuluje kopertę i powiadamia adresatów.
Usuwanie kopert	Trwale usuwa jedną lub więcej kopert.
Uzyskiwanie historii działań koperty	Pobiera pełny dziennik aktywności dla koperty.
Pobieranie historii usuniętej koperty	Pobiera historię usuniętych kopert na koncie.

Szablony

Action	Description
Tworzenie szablonu na podstawie adresu URL	Tworzy szablon podpisywania wielokrotnego użytku przy użyciu publicznie dostępnego adresu URL pliku PDF.
Tworzenie szablonu na podstawie base64	Tworzy szablon podpisywania wielokrotnego użytku przy użyciu dokumentu PDF zakodowanego w formacie Base64.
Pobieranie szczegółów szablonu	Pobiera pełne szczegóły określonego szablonu, w tym definicje pól.
Pobieranie szablonów według identyfikatorów szablonów	Pobiera szczegóły dla co najmniej jednego szablonu według ich identyfikatorów.
Pobieranie listy wszystkich szablonów	Pobiera wszystkie szablony dostępne na koncie.

Webhooks

Action	Description
Wyświetlanie listy wszystkich kanałów elementu webhook	Zwraca listę wszystkich kanałów elementu webhook skonfigurowanych na koncie.
Pobieranie szczegółów kanału elementu webhook	Pobiera szczegóły określonego kanału elementu webhook.

Grupy poczty e-mail

Action	Description
Tworzenie grupy wiadomości e-mail	Tworzy nową grupę wiadomości e-mail do użycia jako adresatów w kopertach.
Pobieranie szczegółów grupy wiadomości e-mail	Pobiera szczegóły i członków grupy poczty e-mail.

Reports

Action	Description
Pobierz raport	Pobiera raport aktywności konta w formacie Microsoft Excel.

Znane problemy i ograniczenia

Limit szybkości: interfejs API foxit eSign umożliwia maksymalnie 4000 żądań na 5 minut na konto. Żądania przekraczające ten limit otrzymują 429 Too Many Requests odpowiedź. Zaleca się zaimplementowanie logiki ponawiania z wykładniczym wycofywaniem w przepływach w celu bezproblemowego obsługi tej logiki.
Limit rozmiaru pliku: maksymalny rozmiar pliku na dokument wynosi 25 MB. Ten limit dotyczy poszczególnych plików, a nie całkowitego rozmiaru koperty.
Automatyczne anulowanie subskrypcji elementu webhook: ze względu na ograniczenie interfejsu API usuwania elementu webhook Foxit eSign (który używa metody POST, a nie DELETE), Power Automate nie może automatycznie wyczyścić subskrypcji kanału elementu webhook po usunięciu lub zmodyfikowaniu przepływu opartego na wyzwalaczu. Użyj akcji Wyświetl wszystkie kanały elementu webhook , aby zidentyfikować aktywne kanały i portal Foxit eSign, aby usunąć subskrypcje podczas likwidowania przepływu.
Po wysłaniu koperty — tylko poziom konta: wyzwalacz "Po wysłaniu koperty" jest uruchamiany tylko wtedy, gdy poziom elementu webhook jest ustawiony na Konto. Nie jest uruchamiana dla kopert utworzonych na poziomie aplikacji interfejsu API . Upewnij się, że podczas konfigurowania tego wyzwalacza wybrano poziom konta.
Dostępność regionalna: łącznik jest dostępny dla kont regionów Ameryki Północnej (NA1) i REGIONU UE. Wybierz odpowiedni region serwera podczas konfigurowania połączenia. Nawiązywanie połączenia z niewłaściwym regionem spowoduje błędy uwierzytelniania.
Rozmiar dokumentu base64: w przypadku korzystania z akcji Create Envelope from Base64 lub Create Template from Base64 ciąg zakodowany w formacie Base64 musi odpowiadać plikowi źródłowemu nie większemu niż 25 MB.

Support

Aby uzyskać pomoc techniczną dla deweloperów, skontaktuj się z zespołem Foxit eSign pod adresem devsupport@foxitsoftware.com.

Aby przesłać zgłoszenie do pomocy technicznej, odwiedź stronę https://kb.foxit.com/s/submit-a-case.

Limity ograniczania

Nazwa	Wywołania	Okres odnowienia
Wywołania interfejsu API na połączenie	100	60 sekund

Akcje

Anulowanie subskrypcji wyzwalacza elementu webhook	Usuwa aktywną subskrypcję kanału elementu webhook według identyfikatora kanału. Użyj tej akcji, aby wyczyścić subskrypcje elementów webhook, które nie są już potrzebne.
Anuluj kopertę	Anuluje wysłaną kopertę. Adresaci nie będą już mogli podpisać dokumentów.
Pobieranie historii usuniętej koperty	Pobiera historię kopert, które zostały usunięte lub przeniesione do kosza.
Pobieranie identyfikatorów koperty	Zwraca listę identyfikatorów kopert filtrowanych według stanu. Służy do znajdowania kopert w określonym stanie.
Pobieranie listy wszystkich szablonów	Zwraca listę wszystkich szablonów dostępnych na twoim koncie.
Pobieranie plików kopert	Pobiera ukończone dokumenty z koperty jako pliku.
Pobieranie szablonów według identyfikatorów szablonów	Pobiera szczegóły dla co najmniej jednego szablonu według ich identyfikatorów.
Pobieranie szczegółów grupy wiadomości e-mail	Pobiera szczegóły istniejącej grupy poczty e-mail.
Pobieranie szczegółów kanału elementu webhook	Pobiera szczegóły określonego kanału elementu webhook.
Pobieranie szczegółów koperty	Pobiera pełne szczegóły koperty, w tym jej stan, adresatów i dokumenty.
Pobieranie szczegółów szablonu	Pobiera pełne szczegóły określonego szablonu, w tym jego pola i adresatów.
Pobierz plik PDF z pojedynczym dokumentem	Pobiera pojedynczy dokument z koperty jako plik PDF.
Pobierz raport	Pobiera raport działania koperty jako plik Microsoft Excel. Użyj filtrów, aby zawęzić wyniki według stanu, zakresu dat, nazwy koperty, autora lub osoby podpisającego.
Przenoszenie kopert do Kosza	Przenosi co najmniej jedną kopertę do kosza. Koperty w koszu nie są trwale usuwane.
Tworzenie grupy wiadomości e-mail	Tworzy nową grupę wiadomości e-mail, która może służyć do wysyłania kopert do wielu adresatów jednocześnie.
Tworzenie koperty na podstawie adresu URL	Tworzy i wysyła kopertę przy użyciu publicznie dostępnych adresów URL plików PDF. Podaj adresy URL dokumentów i szczegóły adresata, aby zainicjować proces podpisywania.
Tworzenie koperty na podstawie base64	Tworzy i wysyła kopertę przy użyciu dokumentu PDF zakodowanego w formacie Base64.
Tworzenie koperty na podstawie szablonu	Tworzy i wysyła kopertę przy użyciu istniejącego szablonu. Szczegóły adresata można dostosować.
Tworzenie szablonu na podstawie adresu URL	Tworzy nowy szablon przy użyciu publicznie dostępnego adresu URL pliku PDF.
Tworzenie szablonu na podstawie base64	Tworzy nowy szablon przy użyciu ciągu PDF zakodowanego w formacie Base64. Użyj tej funkcji, gdy plik PDF jest już dostępny jako ciąg Base64 w przepływie, na przykład z pliku SharePoint lub dokumentu OneDrive.
Usuwanie kopert	Trwale usuwa jedną lub więcej kopert.
Uzyskiwanie historii działań koperty	Pobiera pełny dziennik aktywności dla koperty, pokazując wszystkie akcje podjęte przez adresatów i nadawcę.
Wysyłanie przypomnienia o podpisie	Wysyła powiadomienie z przypomnieniem do oczekujących adresatów koperty z monitem o ukończenie podpisywania.
Wyświetlanie listy wszystkich kanałów elementu webhook	Zwraca listę wszystkich kanałów elementu webhook skonfigurowanych na koncie.

Anulowanie subskrypcji wyzwalacza elementu webhook

Identyfikator operacji:: DeleteTriggerWebhookChannel

Usuwa aktywną subskrypcję kanału elementu webhook według identyfikatora kanału. Użyj tej akcji, aby wyczyścić subskrypcje elementów webhook, które nie są już potrzebne.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator kanału	channelId	True	integer	Identyfikator kanału elementu webhook do usunięcia.

Anuluj kopertę

Identyfikator operacji:: CancelEnvelope

Anuluje wysłaną kopertę. Adresaci nie będą już mogli podpisać dokumentów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	folderId	True	integer	Identyfikator koperty do anulowania.
Przyczyna anulowania	reason_for_cancellation	True	string	Przyczyna anulowania tej koperty. Jest to rejestrowane w historii działań koperty.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
Anulowane identyfikatory kopert	folders cancelled	array of integer	Lista identyfikatorów kopert, które zostały pomyślnie anulowane.

Pobieranie historii usuniętej koperty

Identyfikator operacji:: GetDeletedEnvelopeHistory

Pobiera historię kopert, które zostały usunięte lub przeniesione do kosza.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	folderId	True	string	Unikatowy identyfikator koperty, której historia usuwania ma zostać pobrana.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
Usunięte informacje o kopercie	Deleted Folder Log Info	array of object	Podsumowanie informacji o usuniętej kopercie.
Identyfikator koperty	Deleted Folder Log Info.folderId	integer	Unikatowy identyfikator usuniętej koperty.
Nazwa koperty	Deleted Folder Log Info.folderName	string	Nazwa usuniętej koperty.
Nazwa dokumentu	Deleted Folder Log Info.documentName	string	Nazwa dokumentu w usuniętej kopercie.
Identyfikator dokumentu	Deleted Folder Log Info.documentId	string	Unikatowy identyfikator dokumentu w usuniętej kopercie.
Data usunięcia	Deleted Folder Log Info.deletionDate	integer	Data i godzina usunięcia koperty w milisekundach unix.
Usunięte przez	Deleted Folder Log Info.deletedBy	string	Nazwa użytkownika, który usunął kopertę.
Historia dziennika usuwania	Deleted Folder Log History	array of object	Dziennik krok po kroku wszystkich akcji usuwania wykonywanych na kopercie.
Wykonane przez	Deleted Folder Log History.partiesName	string	Nazwa użytkownika, który wykonał krok usuwania.
Źródło	Deleted Folder Log History.source	string	Źródło, z którego zainicjowano usunięcie (np. Sieć Web, interfejs API).
Event	Deleted Folder Log History.event	string	Wykonano określoną akcję usuwania (np. Usuń folder, Usuń wszystkie strony z folderu).

Pobieranie identyfikatorów koperty

Identyfikator operacji:: GetEnvelopeIds

Zwraca listę identyfikatorów kopert filtrowanych według stanu. Służy do znajdowania kopert w określonym stanie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Data od	dateFrom	True	string	Początek zakresu dat tworzenia koperty. Zaakceptowany format: RRRR-MM-DD.
Data do	dateTo	True	string	Koniec zakresu dat tworzenia koperty. Zaakceptowany format: RRRR-MM-DD. Wartość dateTo musi należeć do 6 miesięcy od wartości dateFrom.
Status	status		string	Filtruj koperty według stanu. Zaakceptowane wartości: EXECUTED, SHARED, DRAFT, PARTIALLY SIGNED, CANCELLED, EXPIRED, DELETED. W przypadku pominięcia zwracane są koperty z dowolnym stanem.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
Message	message	string	Komunikat podsumowania wskazujący, ile identyfikatorów kopert zostało zwróconych.
Identyfikatory kopert	allFolderIds	array of integer	Lista identyfikatorów kopert spełniających kryteria filtrowania. Użyj tych identyfikatorów z instrukcjami Pobierz szczegóły koperty, aby pobrać pełne informacje o kopercie.

Pobieranie listy wszystkich szablonów

Identyfikator operacji:: GetalistofallTemplates

Zwraca listę wszystkich szablonów dostępnych na twoim koncie.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
Łączna liczba szablonów	total_templates	integer	Łączna liczba szablonów na koncie.
Lista szablonów	templatesList	array of object	Lista wszystkich szablonów dostępnych na koncie.
Identyfikator szablonu	templatesList.templateId	integer	Unikatowy identyfikator szablonu. Użyj tego identyfikatora z szablonem Utwórz kopertę, aby wysłać szablon do podpisywania.
Nazwa szablonu	templatesList.templateName	string	Nazwa szablonu.
Opis szablonu	templatesList.templateDesc	string	Opis szablonu.
Typ szablonu	templatesList.templateType	string	Typ lub kategoria szablonu.
Data utworzenia	templatesList.templateCreationDate	integer	Data utworzenia szablonu w milisekundach systemu Unix.
Data ostatniej aktualizacji	templatesList.templateLastUpdateDate	integer	Data ostatniej aktualizacji szablonu w milisekundach systemu Unix.
Można edytować	templatesList.editable	boolean	Wskazuje, czy szablon można edytować.
Liczba stron	templatesList.numberOfParties	integer	Liczba stron podpisywania zdefiniowanych w szablonie.
Identyfikator firmy	templatesList.companyId	integer	Konto firmowe, do którego należy szablon.
Udostępnij wszystkim	templatesList.shareAll	boolean	Wskazuje, czy szablon jest udostępniany wszystkim użytkownikom na koncie.
Identyfikator strony	templatesList.templateCreatedBy.partyId	integer	Unikatowy identyfikator użytkownika.
Imię	templatesList.templateCreatedBy.firstName	string	Imię użytkownika.
Nazwisko	templatesList.templateCreatedBy.lastName	string	Nazwisko użytkownika.
Email	templatesList.templateCreatedBy.emailId	string	Adres e-mail użytkownika.
Identyfikator strony	templatesList.templateLastUpdatedBy.partyId	integer	Unikatowy identyfikator użytkownika.
Imię	templatesList.templateLastUpdatedBy.firstName	string	Imię użytkownika.
Nazwisko	templatesList.templateLastUpdatedBy.lastName	string	Nazwisko użytkownika.
Email	templatesList.templateLastUpdatedBy.emailId	string	Adres e-mail użytkownika.

Pobieranie plików kopert

Identyfikator operacji:: DownloadEnvelopeFiles

Pobiera ukończone dokumenty z koperty jako pliku.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	folderId	True	string	Unikatowy identyfikator koperty, której dokumenty chcesz pobrać.

Zwraca

response: binary

Pobieranie szablonów według identyfikatorów szablonów

Identyfikator operacji:: GetTemplatesbyTemplateIds

Pobiera szczegóły dla co najmniej jednego szablonu według ich identyfikatorów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikatory szablonów	templateIds	True	array of integer	Tablica identyfikatorów szablonów do pobrania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
Łączna liczba szablonów	total_templates	integer	Całkowita liczba zwróconych szablonów.
Lista szablonów	templateIdList	object	Mapa danych szablonu kluczem według identyfikatora szablonu. Każdy wpis zawiera szczegóły szablonu i jego pola.

Pobieranie szczegółów grupy wiadomości e-mail

Identyfikator operacji:: GetEmailGroupDetails

Pobiera szczegóły istniejącej grupy poczty e-mail.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwy grup poczty e-mail	emailGroupNames	True	array of string	Tablica nazw grup poczty e-mail używanych do identyfikowania grup.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Grupy poczty e-mail	allEmailGroups	array of object	Lista grup poczty e-mail pasujących do żądanych nazw grup.
Identyfikator grupy	allEmailGroups.groupId	integer	Unikatowy identyfikator grupy poczty e-mail.
Nazwa grupy	allEmailGroups.groupName	string	Nazwa grupy poczty e-mail.
Opis grupy	allEmailGroups.groupDesc	string	Opis grupy poczty e-mail.
Data utworzenia	allEmailGroups.dateCreated	integer	Data utworzenia grupy wiadomości e-mail w milisekundach systemu Unix.
Identyfikator firmy	allEmailGroups.companyId	integer	Konto firmowe, do którego należy ta grupa poczty e-mail.
Parties	allEmailGroups.parties	array of object	Lista adresatów w tej grupie wiadomości e-mail.
Imię	allEmailGroups.parties.firstName	string	Imię odbiorcy.
Nazwisko	allEmailGroups.parties.lastName	string	Nazwisko adresata.
Email	allEmailGroups.parties.emailId	string	Adres e-mail odbiorcy.

Pobieranie szczegółów kanału elementu webhook

Identyfikator operacji:: GetWebhookChannelDetails

Pobiera szczegóły określonego kanału elementu webhook.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator kanału	channelId	True	string	Unikatowy identyfikator kanału elementu webhook do pobrania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
identyfikator	channel.channelId	integer	Unikatowy identyfikator kanału elementu webhook.
Identyfikator firmy	channel.companyId	integer	Konto firmowe, do którego należy ten kanał.
Name	channel.channelName	string	Nazwa kanału elementu webhook.
Webhook URL	channel.webhookUrl	string	Adres URL, który foxit eSign będzie wywoływany po wystąpieniu subskrybowanego zdarzenia.
Wpis tajny elementu webhook	channel.webhookSecret	string	Klucz tajny używany do weryfikowania ładunków elementu webhook.
Data utworzenia	channel.dateCreated	integer	Data utworzenia kanału w milisekundach systemu Unix.
Data aktualizacji	channel.dateUpdated	integer	Data ostatniej aktualizacji kanału w milisekundach systemu Unix.
Poziom elementu webhook	channel.webhookLevel	string	Zakres kanału elementu webhook. "Konto" (wyzwalacze dla wszystkich kopert) lub "Aplikacja interfejsu API" (wyzwalacze tylko dla kopert utworzonych za pośrednictwem interfejsu API).
Status	channel.status	string	Bieżący stan kanału. "aktywny" lub "dezaktywuj".
Wysłane koperty	channel.eventsSubscribedMap.folder_sent	boolean	Wyzwala, gdy koperta jest wysyłana do adresatów.
Widok koperty	channel.eventsSubscribedMap.folder_viewed	boolean	Wyzwala, gdy koperta jest otwierana przez adresata.
Podpisana koperta	channel.eventsSubscribedMap.folder_signed	boolean	Wyzwala, gdy koperta jest podpisana przez adresata.
Anulowana koperta	channel.eventsSubscribedMap.folder_cancelled	boolean	Wyzwala po anulowaniu koperty.
Wykonane koperty	channel.eventsSubscribedMap.folder_executed	boolean	Wyzwala, gdy wszystkie strony podpisały i koperta jest w pełni wykonywana.
Usunięto kopertę	channel.eventsSubscribedMap.folder_deleted	boolean	Wyzwala po usunięciu koperty.

Pobieranie szczegółów koperty

Identyfikator operacji:: GetEnvelopeDetails

Pobiera pełne szczegóły koperty, w tym jej stan, adresatów i dokumenty.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	folderId	True	integer	Unikatowy identyfikator koperty do pobrania.
Token dostępu	access_token		string	Token dostępu OAuth 2.0 na potrzeby uwierzytelniania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy operacja zakończyła się pomyślnie (np. "powodzenie").
identyfikator	folder.folderId	integer	Unikatowy identyfikator koperty.
Name	folder.folderName	string	Nazwa koperty.
Identyfikator autora	folder.folderAuthorId	integer	Unikatowy identyfikator użytkownika, który utworzył kopertę.
Imię autora	folder.folderAuthorFirstName	string	Imię twórcy koperty.
Nazwisko autora	folder.folderAuthorLastName	string	Nazwisko twórcy koperty.
Adres e-mail autora	folder.folderAuthorEmail	string	Adres e-mail twórcy koperty.
Rola autora	folder.folderAuthorRole	string	Rola konta twórcy koperty.
Identyfikator firmy	folder.folderCompanyId	integer	Unikatowy identyfikator firmy, do którego należy koperta.
Data utworzenia	folder.folderCreationDate	integer	Data i godzina utworzenia koperty w milisekundach unix.
Data wysłania	folder.folderSentDate	integer	Data i godzina wysłania koperty do adresatów w milisekundach unix. Wartość null, jeśli jeszcze nie została wysłana.
Status	folder.folderStatus	string	Bieżący stan koperty (np. SHARED, EXECUTED, DRAFT, CANCELLED).
Identyfikatory dokumentów	folder.folderDocumentIds	array of integer	Lista identyfikatorów dokumentów zawartych w tej kopercie.
Documents	folder.documentsList	array of object	Szczegóły każdego dokumentu zawartego w kopercie.
Identyfikator dokumentu	folder.documentsList.documentId	integer	Unikatowy identyfikator dokumentu.
Identyfikator kontraktu	folder.documentsList.contractId	integer	Unikatowy identyfikator kontraktu skojarzonego z tym dokumentem.
Identyfikator firmy	folder.documentsList.companyId	integer	Unikatowy identyfikator firmy, do którego należy ten dokument.
Stworzone przez	folder.documentsList.contractCreatedBy	integer	Identyfikator użytkownika osoby, która utworzyła kontrakt.
Data utworzenia	folder.documentsList.contractCreatedOn	integer	Data utworzenia kontraktu w milisekundach systemu Unix.
Typ kontraktu	folder.documentsList.contractType	string	Typ lub kategoria kontraktu.
Stan dokumentu	folder.documentsList.contractStatus	string	Bieżący stan podpisywania dokumentu (np. WAITING_FOR_SIGNATURE, WYKONANY).
Można edytować	folder.documentsList.editable	boolean	Wskazuje, czy dokument można edytować.
Identyfikator wersji	folder.documentsList.contractVersionId	integer	Unikatowy identyfikator bieżącej wersji dokumentu.
Nazwa wersji	folder.documentsList.contractVersionName	string	Nazwa bieżącej wersji dokumentu.
Opis wersji	folder.documentsList.contractVersionDesc	string	Opis bieżącej wersji dokumentu.
Wersja utworzona przez	folder.documentsList.versionCreatedby	integer	Identyfikator użytkownika osoby, która utworzyła tę wersję dokumentu.
Wersja utworzona w dniu	folder.documentsList.versionCreatedOn	integer	Data utworzenia tej wersji dokumentu w milisekundach systemu Unix.
Numer wersji	folder.documentsList.contractVersionNumber	integer	Numer wersji dokumentu.
Adresatów	folder.folderRecipientParties	array of object	Lista adresatów tej koperty, w tym ich stan podpisywania i linki dostępu.
Identyfikator adresata	folder.folderRecipientParties.partyId	integer	Unikatowy identyfikator odbiorcy.
Identyfikator adresata	folder.folderRecipientParties.partyDetails.partyId	integer	Unikatowy identyfikator odbiorcy.
Imię	folder.folderRecipientParties.partyDetails.firstName	string	Imię odbiorcy.
Nazwisko	folder.folderRecipientParties.partyDetails.lastName	string	Nazwisko adresata.
Email	folder.folderRecipientParties.partyDetails.emailId	string	Adres e-mail adresata.
Address	folder.folderRecipientParties.partyDetails.address	string	Adres odbiorcy.
Data utworzenia konta	folder.folderRecipientParties.partyDetails.dateCreated	integer	Data utworzenia konta adresata w milisekundach unix.
uprawnienia	folder.folderRecipientParties.contractPermissions	string	Uprawnienia podpisywania przyznane temu adresatowi (np. FILL_FIELDS_AND_SIGN).
Kolejność podpisywania	folder.folderRecipientParties.partySequence	integer	Pozycja tego adresata w zamówieniu podpisywania.
Sekwencja przepływu pracy	folder.folderRecipientParties.workflowSignSequence	integer	Numer sekwencji podpisywania przepływu pracy dla tego adresata.
Identyfikator koperty	folder.folderRecipientParties.envelopeId	integer	Identyfikator koperty, do którego należy ten odbiorca.
Tryb udostępniania	folder.folderRecipientParties.sharingMode	string	Metoda używana do udostępniania dokumentu temu adresatowi (np. wiadomości e-mail).
Adres URL podpisywania	folder.folderRecipientParties.folderAccessURL	string	Unikatowy adres URL podpisywania dla tego adresata. Null, jeśli koperta została już ukończona lub anulowana.
Tryb zabezpieczeń	folder.folderRecipientParties.securityMode	string	Tryb zabezpieczeń zastosowany do dostępu tego adresata.
Dodatkowe komentarze	folder.folderRecipientParties.extraComments	string	Wszelkie dodatkowe komentarze zawarte w zaproszeniu do podpisywania dla tego adresata.
Adres URL dostępu autora	folder.folderAccessURLForAuthor	string	Adres URL autora koperty w celu uzyskania dostępu do dokumentu. Zero, jeśli nie ma to zastosowania.
Identyfikator zbiorczy	folder.bulkId	integer	Identyfikator partii wysyłania zbiorczego, do którego należy ta koperta, jeśli istnieje.
Wymuszanie kolejności podpisywania	folder.enforceSignWorkflow	boolean	Wskazuje, czy adresaci muszą się zalogować w określonej kolejności.
Bieżący krok przepływu pracy	folder.currentWorkflowStep	integer	Bieżący krok w przepływie pracy podpisywania.
Źródło transakcji	folder.transactionSource	string	Źródło, które zainicjowało tę transakcję koperty.
Można edytować	folder.editable	boolean	Wskazuje, czy koperta może być nadal edytowana.
podpisywanie In-Person	folder.inPersonSignable	boolean	Wskazuje, czy koperta może być podpisana osobiście.
Przesłanianie przypomnień	folder.overrideAccountReminders	boolean	Wskazuje, czy ustawienia przypomnienia na poziomie konta są zastępowane dla tej koperty.
identyfikator	folder.envelopeId	integer	Unikatowy identyfikator koperty. Taka sama wartość jak identyfikator koperty (folderId).
Name	folder.envelopeName	string	Nazwa koperty. Ta sama wartość co nazwa koperty (folderName).
Identyfikator obiektu źródłowego	folder.envelopeOriginatorId	integer	Identyfikator użytkownika osoby, która utworzyła kopertę.
Identyfikator firmy	folder.envelopeCompanyId	integer	Identyfikator firmy, do którego należy koperta.
Date	folder.envelopeDate	integer	Data i godzina utworzenia koperty w milisekundach unix.
Data udostępnienia	folder.envelopeSharedDate	integer	Data i godzina udostępnienia koperty adresatom w milisekundach systemu Unix. Wartość null, jeśli jeszcze nie jest udostępniona.
Status	folder.envelopeStatus	string	Bieżący stan koperty. Taka sama wartość jak Stan koperty (folderStatus).
Identyfikatory kontraktów	folder.envelopeContractIds	array of integer	Lista identyfikatorów kontraktów skojarzonych z tą kopertą.
Uprawnienia jednostki	folder.envelopePartyPermissions	array of object	Lista adresatów i ich uprawnień do podpisywania. Taka sama struktura jak adresaci.
Identyfikator adresata	folder.envelopePartyPermissions.partyId	integer	Unikatowy identyfikator odbiorcy.
Imię	folder.envelopePartyPermissions.partyDetails.firstName	string	Imię odbiorcy.
Nazwisko	folder.envelopePartyPermissions.partyDetails.lastName	string	Nazwisko adresata.
Email	folder.envelopePartyPermissions.partyDetails.emailId	string	Adres e-mail adresata.
uprawnienia	folder.envelopePartyPermissions.contractPermissions	string	Uprawnienia podpisywania dla tego adresata.
Kolejność podpisywania	folder.envelopePartyPermissions.partySequence	integer	Pozycja tego adresata w zamówieniu podpisywania.
Adres URL podpisywania	folder.envelopePartyPermissions.folderAccessURL	string	Unikatowy adres URL podpisywania dla tego adresata.
Wszystkie pola	allFields	array of object	Lista wszystkich pól podpisu i formularza umieszczonych w dokumentach koperty.
Identyfikator pola	allFields.fieldTagId	integer	Unikatowy identyfikator pola.
Identyfikator dokumentu	allFields.contractId	integer	Identyfikator dokumentu, do którego należy to pole.
Identyfikator wersji	allFields.versionId	integer	Identyfikator wersji dokumentu, do którego należy to pole.
Typ pola	allFields.fieldType	string	Typ pola (np. pole logowania, pole tekstowe, pole wyboru, pole wyboru, pole rozwijane, pole początkowe).
Numer strony	allFields.documentPageNumber	integer	Numer strony, w którym znajduje się to pole.
Identyfikator dokumentu pola	allFields.docFieldId	string	Identyfikator na poziomie dokumentu dla tego pola.
Odpowiedzialna strona	allFields.partyResponsible	integer	Identyfikator strony odpowiedzialny za wypełnienie tego pola.
Jest zależny	allFields.dependent	boolean	Wskazuje, czy widoczność tego pola zależy od wartości innego pola.
Wymagania	allFields.required	boolean	Wskazuje, czy to pole musi zostać wypełnione, zanim będzie można przesłać dokument.
Wartość pola	allFields.value	string	Bieżąca wartość pola, jeśli zostanie wypełniona.
Wartości pól	allFieldsNameValue	array of object	Uproszczona lista wszystkich nazw pól i ich bieżących wartości. Służy do odczytywania wypełnionych danych pól z podpisanej koperty.
Identyfikator pola	allFieldsNameValue.fieldId	integer	Unikatowy identyfikator pola.
Identyfikator dokumentu	allFieldsNameValue.documentId	integer	Identyfikator dokumentu, do którego należy to pole.
Identyfikator wersji	allFieldsNameValue.documentVersionId	integer	Identyfikator wersji dokumentu, do którego należy to pole.
Typ pola	allFieldsNameValue.fieldType	string	Typ pola (np. pole tekstowe, pole logowania, pole wyboru, pole wyboru, pole wyboru, pole rozwijane).
Nazwa pola	allFieldsNameValue.name	string	Etykieta lub nazwa pola zgodnie z definicją w szablonie.
Wartość pola	allFieldsNameValue.value	string	Wartość wprowadzona lub wybrana dla tego pola.
Historia kopert	Folder History	array of object	Dziennik inspekcji wszystkich działań podjętych na tej kopercie, w porządku chronologicznym.
Imię	Folder History.firstName	string	Imię osoby, która wykonała akcję.
Nazwisko	Folder History.lastName	string	Nazwisko osoby, która wykonała akcję.
Email	Folder History.email	string	Adres e-mail osoby, która wykonała akcję.
Identyfikator koperty	Folder History.envelopeId	integer	Identyfikator koperty, na której wykonano akcję.
Date	Folder History.dateChanged	integer	Data i godzina wystąpienia akcji w milisekundach systemu Unix.
Identyfikator strony	Folder History.changeDoneByParty	integer	Identyfikator strony osoby, która wykonała akcję.
Action	Folder History.action	string	Akcja wykonywana na kopercie (np. Created, InviteSentTo, InviteAccepted, Signed, Executed).

Pobieranie szczegółów szablonu

Identyfikator operacji:: GetTemplateDetails

Pobiera pełne szczegóły określonego szablonu, w tym jego pola i adresatów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator szablonu	templateId	True	string	Unikatowy identyfikator szablonu do pobrania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
identyfikator	template.templateId	integer	Unikatowy identyfikator szablonu.
Name	template.templateName	string	Nazwa szablonu.
Description	template.templateDesc	string	Opis szablonu.
Typ	template.templateType	string	Typ szablonu.
Data utworzenia	template.templateCreationDate	integer	Data utworzenia szablonu w milisekundach systemu Unix.
Data ostatniej aktualizacji	template.templateLastUpdateDate	integer	Data ostatniej aktualizacji szablonu w milisekundach systemu Unix.
Można edytować	template.editable	boolean	Wskazuje, czy szablon można edytować.
Liczba stron	template.numberOfParties	integer	Liczba stron podpisywania zdefiniowanych w szablonie.
Łączna liczba stron	template.totalPages	integer	Całkowita liczba stron w dokumencie szablonu.
Identyfikator firmy	template.companyId	integer	Konto firmowe, do którego należy szablon.
Udostępnij wszystkim	template.shareAll	boolean	Wskazuje, czy szablon jest udostępniany wszystkim użytkownikom na koncie.
Wzorzec nazwy niestandardowej	template.templateCustomName	string	Wzorzec nazwy niestandardowej zastosowany do kopert utworzonych na podstawie tego szablonu.
Uprawnienia jednostki	template.templatePartyPermissions	array of object	Lista ról adresatów i ich uprawnień podpisywania zdefiniowanych w tym szablonie.
Identyfikator strony	template.templatePartyPermissions.template_party_id	integer	Unikatowy identyfikator wpisu strony szablonu.
identyfikator	template.templatePartyPermissions.templateId	integer	Identyfikator szablonu, do którego należy ta strona.
uprawnienia	template.templatePartyPermissions.templatePermissions	string	Uprawnienia podpisywania dla tej strony (np. FILL_FIELDS_AND_SIGN).
Kolejność podpisywania	template.templatePartyPermissions.partySequence	integer	Pozycja zamówienia podpisania dla tej strony.
Rola partii	template.templatePartyPermissions.templatePartyRole	string	Nazwa roli przypisana do tej strony. Użyj tej wartości podczas tworzenia koperty na podstawie tego szablonu.
Identyfikator strony	template.templatePartyPermissions.partyId	integer	Identyfikator strony przypisanej do tej roli, jeśli została wstępnie przypisana.
Identyfikator strony	template.templateCreatedBy.partyId	integer	Unikatowy identyfikator użytkownika.
Imię	template.templateCreatedBy.firstName	string	Imię użytkownika.
Nazwisko	template.templateCreatedBy.lastName	string	Nazwisko użytkownika.
Email	template.templateCreatedBy.emailId	string	Adres e-mail użytkownika.
Dział	template.templateCreatedBy.department	string	Dział użytkownika.
Title	template.templateCreatedBy.title	string	Stanowisko użytkownika.
Aktywne	template.templateCreatedBy.active	boolean	Wskazuje, czy konto użytkownika jest aktywne.
Identyfikator strony	template.templateLastUpdatedBy.partyId	integer	Unikatowy identyfikator użytkownika.
Imię	template.templateLastUpdatedBy.firstName	string	Imię użytkownika.
Nazwisko	template.templateLastUpdatedBy.lastName	string	Nazwisko użytkownika.
Email	template.templateLastUpdatedBy.emailId	string	Adres e-mail użytkownika.
Dział	template.templateLastUpdatedBy.department	string	Dział użytkownika.
Title	template.templateLastUpdatedBy.title	string	Stanowisko użytkownika.
Aktywne	template.templateLastUpdatedBy.active	boolean	Wskazuje, czy konto użytkownika jest aktywne.
Wszystkie pola	allfields	array of object	Lista wszystkich pól zdefiniowanych w tym szablonie.
Identyfikator tagu pola	allfields.fieldTagId	integer	Unikatowy identyfikator pola.
Identyfikator szablonu	allfields.templateId	integer	Identyfikator szablonu, do którego należy to pole.
Identyfikator firmy	allfields.companyId	integer	Konto firmowe, do którego należy to pole.
Typ pola	allfields.fieldType	string	Typ pola (np. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Numer strony	allfields.documentPageNumber	integer	Numer strony dokumentu, w którym znajduje się to pole.
Strona odpowiedzialna	allfields.partyResponsible	integer	Numer sekwencji strony odpowiedzialny za ukończenie tego pola.
Sekwencja stron	allfields.partyResponsibleSequence	integer	Pozycja sekwencji strony odpowiedzialnej.
Identyfikator pola dokumentu	allfields.docFieldId	string	Identyfikator tego pola w dokumencie.
Zależne	allfields.dependent	boolean	Wskazuje, czy widoczność tego pola zależy od wartości innego pola.
Kolejność tabulacji	allfields.tabOrder	integer	Kolejność nawigowania między polami.
Wymagania	allfields.required	boolean	Wskazuje, czy to pole musi zostać ukończone przed podpisaniem dokumentu.
Nazwa pola niestandardowego	allfields.customFieldName	string	Nazwa niestandardowa przypisana do tego pola.
Udostępnij wszystko	allfields.shareAll	boolean	Wskazuje, czy to pole jest udostępniane wszystkim użytkownikom.
Zezwalaj na edycję	allfields.allowEdit	boolean	Wskazuje, czy to pole może być edytowane przez adresata.
Nazwa pola tekstowego	allfields.textfieldName	string	Etykieta pola tekstowego (dotyczy pola pola tekstowego).
Wartość	allfields.value	string	Wstępnie wypełniona lub wprowadzona wartość pola.
Rozmiar czcionki	allfields.fontSize	integer	Rozmiar czcionki używany dla tekstu w tym polu.
Kolor czcionki	allfields.fontColor	string	Kolor czcionki używany do tekstu w tym polu (np. #000000).
Tylko do odczytu	allfields.readOnly	boolean	Wskazuje, czy pole jest tylko do odczytu i nie może być edytowane przez adresata.
Wiele wierszy	allfields.multiLine	boolean	Wskazuje, czy pole tekstowe akceptuje wiele wierszy danych wejściowych (dotyczy, gdy pole fieldType jest polem tekstowym).
Limit znaków	allfields.characterLimit	integer	Maksymalna liczba znaków dozwolonych w polu (dotyczy pola fieldType to "textfield").
Nazwa pola daty	allfields.datefieldName	string	Etykieta pola daty (dotyczy pola fieldType to "datefield").
Format daty	allfields.dateFormat	string	Format daty używany przez to pole (np. MM/DD/RRRR) (dotyczy, gdy fieldType ma wartość "datefield").
Nazwa pola wyboru	allfields.cbname	string	Etykieta pola wyboru (ma zastosowanie, gdy pole wyboru ma wartość "pole wyboru").
Grupa pól wyboru	allfields.cbgroup	string	Nazwa grupy dla tego pola wyboru, używana, gdy wiele pól wyboru jest połączonych (ma zastosowanie, gdy fieldType ma wartość "pole wyboru").
Sprawdzane	allfields.checked	boolean	Wskazuje, czy pole wyboru jest zaznaczone domyślnie (ma zastosowanie, gdy pole wyboru ma wartość "pole wyboru").
Nazwa pola zabezpieczonego	allfields.securedfieldName	string	Etykieta zabezpieczonego pola (ma zastosowanie, gdy pole fieldType ma wartość "securedfield").
Znaki do wyświetlenia	allfields.charToDisplay	integer	Liczba niemaskowanych znaków do wyświetlenia na końcu zabezpieczonej wartości pola (dotyczy, gdy pole fieldType ma wartość "securedfield").
Identyfikator podpisu	allfields.signatureId	string	Identyfikator podpisu zastosowanego do tego pola podpisywania (dotyczy, gdy pole fieldType ma wartość "signfield").
Obraz początkowy	allfields.initialImage	string	Dane obrazu dla inicjałów zastosowanych do tego pola (dotyczy, gdy pole fieldType ma wartość "initialfield").
Nazwa pola załącznika	allfields.attachmentfieldName	string	Nazwa pola załącznika (dotyczy pola fieldType to "attachmentfield").
Opis załącznika	allfields.attachmentfieldDescription	string	Opis elementów do dołączenia (dotyczy, gdy pole fieldType to "attachmentfield").

Pobierz plik PDF z pojedynczym dokumentem

Identyfikator operacji:: DownloadSingleDocumentPDF

Pobiera pojedynczy dokument z koperty jako plik PDF.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	folderId	True	string	Unikatowy identyfikator koperty zawierającej dokument do pobrania.
Numer dokumentu	docNumber	True	string	Indeks dokumentu do pobrania, począwszy od 1.

Zwraca

response: binary

Pobierz raport

Identyfikator operacji:: DownloadReport

Pobiera raport działania koperty jako plik Microsoft Excel. Użyj filtrów, aby zawęzić wyniki według stanu, zakresu dat, nazwy koperty, autora lub osoby podpisającego.

Parametry

Nazwa	Klucz	Typ	Opis
kopertaStatus	status	string	Stany folderu, za pomocą którego filtrujemy raport
Data utworzenia od	creationDateFrom	string	Początek zakresu dat utworzenia. Zaakceptowany format: RRRR-MM-DD.
Data utworzenia do	creationDateTo	string	Koniec zakresu dat utworzenia. Zaakceptowany format: RRRR-MM-DD.
Nazwa koperty	folderName	string	Dowolny folder zawierający ten ciąg.
Uwzględnij pola	includeFields	string	Ustaw wartość "true", aby uwzględnić wartości pól koperty w raporcie. Wartość domyślna to "false".
Adres e-mail autora	authorEmail	string	Przefiltruj raport, aby uwzględnić tylko koperty utworzone przez ten autor adresu e-mail.
Adres e-mail sygnatariusza	signerEmail	string	Odfiltruj raport, aby uwzględnić tylko koperty, w których ten adres e-mail jest podpisem.

Zwraca

Plik raportu: binary

Przenoszenie kopert do Kosza

Identyfikator operacji:: MoveEnvelopestoRecycleBin

Przenosi co najmniej jedną kopertę do kosza. Koperty w koszu nie są trwale usuwane.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikatory folderów	folderIds	True	array of integer	Tablica identyfikatorów kopert do działania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy operacja zakończyła się pomyślnie.

Tworzenie grupy wiadomości e-mail

Identyfikator operacji:: CreateEmailGroup

Tworzy nową grupę wiadomości e-mail, która może służyć do wysyłania kopert do wielu adresatów jednocześnie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa grupy	emailGroupName	True	string	Nazwa nowej grupy poczty e-mail.
Opis grupy	emailGroupDescription		string	Opcjonalny opis grupy wiadomości e-mail.
Zezwalaj na zaawansowaną walidację poczty e-mail	allowAdvancedEmailValidation		boolean	Po włączeniu funkcji Foxit eSign sprawdza, czy wszystkie adresy e-mail w grupie są osiągalne przed wysłaniem.
Imię	firstName	True	string	Imię odbiorcy.
Nazwisko	lastName	True	string	Nazwisko adresata.
Email	emailId	True	string	Adres e-mail odbiorcy.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
Message	message	string	Komunikat potwierdzający dla wykonanej akcji.
Identyfikator grupy	emailGroup.groupId	integer	Unikatowy identyfikator grupy poczty e-mail. Użyj tego identyfikatora podczas wysyłania kopert do grupy.
Nazwa grupy	emailGroup.groupName	string	Nazwa grupy poczty e-mail.
Opis grupy	emailGroup.groupDesc	string	Opis grupy poczty e-mail.
Data utworzenia	emailGroup.dateCreated	integer	Data utworzenia grupy wiadomości e-mail w milisekundach systemu Unix.
Identyfikator firmy	emailGroup.companyId	integer	Konto firmowe, do którego należy ta grupa poczty e-mail.
Parties	emailGroup.parties	array of object	Lista adresatów w grupie wiadomości e-mail.
Imię	emailGroup.parties.firstName	string	Imię odbiorcy.
Nazwisko	emailGroup.parties.lastName	string	Nazwisko adresata.
Email	emailGroup.parties.emailId	string	Adres e-mail odbiorcy.

Tworzenie koperty na podstawie adresu URL

Identyfikator operacji:: CreateEnvelopefromURL

Tworzy i wysyła kopertę przy użyciu publicznie dostępnych adresów URL plików PDF. Podaj adresy URL dokumentów i szczegóły adresata, aby zainicjować proces podpisywania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa koperty	folderName	True	string	Nazwa tej koperty.
Typ danych wejściowych	inputType		string	Określa format źródła dokumentu. Ustaw wartość na adres URL, aby udostępnić adresy URL plików lub base64, aby zapewnić zawartość pliku zakodowaną w formacie Base64.
Adresy URL plików	fileUrls	True	array of string	Tablica publicznie dostępnych adresów URL wskazująca dokumenty do dodania do tej koperty.
Nazwy plików	fileNames	True	array of string	Tablica nazw wyświetlanych dla każdego dokumentu w tej samej kolejności co adresy URL plików.
Imię	firstName	True	string	Imię odbiorcy.
Nazwisko	lastName	True	string	Nazwisko adresata.
Adres e-mail	emailId	True	string	Adres e-mail odbiorcy.
uprawnienia	permission	True	string
Sequence	sequence	True	integer	Użyj tego pola, aby przypisać numer sekwencji do adresata na liście stron adresatów. Użyj unikatowych numerów sekwencji dla każdej strony, zaczynając od 1,2,3,4.... Jeśli jedna osoba pojawia się wiele razy w przepływie pracy podpisywania, przypisz inną sekwencję za każdym razem, gdy odbiorca będzie powtarzany.
signerAuthLevels	signerAuthLevel		string	Poziom uwierzytelniania, który użytkownik podpisujący będzie wykorzystywać do celów weryfikacji
Jest symbolem zastępczym	isPlaceholder		boolean	Użyj tego pola, aby zainicjować stronę jest symbolem zastępczym. Uwaga: 1. firstName, lastName, wartość parametru emailId musi być pusta dla tej strony. 2. Aby dodać symbol zastępczy, jeden adresat musi zostać ponownie przyciągnięty z uprawnieniem "PARTY_ASSIGNER".
Rola adresata	partyRole		string	Użyj tego pola, aby przypisać rolę symbolu zastępczego.
Zezwalaj na zmianę nazwy	allowNameChange		string	Wartość może mieć wartość true lub false Użyj tego parametru, aby umożliwić użytkownikowi podpisywanie zaktualizowanie imienia i nazwiska przed ukończeniem procesu podpisywania.
Sekwencja przepływu pracy	workflowSequence		integer	Przypisz numer sekwencji przepływu pracy do tego adresata. Po włączeniu sekwencji logowania adresaci otrzymają zaproszenie do podpisywania w kolejności rosnącej.
Identyfikator adresu e-mail hosta	hostEmailId		string	Adres e-mail administratora In-Person.
Kod dostępu	userDefinedAccessCode		string	Parametr będzie zawierać kod dostępu, gdy wartość "signerAuthLevel" jest ustawiona jako "Kod dostępu zdefiniowany przez użytkownika" na potrzeby uwierzytelniania. Uwaga: 1. Kody nie są uwzględniane wielkości liter. 2. System nie wysyła tego kodu, więc musisz udostępnić ten kod bezpośrednio podpisowi. 3. Kod programu Access może zawierać alfabety, cyfry i następujące znaki specjalne: @,&,{,},%,(,),~,\|,!,+,^.
Strona jest grupą poczty e-mail	partyIsEmailGroup		boolean	Użyj tego parametru podczas tworzenia strony jako zbiorczej. Uwaga: Jeśli ten parametr ma wartość true, firstName, lastName i emailId tej strony zostaną zignorowane.
Identyfikator grupy wiadomości e-mail	emailGroupId		integer	Przekaż wiadomość e-mail identyfikator grupy, której chcesz użyć do utworzenia zbiorczego.
Zbiorcze logowanie jednokrotne	allowSingleSignerInBulk		boolean	Użyj tego parametru, aby zezwolić tylko jednej osobie na logowanie się do grupy poczty e-mail.
Kod wybierania numerów	dialingCode		string	To pole służy do przypisywania kodów wybierania numerów telefonicznych w kraju jako prefiksów numerów telefonów komórkowych do adresata na liście stron adresatów.
Numer telefonu komórkowego	mobileNumber		string	Użyj tego pola, aby przypisać numer telefonu komórkowego do adresata na liście stron adresatów.
Pola	Fields		object
Wyślij teraz	sendNow		boolean	Po włączeniu funkcji Foxit eSign natychmiast wysyła unikatowy link podpisywania do adresu e-mail każdego adresata. Wyłącz tę opcję, aby zapisać kopertę jako wersję roboczą.
Tworzenie osadzonej sesji podpisywania	createEmbeddedSigningSession	True	boolean	Token sesji podpisywania zostanie wygenerowany bez wysyłania wiadomości e-mail do adresatów.
Tworzenie osadzonej sesji podpisywania dla wszystkich stron	createEmbeddedSigningSessionForAllParties		boolean	W przypadku ustawienia wartości true osadzony adres URL podpisywania zostanie wygenerowany dla każdego adresata w kopercie.
Przetwarzanie tagów tekstowych	processTextTags	True	boolean	Wartość może mieć wartość true lub false. To pole służy do określania, czy program Foxit eSign powinien analizować dokumenty dla tagów tekstowych, aby przekonwertować je na pola Foxit eSign.
Przetwarzanie pól Acro	processAcroFields	True	boolean	To pole służy do określania, czy foxit eSign powinien analizować dokumenty dla AcroFields, aby przekonwertować je na pola Foxit eSign.
Sekwencja logowania	signInSequence		boolean	To pole służy do określania, czy adresaci podpiszą dokumenty koperty w sekwencji. Jeśli wartość false, wszyscy adresaci otrzymają jednocześnie wiadomość e-mail z zaproszeniem. W przypadku wartości true każdy adresat otrzymuje wiadomość e-mail z zaproszeniem po wykonaniu przez poprzedniego adresata wymaganego zadania, takiego jak podpisywanie dokumentów lub wypełnianie pól itp.
Włącz osobiście	inPersonEnable		boolean	To pole służy do inicjowania procesu podpisywania osoby, który można łatwo ukończyć na dowolnym urządzeniu w ciągu kilku minut i unika podpisów opartych na wiadomości e-mail, jeśli jest to wymagane. Jeśli wartość false, wszyscy adresaci otrzymają jednocześnie wiadomość e-mail z zaproszeniem. W przypadku wartości true administrator osoby otrzymuje wiadomość e-mail z zaproszeniem w celu zainicjowania procesu podpisywania dla osoby podpisującego.
Naprawianie stron adresatów	fixRecipientParties		boolean	Jeśli to prawda, w osadzonym widoku wysyłania nie można zmienić stron koperty, które zostały już dodane w ramach tego żądania.
Naprawianie dokumentów	fixDocuments		boolean	Jeśli to prawda, w osadzonym wysyłaniu nie można zmienić dokumentów dla koperty, które zostały już dodane w ramach tego żądania.
Adres URL powodzenia wysyłania	sendSuccessUrl		string	Wprowadź bezwzględny adres URL strony docelowej, do której będzie przekierowywany podpisujący po pomyślnym wysłaniu folderu w osadzonym widoku wysyłania.
Adres URL błędu wysyłania	sendErrorUrl		string	Wprowadź bezwzględny adres URL strony docelowej, do której użytkownik podpisujący zostanie przekierowany, jeśli podczas wysyłania folderu w osadzonym widoku wysyłania wystąpi błąd.
Tworzenie osadzonej sesji wysyłania	createEmbeddedSendingSession		boolean	Jeśli ustawiono wartość true, wygeneruje on osadzony token umożliwiający otwarcie widoku przygotowywania dokumentu foxit eSign.
Identyfikatory e-mail osadzonych osób podpisujących	embeddedSignersEmailIds		array of string	Tablica identyfikatorów wiadomości e-mail adresatów, dla których należy utworzyć osadzoną sesję podpisywania. Identyfikatory e-mail od stron adresatów dodane na liście stron.
Adres URL powodzenia podpisywania	signSuccessUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, do których nastąpi przekierowanie po pomyślnym zalogowaniu się w osadzonym widoku podpisywania.
Adres URL odrzucenia znaku	signDeclineUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, do których nastąpi przekierowanie, jeśli odmówi zalogowania się osadzonego widoku podpisywania.
Podpisz późniejszy adres URL	signLaterUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, do których nastąpi przekierowanie, jeśli zdecyduje się zalogować później w osadzonym widoku podpisywania.
Adres URL błędu podpisywania	signErrorUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, którzy zostaną przekierowani do, jeśli podczas podpisywania dokumentu w osadzonym widoku podpisywania wystąpi błąd.
Zezwalaj na wysyłanie teraz i osadzoną sesję podpisywania	allowSendNowAndEmbeddedSigningSession		boolean	Jeśli ustawisz wartość true, funkcja Foxit eSign wyśle unikatowy link podpisywania do każdego adresata. Ma to zastosowanie tylko wtedy, gdy parametry sendNow i createEmbeddedSigningSession mają wartość true.
Zaawansowana weryfikacja poczty e-mail	allowAdvancedEmailValidation		boolean	Zweryfikuj adres e-mail stron po ustawieniu wartości true.
Adres URL sukcesu podpisywania — wszystkie strony	signSuccessUrlAllParties		boolean	Jeśli ustawiono wartość true, znakator zostanie przekierowany do adresu URL podanego w elemencie signSuccessUrl po pomyślnym podpisaniu. Ma to zastosowanie tylko wtedy, gdy element sendNow ma wartość true.
Identyfikator szablonu wiadomości e-mail	emailTemplateId		integer	Przekaż identyfikator szablonu wiadomości e-mail, aby wysłać szablony wiadomości e-mail inne niż domyślne szablony wiadomości e-mail.
Identyfikator instrukcji podpisywania	signerInstructionId		integer	Przekaż identyfikator instrukcji, aby wysłać instrukcje logowania inne niż domyślne instrukcje dotyczące podpisywania.
Identyfikator instrukcji potwierdzenia	confirmationInstructionId		string	Przekaż identyfikator instrukcji potwierdzenia, aby wysłać instrukcje potwierdzenia inne niż domyślne instrukcje potwierdzenia.
Kolor motywu	themeColor		string	Wprowadź wartość CSS, aby ustawić kolor motywu.
Wygaśnięcie sesji	sessionExpire		boolean	Ustaw wartość true, aby zainicjować wygaśnięcie osadzonej sesji podpisywania.
Wygaśnięcie	expiry		integer	Wymagane, jeśli wartość sessionExpire ma wartość true. Wprowadź czas trwania w milisekundach wygaśnięcia osadzonej sesji podpisywania.
Nazwa pola zależnego	dependentFieldName	True	string	Nazwa pola, którego widoczność jest kontrolowana przez pole nadrzędne.
Nazwa pola nadrzędnego	parentFieldName	True	string	Nazwa pola nadrzędnego, którego wartość kontroluje widoczność pola zależnego. Obsługiwane typy pól nadrzędnych: pole tekstowe, pole tekstowe, pole wyboru, przycisk radiowy, lista rozwijana.
Wartość pola nadrzędnego	parentFieldValue	True	string	Wartość pola nadrzędnego, które wyzwala pole zależne, aby stało się widoczne. W przypadku pól pola wyboru i przycisku radiowego użyj zaznaczonego lub niezaznaczonego.
Opcje	options	True	string	Dodatkowe opcje dopasowania dla pól nadrzędnych opartych na tekście. Zaakceptowane wartości: isblank, allowNull, contains.
Metadane	metadata		object	Powinno to być w parze wartości klucza. Dozwolone są maksymalnie 1000 par klucz-wartość.
Adres e-mail nadawcy	senderEmail		string	Wprowadź adres e-mail innego użytkownika na koncie, który będzie używany do wysyłania tego folderu dokumentów do osób adresatów.
Ukryj przycisk Dodaj mnie	hideAddMeButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Dodaj mnie" na stronie adresatów w osadzonej sesji wysyłania.
Ukryj przycisk Dodaj nowy	hideAddNewButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Dodaj nowy" na stronie adresatów w osadzonej sesji wysyłania.
Ukryj przycisk Dodaj grupę	hideAddGroupButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Dodaj grupę" na stronie adresatów w osadzonej sesji wysyłania.
Ukryj nazwę pola dla adresatów	hideFieldNameForRecipients		boolean	Ukryj nazwy pól dla adresatów pól wprowadzania danych i pól zaawansowanych. (Z wyjątkiem przycisku radiowego, pola wyboru, obrazu i hiperłącza).
Ukryj obramowanie pola wyboru	hideCheckboxBorder		boolean	Obramowania pola wyboru będą ukryte w wykonanych dokumentach.
Ukryj opcję wyboru signer	hideSignerSelectOption		boolean	Jeśli to prawda, spowoduje to ukrycie pola wejściowego "Istniejąca nazwa/adres e-mail osoby podpisywającego" w osadzonej sesji wysyłania.
Ukryj akcje signer	hideSignerActions		boolean	Jeśli to prawda, spowoduje to ukrycie akcji "edit", "change" i "remove" dla stron adresatów w osadzonej sesji wysyłania.
Ukryj nazwę nadawcy	hideSenderName		boolean	Jeśli to prawda, spowoduje to ukrycie nazwy nadawcy na stronach adresatów w osadzonej sesji wysyłania.
Ukryj nazwę folderu	hideFolderName		boolean	Jeśli to prawda, spowoduje to ukrycie nazwy folderu na nawigacji w obu sesjach osadzonych.
Ukryj nazwę dokumentów	hideDocumentsName		boolean	Jeśli to prawda, spowoduje to ukrycie nazwy dokumentu w obu sesjach osadzonych.
Ukryj odrzuć do podpisania	hideDeclineToSign		boolean	Jeśli wartość true, spowoduje to ukrycie opcji "Odrzuć znak" dla osoby podpisającego.
Ukryj więcej akcji	hideMoreAction		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Więcej akcji" w sesji wysyłania/podpisywania. W przypadku polecenia "Wyślij teraz": prawda, nie spowoduje ukrycia niczego.
Ukryj przycisk Wyślij	hideSendButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku Wyślij w osadzonej sesji wysyłania.
Ukryj następne wymagane polebtn	hideNextRequiredFieldbtn		boolean	Jeśli ustawiono wartość true, ukrywa przycisk nawigacji, który przenosi osoby podpisujące do następnego wymaganego pola.
Wymagana obie sesje osadzone	requiredBothEmbeddedSession		boolean	Jeśli to prawda, wygeneruje osadzone adresy URL wysyłania i podpisywania razem.
Hasło koperty	folderPassword		string	To hasło będzie wymagane przez sygnatariusza/autora, aby otworzyć podpisany cyfrowo dokument. Jeśli parametr jest pusty, żadne hasło nie będzie wymagane do otwarcia dokumentu podpisanego cyfrowo.
Włącz krok po kroku	enableStepByStep		boolean	Aby włączyć akcję krok po kroku w osadzonej sesji wysyłania.
Ukryj opcję Dodaj strony	hideAddPartiesOption		boolean	W przypadku wartości true opcja spowoduje ukrycie opcji dodawania stron w trybie tworzenia wersji roboczej i szablonu.
Podpis własny	selfSign		boolean	Umożliwia ona osadzony znak własny za pośrednictwem interfejsów API. Ten parametr ma zastosowanie tylko wtedy, gdy parametr createEmbeddedSendingSession ma wartość true.
Adres URL powodzenia logowania samodzielnego	selfSignerSuccessUrl		string	Wprowadź bezwzględny adres URL strony docelowej w witrynie internetowej/aplikacji, do której użytkownik zostanie przekierowany po pomyślnym podpisie własnym wysyłającym folder w osadzonym widoku wysyłania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	folder.folderId	integer	Unikatowy identyfikator nowo utworzonej koperty. Użyj tej funkcji w kolejnych akcjach, aby odwołać się do tej koperty.
Name	folder.folderName	string	Nazwa nowo utworzonej koperty.
Nazwa niestandardowa	folder.folderCustomName	string	Niestandardowa nazwa koperty.
Hasło	folder.folderPassword	string	Jeśli ustawiono hasło dostępu dla koperty.
Identyfikator twórcy	folder.folderAuthorId	integer	Unikatowy identyfikator twórcy koperty.
Imię twórcy	folder.folderAuthorFirstName	string	Imię twórcy koperty.
Nazwisko twórcy	folder.folderAuthorLastName	string	Nazwisko twórcy koperty.
Adres e-mail twórcy	folder.folderAuthorEmail	string	Adres e-mail twórcy koperty.
Rola twórcy	folder.folderAuthorRole	string	Rola twórcy koperty.
Identyfikator firmy	folder.folderCompanyId	integer	Unikatowy identyfikator firmy, która jest właścicielem koperty.
Data utworzenia	folder.folderCreationDate	integer	Data utworzenia koperty (sygnatura czasowa systemu Unix w milisekundach).
Data wysłania	folder.folderSentDate	integer	Data wysłania koperty (sygnatura czasowa systemu Unix w milisekundach).
Status	folder.folderStatus	string	Bieżący stan koperty.
Pole niestandardowe 1	folder.custom_field1	string	Pierwsze pole niestandardowych metadanych dla koperty.
Pole niestandardowe 2	folder.custom_field2	string	Drugie pole niestandardowych metadanych dla koperty.
Metadane	folder.metadata	string	Niestandardowe metadane skojarzone z kopertą.
Identyfikatory dokumentów	folder.folderDocumentIds	array of integer	Lista identyfikatorów dokumentów zawartych w kopercie.
Documents	folder.documentsList	array of object	Lista dokumentów w kopercie.
Identyfikator dokumentu	folder.documentsList.documentId	integer	Unikatowy identyfikator dokumentu.
Identyfikator kontraktu	folder.documentsList.contractId	integer	Unikatowy identyfikator kontraktu.
Identyfikator firmy	folder.documentsList.companyId	integer	Unikatowy identyfikator firmy.
Stworzone przez	folder.documentsList.contractCreatedBy	integer	Identyfikator użytkownika osoby, która utworzyła kontrakt.
Data utworzenia	folder.documentsList.contractCreatedOn	string	Data i godzina utworzenia kontraktu.
Typ kontraktu	folder.documentsList.contractType	string	Typ kontraktu.
Stan kontraktu	folder.documentsList.contractStatus	string	Bieżący stan kontraktu.
Można edytować	folder.documentsList.editable	boolean	Wskazuje, czy element jest edytowalny.
Identyfikator wersji	folder.documentsList.contractVersionId	integer	Unikatowy identyfikator wersji kontraktu.
Nazwa wersji	folder.documentsList.contractVersionName	string	Nazwa wersji kontraktu.
Opis wersji	folder.documentsList.contractVersionDesc	string	Opis wersji kontraktu.
Wersja utworzona przez	folder.documentsList.versionCreatedby	integer	Identyfikator użytkownika osoby, która utworzyła tę wersję.
Wersja utworzona w dniu	folder.documentsList.versionCreatedOn	string	Data i godzina utworzenia tej wersji.
Numer wersji	folder.documentsList.contractVersionNumber	integer	Numer wersji kontraktu.
Źródło transakcji	folder.documentsList.contractTransactionSource	string	System źródłowy, który zainicjował transakcję kontraktu.
Adresatów	folder.folderRecipientParties	array of object	Lista osób adresatów dla tej koperty.
Identyfikator adresata	folder.folderRecipientParties.partyId	integer	Unikatowy identyfikator odbiorcy.
Identyfikator adresata	folder.folderRecipientParties.partyDetails.partyId	integer	Unikatowy identyfikator odbiorcy.
Imię	folder.folderRecipientParties.partyDetails.firstName	string	Imię odbiorcy.
Nazwisko	folder.folderRecipientParties.partyDetails.lastName	string	Nazwisko adresata.
Adres e-mail	folder.folderRecipientParties.partyDetails.emailId	string	Adres e-mail odbiorcy.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Wskazuje, czy ta strona jest adresatem zastępczym.
Address	folder.folderRecipientParties.partyDetails.address	string	Fizyczny adres odbiorcy.
Data utworzenia	folder.folderRecipientParties.partyDetails.dateCreated	integer	Data utworzenia rekordu (sygnatura czasowa systemu Unix w milisekundach).
Rezygnacja z wiadomości e-mail	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Wskazuje, czy odbiorca zrezygnował z powiadomień e-mail.
Unikatowy identyfikator adresata	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Unikatowy identyfikator systemu dla tego adresata.
Poziom uwierzytelniania	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Metoda uwierzytelniania wymagana dla tego adresata.
Data aktualizacji hasła	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Data ostatniej aktualizacji hasła.
Stan zaktualizowanego hasła	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Wskazuje, czy hasło zostało zaktualizowane.
Identyfikator firmy	folder.folderRecipientParties.partyDetails.companyId	integer	Unikatowy identyfikator firmy.
Rola użytkownika	folder.folderRecipientParties.partyDetails.userRole	string	Rola przypisana użytkownikowi.
Dział	folder.folderRecipientParties.partyDetails.department	string	Dział, do którego należy użytkownik.
Title	folder.folderRecipientParties.partyDetails.title	string	Stanowisko użytkownika.
Aktywne	folder.folderRecipientParties.partyDetails.active	boolean	Wskazuje, czy użytkownik lub rekord jest aktywny.
Lokalizacja	folder.folderRecipientParties.partyDetails.requestLocale	string	Ustawienie ustawień regionalnych dla użytkownika.
Udostępnianie za pomocą działu	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Wskazuje, czy koperty są udostępniane w całym dziale.
Kod wybierania numerów	folder.folderRecipientParties.partyDetails.dialingCode	string	Międzynarodowy kod wybierania numeru telefonu.
Numer telefonu komórkowego	folder.folderRecipientParties.partyDetails.mobileNumber	string	Numer telefonu komórkowego.
Filtr stanu	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Filtr stanu dokumentu.
Filtr daty	folder.folderRecipientParties.partyDetails.docDateFilter	string	Filtr daty dokumentu.
Bezpieczny dostęp do pól	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Wskazuje, czy użytkownik ma dostęp do bezpiecznych pól.
Rozwiń pasek boczny	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Wskazuje, czy pasek boczny jest domyślnie rozwinięty.
Adv. Weryfikacja wiadomości e-mail	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Wskazuje, czy włączono zaawansowaną walidację poczty e-mail.
Identyfikator menedżera	folder.folderRecipientParties.partyDetails.managerId	string	Unikatowy identyfikator menedżera użytkownika.
Liczba logowań	folder.folderRecipientParties.partyDetails.loginCount	integer	Liczba logowanych przez użytkownika.
Wiadomość e-mail dotycząca resetowania hasła	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Wskazuje, czy ma zostać wysłana wiadomość e-mail z funkcją resetowania hasła.
Identyfikator działu	folder.folderRecipientParties.partyDetails.departmentId	string	Unikatowy identyfikator działu.
Podstawowa firma	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Podstawowa firma skojarzona z użytkownikiem.
Typ urządzenia	folder.folderRecipientParties.partyDetails.deviceType	string	Typ używanego urządzenia.
Token urządzenia	folder.folderRecipientParties.partyDetails.deviceToken	string	Token powiadomień wypychanych dla urządzenia.
Opis podwykonawcy	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Opis podwykonawcy lub sygnatariusza zewnętrznego.
Organizacja podwykonawców	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Nazwa organizacji podwykonawcy lub osoby podpisowej zewnętrznej.
Data dodania podwykonawcy	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Data dodania podwykonawcy (sygnatura czasowa systemu Unix w milisekundach).
Źródło	folder.folderRecipientParties.partyDetails.source	string	System źródłowy, z którego dodano zewnętrznego sygnatariusza.
Kod wybierania numerów	folder.folderRecipientParties.dialingCode	string	Międzynarodowy kod wybierania numeru telefonu.
Numer telefonu komórkowego	folder.folderRecipientParties.mobileNumber	string	Numer telefonu komórkowego.
Typ podpisu	folder.folderRecipientParties.signerSignatureType	string	Typ podpisu, który będzie używany przez sygnatariusza.
uprawnienia	folder.folderRecipientParties.contractPermissions	string	Uprawnienia przyznane tej stronie dla umowy.
Kolejność podpisywania	folder.folderRecipientParties.partySequence	integer	Numer sekwencji zamówień podpisywania dla tego adresata.
Sekwencja przepływu pracy	folder.folderRecipientParties.workflowSignSequence	integer	Numer sekwencji podpisywania przepływu pracy.
Identyfikator koperty	folder.folderRecipientParties.envelopeId	integer	Unikatowy identyfikator koperty.
Identyfikator firmy odbiorcy	folder.folderRecipientParties.partyCompanyId	integer	Unikatowy identyfikator firmy skojarzonej z tym adresatem.
Tryb udostępniania	folder.folderRecipientParties.sharingMode	string	Tryb udostępniania dla tej koperty.
Adres URL dostępu adresata	folder.folderRecipientParties.folderAccessURL	string	Adres URL, który odbiorca może użyć do uzyskania dostępu do koperty i podpisania jej.
Tryb zabezpieczeń	folder.folderRecipientParties.securityMode	string	Tryb zabezpieczeń zastosowany do tej koperty.
Comments	folder.folderRecipientParties.extraComments	string	Dodatkowe komentarze dołączone do koperty.
Zezwalaj na zmianę nazwy	folder.folderRecipientParties.allowNameChange	boolean	Wskazuje, czy odbiorca może zaktualizować swoją nazwę.
Nazwa zaktualizowana	folder.folderRecipientParties.signerNameUpdated	boolean	Wskazuje, czy sygnatariusz zaktualizował swoją nazwę.
Poziom uwierzytelniania logowania	folder.folderRecipientParties.signerAuthenticationLevel	string	Poziom uwierzytelniania wymagany dla sygnatariusza.
Kod dostępu	folder.folderRecipientParties.userDefinedAccessCode	string	Niestandardowy kod dostępu zdefiniowany dla użytkownika podpisjącego.
Identyfikator podpisu	folder.folderRecipientParties.signatureId	string	Unikatowy identyfikator podpisu.
Rola adresata	folder.folderRecipientParties.partyRole	string	Rola przypisana do tego adresata w przepływie pracy podpisywania.
Pole firmy	folder.folderRecipientParties.companyFieldValue	string	Wartość pola nazwa firmy w podpisie.
Pole tytułu	folder.folderRecipientParties.titleFieldValue	string	Wartość pola tytułu w podpisie.
Przyczyna podpisywania	folder.folderRecipientParties.reasonSigning	string	Przyczyną podpisania dokumentu przez odbiorcę.
Dodano pole płatności	folder.folderRecipientParties.payFieldAdded	boolean	Wskazuje, czy dodano pole płatności.
Odbiorcy	folder.folderRecipientParties.payee	boolean	Wskazuje, czy ten odbiorca jest odbiorcą.
Płatność cykliczna	folder.folderRecipientParties.recurringFieldExist	boolean	Wskazuje, czy istnieje pole płatności cyklicznej.
Drukowanie i podpisywanie gotowe	folder.folderRecipientParties.printAndSignCompleted	boolean	Wskazuje, czy proces drukowania i podpisywania został ukończony.
Paid	folder.folderRecipientParties.paid	boolean	Wskazuje, czy płatność została ukończona.
Opcjonalne dozwolone podpisywanie	folder.folderRecipientParties.allowOptionalSigner	boolean	Wskazuje, czy ten odbiorca jest opcjonalnym sygnatariuszem.
Opcjonalne osoby podpisujących	folder.folderRecipientParties.optionalSigners	array of integer	Lista opcjonalnych identyfikatorów stron podpisywania dla tej koperty.
Adres URL podpisywania autora	folder.folderAccessURLForAuthor	string	Adres URL, za pomocą których nadawca może uzyskać dostęp do koperty.
Draft Access URL	folder.draftFolderAccessURL	string	Adres URL używany do uzyskiwania dostępu do wersji roboczej koperty.
Podpisywanie sali konferencyjnej	folder.boardRoomSign	boolean	Wskazuje, czy tryb podpisywania sali tablicy jest włączony.
Dołącz logo	folder.includeLogo	boolean	Wskazuje, czy logo firmy jest zawarte w wiadomościach e-mail.
Kolor tła przycisku	folder.email_btnBgColor	string	Kolor tła przycisku wiadomości e-mail.
Kolor tekstu przycisku	folder.email_btnTxtColor	string	Kolor tekstu przycisku wiadomości e-mail.
Logo poczty e-mail	folder.emailTemplateLogo	string	Adres URL logo używany w szablonie wiadomości e-mail.
Identyfikator szablonu wiadomości e-mail	folder.emailTemplateId	integer	Unikatowy identyfikator szablonu wiadomości e-mail.
Nagłówek wiadomości e-mail	folder.emailHeader	string	Tekst nagłówka używany w wiadomościach e-mail z powiadomieniami.
Stopka wiadomości e-mail	folder.emailFooter	string	Tekst stopki używany w wiadomościach e-mail z powiadomieniami.
Przeczyść zaplanowane	folder.purgeFlag	boolean	Wskazuje, czy koperta jest zaplanowana do przeczyszczania.
Data rozpoczęcia przeczyszczania	folder.purgeStartDate	string	Data rozpoczęcia przeczyszczania.
Data zakończenia przeczyszczania	folder.purgeEndDate	string	Data zakończenia przeczyszczania.
Identyfikator wysyłania zbiorczego	folder.bulkId	integer	Unikatowy identyfikator operacji wysyłania zbiorczego.
Wymuszanie kolejności podpisywania	folder.enforceSignWorkflow	boolean	Wskazuje, czy adresaci muszą zalogować się w zdefiniowanej sekwencji.
Bieżący krok	folder.currentWorkflowStep	integer	Bieżący krok w przepływie pracy podpisywania.
Źródło transakcji	folder.transactionSource	string	System źródłowy, który zainicjował tę transakcję.
Można edytować	folder.editable	boolean	Wskazuje, czy element jest edytowalny.
podpisywanie In-Person	folder.inPersonSignable	boolean	Wskazuje, czy koperta może być podpisana osobiście.
Przesłanianie przypomnień	folder.overrideAccountReminders	boolean	Wskazuje, czy ustawienia przypomnienia na poziomie konta są zastępowane.
Zastępowanie delegowania	folder.overrideAccountRecipientDelegation	boolean	Wskazuje, czy ustawienia delegowania na poziomie konta są zastępowane.
Zezwalaj na delegowanie	folder.allowRecipientsToDelegate	boolean	Wskazuje, czy adresaci mogą delegować podpisywanie.
identyfikator	folder.envelopeId	integer	Unikatowy identyfikator koperty.
Name	folder.envelopeName	string	Nazwa koperty.
Identyfikator obiektu źródłowego	folder.envelopeOriginatorId	integer	Unikatowy identyfikator użytkownika, który utworzył kopertę.
Identyfikator firmy	folder.envelopeCompanyId	integer	Unikatowy identyfikator firmy, która jest właścicielem koperty.
Date	folder.envelopeDate	integer	Data utworzenia koperty (sygnatura czasowa systemu Unix w milisekundach).
Data udostępnienia	folder.envelopeSharedDate	integer	Data udostępnienia koperty (sygnatura czasowa systemu Unix w milisekundach).
Status	folder.envelopeStatus	string	Bieżący stan koperty.
Identyfikatory kontraktów	folder.envelopeContractIds	array of integer	Lista identyfikatorów kontraktów skojarzonych z tą kopertą.
Uprawnienia adresata	folder.envelopePartyPermissions	array of object	Lista uprawnień adresata dla tej koperty.
Identyfikator adresata	folder.envelopePartyPermissions.partyId	integer	Unikatowy identyfikator odbiorcy.
Identyfikator adresata	folder.envelopePartyPermissions.partyDetails.partyId	integer	Unikatowy identyfikator odbiorcy.
Imię	folder.envelopePartyPermissions.partyDetails.firstName	string	Imię odbiorcy.
Nazwisko	folder.envelopePartyPermissions.partyDetails.lastName	string	Nazwisko adresata.
Adres e-mail	folder.envelopePartyPermissions.partyDetails.emailId	string	Adres e-mail odbiorcy.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Wskazuje, czy ta strona jest adresatem zastępczym.
Address	folder.envelopePartyPermissions.partyDetails.address	string	Fizyczny adres odbiorcy.
Data utworzenia	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Data utworzenia rekordu (sygnatura czasowa systemu Unix w milisekundach).
Rezygnacja z wiadomości e-mail	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Wskazuje, czy odbiorca zrezygnował z powiadomień e-mail.
Unikatowy identyfikator adresata	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Unikatowy identyfikator systemu dla tego adresata.
Poziom uwierzytelniania	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Metoda uwierzytelniania wymagana dla tego adresata.
Data aktualizacji hasła	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Data ostatniej aktualizacji hasła.
Stan zaktualizowanego hasła	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Wskazuje, czy hasło zostało zaktualizowane.
Identyfikator firmy	folder.envelopePartyPermissions.partyDetails.companyId	integer	Unikatowy identyfikator firmy.
Rola użytkownika	folder.envelopePartyPermissions.partyDetails.userRole	string	Rola przypisana użytkownikowi.
Dział	folder.envelopePartyPermissions.partyDetails.department	string	Dział, do którego należy użytkownik.
Title	folder.envelopePartyPermissions.partyDetails.title	string	Stanowisko użytkownika.
Aktywne	folder.envelopePartyPermissions.partyDetails.active	boolean	Wskazuje, czy użytkownik lub rekord jest aktywny.
Lokalizacja	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Ustawienie ustawień regionalnych dla użytkownika.
Udostępnianie za pomocą działu	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Wskazuje, czy koperty są udostępniane w całym dziale.
Kod wybierania numerów	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Międzynarodowy kod wybierania numeru telefonu.
Numer telefonu komórkowego	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Numer telefonu komórkowego.
Filtr stanu	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Filtr stanu dokumentu.
Filtr daty	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Filtr daty dokumentu.
Bezpieczny dostęp do pól	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Wskazuje, czy użytkownik ma dostęp do bezpiecznych pól.
Rozwiń pasek boczny	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Wskazuje, czy pasek boczny jest domyślnie rozwinięty.
Adv. Weryfikacja wiadomości e-mail	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Wskazuje, czy włączono zaawansowaną walidację poczty e-mail.
Identyfikator menedżera	folder.envelopePartyPermissions.partyDetails.managerId	string	Unikatowy identyfikator menedżera użytkownika.
Liczba logowań	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Liczba logowanych przez użytkownika.
Wiadomość e-mail dotycząca resetowania hasła	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Wskazuje, czy ma zostać wysłana wiadomość e-mail z funkcją resetowania hasła.
Identyfikator działu	folder.envelopePartyPermissions.partyDetails.departmentId	string	Unikatowy identyfikator działu.
Podstawowa firma	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Podstawowa firma skojarzona z użytkownikiem.
Typ urządzenia	folder.envelopePartyPermissions.partyDetails.deviceType	string	Typ używanego urządzenia.
Token urządzenia	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Token powiadomień wypychanych dla urządzenia.
Opis podwykonawcy	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Opis podwykonawcy lub sygnatariusza zewnętrznego.
Organizacja podwykonawców	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Nazwa organizacji podwykonawcy lub osoby podpisowej zewnętrznej.
Data dodania podwykonawcy	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Data dodania podwykonawcy (sygnatura czasowa systemu Unix w milisekundach).
Źródło	folder.envelopePartyPermissions.partyDetails.source	string	System źródłowy, z którego dodano zewnętrznego sygnatariusza.
Kod wybierania numerów	folder.envelopePartyPermissions.dialingCode	string	Międzynarodowy kod wybierania numeru telefonu.
Numer telefonu komórkowego	folder.envelopePartyPermissions.mobileNumber	string	Numer telefonu komórkowego.
Typ podpisu	folder.envelopePartyPermissions.signerSignatureType	string	Typ podpisu, który będzie używany przez sygnatariusza.
uprawnienia	folder.envelopePartyPermissions.contractPermissions	string	Uprawnienia przyznane tej stronie dla umowy.
Kolejność podpisywania	folder.envelopePartyPermissions.partySequence	integer	Numer sekwencji zamówień podpisywania dla tego adresata.
Sekwencja przepływu pracy	folder.envelopePartyPermissions.workflowSignSequence	integer	Numer sekwencji podpisywania przepływu pracy.
Identyfikator koperty	folder.envelopePartyPermissions.envelopeId	integer	Unikatowy identyfikator koperty.
Identyfikator firmy odbiorcy	folder.envelopePartyPermissions.partyCompanyId	integer	Unikatowy identyfikator firmy skojarzonej z tym adresatem.
Tryb udostępniania	folder.envelopePartyPermissions.sharingMode	string	Tryb udostępniania dla tej koperty.
Adres URL dostępu adresata	folder.envelopePartyPermissions.folderAccessURL	string	Adres URL, który odbiorca może użyć do uzyskania dostępu do koperty i podpisania jej.
Tryb zabezpieczeń	folder.envelopePartyPermissions.securityMode	string	Tryb zabezpieczeń zastosowany do tej koperty.
Comments	folder.envelopePartyPermissions.extraComments	string	Dodatkowe komentarze dołączone do koperty.
Zezwalaj na zmianę nazwy	folder.envelopePartyPermissions.allowNameChange	boolean	Wskazuje, czy odbiorca może zaktualizować swoją nazwę.
Nazwa zaktualizowana	folder.envelopePartyPermissions.signerNameUpdated	boolean	Wskazuje, czy sygnatariusz zaktualizował swoją nazwę.
Poziom uwierzytelniania logowania	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Poziom uwierzytelniania wymagany dla sygnatariusza.
Kod dostępu	folder.envelopePartyPermissions.userDefinedAccessCode	string	Niestandardowy kod dostępu zdefiniowany dla użytkownika podpisjącego.
Identyfikator podpisu	folder.envelopePartyPermissions.signatureId	string	Unikatowy identyfikator podpisu.
Rola adresata	folder.envelopePartyPermissions.partyRole	string	Rola przypisana do tego adresata w przepływie pracy podpisywania.
Pole firmy	folder.envelopePartyPermissions.companyFieldValue	string	Wartość pola nazwa firmy w podpisie.
Pole tytułu	folder.envelopePartyPermissions.titleFieldValue	string	Wartość pola tytułu w podpisie.
Przyczyna podpisywania	folder.envelopePartyPermissions.reasonSigning	string	Przyczyną podpisania dokumentu przez odbiorcę.
Dodano pole płatności	folder.envelopePartyPermissions.payFieldAdded	boolean	Wskazuje, czy dodano pole płatności.
Odbiorcy	folder.envelopePartyPermissions.payee	boolean	Wskazuje, czy ten odbiorca jest odbiorcą.
Płatność cykliczna	folder.envelopePartyPermissions.recurringFieldExist	boolean	Wskazuje, czy istnieje pole płatności cyklicznej.
Drukowanie i podpisywanie gotowe	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Wskazuje, czy proces drukowania i podpisywania został ukończony.
Paid	folder.envelopePartyPermissions.paid	boolean	Wskazuje, czy płatność została ukończona.
Poziom uwierzytelniania	folder.envelopeAuthenticationLevel	string	Poziom uwierzytelniania wymagany dla koperty.
Zbiorcze logowanie jednokrotne	folder.allowSingleSignerInBulk	boolean	Wskazuje, czy logowanie jednokrotne jest dozwolone w trybie wysyłania zbiorczego.
File-Based nazewnictwo	folder.folderNameBasedOnFileNaming	boolean	Wskazuje, czy nazwa folderu jest oparta na nazwie pliku.
Nazwa File-Based dokumentu	folder.documentNameBasedOnFileNaming	boolean	Wskazuje, czy nazwa dokumentu jest oparta na nazwie pliku.
Nazwa certyfikatu File-Based	folder.certificateNameBasedOnFileNaming	boolean	Wskazuje, czy nazwa certyfikatu jest oparta na nazwie pliku.
Nazewnictwo plików pre-exec	folder.enableFileNamingBeforeExecution	boolean	Wskazuje, czy nazwa pliku jest włączona przed wykonaniem dokumentu.
Płatność dodana	folder.payeeAddedd	boolean	Wskazuje, czy płatność została dodana.
Self-Signing włączone	folder.selfSignerEnabled	boolean	Wskazuje, czy tryb samodzielnego podpisywania jest włączony.
Włączone notary	folder.notaryEnabled	boolean	Wskazuje, czy podpisywanie notaryjne jest włączone.
Ograniczona widoczność	folder.limitedVisibilityFlag	boolean	Wskazuje, czy dla tej koperty jest włączona ograniczona widoczność.
Widoczność po znaku	folder.postSigningVisibility	boolean	Wskazuje, czy widoczność po podpisaniu jest włączona.
Podpis mokry	folder.wetSignatureEnabled	boolean	Wskazuje, czy są włączone podpisy mokre.
Scalanie włączone	folder.mergeEnabled	boolean	Wskazuje, czy scalanie dokumentów jest włączone.
Osadzone sesje podpisywania	embeddedSigningSessions	array of object	Lista osadzonych sesji podpisywania, po jednym na odbiorcę. Występuje tylko wtedy, gdy wartość createEmbeddedSigningSession ma wartość true.
Adres e-mail sygnatariusza	embeddedSigningSessions.emailIdOfSigner	string	Adres e-mail odbiorcy dla tej osadzonej sesji podpisywania.
Token podpisywania	embeddedSigningSessions.embeddedToken	string	Unikatowy token dla osadzonej sesji podpisywania tego adresata.
Adres URL sesji podpisywania	embeddedSigningSessions.embeddedSessionURL	string	Adres URL do otwarcia lub osadzenia dla tego adresata w celu podpisania dokumentu.
Osadzony token wysyłania	embeddedToken	string	Token osadzonej sesji wysyłania. Występuje tylko wtedy, gdy wartość createEmbeddedSendingSession ma wartość true.
Adres URL sesji wysyłania	embeddedSessionURL	string	Adres URL umożliwiający otwarcie lub osadzenie dla autora koperty w celu przygotowania i wysłania koperty. Występuje tylko wtedy, gdy wartość createEmbeddedSendingSession ma wartość true.
Result	result	string	Wynik operacji.
Message	message	string	Komunikat opisujący wynik operacji.

Tworzenie koperty na podstawie base64

Identyfikator operacji:: CreateEnvelopefromBase64

Tworzy i wysyła kopertę przy użyciu dokumentu PDF zakodowanego w formacie Base64.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa koperty	folderName	True	string	Nazwa tej koperty.
Typ danych wejściowych	inputType		string	Typ danych wejściowych dla źródła dokumentu. Naprawiono wartość base64 dla tej akcji.
Ciągi plików Base64	base64FileString	True	array of string	Tablica dokumentów PDF zakodowanych w formacie Base64 do wysłania.
Nazwy plików	fileNames	True	array of string	Tablica nazw wyświetlanych dla każdego dokumentu w tej samej kolejności co tablica Ciąg pliku Base64.
Imię	firstName	True	string	Imię odbiorcy.
Nazwisko	lastName	True	string	Nazwisko adresata.
Adres e-mail	emailId	True	string	Adres e-mail odbiorcy.
uprawnienia	permission	True	string
Sequence	sequence	True	integer	Użyj tego pola, aby przypisać numer sekwencji do adresata na liście stron adresatów. Użyj unikatowych numerów sekwencji dla każdej strony, zaczynając od 1,2,3,4.... Jeśli jedna osoba pojawia się wiele razy w przepływie pracy podpisywania, przypisz inną sekwencję za każdym razem, gdy odbiorca będzie powtarzany.
signerAuthLevels	signerAuthLevel		string	Poziom uwierzytelniania, który użytkownik podpisujący będzie wykorzystywać do celów weryfikacji
Jest symbolem zastępczym	isPlaceholder		boolean	Użyj tego pola, aby zainicjować stronę jest symbolem zastępczym. Uwaga: 1. firstName, lastName, wartość parametru emailId musi być pusta dla tej strony. 2. Aby dodać symbol zastępczy, jeden adresat musi zostać ponownie przyciągnięty z uprawnieniem "PARTY_ASSIGNER".
Rola adresata	partyRole		string	Użyj tego pola, aby przypisać rolę symbolu zastępczego.
Zezwalaj na zmianę nazwy	allowNameChange		string	Wartość może mieć wartość true lub false Użyj tego parametru, aby umożliwić użytkownikowi podpisywanie zaktualizowanie imienia i nazwiska przed ukończeniem procesu podpisywania.
Sekwencja przepływu pracy	workflowSequence		integer	Przypisz numer sekwencji przepływu pracy do tego adresata. Po włączeniu sekwencji logowania adresaci otrzymają zaproszenie do podpisywania w kolejności rosnącej.
Identyfikator adresu e-mail hosta	hostEmailId		string	Adres e-mail administratora In-Person.
Kod dostępu	userDefinedAccessCode		string	Parametr będzie zawierać kod dostępu, gdy wartość "signerAuthLevel" jest ustawiona jako "Kod dostępu zdefiniowany przez użytkownika" na potrzeby uwierzytelniania. Uwaga: 1. Kody nie są uwzględniane wielkości liter. 2. System nie wysyła tego kodu, więc musisz udostępnić ten kod bezpośrednio podpisowi. 3. Kod programu Access może zawierać alfabety, cyfry i następujące znaki specjalne: @,&,{,},%,(,),~,\|,!,+,^.
Strona jest grupą poczty e-mail	partyIsEmailGroup		boolean	Użyj tego parametru podczas tworzenia strony jako zbiorczej. Uwaga: Jeśli ten parametr ma wartość true, firstName, lastName i emailId tej strony zostaną zignorowane.
Identyfikator grupy wiadomości e-mail	emailGroupId		integer	Przekaż wiadomość e-mail identyfikator grupy, której chcesz użyć do utworzenia zbiorczego.
Zbiorcze logowanie jednokrotne	allowSingleSignerInBulk		boolean	Użyj tego parametru, aby zezwolić tylko jednej osobie na logowanie się do grupy poczty e-mail.
Kod wybierania numerów	dialingCode		string	To pole służy do przypisywania kodów wybierania numerów telefonicznych w kraju jako prefiksów numerów telefonów komórkowych do adresata na liście stron adresatów.
Numer telefonu komórkowego	mobileNumber		string	Użyj tego pola, aby przypisać numer telefonu komórkowego do adresata na liście stron adresatów.
Pola	Fields		object
Wyślij teraz	sendNow		boolean	Po włączeniu funkcji Foxit eSign natychmiast wysyła unikatowy link podpisywania do adresu e-mail każdego adresata. Wyłącz tę opcję, aby zapisać kopertę jako wersję roboczą.
Tworzenie osadzonej sesji podpisywania	createEmbeddedSigningSession	True	boolean	Token sesji podpisywania zostanie wygenerowany bez wysyłania wiadomości e-mail do adresatów.
Tworzenie osadzonej sesji podpisywania dla wszystkich stron	createEmbeddedSigningSessionForAllParties		boolean	W przypadku ustawienia wartości true osadzony adres URL podpisywania zostanie wygenerowany dla każdego adresata w kopercie.
Przetwarzanie tagów tekstowych	processTextTags	True	boolean	Wartość może mieć wartość true lub false. To pole służy do określania, czy program Foxit eSign powinien analizować dokumenty dla tagów tekstowych, aby przekonwertować je na pola Foxit eSign.
Przetwarzanie pól Acro	processAcroFields	True	boolean	To pole służy do określania, czy foxit eSign powinien analizować dokumenty dla AcroFields, aby przekonwertować je na pola Foxit eSign.
Sekwencja logowania	signInSequence		boolean	To pole służy do określania, czy adresaci podpiszą dokumenty koperty w sekwencji. Jeśli wartość false, wszyscy adresaci otrzymają jednocześnie wiadomość e-mail z zaproszeniem. W przypadku wartości true każdy adresat otrzymuje wiadomość e-mail z zaproszeniem po wykonaniu przez poprzedniego adresata wymaganego zadania, takiego jak podpisywanie dokumentów lub wypełnianie pól itp.
Włącz osobiście	inPersonEnable		boolean	To pole służy do inicjowania procesu podpisywania osoby, który można łatwo ukończyć na dowolnym urządzeniu w ciągu kilku minut i unika podpisów opartych na wiadomości e-mail, jeśli jest to wymagane. Jeśli wartość false, wszyscy adresaci otrzymają jednocześnie wiadomość e-mail z zaproszeniem. W przypadku wartości true administrator osoby otrzymuje wiadomość e-mail z zaproszeniem w celu zainicjowania procesu podpisywania dla osoby podpisującego.
Naprawianie stron adresatów	fixRecipientParties		boolean	Jeśli to prawda, w osadzonym widoku wysyłania nie można zmienić stron koperty, które zostały już dodane w ramach tego żądania.
Naprawianie dokumentów	fixDocuments		boolean	Jeśli to prawda, w osadzonym wysyłaniu nie można zmienić dokumentów dla koperty, które zostały już dodane w ramach tego żądania.
Adres URL powodzenia wysyłania	sendSuccessUrl		string	Wprowadź bezwzględny adres URL strony docelowej, do której będzie przekierowywany podpisujący po pomyślnym wysłaniu folderu w osadzonym widoku wysyłania.
Adres URL błędu wysyłania	sendErrorUrl		string	Wprowadź bezwzględny adres URL strony docelowej, do której użytkownik podpisujący zostanie przekierowany, jeśli podczas wysyłania folderu w osadzonym widoku wysyłania wystąpi błąd.
Tworzenie osadzonej sesji wysyłania	createEmbeddedSendingSession		boolean	Jeśli ustawiono wartość true, wygeneruje on osadzony token umożliwiający otwarcie widoku przygotowywania dokumentu foxit eSign.
Identyfikatory e-mail osadzonych osób podpisujących	embeddedSignersEmailIds		array of string	Tablica identyfikatorów wiadomości e-mail adresatów, dla których należy utworzyć osadzoną sesję podpisywania. Identyfikatory e-mail od stron adresatów dodane na liście stron.
Adres URL powodzenia podpisywania	signSuccessUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, do których nastąpi przekierowanie po pomyślnym zalogowaniu się w osadzonym widoku podpisywania.
Adres URL odrzucenia znaku	signDeclineUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, do których nastąpi przekierowanie, jeśli odmówi zalogowania się osadzonego widoku podpisywania.
Podpisz późniejszy adres URL	signLaterUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, do których nastąpi przekierowanie, jeśli zdecyduje się zalogować później w osadzonym widoku podpisywania.
Adres URL błędu podpisywania	signErrorUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, którzy zostaną przekierowani do, jeśli podczas podpisywania dokumentu w osadzonym widoku podpisywania wystąpi błąd.
Zezwalaj na wysyłanie teraz i osadzoną sesję podpisywania	allowSendNowAndEmbeddedSigningSession		boolean	Jeśli ustawisz wartość true, funkcja Foxit eSign wyśle unikatowy link podpisywania do każdego adresata. Ma to zastosowanie tylko wtedy, gdy parametry sendNow i createEmbeddedSigningSession mają wartość true.
Zaawansowana weryfikacja poczty e-mail	allowAdvancedEmailValidation		boolean	Zweryfikuj adres e-mail stron po ustawieniu wartości true.
Adres URL sukcesu podpisywania — wszystkie strony	signSuccessUrlAllParties		boolean	Jeśli ustawiono wartość true, znakator zostanie przekierowany do adresu URL podanego w elemencie signSuccessUrl po pomyślnym podpisaniu. Ma to zastosowanie tylko wtedy, gdy element sendNow ma wartość true.
Identyfikator szablonu wiadomości e-mail	emailTemplateId		integer	Przekaż identyfikator szablonu wiadomości e-mail, aby wysłać szablony wiadomości e-mail inne niż domyślne szablony wiadomości e-mail.
Identyfikator instrukcji podpisywania	signerInstructionId		integer	Przekaż identyfikator instrukcji, aby wysłać instrukcje logowania inne niż domyślne instrukcje dotyczące podpisywania.
Identyfikator instrukcji potwierdzenia	confirmationInstructionId		string	Przekaż identyfikator instrukcji potwierdzenia, aby wysłać instrukcje potwierdzenia inne niż domyślne instrukcje potwierdzenia.
Kolor motywu	themeColor		string	Wprowadź wartość CSS, aby ustawić kolor motywu.
Wygaśnięcie sesji	sessionExpire		boolean	Ustaw wartość true, aby zainicjować wygaśnięcie osadzonej sesji podpisywania.
Wygaśnięcie	expiry		integer	Wymagane, jeśli wartość sessionExpire ma wartość true. Wprowadź czas trwania w milisekundach wygaśnięcia osadzonej sesji podpisywania.
Nazwa pola zależnego	dependentFieldName	True	string	Nazwa pola, którego widoczność jest kontrolowana przez pole nadrzędne.
Nazwa pola nadrzędnego	parentFieldName	True	string	Nazwa pola nadrzędnego, którego wartość kontroluje widoczność pola zależnego. Obsługiwane typy pól nadrzędnych: pole tekstowe, pole tekstowe, pole wyboru, przycisk radiowy, lista rozwijana.
Wartość pola nadrzędnego	parentFieldValue	True	string	Wartość pola nadrzędnego, które wyzwala pole zależne, aby stało się widoczne. W przypadku pól pola wyboru i przycisku radiowego użyj zaznaczonego lub niezaznaczonego.
Opcje	options	True	string	Dodatkowe opcje dopasowania dla pól nadrzędnych opartych na tekście. Zaakceptowane wartości: isblank, allowNull, contains.
Metadane	metadata		object	Powinno to być w parze wartości klucza. Dozwolone są maksymalnie 1000 par klucz-wartość.
Adres e-mail nadawcy	senderEmail		string	Wprowadź adres e-mail innego użytkownika na koncie, który będzie używany do wysyłania tego folderu dokumentów do osób adresatów.
Ukryj przycisk Dodaj mnie	hideAddMeButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Dodaj mnie" na stronie adresatów w osadzonej sesji wysyłania.
Ukryj przycisk Dodaj nowy	hideAddNewButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Dodaj nowy" na stronie adresatów w osadzonej sesji wysyłania.
Ukryj przycisk Dodaj grupę	hideAddGroupButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Dodaj grupę" na stronie adresatów w osadzonej sesji wysyłania.
Ukryj nazwę pola dla adresatów	hideFieldNameForRecipients		boolean	Ukryj nazwy pól dla adresatów pól wprowadzania danych i pól zaawansowanych. (Z wyjątkiem przycisku radiowego, pola wyboru, obrazu i hiperłącza).
Ukryj obramowanie pola wyboru	hideCheckboxBorder		boolean	Obramowania pola wyboru będą ukryte w wykonanych dokumentach.
Ukryj opcję wyboru signer	hideSignerSelectOption		boolean	Jeśli to prawda, spowoduje to ukrycie pola wejściowego "Istniejąca nazwa/adres e-mail osoby podpisywającego" w osadzonej sesji wysyłania.
Ukryj akcje signer	hideSignerActions		boolean	Jeśli to prawda, spowoduje to ukrycie akcji "edit", "change" i "remove" dla stron adresatów w osadzonej sesji wysyłania.
Ukryj nazwę nadawcy	hideSenderName		boolean	Jeśli to prawda, spowoduje to ukrycie nazwy nadawcy na stronach adresatów w osadzonej sesji wysyłania.
Ukryj nazwę folderu	hideFolderName		boolean	Jeśli to prawda, spowoduje to ukrycie nazwy folderu na nawigacji w obu sesjach osadzonych.
Ukryj nazwę dokumentów	hideDocumentsName		boolean	Jeśli to prawda, spowoduje to ukrycie nazwy dokumentu w obu sesjach osadzonych.
Ukryj odrzuć do podpisania	hideDeclineToSign		boolean	Jeśli wartość true, spowoduje to ukrycie opcji "Odrzuć znak" dla osoby podpisającego.
Ukryj więcej akcji	hideMoreAction		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Więcej akcji" w sesji wysyłania/podpisywania. W przypadku polecenia "Wyślij teraz": prawda, nie spowoduje ukrycia niczego.
Ukryj przycisk Wyślij	hideSendButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku Wyślij w osadzonej sesji wysyłania.
Ukryj następne wymagane polebtn	hideNextRequiredFieldbtn		boolean	Jeśli ustawiono wartość true, ukrywa przycisk nawigacji, który przenosi osoby podpisujące do następnego wymaganego pola.
Wymagana obie sesje osadzone	requiredBothEmbeddedSession		boolean	Jeśli to prawda, wygeneruje osadzone adresy URL wysyłania i podpisywania razem.
Hasło koperty	folderPassword		string	To hasło będzie wymagane przez sygnatariusza/autora, aby otworzyć podpisany cyfrowo dokument. Jeśli parametr jest pusty, żadne hasło nie będzie wymagane do otwarcia dokumentu podpisanego cyfrowo.
Włącz krok po kroku	enableStepByStep		boolean	Aby włączyć akcję krok po kroku w osadzonej sesji wysyłania.
Ukryj opcję Dodaj strony	hideAddPartiesOption		boolean	W przypadku wartości true opcja spowoduje ukrycie opcji dodawania stron w trybie tworzenia wersji roboczej i szablonu.
Podpis własny	selfSign		boolean	Umożliwia ona osadzony znak własny za pośrednictwem interfejsów API. Ten parametr ma zastosowanie tylko wtedy, gdy parametr createEmbeddedSendingSession ma wartość true.
Adres URL powodzenia logowania samodzielnego	selfSignerSuccessUrl		string	Wprowadź bezwzględny adres URL strony docelowej w witrynie internetowej/aplikacji, do której użytkownik zostanie przekierowany po pomyślnym podpisie własnym wysyłającym folder w osadzonym widoku wysyłania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	folder.folderId	integer	Unikatowy identyfikator nowo utworzonej koperty. Użyj tej funkcji w kolejnych akcjach, aby odwołać się do tej koperty.
Name	folder.folderName	string	Nazwa nowo utworzonej koperty.
Nazwa niestandardowa	folder.folderCustomName	string	Niestandardowa nazwa koperty.
Hasło	folder.folderPassword	string	Jeśli ustawiono hasło dostępu dla koperty.
Identyfikator twórcy	folder.folderAuthorId	integer	Unikatowy identyfikator twórcy koperty.
Imię twórcy	folder.folderAuthorFirstName	string	Imię twórcy koperty.
Nazwisko twórcy	folder.folderAuthorLastName	string	Nazwisko twórcy koperty.
Adres e-mail twórcy	folder.folderAuthorEmail	string	Adres e-mail twórcy koperty.
Rola twórcy	folder.folderAuthorRole	string	Rola twórcy koperty.
Identyfikator firmy	folder.folderCompanyId	integer	Unikatowy identyfikator firmy, która jest właścicielem koperty.
Data utworzenia	folder.folderCreationDate	integer	Data utworzenia koperty (sygnatura czasowa systemu Unix w milisekundach).
Data wysłania	folder.folderSentDate	integer	Data wysłania koperty (sygnatura czasowa systemu Unix w milisekundach).
Status	folder.folderStatus	string	Bieżący stan koperty.
Pole niestandardowe 1	folder.custom_field1	string	Pierwsze pole niestandardowych metadanych dla koperty.
Pole niestandardowe 2	folder.custom_field2	string	Drugie pole niestandardowych metadanych dla koperty.
Metadane	folder.metadata	string	Niestandardowe metadane skojarzone z kopertą.
Identyfikatory dokumentów	folder.folderDocumentIds	array of integer	Lista identyfikatorów dokumentów zawartych w kopercie.
Documents	folder.documentsList	array of object	Lista dokumentów w kopercie.
Identyfikator dokumentu	folder.documentsList.documentId	integer	Unikatowy identyfikator dokumentu.
Identyfikator kontraktu	folder.documentsList.contractId	integer	Unikatowy identyfikator kontraktu.
Identyfikator firmy	folder.documentsList.companyId	integer	Unikatowy identyfikator firmy.
Stworzone przez	folder.documentsList.contractCreatedBy	integer	Identyfikator użytkownika osoby, która utworzyła kontrakt.
Data utworzenia	folder.documentsList.contractCreatedOn	string	Data i godzina utworzenia kontraktu.
Typ kontraktu	folder.documentsList.contractType	string	Typ kontraktu.
Stan kontraktu	folder.documentsList.contractStatus	string	Bieżący stan kontraktu.
Można edytować	folder.documentsList.editable	boolean	Wskazuje, czy element jest edytowalny.
Identyfikator wersji	folder.documentsList.contractVersionId	integer	Unikatowy identyfikator wersji kontraktu.
Nazwa wersji	folder.documentsList.contractVersionName	string	Nazwa wersji kontraktu.
Opis wersji	folder.documentsList.contractVersionDesc	string	Opis wersji kontraktu.
Wersja utworzona przez	folder.documentsList.versionCreatedby	integer	Identyfikator użytkownika osoby, która utworzyła tę wersję.
Wersja utworzona w dniu	folder.documentsList.versionCreatedOn	string	Data i godzina utworzenia tej wersji.
Numer wersji	folder.documentsList.contractVersionNumber	integer	Numer wersji kontraktu.
Źródło transakcji	folder.documentsList.contractTransactionSource	string	System źródłowy, który zainicjował transakcję kontraktu.
Adresatów	folder.folderRecipientParties	array of object	Lista osób adresatów dla tej koperty.
Identyfikator adresata	folder.folderRecipientParties.partyId	integer	Unikatowy identyfikator odbiorcy.
Identyfikator adresata	folder.folderRecipientParties.partyDetails.partyId	integer	Unikatowy identyfikator odbiorcy.
Imię	folder.folderRecipientParties.partyDetails.firstName	string	Imię odbiorcy.
Nazwisko	folder.folderRecipientParties.partyDetails.lastName	string	Nazwisko adresata.
Adres e-mail	folder.folderRecipientParties.partyDetails.emailId	string	Adres e-mail odbiorcy.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Wskazuje, czy ta strona jest adresatem zastępczym.
Address	folder.folderRecipientParties.partyDetails.address	string	Fizyczny adres odbiorcy.
Data utworzenia	folder.folderRecipientParties.partyDetails.dateCreated	integer	Data utworzenia rekordu (sygnatura czasowa systemu Unix w milisekundach).
Rezygnacja z wiadomości e-mail	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Wskazuje, czy odbiorca zrezygnował z powiadomień e-mail.
Unikatowy identyfikator adresata	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Unikatowy identyfikator systemu dla tego adresata.
Poziom uwierzytelniania	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Metoda uwierzytelniania wymagana dla tego adresata.
Data aktualizacji hasła	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Data ostatniej aktualizacji hasła.
Stan zaktualizowanego hasła	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Wskazuje, czy hasło zostało zaktualizowane.
Identyfikator firmy	folder.folderRecipientParties.partyDetails.companyId	integer	Unikatowy identyfikator firmy.
Rola użytkownika	folder.folderRecipientParties.partyDetails.userRole	string	Rola przypisana użytkownikowi.
Dział	folder.folderRecipientParties.partyDetails.department	string	Dział, do którego należy użytkownik.
Title	folder.folderRecipientParties.partyDetails.title	string	Stanowisko użytkownika.
Aktywne	folder.folderRecipientParties.partyDetails.active	boolean	Wskazuje, czy użytkownik lub rekord jest aktywny.
Lokalizacja	folder.folderRecipientParties.partyDetails.requestLocale	string	Ustawienie ustawień regionalnych dla użytkownika.
Udostępnianie za pomocą działu	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Wskazuje, czy koperty są udostępniane w całym dziale.
Kod wybierania numerów	folder.folderRecipientParties.partyDetails.dialingCode	string	Międzynarodowy kod wybierania numeru telefonu.
Numer telefonu komórkowego	folder.folderRecipientParties.partyDetails.mobileNumber	string	Numer telefonu komórkowego.
Filtr stanu	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Filtr stanu dokumentu.
Filtr daty	folder.folderRecipientParties.partyDetails.docDateFilter	string	Filtr daty dokumentu.
Bezpieczny dostęp do pól	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Wskazuje, czy użytkownik ma dostęp do bezpiecznych pól.
Rozwiń pasek boczny	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Wskazuje, czy pasek boczny jest domyślnie rozwinięty.
Adv. Weryfikacja wiadomości e-mail	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Wskazuje, czy włączono zaawansowaną walidację poczty e-mail.
Identyfikator menedżera	folder.folderRecipientParties.partyDetails.managerId	string	Unikatowy identyfikator menedżera użytkownika.
Liczba logowań	folder.folderRecipientParties.partyDetails.loginCount	integer	Liczba logowanych przez użytkownika.
Wiadomość e-mail dotycząca resetowania hasła	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Wskazuje, czy ma zostać wysłana wiadomość e-mail z funkcją resetowania hasła.
Identyfikator działu	folder.folderRecipientParties.partyDetails.departmentId	string	Unikatowy identyfikator działu.
Podstawowa firma	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Podstawowa firma skojarzona z użytkownikiem.
Typ urządzenia	folder.folderRecipientParties.partyDetails.deviceType	string	Typ używanego urządzenia.
Token urządzenia	folder.folderRecipientParties.partyDetails.deviceToken	string	Token powiadomień wypychanych dla urządzenia.
Opis podwykonawcy	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Opis podwykonawcy lub sygnatariusza zewnętrznego.
Organizacja podwykonawców	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Nazwa organizacji podwykonawcy lub osoby podpisowej zewnętrznej.
Data dodania podwykonawcy	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Data dodania podwykonawcy (sygnatura czasowa systemu Unix w milisekundach).
Źródło	folder.folderRecipientParties.partyDetails.source	string	System źródłowy, z którego dodano zewnętrznego sygnatariusza.
Kod wybierania numerów	folder.folderRecipientParties.dialingCode	string	Międzynarodowy kod wybierania numeru telefonu.
Numer telefonu komórkowego	folder.folderRecipientParties.mobileNumber	string	Numer telefonu komórkowego.
Typ podpisu	folder.folderRecipientParties.signerSignatureType	string	Typ podpisu, który będzie używany przez sygnatariusza.
uprawnienia	folder.folderRecipientParties.contractPermissions	string	Uprawnienia przyznane tej stronie dla umowy.
Kolejność podpisywania	folder.folderRecipientParties.partySequence	integer	Numer sekwencji zamówień podpisywania dla tego adresata.
Sekwencja przepływu pracy	folder.folderRecipientParties.workflowSignSequence	integer	Numer sekwencji podpisywania przepływu pracy.
Identyfikator koperty	folder.folderRecipientParties.envelopeId	integer	Unikatowy identyfikator koperty.
Identyfikator firmy odbiorcy	folder.folderRecipientParties.partyCompanyId	integer	Unikatowy identyfikator firmy skojarzonej z tym adresatem.
Tryb udostępniania	folder.folderRecipientParties.sharingMode	string	Tryb udostępniania dla tej koperty.
Adres URL dostępu adresata	folder.folderRecipientParties.folderAccessURL	string	Adres URL, który odbiorca może użyć do uzyskania dostępu do koperty i podpisania jej.
Tryb zabezpieczeń	folder.folderRecipientParties.securityMode	string	Tryb zabezpieczeń zastosowany do tej koperty.
Comments	folder.folderRecipientParties.extraComments	string	Dodatkowe komentarze dołączone do koperty.
Zezwalaj na zmianę nazwy	folder.folderRecipientParties.allowNameChange	boolean	Wskazuje, czy odbiorca może zaktualizować swoją nazwę.
Nazwa zaktualizowana	folder.folderRecipientParties.signerNameUpdated	boolean	Wskazuje, czy sygnatariusz zaktualizował swoją nazwę.
Poziom uwierzytelniania logowania	folder.folderRecipientParties.signerAuthenticationLevel	string	Poziom uwierzytelniania wymagany dla sygnatariusza.
Kod dostępu	folder.folderRecipientParties.userDefinedAccessCode	string	Niestandardowy kod dostępu zdefiniowany dla użytkownika podpisjącego.
Identyfikator podpisu	folder.folderRecipientParties.signatureId	string	Unikatowy identyfikator podpisu.
Rola adresata	folder.folderRecipientParties.partyRole	string	Rola przypisana do tego adresata w przepływie pracy podpisywania.
Pole firmy	folder.folderRecipientParties.companyFieldValue	string	Wartość pola nazwa firmy w podpisie.
Pole tytułu	folder.folderRecipientParties.titleFieldValue	string	Wartość pola tytułu w podpisie.
Przyczyna podpisywania	folder.folderRecipientParties.reasonSigning	string	Przyczyną podpisania dokumentu przez odbiorcę.
Dodano pole płatności	folder.folderRecipientParties.payFieldAdded	boolean	Wskazuje, czy dodano pole płatności.
Odbiorcy	folder.folderRecipientParties.payee	boolean	Wskazuje, czy ten odbiorca jest odbiorcą.
Płatność cykliczna	folder.folderRecipientParties.recurringFieldExist	boolean	Wskazuje, czy istnieje pole płatności cyklicznej.
Drukowanie i podpisywanie gotowe	folder.folderRecipientParties.printAndSignCompleted	boolean	Wskazuje, czy proces drukowania i podpisywania został ukończony.
Paid	folder.folderRecipientParties.paid	boolean	Wskazuje, czy płatność została ukończona.
Opcjonalne dozwolone podpisywanie	folder.folderRecipientParties.allowOptionalSigner	boolean	Wskazuje, czy ten odbiorca jest opcjonalnym sygnatariuszem.
Opcjonalne osoby podpisujących	folder.folderRecipientParties.optionalSigners	array of integer	Lista opcjonalnych identyfikatorów stron podpisywania dla tej koperty.
Adres URL podpisywania autora	folder.folderAccessURLForAuthor	string	Adres URL, za pomocą których nadawca może uzyskać dostęp do koperty.
Draft Access URL	folder.draftFolderAccessURL	string	Adres URL używany do uzyskiwania dostępu do wersji roboczej koperty.
Podpisywanie sali konferencyjnej	folder.boardRoomSign	boolean	Wskazuje, czy tryb podpisywania sali tablicy jest włączony.
Dołącz logo	folder.includeLogo	boolean	Wskazuje, czy logo firmy jest zawarte w wiadomościach e-mail.
Kolor tła przycisku	folder.email_btnBgColor	string	Kolor tła przycisku wiadomości e-mail.
Kolor tekstu przycisku	folder.email_btnTxtColor	string	Kolor tekstu przycisku wiadomości e-mail.
Logo poczty e-mail	folder.emailTemplateLogo	string	Adres URL logo używany w szablonie wiadomości e-mail.
Identyfikator szablonu wiadomości e-mail	folder.emailTemplateId	integer	Unikatowy identyfikator szablonu wiadomości e-mail.
Nagłówek wiadomości e-mail	folder.emailHeader	string	Tekst nagłówka używany w wiadomościach e-mail z powiadomieniami.
Stopka wiadomości e-mail	folder.emailFooter	string	Tekst stopki używany w wiadomościach e-mail z powiadomieniami.
Przeczyść zaplanowane	folder.purgeFlag	boolean	Wskazuje, czy koperta jest zaplanowana do przeczyszczania.
Data rozpoczęcia przeczyszczania	folder.purgeStartDate	string	Data rozpoczęcia przeczyszczania.
Data zakończenia przeczyszczania	folder.purgeEndDate	string	Data zakończenia przeczyszczania.
Identyfikator wysyłania zbiorczego	folder.bulkId	integer	Unikatowy identyfikator operacji wysyłania zbiorczego.
Wymuszanie kolejności podpisywania	folder.enforceSignWorkflow	boolean	Wskazuje, czy adresaci muszą zalogować się w zdefiniowanej sekwencji.
Bieżący krok	folder.currentWorkflowStep	integer	Bieżący krok w przepływie pracy podpisywania.
Źródło transakcji	folder.transactionSource	string	System źródłowy, który zainicjował tę transakcję.
Można edytować	folder.editable	boolean	Wskazuje, czy element jest edytowalny.
podpisywanie In-Person	folder.inPersonSignable	boolean	Wskazuje, czy koperta może być podpisana osobiście.
Przesłanianie przypomnień	folder.overrideAccountReminders	boolean	Wskazuje, czy ustawienia przypomnienia na poziomie konta są zastępowane.
Zastępowanie delegowania	folder.overrideAccountRecipientDelegation	boolean	Wskazuje, czy ustawienia delegowania na poziomie konta są zastępowane.
Zezwalaj na delegowanie	folder.allowRecipientsToDelegate	boolean	Wskazuje, czy adresaci mogą delegować podpisywanie.
identyfikator	folder.envelopeId	integer	Unikatowy identyfikator koperty.
Name	folder.envelopeName	string	Nazwa koperty.
Identyfikator obiektu źródłowego	folder.envelopeOriginatorId	integer	Unikatowy identyfikator użytkownika, który utworzył kopertę.
Identyfikator firmy	folder.envelopeCompanyId	integer	Unikatowy identyfikator firmy, która jest właścicielem koperty.
Date	folder.envelopeDate	integer	Data utworzenia koperty (sygnatura czasowa systemu Unix w milisekundach).
Data udostępnienia	folder.envelopeSharedDate	integer	Data udostępnienia koperty (sygnatura czasowa systemu Unix w milisekundach).
Status	folder.envelopeStatus	string	Bieżący stan koperty.
Identyfikatory kontraktów	folder.envelopeContractIds	array of integer	Lista identyfikatorów kontraktów skojarzonych z tą kopertą.
Uprawnienia adresata	folder.envelopePartyPermissions	array of object	Lista uprawnień adresata dla tej koperty.
Identyfikator adresata	folder.envelopePartyPermissions.partyId	integer	Unikatowy identyfikator odbiorcy.
Identyfikator adresata	folder.envelopePartyPermissions.partyDetails.partyId	integer	Unikatowy identyfikator odbiorcy.
Imię	folder.envelopePartyPermissions.partyDetails.firstName	string	Imię odbiorcy.
Nazwisko	folder.envelopePartyPermissions.partyDetails.lastName	string	Nazwisko adresata.
Adres e-mail	folder.envelopePartyPermissions.partyDetails.emailId	string	Adres e-mail odbiorcy.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Wskazuje, czy ta strona jest adresatem zastępczym.
Address	folder.envelopePartyPermissions.partyDetails.address	string	Fizyczny adres odbiorcy.
Data utworzenia	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Data utworzenia rekordu (sygnatura czasowa systemu Unix w milisekundach).
Rezygnacja z wiadomości e-mail	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Wskazuje, czy odbiorca zrezygnował z powiadomień e-mail.
Unikatowy identyfikator adresata	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Unikatowy identyfikator systemu dla tego adresata.
Poziom uwierzytelniania	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Metoda uwierzytelniania wymagana dla tego adresata.
Data aktualizacji hasła	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Data ostatniej aktualizacji hasła.
Stan zaktualizowanego hasła	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Wskazuje, czy hasło zostało zaktualizowane.
Identyfikator firmy	folder.envelopePartyPermissions.partyDetails.companyId	integer	Unikatowy identyfikator firmy.
Rola użytkownika	folder.envelopePartyPermissions.partyDetails.userRole	string	Rola przypisana użytkownikowi.
Dział	folder.envelopePartyPermissions.partyDetails.department	string	Dział, do którego należy użytkownik.
Title	folder.envelopePartyPermissions.partyDetails.title	string	Stanowisko użytkownika.
Aktywne	folder.envelopePartyPermissions.partyDetails.active	boolean	Wskazuje, czy użytkownik lub rekord jest aktywny.
Lokalizacja	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Ustawienie ustawień regionalnych dla użytkownika.
Udostępnianie za pomocą działu	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Wskazuje, czy koperty są udostępniane w całym dziale.
Kod wybierania numerów	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Międzynarodowy kod wybierania numeru telefonu.
Numer telefonu komórkowego	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Numer telefonu komórkowego.
Filtr stanu	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Filtr stanu dokumentu.
Filtr daty	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Filtr daty dokumentu.
Bezpieczny dostęp do pól	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Wskazuje, czy użytkownik ma dostęp do bezpiecznych pól.
Rozwiń pasek boczny	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Wskazuje, czy pasek boczny jest domyślnie rozwinięty.
Adv. Weryfikacja wiadomości e-mail	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Wskazuje, czy włączono zaawansowaną walidację poczty e-mail.
Identyfikator menedżera	folder.envelopePartyPermissions.partyDetails.managerId	string	Unikatowy identyfikator menedżera użytkownika.
Liczba logowań	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Liczba logowanych przez użytkownika.
Wiadomość e-mail dotycząca resetowania hasła	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Wskazuje, czy ma zostać wysłana wiadomość e-mail z funkcją resetowania hasła.
Identyfikator działu	folder.envelopePartyPermissions.partyDetails.departmentId	string	Unikatowy identyfikator działu.
Podstawowa firma	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Podstawowa firma skojarzona z użytkownikiem.
Typ urządzenia	folder.envelopePartyPermissions.partyDetails.deviceType	string	Typ używanego urządzenia.
Token urządzenia	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Token powiadomień wypychanych dla urządzenia.
Opis podwykonawcy	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Opis podwykonawcy lub sygnatariusza zewnętrznego.
Organizacja podwykonawców	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Nazwa organizacji podwykonawcy lub osoby podpisowej zewnętrznej.
Data dodania podwykonawcy	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Data dodania podwykonawcy (sygnatura czasowa systemu Unix w milisekundach).
Źródło	folder.envelopePartyPermissions.partyDetails.source	string	System źródłowy, z którego dodano zewnętrznego sygnatariusza.
Kod wybierania numerów	folder.envelopePartyPermissions.dialingCode	string	Międzynarodowy kod wybierania numeru telefonu.
Numer telefonu komórkowego	folder.envelopePartyPermissions.mobileNumber	string	Numer telefonu komórkowego.
Typ podpisu	folder.envelopePartyPermissions.signerSignatureType	string	Typ podpisu, który będzie używany przez sygnatariusza.
uprawnienia	folder.envelopePartyPermissions.contractPermissions	string	Uprawnienia przyznane tej stronie dla umowy.
Kolejność podpisywania	folder.envelopePartyPermissions.partySequence	integer	Numer sekwencji zamówień podpisywania dla tego adresata.
Sekwencja przepływu pracy	folder.envelopePartyPermissions.workflowSignSequence	integer	Numer sekwencji podpisywania przepływu pracy.
Identyfikator koperty	folder.envelopePartyPermissions.envelopeId	integer	Unikatowy identyfikator koperty.
Identyfikator firmy odbiorcy	folder.envelopePartyPermissions.partyCompanyId	integer	Unikatowy identyfikator firmy skojarzonej z tym adresatem.
Tryb udostępniania	folder.envelopePartyPermissions.sharingMode	string	Tryb udostępniania dla tej koperty.
Adres URL dostępu adresata	folder.envelopePartyPermissions.folderAccessURL	string	Adres URL, który odbiorca może użyć do uzyskania dostępu do koperty i podpisania jej.
Tryb zabezpieczeń	folder.envelopePartyPermissions.securityMode	string	Tryb zabezpieczeń zastosowany do tej koperty.
Comments	folder.envelopePartyPermissions.extraComments	string	Dodatkowe komentarze dołączone do koperty.
Zezwalaj na zmianę nazwy	folder.envelopePartyPermissions.allowNameChange	boolean	Wskazuje, czy odbiorca może zaktualizować swoją nazwę.
Nazwa zaktualizowana	folder.envelopePartyPermissions.signerNameUpdated	boolean	Wskazuje, czy sygnatariusz zaktualizował swoją nazwę.
Poziom uwierzytelniania logowania	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Poziom uwierzytelniania wymagany dla sygnatariusza.
Kod dostępu	folder.envelopePartyPermissions.userDefinedAccessCode	string	Niestandardowy kod dostępu zdefiniowany dla użytkownika podpisjącego.
Identyfikator podpisu	folder.envelopePartyPermissions.signatureId	string	Unikatowy identyfikator podpisu.
Rola adresata	folder.envelopePartyPermissions.partyRole	string	Rola przypisana do tego adresata w przepływie pracy podpisywania.
Pole firmy	folder.envelopePartyPermissions.companyFieldValue	string	Wartość pola nazwa firmy w podpisie.
Pole tytułu	folder.envelopePartyPermissions.titleFieldValue	string	Wartość pola tytułu w podpisie.
Przyczyna podpisywania	folder.envelopePartyPermissions.reasonSigning	string	Przyczyną podpisania dokumentu przez odbiorcę.
Dodano pole płatności	folder.envelopePartyPermissions.payFieldAdded	boolean	Wskazuje, czy dodano pole płatności.
Odbiorcy	folder.envelopePartyPermissions.payee	boolean	Wskazuje, czy ten odbiorca jest odbiorcą.
Płatność cykliczna	folder.envelopePartyPermissions.recurringFieldExist	boolean	Wskazuje, czy istnieje pole płatności cyklicznej.
Drukowanie i podpisywanie gotowe	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Wskazuje, czy proces drukowania i podpisywania został ukończony.
Paid	folder.envelopePartyPermissions.paid	boolean	Wskazuje, czy płatność została ukończona.
Poziom uwierzytelniania	folder.envelopeAuthenticationLevel	string	Poziom uwierzytelniania wymagany dla koperty.
Zbiorcze logowanie jednokrotne	folder.allowSingleSignerInBulk	boolean	Wskazuje, czy logowanie jednokrotne jest dozwolone w trybie wysyłania zbiorczego.
File-Based nazewnictwo	folder.folderNameBasedOnFileNaming	boolean	Wskazuje, czy nazwa folderu jest oparta na nazwie pliku.
Nazwa File-Based dokumentu	folder.documentNameBasedOnFileNaming	boolean	Wskazuje, czy nazwa dokumentu jest oparta na nazwie pliku.
Nazwa certyfikatu File-Based	folder.certificateNameBasedOnFileNaming	boolean	Wskazuje, czy nazwa certyfikatu jest oparta na nazwie pliku.
Nazewnictwo plików pre-exec	folder.enableFileNamingBeforeExecution	boolean	Wskazuje, czy nazwa pliku jest włączona przed wykonaniem dokumentu.
Płatność dodana	folder.payeeAddedd	boolean	Wskazuje, czy płatność została dodana.
Self-Signing włączone	folder.selfSignerEnabled	boolean	Wskazuje, czy tryb samodzielnego podpisywania jest włączony.
Włączone notary	folder.notaryEnabled	boolean	Wskazuje, czy podpisywanie notaryjne jest włączone.
Ograniczona widoczność	folder.limitedVisibilityFlag	boolean	Wskazuje, czy dla tej koperty jest włączona ograniczona widoczność.
Widoczność po znaku	folder.postSigningVisibility	boolean	Wskazuje, czy widoczność po podpisaniu jest włączona.
Podpis mokry	folder.wetSignatureEnabled	boolean	Wskazuje, czy są włączone podpisy mokre.
Scalanie włączone	folder.mergeEnabled	boolean	Wskazuje, czy scalanie dokumentów jest włączone.
Osadzone sesje podpisywania	embeddedSigningSessions	array of object	Lista osadzonych sesji podpisywania, po jednym na odbiorcę. Występuje tylko wtedy, gdy wartość createEmbeddedSigningSession ma wartość true.
Adres e-mail sygnatariusza	embeddedSigningSessions.emailIdOfSigner	string	Adres e-mail odbiorcy dla tej osadzonej sesji podpisywania.
Token podpisywania	embeddedSigningSessions.embeddedToken	string	Unikatowy token dla osadzonej sesji podpisywania tego adresata.
Adres URL sesji podpisywania	embeddedSigningSessions.embeddedSessionURL	string	Adres URL do otwarcia lub osadzenia dla tego adresata w celu podpisania dokumentu.
Osadzony token wysyłania	embeddedToken	string	Token osadzonej sesji wysyłania. Występuje tylko wtedy, gdy wartość createEmbeddedSendingSession ma wartość true.
Adres URL sesji wysyłania	embeddedSessionURL	string	Adres URL umożliwiający otwarcie lub osadzenie dla autora koperty w celu przygotowania i wysłania koperty. Występuje tylko wtedy, gdy wartość createEmbeddedSendingSession ma wartość true.
Result	result	string	Wynik operacji.
Message	message	string	Komunikat opisujący wynik operacji.

Tworzenie koperty na podstawie szablonu

Identyfikator operacji:: CreateEnvelopefromTemplate

Tworzy i wysyła kopertę przy użyciu istniejącego szablonu. Szczegóły adresata można dostosować.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa koperty	folderName		string	Nazwa folderu dokumentów. Jeśli ta wartość nie zostanie podana, nazwa folderu dokumentów jest taka sama jak nazwy szablonów.
Identyfikatory szablonów	templateIds	True	array of integer	Tablica identyfikatorów szablonów, których chcesz użyć do utworzenia dokumentów dla tego folderu.
Pola	fields		object	Możesz przekazać wartości pól używane w szablonach, aby wstępnie wypełnić je w dokumentach utworzonych na podstawie szablonu. FIELD_NAME to nazwa pola używanego w szablonie. FIELD_VALUE jest wartością pola dokumentu.
Zaawansowana weryfikacja poczty e-mail	allowAdvancedEmailValidation		boolean	Zweryfikuj adresy e-mail stron po ustawieniu wartości true.
Imię	firstName	True	string	Imię odbiorcy.
Nazwisko	lastName	True	string	Nazwisko adresata.
Adres e-mail	emailId	True	string	Adres e-mail odbiorcy.
uprawnienia	permission	True	string
Sequence	sequence	True	integer	Użyj tego pola, aby przypisać numer sekwencji do adresata na liście stron adresatów. Użyj unikatowych numerów sekwencji dla każdej strony, zaczynając od 1,2,3,4.... Jeśli jedna osoba pojawia się wiele razy w przepływie pracy podpisywania, przypisz inną sekwencję za każdym razem, gdy odbiorca będzie powtarzany.
signerAuthLevels	signerAuthLevel		string	Poziom uwierzytelniania, który użytkownik podpisujący będzie wykorzystywać do celów weryfikacji
Jest symbolem zastępczym	isPlaceholder		boolean	Użyj tego pola, aby zainicjować stronę jest symbolem zastępczym. Uwaga: 1. firstName, lastName, wartość parametru emailId musi być pusta dla tej strony. 2. Aby dodać symbol zastępczy, jeden adresat musi zostać ponownie przyciągnięty z uprawnieniem "PARTY_ASSIGNER".
Rola adresata	partyRole		string	Użyj tego pola, aby przypisać rolę symbolu zastępczego.
Zezwalaj na zmianę nazwy	allowNameChange		string	Wartość może mieć wartość true lub false Użyj tego parametru, aby umożliwić użytkownikowi podpisywanie zaktualizowanie imienia i nazwiska przed ukończeniem procesu podpisywania.
Sekwencja przepływu pracy	workflowSequence		integer	Przypisz numer sekwencji przepływu pracy do tego adresata. Po włączeniu sekwencji logowania adresaci otrzymają zaproszenie do podpisywania w kolejności rosnącej.
Identyfikator adresu e-mail hosta	hostEmailId		string	Adres e-mail administratora In-Person.
Kod dostępu	userDefinedAccessCode		string	Parametr będzie zawierać kod dostępu, gdy wartość "signerAuthLevel" jest ustawiona jako "Kod dostępu zdefiniowany przez użytkownika" na potrzeby uwierzytelniania. Uwaga: 1. Kody nie są uwzględniane wielkości liter. 2. System nie wysyła tego kodu, więc musisz udostępnić ten kod bezpośrednio podpisowi. 3. Kod programu Access może zawierać alfabety, cyfry i następujące znaki specjalne: @,&,{,},%,(,),~,\|,!,+,^.
Strona jest grupą poczty e-mail	partyIsEmailGroup		boolean	Użyj tego parametru podczas tworzenia strony jako zbiorczej. Uwaga: Jeśli ten parametr ma wartość true, firstName, lastName i emailId tej strony zostaną zignorowane.
Identyfikator grupy wiadomości e-mail	emailGroupId		integer	Przekaż wiadomość e-mail identyfikator grupy, której chcesz użyć do utworzenia zbiorczego.
Zbiorcze logowanie jednokrotne	allowSingleSignerInBulk		boolean	Użyj tego parametru, aby zezwolić tylko jednej osobie na logowanie się do grupy poczty e-mail.
Kod wybierania numerów	dialingCode		string	To pole służy do przypisywania kodów wybierania numerów telefonicznych w kraju jako prefiksów numerów telefonów komórkowych do adresata na liście stron adresatów.
Numer telefonu komórkowego	mobileNumber		string	Użyj tego pola, aby przypisać numer telefonu komórkowego do adresata na liście stron adresatów.
Hasło koperty	folderPassword		string	To hasło będzie wymagane przez sygnatariusza/autora, aby otworzyć podpisany cyfrowo dokument. Jeśli parametr jest pusty, żadne hasło nie będzie wymagane do otwarcia dokumentu podpisanego cyfrowo.
Sekwencja logowania	signInSequence		boolean	To pole służy do określania, czy adresaci podpiszą dokumenty koperty w sekwencji. Jeśli wartość false, wszyscy adresaci otrzymają jednocześnie wiadomość e-mail z zaproszeniem. W przypadku wartości true każdy adresat otrzymuje wiadomość e-mail z zaproszeniem po wykonaniu przez poprzedniego adresata wymaganego zadania, takiego jak podpisywanie dokumentów lub wypełnianie pól itp.
Włącz osobiście	inPersonEnable		boolean	To pole służy do inicjowania procesu podpisywania osoby, który można łatwo ukończyć na dowolnym urządzeniu w ciągu kilku minut i unika podpisów opartych na wiadomości e-mail, jeśli jest to wymagane. Jeśli wartość false, wszyscy adresaci otrzymają jednocześnie wiadomość e-mail z zaproszeniem. W przypadku wartości true administrator osoby otrzymuje wiadomość e-mail z zaproszeniem w celu zainicjowania procesu podpisywania dla osoby podpisującego.
Wyślij teraz	sendNow		boolean	Po włączeniu funkcji Foxit eSign natychmiast wysyła unikatowy link podpisywania do adresu e-mail każdego adresata. Wyłącz tę opcję, aby zapisać kopertę jako wersję roboczą.
Adres URL sukcesu podpisywania — wszystkie strony	signSuccessUrlAllParties		boolean	Jeśli ustawiono wartość true, znakator zostanie przekierowany do adresu URL podanego w elemencie signSuccessUrl po pomyślnym podpisaniu. Ma to zastosowanie tylko wtedy, gdy element sendNow ma wartość true.
Tworzenie osadzonej sesji wysyłania	createEmbeddedSendingSession		boolean	Jeśli ustawiono wartość true, zostanie wygenerowany osadzony adres URL umożliwiający otwarcie widoku przygotowywania dokumentu foxit eSign.
Naprawianie stron adresatów	fixRecipientParties		boolean	Jeśli to prawda, w osadzonym widoku wysyłania nie można zmienić stron koperty, które zostały już dodane w ramach tego żądania.
Naprawianie dokumentów	fixDocuments		boolean	Jeśli to prawda, w osadzonym wysyłaniu nie można zmienić dokumentów dla koperty, które zostały już dodane w ramach tego żądania.
Adres URL powodzenia wysyłania	sendSuccessUrl		string	Wprowadź bezwzględny adres URL strony docelowej, do której będzie przekierowywany podpisujący po pomyślnym wysłaniu folderu w osadzonym widoku wysyłania.
Adres URL błędu wysyłania	sendErrorUrl		string	Wprowadź bezwzględny adres URL strony docelowej, do której użytkownik podpisujący zostanie przekierowany, jeśli podczas wysyłania folderu w osadzonym widoku wysyłania wystąpi błąd.
Ukryj opcję wyboru signer	hideSignerSelectOption		boolean	Jeśli to prawda, spowoduje to ukrycie pola wejściowego "Istniejąca nazwa/adres e-mail osoby podpisywającego" w osadzonej sesji wysyłania.
Ukryj akcje signer	hideSignerActions		boolean	Jeśli to prawda, spowoduje to ukrycie akcji "edit", "change" i "remove" dla stron adresatów w osadzonej sesji wysyłania.
Ukryj nazwę nadawcy	hideSenderName		boolean	Jeśli to prawda, spowoduje to ukrycie nazwy nadawcy na stronach adresatów w osadzonej sesji wysyłania.
Ukryj przycisk Wyślij	hideSendButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku Wyślij w osadzonej sesji wysyłania.
Ukryj nazwę folderu	hideFolderName		boolean	Jeśli to prawda, spowoduje to ukrycie nazwy folderu na nawigacji w obu sesjach osadzonych.
Ukryj nazwę dokumentów	hideDocumentsName		boolean	Jeśli to prawda, spowoduje to ukrycie nazwy dokumentu w obu sesjach osadzonych.
Ukryj przycisk Dodaj mnie	hideAddMeButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Dodaj mnie" na stronie adresatów w osadzonej sesji wysyłania.
Ukryj przycisk Dodaj nowy	hideAddNewButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Dodaj nowy" na stronie adresatów w osadzonej sesji wysyłania.
Ukryj przycisk Dodaj grupę	hideAddGroupButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Dodaj grupę" na stronie adresatów w osadzonej sesji wysyłania.
Tworzenie osadzonej sesji podpisywania	createEmbeddedSigningSession		boolean	Token sesji podpisywania zostanie wygenerowany bez wysyłania wiadomości e-mail do adresatów.
Tworzenie osadzonej sesji podpisywania dla wszystkich stron	createEmbeddedSigningSessionForAllParties		boolean	W przypadku ustawienia wartości true osadzony adres URL podpisywania jest generowany dla każdego adresata w kopercie. Jeśli wartość false, tylko adresaci wymienieni w osadzonych identyfikatorach e-mail osoby podpisujących otrzymają osadzoną sesję.
Identyfikatory e-mail osadzonych osób podpisujących	embeddedSignersEmailIds		array of string	Tablica identyfikatorów wiadomości e-mail adresatów, dla których należy utworzyć osadzoną sesję podpisywania. Identyfikatory e-mail od stron adresatów dodane na liście stron.
Adres URL powodzenia podpisywania	signSuccessUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, do których nastąpi przekierowanie po pomyślnym zalogowaniu się w osadzonym widoku podpisywania.
Adres URL odrzucenia znaku	signDeclineUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, do których nastąpi przekierowanie, jeśli odmówi zalogowania się osadzonego widoku podpisywania.
Podpisz późniejszy adres URL	signLaterUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, do których nastąpi przekierowanie, jeśli zdecyduje się zalogować później w osadzonym widoku podpisywania.
Adres URL błędu podpisywania	signErrorUrl		string	Wprowadź bezwzględny adres URL dla osób podpisujących, którzy zostaną przekierowani do, jeśli podczas podpisywania dokumentu w osadzonym widoku podpisywania wystąpi błąd.
Ukryj następne wymagane pole Btn	hideNextRequiredFieldBtn		boolean	Jeśli ustawiono wartość true, ukrywa przycisk nawigacji, który przenosi osoby podpisujące do następnego wymaganego pola.
Kolor motywu	themeColor		string	Wprowadź wartość CSS, aby ustawić kolor motywu.
Ukryj odrzuć do podpisania	hideDeclineToSign		boolean	Jeśli ustawiono wartość true, opcja Odrzuć do podpisania na ekranie podpisywania.
Ukryj więcej akcji	hideMoreAction		boolean	Jeśli ustawiono wartość true, powoduje ukrycie przycisku Więcej akcji w sesji wysyłania i podpisywania. Nie ma żadnego wpływu, gdy wartość Send Now ma wartość true.
Ukryj opcję Dodaj strony	hideAddPartiesOption		boolean	W przypadku ustawienia wartości true opcja powoduje ukrycie opcji dodawania stron w trybie tworzenia wersji roboczej i szablonu.
Wygaśnięcie sesji	sessionExpire		boolean	Ustaw wartość true, aby zainicjować wygaśnięcie osadzonej sesji podpisywania.
Wygaśnięcie	expiry		integer	Wymagane, jeśli wartość sessionExpire ma wartość true. Wprowadź czas trwania w milisekundach wygaśnięcia osadzonej sesji podpisywania.
Adres e-mail nadawcy	senderEmail		string	Wprowadź adres e-mail innego użytkownika na koncie, który będzie używany do wysyłania tego folderu dokumentów do osób adresatów.
Zezwalaj na wysyłanie teraz i osadzoną sesję podpisywania	allowSendNowAndEmbeddedSigningSession		boolean	Jeśli ustawiono wartość true, foxit eSign wysyła wiadomość e-mail z zaproszeniem do podpisywania do każdego adresata, a także generuje osadzony link podpisywania dla adresatów, których adres e-mail jest dołączony do osadzonej wiadomości e-mail osoby podpisującego. Zarówno wiadomość e-mail, jak i link osadzony są aktywne jednocześnie.
Włącz krok po kroku	enableStepByStep		boolean	Aby włączyć akcję krok po kroku w osadzonej sesji wysyłania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy operacja zakończyła się pomyślnie (np. "powodzenie").
Message	message	string	Opis wyniku operacji.
Osadzone sesje podpisywania	embeddedSigningSessions	array of object	Lista osadzonych sesji podpisywania, po jednym na odbiorcę. Występuje tylko wtedy, gdy wartość createEmbeddedSigningSession ma wartość true.
Adres e-mail sygnatariusza	embeddedSigningSessions.emailIdOfSigner	string	Adres e-mail odbiorcy dla tej osadzonej sesji podpisywania.
Token podpisywania	embeddedSigningSessions.embeddedToken	string	Unikatowy token dla osadzonej sesji podpisywania tego adresata.
Adres URL sesji podpisywania	embeddedSigningSessions.embeddedSessionURL	string	Adres URL do otwarcia lub osadzenia dla tego adresata w celu podpisania dokumentu.
Osadzony token wysyłania	embeddedToken	string	Token osadzonej sesji wysyłania. Występuje tylko wtedy, gdy wartość createEmbeddedSendingSession ma wartość true.
Adres URL sesji wysyłania	embeddedSessionURL	string	Adres URL umożliwiający otwarcie lub osadzenie dla autora koperty w celu przygotowania i wysłania koperty. Występuje tylko wtedy, gdy wartość createEmbeddedSendingSession ma wartość true.
identyfikator	folder.folderId	integer	Unikatowy identyfikator utworzonej koperty. Służy do odwołowania się do koperty w kolejnych akcjach.
Name	folder.folderName	string	Nazwa koperty.
Nazwa niestandardowa	folder.folderCustomName	string	Nazwa niestandardowa przypisana do koperty.
Hasło	folder.folderPassword	string	Hasło ustawione dla koperty, jeśli istnieje.
Identyfikator autora	folder.folderAuthorId	integer	Unikatowy identyfikator użytkownika, który utworzył kopertę.
Imię autora	folder.folderAuthorFirstName	string	Imię twórcy koperty.
Nazwisko autora	folder.folderAuthorLastName	string	Nazwisko twórcy koperty.
Adres e-mail autora	folder.folderAuthorEmail	string	Adres e-mail twórcy koperty.
Rola autora	folder.folderAuthorRole	string	Rola konta twórcy koperty.
Identyfikator firmy	folder.folderCompanyId	integer	Unikatowy identyfikator firmy, do którego należy koperta.
Data utworzenia	folder.folderCreationDate	integer	Data i godzina utworzenia koperty w milisekundach unix.
Data wysłania	folder.folderSentDate	integer	Data i godzina wysłania koperty do adresatów w milisekundach unix.
Status	folder.folderStatus	string	Bieżący stan koperty (np. SHARED, EXECUTED, DRAFT, CANCELLED).
Pole niestandardowe 1	folder.custom_field1	string	Wartość pola niestandardowego 1 ustawionego na kopercie.
Pole niestandardowe 2	folder.custom_field2	string	Wartość pola niestandardowego 2 ustawionego na kopercie.
Metadane	folder.metadata	string	Wszelkie dodatkowe metadane skojarzone z kopertą.
Identyfikatory dokumentów	folder.folderDocumentIds	array of integer	Lista identyfikatorów dokumentów zawartych w tej kopercie.
Documents	folder.documentsList	array of object	Szczegóły każdego dokumentu zawartego w kopercie.
Identyfikator dokumentu	folder.documentsList.documentId	integer	Unikatowy identyfikator dokumentu.
Identyfikator kontraktu	folder.documentsList.contractId	integer	Unikatowy identyfikator kontraktu skojarzonego z tym dokumentem.
Identyfikator firmy	folder.documentsList.companyId	integer	Unikatowy identyfikator firmy, do którego należy ten dokument.
Stworzone przez	folder.documentsList.contractCreatedBy	integer	Identyfikator użytkownika osoby, która utworzyła kontrakt.
Data utworzenia	folder.documentsList.contractCreatedOn	string	Data utworzenia kontraktu.
Typ kontraktu	folder.documentsList.contractType	string	Typ kontraktu.
Stan dokumentu	folder.documentsList.contractStatus	string	Bieżący stan podpisywania dokumentu (np. WAITING_FOR_SIGNATURE, WYKONANY).
Można edytować	folder.documentsList.editable	boolean	Wskazuje, czy dokument można edytować.
Identyfikator wersji	folder.documentsList.contractVersionId	integer	Unikatowy identyfikator bieżącej wersji dokumentu.
Nazwa wersji	folder.documentsList.contractVersionName	string	Nazwa bieżącej wersji dokumentu.
Opis wersji	folder.documentsList.contractVersionDesc	string	Opis bieżącej wersji dokumentu.
Wersja utworzona przez	folder.documentsList.versionCreatedby	integer	Identyfikator użytkownika osoby, która utworzyła tę wersję dokumentu.
Wersja utworzona w dniu	folder.documentsList.versionCreatedOn	string	Data utworzenia tej wersji dokumentu.
Numer wersji	folder.documentsList.contractVersionNumber	integer	Numer wersji dokumentu.
Źródło transakcji	folder.documentsList.contractTransactionSource	string	Źródło transakcji kontraktu.
Adresatów	folder.folderRecipientParties	array of object	Lista adresatów tej koperty, w tym ich indywidualne linki podpisywania.
Identyfikator adresata	folder.folderRecipientParties.partyId	integer	Unikatowy identyfikator odbiorcy.
Identyfikator adresata	folder.folderRecipientParties.partyDetails.partyId	integer	Unikatowy identyfikator odbiorcy.
Imię	folder.folderRecipientParties.partyDetails.firstName	string	Imię odbiorcy.
Nazwisko	folder.folderRecipientParties.partyDetails.lastName	string	Nazwisko adresata.
Email	folder.folderRecipientParties.partyDetails.emailId	string	Adres e-mail adresata.
Jest symbolem zastępczym	folder.folderRecipientParties.partyDetails.placeholder	boolean	Wskazuje, czy ten adresat jest symbolem zastępczym.
Address	folder.folderRecipientParties.partyDetails.address	string	Adres odbiorcy.
Data utworzenia konta	folder.folderRecipientParties.partyDetails.dateCreated	integer	Data utworzenia konta adresata w milisekundach unix.
Rezygnacja z wiadomości e-mail	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Wskazuje, czy odbiorca zrezygnował z powiadomień e-mail.
Unikatowy identyfikator strony	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Unikatowy identyfikator ciągu dla adresata.
Poziom uwierzytelniania	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Poziom uwierzytelniania wymagany dla tego adresata.
Identyfikator firmy	folder.folderRecipientParties.partyDetails.companyId	integer	Identyfikator firmy, do którego należy odbiorca.
Rola użytkownika	folder.folderRecipientParties.partyDetails.userRole	string	Rola odbiorcy w organizacji.
Dział	folder.folderRecipientParties.partyDetails.department	string	Dział odbiorcy.
Title	folder.folderRecipientParties.partyDetails.title	string	Stanowisko odbiorcy.
Aktywne	folder.folderRecipientParties.partyDetails.active	boolean	Wskazuje, czy konto odbiorcy jest aktywne.
Kod wybierania numerów	folder.folderRecipientParties.partyDetails.dialingCode	string	Numer telefonu odbiorcy jest numerem telefonu kraju.
Numer telefonu komórkowego	folder.folderRecipientParties.partyDetails.mobileNumber	string	Numer telefonu komórkowego odbiorcy.
Opis podwykonawcy	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Opis podwykonawcy, jeśli ma to zastosowanie.
Organizacja podwykonawców	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	W razie potrzeby nazwa organizacji podwykonawcy.
Data dodania podwykonawcy	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Data dodania podwykonawcy w milisekundach unix.
Źródło	folder.folderRecipientParties.partyDetails.source	string	Źródło, za pośrednictwem którego odbiorca został dodany.
Kod wybierania numerów	folder.folderRecipientParties.dialingCode	string	Numer telefonu komórkowego odbiorcy jest numerem telefonu komórkowego kraju.
Numer telefonu komórkowego	folder.folderRecipientParties.mobileNumber	string	Numer telefonu komórkowego odbiorcy.
Typ podpisu	folder.folderRecipientParties.signerSignatureType	string	Typ podpisu dozwolonego dla tego adresata.
uprawnienia	folder.folderRecipientParties.contractPermissions	string	Uprawnienia podpisywania przyznane temu adresatowi (np. FILL_FIELDS_AND_SIGN).
Kolejność podpisywania	folder.folderRecipientParties.partySequence	integer	Pozycja tego adresata w zamówieniu podpisywania.
Sekwencja przepływu pracy	folder.folderRecipientParties.workflowSignSequence	integer	Numer sekwencji podpisywania przepływu pracy dla tego adresata.
Identyfikator koperty	folder.folderRecipientParties.envelopeId	integer	Identyfikator koperty, do którego należy ten odbiorca.
Identyfikator firmy testowej	folder.folderRecipientParties.partyCompanyId	integer	Identyfikator firmy, do którego należy ten odbiorca.
Tryb udostępniania	folder.folderRecipientParties.sharingMode	string	Metoda używana do udostępniania dokumentu temu adresatowi (np. wiadomości e-mail).
Adres URL podpisywania	folder.folderRecipientParties.folderAccessURL	string	Unikatowy adres URL podpisywania dla tego adresata. Użyj tego polecenia, aby bezpośrednio udostępnić link podpisywania.
Tryb zabezpieczeń	folder.folderRecipientParties.securityMode	string	Tryb zabezpieczeń zastosowany do dostępu tego adresata.
Dodatkowe komentarze	folder.folderRecipientParties.extraComments	string	Wszelkie dodatkowe komentarze zawarte w zaproszeniu do podpisywania dla tego adresata.
Zezwalaj na zmianę nazwy	folder.folderRecipientParties.allowNameChange	boolean	Wskazuje, czy odbiorca może zmienić swoją nazwę przed podpisaniem.
Nazwa zaktualizowana	folder.folderRecipientParties.signerNameUpdated	boolean	Wskazuje, czy odbiorca zaktualizował swoją nazwę wyświetlaną.
Poziom uwierzytelniania	folder.folderRecipientParties.signerAuthenticationLevel	string	Metoda uwierzytelniania wymagana dla tego adresata w celu uzyskania dostępu do dokumentu.
Kod dostępu	folder.folderRecipientParties.userDefinedAccessCode	string	Niestandardowy kod dostępu wymagany dla tego adresata do otwarcia dokumentu.
Identyfikator podpisu	folder.folderRecipientParties.signatureId	string	Identyfikator zapisanego podpisu używanego przez tego adresata.
Rola adresata	folder.folderRecipientParties.partyRole	string	Rola przypisana do tego adresata w kopercie.
Wartość pola firmy	folder.folderRecipientParties.companyFieldValue	string	Wartość pola firmy jest wstępnie wypełniona dla tego adresata.
Wartość pola tytułu	folder.folderRecipientParties.titleFieldValue	string	Wstępnie wypełniona wartość pola tytułu dla tego adresata.
Przyczyna podpisywania	folder.folderRecipientParties.reasonSigning	string	Przyczyna podpisania dostarczona przez tego adresata.
Dodano pole płatności	folder.folderRecipientParties.payFieldAdded	boolean	Wskazuje, czy dla tego adresata dodano pole płatności.
Jest payee	folder.folderRecipientParties.payee	boolean	Wskazuje, czy ten odbiorca jest odbiorcą.
Pole cykliczne istnieje	folder.folderRecipientParties.recurringFieldExist	boolean	Wskazuje, czy dla tego adresata istnieją pola płatności cyklicznych.
Drukowanie i podpisywanie zostało ukończone	folder.folderRecipientParties.printAndSignCompleted	boolean	Wskazuje, czy adresat wykonał akcję drukowania i podpisywania.
Zezwalaj na opcjonalne podpisywanie	folder.folderRecipientParties.allowOptionalSigner	boolean	Wskazuje, czy ten odbiorca może zostać pominięty jako opcjonalny sygnatariusz.
Opcjonalne osoby podpisujących	folder.folderRecipientParties.optionalSigners	string	Lista opcjonalnych osób podpisujących skojarzonych z tym adresatem, jeśli istnieje.
Paid	folder.folderRecipientParties.paid	boolean	Wskazuje, czy ten odbiorca zakończył płatność.
Adres URL dostępu autora	folder.folderAccessURLForAuthor	string	Adres URL autora koperty w celu uzyskania dostępu do dokumentu.
Draft Access URL	folder.draftFolderAccessURL	string	Adres URL umożliwiający uzyskanie dostępu do koperty w stanie roboczym.
Znak pokoju pokładowego	folder.boardRoomSign	boolean	Wskazuje, czy podpisywanie sal pokładowych jest włączone dla tej koperty.
Dołącz logo	folder.includeLogo	boolean	Wskazuje, czy logo firmy jest dołączone do powiadomień e-mail.
Kolor przycisku poczty e-mail	folder.email_btnBgColor	string	Kolor tła przycisku akcji w wiadomości e-mail z podpisem.
Kolor tekstu przycisku wiadomości e-mail	folder.email_btnTxtColor	string	Kolor tekstu przycisku akcji w wiadomości e-mail z podpisem.
Logo poczty e-mail	folder.emailTemplateLogo	string	Obraz logo używany w szablonie wiadomości e-mail.
Identyfikator szablonu wiadomości e-mail	folder.emailTemplateId	integer	Identyfikator szablonu wiadomości e-mail używanego do podpisywania powiadomień.
Nagłówek wiadomości e-mail	folder.emailHeader	string	Tekst nagłówka niestandardowego w wiadomościach e-mail z powiadomieniem o podpisywaniu.
Stopka wiadomości e-mail	folder.emailFooter	string	Niestandardowy tekst stopki w wiadomościach e-mail z powiadomieniem o podpisywaniu.
Przeczyść zaplanowane	folder.purgeFlag	boolean	Wskazuje, czy ta koperta jest zaplanowana na automatyczne przeczyszczanie.
Data rozpoczęcia przeczyszczania	folder.purgeStartDate	string	Data rozpoczęcia okresu przeczyszczania.
Data zakończenia przeczyszczania	folder.purgeEndDate	string	Data przeczyszczania koperty.
Identyfikator zbiorczy	folder.bulkId	integer	Identyfikator partii wysyłania zbiorczego, do którego należy ta koperta, jeśli istnieje.
Wymuszanie kolejności podpisywania	folder.enforceSignWorkflow	boolean	Wskazuje, czy adresaci muszą się zalogować w określonej kolejności.
Bieżący krok przepływu pracy	folder.currentWorkflowStep	integer	Bieżący krok w przepływie pracy podpisywania.
Źródło transakcji	folder.transactionSource	string	Źródło, które zainicjowało tę transakcję koperty.
Można edytować	folder.editable	boolean	Wskazuje, czy koperta może być nadal edytowana.
podpisywanie In-Person	folder.inPersonSignable	boolean	Wskazuje, czy koperta może być podpisana osobiście.
Przesłanianie przypomnień	folder.overrideAccountReminders	boolean	Wskazuje, czy ustawienia przypomnienia na poziomie konta są zastępowane dla tej koperty.
Zastępowanie delegowania	folder.overrideAccountRecipientDelegation	boolean	Wskazuje, czy ustawienia delegowania na poziomie konta są zastępowane dla tej koperty.
Zezwalaj na delegowanie	folder.allowRecipientsToDelegate	boolean	Wskazuje, czy adresaci mogą delegować swoje podpisywanie do innej osoby.
identyfikator	folder.envelopeId	integer	Unikatowy identyfikator koperty. Taka sama wartość jak identyfikator koperty (folderId).
Name	folder.envelopeName	string	Nazwa koperty. Ta sama wartość co nazwa koperty (folderName).
Identyfikator obiektu źródłowego	folder.envelopeOriginatorId	integer	Identyfikator użytkownika osoby, która utworzyła kopertę.
Identyfikator firmy	folder.envelopeCompanyId	integer	Identyfikator firmy, do którego należy koperta.
Date	folder.envelopeDate	integer	Data i godzina utworzenia koperty w milisekundach unix.
Data udostępnienia	folder.envelopeSharedDate	integer	Data i godzina udostępnienia koperty adresatom w milisekundach systemu Unix.
Status	folder.envelopeStatus	string	Bieżący stan koperty. Taka sama wartość jak Stan koperty (folderStatus).
Identyfikatory kontraktów	folder.envelopeContractIds	array of integer	Lista identyfikatorów kontraktów skojarzonych z tą kopertą.
Uprawnienia jednostki	folder.envelopePartyPermissions	array of object	Lista adresatów i ich uprawnień do podpisywania. Taka sama struktura jak adresaci.
Identyfikator adresata	folder.envelopePartyPermissions.partyId	integer	Unikatowy identyfikator odbiorcy.
Adres URL podpisywania	folder.envelopePartyPermissions.folderAccessURL	string	Unikatowy adres URL podpisywania dla tego adresata.
uprawnienia	folder.envelopePartyPermissions.contractPermissions	string	Uprawnienia podpisywania dla tego adresata.
Kolejność podpisywania	folder.envelopePartyPermissions.partySequence	integer	Pozycja tego adresata w zamówieniu podpisywania.
Poziom uwierzytelniania	folder.envelopeAuthenticationLevel	string	Poziom uwierzytelniania zastosowany do całej koperty.
Zezwalaj na zbiorcze logowanie jednokrotne	folder.allowSingleSignerInBulk	boolean	Wskazuje, czy logowanie jednokrotne jest dozwolone w trybie wysyłania zbiorczego.
Nazwa oparta na pliku	folder.folderNameBasedOnFileNaming	boolean	Wskazuje, czy nazwa koperty pochodzi z nazwy pliku.
Nazwa dokumentu oparta na pliku	folder.documentNameBasedOnFileNaming	boolean	Wskazuje, czy nazwa dokumentu pochodzi z nazwy pliku.
Nazwa certyfikatu oparta na pliku	folder.certificateNameBasedOnFileNaming	boolean	Wskazuje, czy nazwa certyfikatu pochodzi z nazwy pliku.
Włączanie nazewnictwa plików	folder.enableFileNamingBeforeExecution	boolean	Wskazuje, czy przed wysłaniem koperty zostanie wyświetlony monit o nazewnictwo pliku.
Płatność dodana	folder.payeeAddedd	boolean	Wskazuje, czy płatność została dodana do koperty.
Podpisz własny	folder.selfSignerEnabled	boolean	Wskazuje, czy nadawca jest również sygnatariuszem tej koperty.
Włączone notary	folder.notaryEnabled	boolean	Wskazuje, czy dla tej koperty włączono notaryzacja.
Ograniczona widoczność	folder.limitedVisibilityFlag	boolean	Wskazuje, czy włączono ograniczoną widoczność dokumentu.
Widoczność po podpisaniu	folder.postSigningVisibility	boolean	Wskazuje, czy odbiorcy mogą wyświetlać podpisany dokument po zakończeniu.
Włączono podpis mokry	folder.wetSignatureEnabled	boolean	Wskazuje, czy dla tej koperty są włączone podpisy mokre (odręczne).
Scalanie włączone	folder.mergeEnabled	boolean	Wskazuje, czy scalanie dokumentów jest włączone dla tej koperty.

Tworzenie szablonu na podstawie adresu URL

Identyfikator operacji:: CreateTemplatefromURL

Tworzy nowy szablon przy użyciu publicznie dostępnego adresu URL pliku PDF.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa szablonu	templateName	True	string	Nazwa szablonu. Musi kończyć się rozszerzeniem .pdf (np. onboarding.pdf).
Adres URL szablonu	templateUrl	True	string	Publicznie dostępny adres URL dokumentu PDF do użycia jako szablon.
Typ danych wejściowych	inputType	True	string	Metoda wejściowa dokumentu. Zawsze ustaw wartość "url" dla tej akcji.
Przetwarzanie tagów tekstowych	processTextTags	True	boolean	Po włączeniu funkcji Foxit eSign przeskanuje dokument pod kątem tagów tekstowych i automatycznie konwertuje je na pola podpisu.
Przetwarzanie pól Acro	processAcroFields	True	boolean	Po włączeniu programu Foxit eSign przeskanuje dokument pod kątem pól AcroFields i automatycznie konwertuje je na pola podpisu.
Udostępnij wszystko	shareAll	True	boolean	Udostępnij ten szablon wszystkim użytkownikom na twoim koncie.
Liczba stron	numberOfParties	True	integer	Dodaj liczbę stron w szablonie. Wartości tego parametru powinny być mniejsze niż 20.
Kolor motywu	themeColor		string	Wprowadź wartość css koloru, aby zmienić motyw createEmbeddedTemplateSession.
Adres e-mail autora	authorEmail		string	Wprowadź adres e-mail innego użytkownika na koncie, które będzie używane jako autor tego szablonu.
Tworzenie sesji osadzonego szablonu	createEmbeddedTemplateSession		boolean	Jeśli ustawiono wartość true, osadzona sesja szablonu w celu bezpośredniego otwarcia szablonu Foxit eSign przygotowującego widok. Przeciąganie i upuszczanie różnych pól w szablonie będzie dostępne.
Adres URL przekierowania	redirectURL		string	Jeśli wartość createEmbeddedTemplateSession ma wartość true, bezwzględny adres URL można wprowadzić dla strony docelowej w dowolnej witrynie internetowej/aplikacji, do której użytkownik zostanie przekierowany po kliknięciu przycisku "Zapisz i zamknij" w widoku osadzonego szablonu.
Ukryj szablon wysyłania	hideSendTemplate		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku Wyślij w osadzonym widoku szablonu.
Naprawianie stron adresatów	fixRecipientParties		boolean	Jeśli to prawda, w osadzonym widoku szablonu nie można zmienić stron dla koperty, które zostały już dodane.
Pola	Fields		object
uprawnienia	permission	True	string
Sequence	sequence	True	integer	Unikatowy numer sekwencji dla tej strony, zaczynając od 1. Definiuje kolejność podpisywania po włączeniu sekwencji logowania.
Rola adresata	partyRole	True	string	Rola przypisana do tej strony w szablonie.
Ukryj więcej akcji	hideMoreAction		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Więcej akcji" w sesji szablonu.
Ukryj udział ze wszystkimi	hideShareWithAll		boolean	Jeśli to prawda, spowoduje to ukrycie opcji "Udostępnij ze wszystkimi" w sesji szablonu.
Ukryj dodaj stronę	hideAddParty		boolean	Jeśli to prawda, spowoduje to ukrycie wszystkich opcji dodawania strony w osadzonej sesji szablonu.
Ukryj mnie, przycisk	hideMeButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Ja" na stronie adresatów w osadzonej sesji szablonu.
Ukryj przycisk Inne	hideOthersButton		boolean	Jeśli to prawda, spowoduje to ukrycie przycisku "Inni" na stronie adresatów w osadzonej sesji szablonu.
Ukryj istniejącą opcję wyboru kontaktu	hideExistingContactSelectOption		boolean	Jeśli to prawda, spowoduje to ukrycie pola wejściowego "Znajdź i dodaj istniejący kontakt" na stronie adresatów w osadzonej sesji szablonu.
Ukryj nazwę pola dla adresatów	hideFieldNameForRecipients		boolean	Ukryj nazwy pól dla adresatów pól wprowadzania danych i pól zaawansowanych. (Z wyjątkiem przycisku radiowego, pola wyboru, obrazu i hiperłącza).
Ukryj obramowanie pola wyboru	hideCheckboxBorder		boolean	Obramowania pola wyboru będą ukryte w wykonanych dokumentach.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy operacja zakończyła się pomyślnie (np. "powodzenie").
Message	message	string	Opis wyniku operacji.
identyfikator	template.templateId	integer	Unikatowy identyfikator utworzonego szablonu. Użyj tego polecenia, aby utworzyć koperty na podstawie tego szablonu.
Name	template.templateName	string	Nazwa szablonu.
Description	template.templateDesc	string	Opis szablonu.
Typ	template.templateType	string	Typ szablonu.
Data utworzenia	template.templateCreationDate	string	Data utworzenia szablonu.
Data ostatniej aktualizacji	template.templateLastUpdateDate	string	Data ostatniej aktualizacji szablonu.
Można edytować	template.editable	boolean	Wskazuje, czy szablon można edytować.
Liczba stron	template.numberOfParties	integer	Liczba stron adresatów zdefiniowanych w szablonie.
Łączna liczba stron	template.totalPages	integer	Całkowita liczba stron w dokumencie szablonu.
Identyfikator firmy	template.companyId	integer	Identyfikator firmy, do którego należy ten szablon.
Udostępnione wszystkim	template.shareAll	boolean	Wskazuje, czy ten szablon jest udostępniany wszystkim użytkownikom na koncie.
Wzorzec nazwy niestandardowej	template.templateCustomName	string	Wzorzec nazwy niestandardowej zastosowany do kopert utworzonych na podstawie tego szablonu.
Uprawnienia jednostki	template.templatePartyPermissions	array of object	Lista ról adresatów i ich uprawnień zdefiniowanych w tym szablonie.
Identyfikator strony	template.templatePartyPermissions.template_party_id	integer	Unikatowy identyfikator wpisu strony szablonu.
identyfikator	template.templatePartyPermissions.templateId	integer	Identyfikator szablonu, do którego należy ta strona.
uprawnienia	template.templatePartyPermissions.templatePermissions	string	Uprawnienia podpisywania dla tej strony (np. FILL_FIELDS_AND_SIGN).
Kolejność podpisywania	template.templatePartyPermissions.partySequence	integer	Pozycja zamówienia podpisania dla tej strony.
Rola partii	template.templatePartyPermissions.templatePartyRole	string	Nazwa roli przypisana do tej strony w szablonie. Użyj tej funkcji podczas tworzenia koperty na podstawie szablonu.
Identyfikator strony	template.templatePartyPermissions.partyId	integer	Identyfikator strony przypisanej do tej roli, jeśli została wstępnie przypisana.
Identyfikator użytkownika	template.templateCreatedBy.partyId	integer	Unikatowy identyfikator użytkownika.
Imię	template.templateCreatedBy.firstName	string	Imię użytkownika.
Nazwisko	template.templateCreatedBy.lastName	string	Nazwisko użytkownika.
Email	template.templateCreatedBy.emailId	string	Adres e-mail użytkownika.
Identyfikator firmy	template.templateCreatedBy.companyId	integer	Identyfikator firmy, do którego należy użytkownik.
Rola użytkownika	template.templateCreatedBy.userRole	string	Rola użytkownika w organizacji.
Aktywne	template.templateCreatedBy.active	boolean	Wskazuje, czy konto użytkownika jest aktywne.
Identyfikator użytkownika	template.templateLastUpdatedBy.partyId	integer	Unikatowy identyfikator użytkownika.
Imię	template.templateLastUpdatedBy.firstName	string	Imię użytkownika.
Nazwisko	template.templateLastUpdatedBy.lastName	string	Nazwisko użytkownika.
Email	template.templateLastUpdatedBy.emailId	string	Adres e-mail użytkownika.
Identyfikator firmy	template.templateLastUpdatedBy.companyId	integer	Identyfikator firmy, do którego należy użytkownik.
Rola użytkownika	template.templateLastUpdatedBy.userRole	string	Rola użytkownika w organizacji.
Aktywne	template.templateLastUpdatedBy.active	boolean	Wskazuje, czy konto użytkownika jest aktywne.
Pola szablonu	allfields	array of object	Lista wszystkich pól podpisu i formularza zdefiniowanych w szablonie.
Identyfikator pola	allfields.fieldTagId	integer	Unikatowy identyfikator pola.
Identyfikator szablonu	allfields.templateId	integer	Identyfikator szablonu, do którego należy to pole.
Identyfikator firmy	allfields.companyId	integer	Konto firmowe, do którego należy to pole.
Typ pola	allfields.fieldType	string	Typ pola (np. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Numer strony	allfields.documentPageNumber	integer	Numer strony dokumentu, w którym znajduje się to pole.
Odpowiedzialna strona	allfields.partyResponsible	integer	Numer sekwencji strony odpowiedzialny za wypełnienie tego pola.
Sekwencja stron	allfields.partyResponsibleSequence	integer	Pozycja sekwencji strony odpowiedzialnej.
Identyfikator dokumentu pola	allfields.docFieldId	string	Identyfikator na poziomie dokumentu dla tego pola.
Jest zależny	allfields.dependent	boolean	Wskazuje, czy widoczność tego pola zależy od wartości innego pola.
Kolejność tabulacji	allfields.tabOrder	integer	Kolejność nawigowania między polami.
Wymagania	allfields.required	boolean	Wskazuje, czy to pole musi być wypełnione przed podpisaniem dokumentu.
Nazwa pola niestandardowego	allfields.customFieldName	string	Nazwa niestandardowa przypisana do tego pola.
Udostępnij wszystko	allfields.shareAll	boolean	Wskazuje, czy to pole jest udostępniane wszystkim użytkownikom.
Zezwalaj na edycję	allfields.allowEdit	boolean	Wskazuje, czy to pole może być edytowane przez adresata.
Nazwa pola tekstowego	allfields.textfieldName	string	Etykieta pola tekstowego (dotyczy pola pola tekstowego).
Wartość	allfields.value	string	Wstępnie wypełniona lub wprowadzona wartość pola.
Rozmiar czcionki	allfields.fontSize	integer	Rozmiar czcionki używany dla tekstu w tym polu.
Kolor czcionki	allfields.fontColor	string	Kolor czcionki używany do tekstu w tym polu (np. #000000).
Tylko do odczytu	allfields.readOnly	boolean	Wskazuje, czy pole jest tylko do odczytu i nie może być edytowane przez adresata.
Wiele wierszy	allfields.multiLine	boolean	Wskazuje, czy pole tekstowe akceptuje wiele wierszy danych wejściowych (dotyczy, gdy pole fieldType jest polem tekstowym).
Limit znaków	allfields.characterLimit	integer	Maksymalna liczba znaków dozwolonych w polu (dotyczy pola fieldType to "textfield").
Nazwa pola daty	allfields.datefieldName	string	Etykieta pola daty (dotyczy pola fieldType to "datefield").
Format daty	allfields.dateFormat	string	Format daty używany przez to pole (np. MM/DD/RRRR) (dotyczy, gdy fieldType ma wartość "datefield").
Nazwa pola wyboru	allfields.cbname	string	Etykieta pola wyboru (ma zastosowanie, gdy pole wyboru ma wartość "pole wyboru").
Grupa pól wyboru	allfields.cbgroup	string	Nazwa grupy dla tego pola wyboru (dotyczy pola wyboru pola wyboru).
Sprawdzane	allfields.checked	boolean	Wskazuje, czy pole wyboru jest zaznaczone domyślnie (ma zastosowanie, gdy pole wyboru ma wartość "pole wyboru").
Nazwa pola zabezpieczonego	allfields.securedfieldName	string	Etykieta zabezpieczonego pola (ma zastosowanie, gdy pole fieldType ma wartość "securedfield").
Znaki do wyświetlenia	allfields.charToDisplay	integer	Liczba niemaskowanych znaków do wyświetlenia na końcu zabezpieczonej wartości pola (dotyczy, gdy pole fieldType ma wartość "securedfield").
Identyfikator podpisu	allfields.signatureId	string	Identyfikator podpisu zastosowanego do tego pola podpisywania (dotyczy, gdy pole fieldType ma wartość "signfield").
Obraz początkowy	allfields.initialImage	string	Dane obrazu dla inicjałów zastosowanych do tego pola (dotyczy, gdy pole fieldType ma wartość "initialfield").
Nazwa pola załącznika	allfields.attachmentfieldName	string	Nazwa pola załącznika (dotyczy pola fieldType to "attachmentfield").
Opis załącznika	allfields.attachmentfieldDescription	string	Opis elementów do dołączenia (dotyczy, gdy pole fieldType to "attachmentfield").

Tworzenie szablonu na podstawie base64

Identyfikator operacji:: CreateTemplatefromBase64

Tworzy nowy szablon przy użyciu ciągu PDF zakodowanego w formacie Base64. Użyj tej funkcji, gdy plik PDF jest już dostępny jako ciąg Base64 w przepływie, na przykład z pliku SharePoint lub dokumentu OneDrive.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa szablonu	templateName	True	string	Nazwa szablonu. Musi kończyć się rozszerzeniem .pdf (np. onboarding.pdf).
Ciąg pliku Base64	base64FileString	True	string	Ciąg BASE64 pliku PDF na potrzeby tworzenia szablonu. Powinien być publicznie dostępny podczas tworzenia szablonu.
Typ danych wejściowych	inputType	True	string	Metoda wejściowa dokumentu. Zawsze ustaw wartość "base64" dla tej akcji.
Przetwarzanie tagów tekstowych	processTextTags	True	boolean	Po włączeniu funkcji Foxit eSign przeskanuje dokument pod kątem tagów tekstowych i automatycznie konwertuje je na pola podpisu.
Przetwarzanie pól Acro	processAcroFields	True	boolean	Po włączeniu programu Foxit eSign przeskanuje dokument pod kątem pól AcroFields i automatycznie konwertuje je na pola podpisu.
Udostępnij wszystko	shareAll	True	boolean	Udostępnij ten szablon wszystkim użytkownikom na twoim koncie.
Liczba stron	numberOfParties	True	integer	Liczba stron adresatów dla tego szablonu. Musi być mniejsza niż 20.
Kolor motywu	themeColor		string	Wartość koloru CSS do dostosowania motywu osadzonej sesji szablonu (np. #42caf4).
Adres e-mail autora	authorEmail		string	Adres e-mail innego użytkownika na koncie, który ma zostać ustawiony jako autor tego szablonu.
Tworzenie sesji osadzonego szablonu	createEmbeddedTemplateSession		boolean	Jeśli ustawiono wartość true, zostanie utworzona osadzona sesja szablonu, aby można było bezpośrednio otworzyć edytor szablonu Foxit eSign i przeciągnąć i upuść pola do szablonu.
Adres URL przekierowania	redirectURL		string	Jeśli wartość Create Embedded Template Session (Utwórz osadzoną sesję szablonu) ma wartość true, adres URL umożliwiający przekierowanie użytkownika na adres po kliknięciu przycisku Zapisz i zamknij w osadzonym edytorze szablonów.
Ukryj szablon wysyłania	hideSendTemplate		boolean	Jeśli to prawda, przycisk Wyślij jest ukryty w osadzonym edytorze szablonów.
Naprawianie stron adresatów	fixRecipientParties		boolean	Jeśli to prawda, nie można już zmienić stron adresatów w osadzonym edytorze szablonów.
Pola	Fields		object
uprawnienia	permission	True	string
Sequence	sequence	True	integer	Unikatowy numer sekwencji dla tej strony, zaczynając od 1. Definiuje kolejność podpisywania po włączeniu sekwencji logowania.
Rola adresata	partyRole	True	string	Rola przypisana do tej strony w szablonie.
Ukryj więcej akcji	hideMoreAction		boolean	Jeśli to prawda, przycisk Więcej akcji jest ukryty w osadzonej sesji szablonu.
Ukryj udział ze wszystkimi	hideShareWithAll		boolean	Jeśli to prawda, opcja Udostępnij ze wszystkimi jest ukryta w osadzonej sesji szablonu.
Ukryj dodaj stronę	hideAddParty		boolean	Jeśli to prawda, wszystkie opcje dodawania jednostki są ukryte w osadzonej sesji szablonu.
Ukryj mnie, przycisk	hideMeButton		boolean	Jeśli to prawda, przycisk Me (Me) na stronie adresata jest ukryty w osadzonej sesji szablonu.
Ukryj przycisk Inne	hideOthersButton		boolean	Jeśli to prawda, przycisk Inne strony odbiorcy jest ukryty w osadzonej sesji szablonu.
Ukryj nazwę pola dla adresatów	hideFieldNameForRecipients		boolean	Jeśli to prawda, nazwy pól są ukryte przed adresatami dla wprowadzania danych i pól zaawansowanych.
Ukryj obramowanie pola wyboru	hideCheckboxBorder		boolean	Jeśli wartość true, obramowania pól wyboru są ukryte w wykonanych dokumentach.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy operacja zakończyła się pomyślnie (np. "powodzenie").
Message	message	string	Opis wyniku operacji.
identyfikator	template.templateId	integer	Unikatowy identyfikator utworzonego szablonu. Użyj tego polecenia, aby utworzyć koperty na podstawie tego szablonu.
Name	template.templateName	string	Nazwa szablonu.
Description	template.templateDesc	string	Opis szablonu.
Typ	template.templateType	string	Typ szablonu.
Data utworzenia	template.templateCreationDate	string	Data utworzenia szablonu.
Data ostatniej aktualizacji	template.templateLastUpdateDate	string	Data ostatniej aktualizacji szablonu.
Można edytować	template.editable	boolean	Wskazuje, czy szablon można edytować.
Liczba stron	template.numberOfParties	integer	Liczba stron adresatów zdefiniowanych w szablonie.
Łączna liczba stron	template.totalPages	integer	Całkowita liczba stron w dokumencie szablonu.
Identyfikator firmy	template.companyId	integer	Identyfikator firmy, do którego należy ten szablon.
Udostępnione wszystkim	template.shareAll	boolean	Wskazuje, czy ten szablon jest udostępniany wszystkim użytkownikom na koncie.
Uprawnienia jednostki	template.templatePartyPermissions	array of object	Lista ról adresatów i ich uprawnień zdefiniowanych w tym szablonie.
Identyfikator strony	template.templatePartyPermissions.template_party_id	integer	Unikatowy identyfikator wpisu strony szablonu.
identyfikator	template.templatePartyPermissions.templateId	integer	Identyfikator szablonu, do którego należy ta strona.
uprawnienia	template.templatePartyPermissions.templatePermissions	string	Uprawnienia podpisywania dla tej strony (np. FILL_FIELDS_AND_SIGN).
Kolejność podpisywania	template.templatePartyPermissions.partySequence	integer	Pozycja zamówienia podpisania dla tej strony.
Rola partii	template.templatePartyPermissions.templatePartyRole	string	Nazwa roli przypisana do tej strony w szablonie. Użyj tej funkcji podczas tworzenia koperty na podstawie szablonu.
Identyfikator użytkownika	template.templateCreatedBy.partyId	integer	Unikatowy identyfikator użytkownika.
Imię	template.templateCreatedBy.firstName	string	Imię użytkownika.
Nazwisko	template.templateCreatedBy.lastName	string	Nazwisko użytkownika.
Email	template.templateCreatedBy.emailId	string	Adres e-mail użytkownika.
Pola szablonu	allfields	array of object	Lista wszystkich pól podpisu i formularza zdefiniowanych w szablonie.
Identyfikator pola	allfields.fieldTagId	integer	Unikatowy identyfikator pola.
Identyfikator szablonu	allfields.templateId	integer	Identyfikator szablonu, do którego należy to pole.
Identyfikator firmy	allfields.companyId	integer	Konto firmowe, do którego należy to pole.
Typ pola	allfields.fieldType	string	Typ pola (np. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Numer strony	allfields.documentPageNumber	integer	Numer strony dokumentu, w którym znajduje się to pole.
Odpowiedzialna strona	allfields.partyResponsible	integer	Numer sekwencji strony odpowiedzialny za wypełnienie tego pola.
Sekwencja stron	allfields.partyResponsibleSequence	integer	Pozycja sekwencji strony odpowiedzialnej.
Identyfikator dokumentu pola	allfields.docFieldId	string	Identyfikator na poziomie dokumentu dla tego pola.
Jest zależny	allfields.dependent	boolean	Wskazuje, czy widoczność tego pola zależy od wartości innego pola.
Kolejność tabulacji	allfields.tabOrder	integer	Kolejność nawigowania między polami.
Wymagania	allfields.required	boolean	Wskazuje, czy to pole musi być wypełnione przed podpisaniem dokumentu.
Nazwa pola niestandardowego	allfields.customFieldName	string	Nazwa niestandardowa przypisana do tego pola.
Udostępnij wszystko	allfields.shareAll	boolean	Wskazuje, czy to pole jest udostępniane wszystkim użytkownikom.
Zezwalaj na edycję	allfields.allowEdit	boolean	Wskazuje, czy to pole może być edytowane przez adresata.
Nazwa pola tekstowego	allfields.textfieldName	string	Etykieta pola tekstowego (dotyczy pola pola tekstowego).
Wartość	allfields.value	string	Wstępnie wypełniona lub wprowadzona wartość pola.
Rozmiar czcionki	allfields.fontSize	integer	Rozmiar czcionki używany dla tekstu w tym polu.
Kolor czcionki	allfields.fontColor	string	Kolor czcionki używany do tekstu w tym polu (np. #000000).
Tylko do odczytu	allfields.readOnly	boolean	Wskazuje, czy pole jest tylko do odczytu i nie może być edytowane przez adresata.
Wiele wierszy	allfields.multiLine	boolean	Wskazuje, czy pole tekstowe akceptuje wiele wierszy danych wejściowych (dotyczy, gdy pole fieldType jest polem tekstowym).
Limit znaków	allfields.characterLimit	integer	Maksymalna liczba znaków dozwolonych w polu (dotyczy pola fieldType to "textfield").
Nazwa pola daty	allfields.datefieldName	string	Etykieta pola daty (dotyczy pola fieldType to "datefield").
Format daty	allfields.dateFormat	string	Format daty używany przez to pole (np. MM/DD/RRRR) (dotyczy, gdy fieldType ma wartość "datefield").
Nazwa pola wyboru	allfields.cbname	string	Etykieta pola wyboru (ma zastosowanie, gdy pole wyboru ma wartość "pole wyboru").
Grupa pól wyboru	allfields.cbgroup	string	Nazwa grupy dla tego pola wyboru (dotyczy pola wyboru pola wyboru).
Sprawdzane	allfields.checked	boolean	Wskazuje, czy pole wyboru jest zaznaczone domyślnie (ma zastosowanie, gdy pole wyboru ma wartość "pole wyboru").
Nazwa pola zabezpieczonego	allfields.securedfieldName	string	Etykieta zabezpieczonego pola (ma zastosowanie, gdy pole fieldType ma wartość "securedfield").
Znaki do wyświetlenia	allfields.charToDisplay	integer	Liczba niemaskowanych znaków do wyświetlenia na końcu zabezpieczonej wartości pola (dotyczy, gdy pole fieldType ma wartość "securedfield").
Identyfikator podpisu	allfields.signatureId	string	Identyfikator podpisu zastosowanego do tego pola podpisywania (dotyczy, gdy pole fieldType ma wartość "signfield").
Obraz początkowy	allfields.initialImage	string	Dane obrazu dla inicjałów zastosowanych do tego pola (dotyczy, gdy pole fieldType ma wartość "initialfield").
Nazwa pola załącznika	allfields.attachmentfieldName	string	Nazwa pola załącznika (dotyczy pola fieldType to "attachmentfield").
Opis załącznika	allfields.attachmentfieldDescription	string	Opis elementów do dołączenia (dotyczy, gdy pole fieldType to "attachmentfield").

Usuwanie kopert

Identyfikator operacji:: DeleteEnvelopes

Trwale usuwa jedną lub więcej kopert.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
folderIdy	folderIds		array of integer

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy operacja zakończyła się pomyślnie.

Uzyskiwanie historii działań koperty

Identyfikator operacji:: GetEnvelopeActivityHistory

Pobiera pełny dziennik aktywności dla koperty, pokazując wszystkie akcje podjęte przez adresatów i nadawcę.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	folderId	True	integer	Unikatowy identyfikator koperty, której historia działań ma zostać pobrana.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
Identyfikator koperty	details.folderId	integer	Unikatowy identyfikator koperty.
Dokumenty ujęte	details.enclosedDocuments	string	Nazwa dokumentów ujęta w kopercie.
Adresatów	details.envelopeRecipients	string	Nazwiska wszystkich adresatów na kopercie.
Author	details.author	string	Nazwa użytkownika, który utworzył kopertę.
Status	details.status	string	Bieżący stan koperty (np. UDOSTĘPNIONE, WYKONANE, ANULOWANE).
Data najnowszego działania	details.latestActivityDate	string	Data i godzina ostatniego działania na kopercie.
Data utworzenia	details.dateCreated	string	Data i godzina utworzenia koperty.
Data wysłania	details.dateSent	string	Data i godzina wysłania koperty do adresatów.
Activities	details.activities	array of object	Chronologiczna lista wszystkich działań podjętych na tej kopercie.
Activity	details.activities.activity	string	Czytelny dla człowieka opis akcji, która wystąpiła.
Action	details.activities.action	string	Typ wykonanej akcji (np. Utworzone, Wysłane zaproszenie, Otwarte, Wyświetlane, Podpisane).
Użytkownik	details.activities.user	string	Nazwa użytkownika, który wykonał akcję.
Stan koperty	details.activities.folderStatus	string	Stan koperty w momencie wystąpienia tej akcji.
Time	details.activities.time	string	Data i godzina wystąpienia akcji.
Źródło	details.activities.source	string	Źródło, z którego wykonano akcję (np. Sieć Web).
Adres IP	details.activities.ipAddress	string	Adres IP, z którego wykonano akcję, jeśli jest dostępna.

Wysyłanie przypomnienia o podpisie

Identyfikator operacji:: SendSignatureReminder

Wysyła powiadomienie z przypomnieniem do oczekujących adresatów koperty z monitem o ukończenie podpisywania.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator koperty	folderId	True	integer	Identyfikator koperty.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
Identyfikator koperty	reminder sent	integer	Identyfikator koperty, dla której wysłano przypomnienie.

Wyświetlanie listy wszystkich kanałów elementu webhook

Identyfikator operacji:: ListallWebhookChannels

Zwraca listę wszystkich kanałów elementu webhook skonfigurowanych na koncie.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Result	result	string	Wskazuje, czy żądanie zakończyło się pomyślnie.
Łączna liczba kanałów	total_channel	integer	Łączna liczba kanałów elementu webhook skonfigurowanych na koncie.
Kanały elementu webhook	templatesList	array of object	Lista wszystkich kanałów elementu webhook na koncie.
Identyfikator kanału	templatesList.channelId	integer	Unikatowy identyfikator kanału elementu webhook.
Identyfikator firmy	templatesList.companyId	integer	Konto firmowe, do którego należy ten kanał.
Nazwa kanału	templatesList.channelName	string	Nazwa kanału elementu webhook.
Webhook URL	templatesList.webhookUrl	string	Adres URL, który foxit eSign będzie wywoływany po wystąpieniu subskrybowanego zdarzenia.
Wpis tajny elementu webhook	templatesList.webhookSecret	string	Klucz tajny używany do weryfikowania ładunków elementu webhook.
Data utworzenia	templatesList.dateCreated	integer	Data utworzenia kanału w milisekundach systemu Unix.
Data aktualizacji	templatesList.dateUpdated	integer	Data ostatniej aktualizacji kanału w milisekundach systemu Unix.
Poziom elementu webhook	templatesList.webhookLevel	string	Zakres kanału elementu webhook. "Konto" (wyzwalacze dla wszystkich kopert) lub "Aplikacja interfejsu API" (wyzwalacze tylko dla kopert utworzonych za pośrednictwem interfejsu API).
Status	templatesList.status	string	Bieżący stan kanału. "aktywny" lub "dezaktywuj".
Wysłane koperty	templatesList.eventsSubscribedMap.folder_sent	boolean	Wyzwala, gdy koperta jest wysyłana do adresatów.
Widok koperty	templatesList.eventsSubscribedMap.folder_viewed	boolean	Wyzwala, gdy koperta jest otwierana przez adresata.
Podpisana koperta	templatesList.eventsSubscribedMap.folder_signed	boolean	Wyzwala, gdy koperta jest podpisana przez adresata.
Anulowana koperta	templatesList.eventsSubscribedMap.folder_cancelled	boolean	Wyzwala po anulowaniu koperty.
Wykonane koperty	templatesList.eventsSubscribedMap.folder_executed	boolean	Wyzwala, gdy wszystkie strony podpisały i koperta jest w pełni wykonywana.
Usunięto kopertę	templatesList.eventsSubscribedMap.folder_deleted	boolean	Wyzwala po usunięciu koperty.

Wyzwalacze

Gdy koperta jest podpisana	Wyzwala, gdy odbiorca podpisuje kopertę.
Gdy koperta jest w pełni wykonana	Wyzwala, gdy wszyscy adresaci podpisali i koperta jest w pełni wykonywana.
Po anulowaniu koperty	Wyzwala, gdy koperta zostanie anulowana przez adresata lub nadawcę.
Po usunięciu koperty	Wyzwala po usunięciu koperty.
Po wysłaniu koperty	Wyzwala, gdy koperta jest wysyłana do adresatów. To zdarzenie jest uruchamiane tylko wtedy, gdy poziom elementu webhook jest ustawiony na "Konto".
Po wyświetleniu koperty	Wyzwala po otwarciu adresata i wyświetleniu koperty.

Gdy koperta jest podpisana

Identyfikator operacji:: TriggerEnvelopeSigned

Wyzwala, gdy odbiorca podpisuje kopertę.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa kanału	channelName	True	string	Nazwa identyfikująca tę subskrypcję elementu webhook na twoim koncie.
Poziom elementu webhook	webhookLevel	True	string	Konto: jest uruchamiane dla wszystkich kopert (internet i interfejs API). Aplikacja interfejsu API: jest uruchamiana tylko dla kopert utworzonych za pośrednictwem interfejsu API.
Wpis tajny elementu webhook	webhookSecret		string	Optional. Foxit eSign podpisuje każdy ładunek elementu webhook z HMAC-SHA-256 przy użyciu tego wpisu tajnego do weryfikacji.

Zwraca

Dane zdarzenia odebrane z programu Foxit eSign po uruchomieniu zdarzenia elementu webhook.

Element webhookEventPayload: WebhookEventPayload

Gdy koperta jest w pełni wykonana

Identyfikator operacji:: TriggerEnvelopeExecuted

Wyzwala, gdy wszyscy adresaci podpisali i koperta jest w pełni wykonywana.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa kanału	channelName	True	string	Nazwa identyfikująca tę subskrypcję elementu webhook na twoim koncie.
Poziom elementu webhook	webhookLevel	True	string	Konto: jest uruchamiane dla wszystkich kopert (internet i interfejs API). Aplikacja interfejsu API: jest uruchamiana tylko dla kopert utworzonych za pośrednictwem interfejsu API.
Wpis tajny elementu webhook	webhookSecret		string	Optional. Foxit eSign podpisuje każdy ładunek elementu webhook z HMAC-SHA-256 przy użyciu tego wpisu tajnego do weryfikacji.

Zwraca

Dane zdarzenia odebrane z programu Foxit eSign po uruchomieniu zdarzenia elementu webhook.

Element webhookEventPayload: WebhookEventPayload

Po anulowaniu koperty

Identyfikator operacji:: TriggerEnvelopeCancelled

Wyzwala, gdy koperta zostanie anulowana przez adresata lub nadawcę.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa kanału	channelName	True	string	Nazwa identyfikująca tę subskrypcję elementu webhook na twoim koncie.
Poziom elementu webhook	webhookLevel	True	string	Konto: jest uruchamiane dla wszystkich kopert (internet i interfejs API). Aplikacja interfejsu API: jest uruchamiana tylko dla kopert utworzonych za pośrednictwem interfejsu API.
Wpis tajny elementu webhook	webhookSecret		string	Optional. Foxit eSign podpisuje każdy ładunek elementu webhook z HMAC-SHA-256 przy użyciu tego wpisu tajnego do weryfikacji.

Zwraca

Dane zdarzenia odebrane z programu Foxit eSign po uruchomieniu zdarzenia elementu webhook.

Element webhookEventPayload: WebhookEventPayload

Po usunięciu koperty

Identyfikator operacji:: TriggerEnvelopeDeleted

Wyzwala po usunięciu koperty.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa kanału	channelName	True	string	Nazwa identyfikująca tę subskrypcję elementu webhook na twoim koncie.
Poziom elementu webhook	webhookLevel	True	string	Konto: jest uruchamiane dla wszystkich kopert (internet i interfejs API). Aplikacja interfejsu API: jest uruchamiana tylko dla kopert utworzonych za pośrednictwem interfejsu API.
Wpis tajny elementu webhook	webhookSecret		string	Optional. Foxit eSign podpisuje każdy ładunek elementu webhook z HMAC-SHA-256 przy użyciu tego wpisu tajnego do weryfikacji.

Zwraca

Dane zdarzenia odebrane z programu Foxit eSign po uruchomieniu zdarzenia elementu webhook.

Element webhookEventPayload: WebhookEventPayload

Po wysłaniu koperty

Identyfikator operacji:: TriggerEnvelopeSent

Wyzwala, gdy koperta jest wysyłana do adresatów. To zdarzenie jest uruchamiane tylko wtedy, gdy poziom elementu webhook jest ustawiony na "Konto".

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa kanału	channelName	True	string	Nazwa identyfikująca tę subskrypcję elementu webhook na twoim koncie.
Poziom elementu webhook	webhookLevel	True	string	Konto: wystrzeliwuje koperty wysyłane za pośrednictwem sieci Web lub interfejsu API. Aplikacja interfejsu API: jest uruchamiana tylko dla kopert utworzonych za pośrednictwem interfejsu API. Zdarzenie folder_sent jest uruchamiane tylko na poziomie konta.
Wpis tajny elementu webhook	webhookSecret		string	Optional. Foxit eSign podpisuje każdy ładunek elementu webhook z HMAC-SHA-256 przy użyciu tego wpisu tajnego do weryfikacji.

Zwraca

Dane zdarzenia odebrane z programu Foxit eSign po uruchomieniu zdarzenia elementu webhook.

Element webhookEventPayload: WebhookEventPayload

Po wyświetleniu koperty

Identyfikator operacji:: TriggerEnvelopeViewed

Wyzwala po otwarciu adresata i wyświetleniu koperty.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa kanału	channelName	True	string	Nazwa identyfikująca tę subskrypcję elementu webhook na twoim koncie.
Poziom elementu webhook	webhookLevel	True	string	Konto: jest uruchamiane dla wszystkich kopert (internet i interfejs API). Aplikacja interfejsu API: jest uruchamiana tylko dla kopert utworzonych za pośrednictwem interfejsu API.
Wpis tajny elementu webhook	webhookSecret		string	Optional. Foxit eSign podpisuje każdy ładunek elementu webhook z HMAC-SHA-256 przy użyciu tego wpisu tajnego do weryfikacji.

Zwraca

Dane zdarzenia odebrane z programu Foxit eSign po uruchomieniu zdarzenia elementu webhook.

Element webhookEventPayload: WebhookEventPayload

Definicje

Element webhookEventPayload

Dane zdarzenia odebrane z programu Foxit eSign po uruchomieniu zdarzenia elementu webhook.

Nazwa	Ścieżka	Typ	Opis
Nazwa zdarzenia	event_name	string	Nazwa wyzwolonego zdarzenia (np. folder_sent, folder_signed, folder_executed).
Data zdarzenia	event_date	integer	Data i godzina wystąpienia zdarzenia (sygnatura czasowa systemu Unix w milisekundach).
identyfikator	data.folder.folderId	integer	Unikatowy identyfikator koperty.
Name	data.folder.folderName	string	Nazwa koperty.
Nazwa niestandardowa	data.folder.folderCustomName	string	Nazwa niestandardowa przypisana do koperty.
Hasło	data.folder.folderPassword	string	Jeśli ustawiono hasło dostępu dla koperty.
Identyfikator twórcy	data.folder.folderAuthorId	integer	Identyfikator użytkownika twórcy koperty.
Imię twórcy	data.folder.folderAuthorFirstName	string	Imię twórcy koperty.
Nazwisko twórcy	data.folder.folderAuthorLastName	string	Nazwisko twórcy koperty.
Adres e-mail twórcy	data.folder.folderAuthorEmail	string	Adres e-mail twórcy koperty.
Rola twórcy	data.folder.folderAuthorRole	string	Rola konta twórcy koperty.
Identyfikator firmy	data.folder.folderCompanyId	integer	Identyfikator firmy, który jest właścicielem koperty.
Data utworzenia	data.folder.folderCreationDate	integer	Data utworzenia koperty (sygnatura czasowa systemu Unix w milisekundach).
Data wysłania	data.folder.folderSentDate	integer	Data wysłania koperty (sygnatura czasowa systemu Unix w milisekundach).
Status	data.folder.folderStatus	string	Bieżący stan koperty.
Pole niestandardowe 1	data.folder.custom_field1	string	Pierwsze pole niestandardowych metadanych.
Pole niestandardowe 2	data.folder.custom_field2	string	Drugie pole niestandardowych metadanych.
Metadane	data.folder.metadata	string	Niestandardowe metadane skojarzone z kopertą.
Identyfikatory dokumentów	data.folder.folderDocumentIds	array of integer	Lista identyfikatorów dokumentów w kopercie.
Documents	data.folder.documentsList	array of object	Lista dokumentów w kopercie.
Identyfikator dokumentu	data.folder.documentsList.documentId	integer	Unikatowy identyfikator dokumentu.
Identyfikator kontraktu	data.folder.documentsList.contractId	integer	Identyfikator kontraktu dla tego dokumentu.
Identyfikator firmy	data.folder.documentsList.companyId	integer	Identyfikator firmy dla tego dokumentu.
Stworzone przez	data.folder.documentsList.contractCreatedBy	integer	Identyfikator użytkownika osoby, która utworzyła kontrakt.
Data utworzenia	data.folder.documentsList.contractCreatedOn	integer	Data utworzenia kontraktu (sygnatura czasowa systemu Unix w milisekundach).
Typ kontraktu	data.folder.documentsList.contractType	string	Typ kontraktu.
Stan kontraktu	data.folder.documentsList.contractStatus	string	Bieżący stan kontraktu.
Można edytować	data.folder.documentsList.editable	boolean	Wskazuje, czy dokument jest edytowalny.
Identyfikator wersji	data.folder.documentsList.contractVersionId	integer	Identyfikator wersji kontraktu.
Nazwa wersji	data.folder.documentsList.contractVersionName	string	Nazwa wersji kontraktu.
Opis wersji	data.folder.documentsList.contractVersionDesc	string	Opis wersji kontraktu.
Wersja utworzona przez	data.folder.documentsList.versionCreatedby	integer	Identyfikator użytkownika osoby, która utworzyła tę wersję.
Wersja utworzona w dniu	data.folder.documentsList.versionCreatedOn	integer	Data utworzenia tej wersji (sygnatura czasowa systemu Unix w milisekundach).
Numer wersji	data.folder.documentsList.contractVersionNumber	integer	Numer wersji kontraktu.
Źródło transakcji	data.folder.documentsList.contractTransactionSource	string	System źródłowy, który zainicjował kontrakt.
Adresatów	data.folder.folderRecipientParties	array of object	Lista adresatów dla tej koperty.
Identyfikator adresata	data.folder.folderRecipientParties.partyId	integer	Unikatowy identyfikator odbiorcy.
Identyfikator adresata	data.folder.folderRecipientParties.partyDetails.partyId	integer	Unikatowy identyfikator odbiorcy.
Imię	data.folder.folderRecipientParties.partyDetails.firstName	string	Imię odbiorcy.
Nazwisko	data.folder.folderRecipientParties.partyDetails.lastName	string	Nazwisko adresata.
Email	data.folder.folderRecipientParties.partyDetails.emailId	string	Adres e-mail adresata.
Placeholder	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Czy jest to adresat zastępczy.
Address	data.folder.folderRecipientParties.partyDetails.address	string	Adres odbiorcy.
Data utworzenia	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	Data utworzenia rekordu odbiorcy (sygnatura czasowa systemu Unix w milisekundach).
Rezygnacja z wiadomości e-mail	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Czy odbiorca zrezygnował z wiadomości e-mail.
Unikatowy identyfikator	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	Unikatowy identyfikator systemu dla tego adresata.
Poziom uwierzytelniania	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	Metoda uwierzytelniania dla tego adresata.
Data aktualizacji hasła	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Data ostatniej aktualizacji hasła.
Stan hasła	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Czy hasło zostało zaktualizowane.
Kod wybierania numerów	data.folder.folderRecipientParties.dialingCode	string	Międzynarodowy kod wybierania numerów.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	Numer telefonu komórkowego odbiorcy.
Typ podpisu	data.folder.folderRecipientParties.signerSignatureType	string	Typ podpisu, który będzie używany przez sygnatariusza.
uprawnienia	data.folder.folderRecipientParties.contractPermissions	string	Uprawnienia przyznane temu adresatowi.
Kolejność podpisywania	data.folder.folderRecipientParties.partySequence	integer	Kolejność podpisywania dla tego adresata.
Sekwencja przepływu pracy	data.folder.folderRecipientParties.workflowSignSequence	integer	Numer sekwencji podpisywania przepływu pracy.
Identyfikator koperty	data.folder.folderRecipientParties.envelopeId	integer	Identyfikator koperty skojarzony z tym adresatem.
Identyfikator firmy odbiorcy	data.folder.folderRecipientParties.partyCompanyId	integer	Identyfikator firmy tego adresata.
Tryb udostępniania	data.folder.folderRecipientParties.sharingMode	string	Tryb udostępniania dla tego adresata.
Adres URL podpisywania adresata	data.folder.folderRecipientParties.folderAccessURL	string	Adres URL tego adresata w celu uzyskania dostępu do koperty i podpisania jej.
Tryb zabezpieczeń	data.folder.folderRecipientParties.securityMode	string	Tryb zabezpieczeń dla tego adresata.
Comments	data.folder.folderRecipientParties.extraComments	string	Dodatkowe komentarze dla adresata.
Zezwalaj na zmianę nazwy	data.folder.folderRecipientParties.allowNameChange	boolean	Czy odbiorca może zaktualizować swoją nazwę.
Nazwa zaktualizowana	data.folder.folderRecipientParties.signerNameUpdated	boolean	Czy sygnatariusz zaktualizował swoje imię i nazwisko.
Poziom uwierzytelniania logowania	data.folder.folderRecipientParties.signerAuthenticationLevel	string	Poziom uwierzytelniania wymagany dla sygnatariusza.
Kod dostępu	data.folder.folderRecipientParties.userDefinedAccessCode	string	Niestandardowy kod dostępu dla sygnatariusza.
Identyfikator podpisu	data.folder.folderRecipientParties.signatureId	string	Identyfikator zastosowanego podpisu.
roli	data.folder.folderRecipientParties.partyRole	string	Rola tego adresata w przepływie pracy podpisywania.
Pole firmy	data.folder.folderRecipientParties.companyFieldValue	string	Wartość pola nazwa firmy.
Pole tytułu	data.folder.folderRecipientParties.titleFieldValue	string	Wartość pola tytułu.
Przyczyna podpisywania	data.folder.folderRecipientParties.reasonSigning	string	Przyczyna podpisania.
Dodano pole płatności	data.folder.folderRecipientParties.payFieldAdded	boolean	Czy dodano pole płatności.
Odbiorcy	data.folder.folderRecipientParties.payee	boolean	Czy ten odbiorca jest odbiorcą.
Płatność cykliczna	data.folder.folderRecipientParties.recurringFieldExist	boolean	Czy istnieje pole płatności cyklicznej.
Drukowanie i podpisywanie gotowe	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Czy drukowanie i podpisywanie zostało ukończone.
Opcjonalny podpisz	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Czy ten odbiorca jest opcjonalnym sygnatariuszem.
Opcjonalne osoby podpisujących	data.folder.folderRecipientParties.optionalSigners	array of integer	Opcjonalne identyfikatory stron podpisywania.
Paid	data.folder.folderRecipientParties.paid	boolean	Czy płatność została ukończona.
Adres URL dostępu autora	data.folder.folderAccessURLForAuthor	string	Adres URL autora koperty w celu uzyskania dostępu do koperty.
Draft Access URL	data.folder.draftFolderAccessURL	string	Adres URL umożliwiający dostęp do koperty w stanie roboczym.
Podpisywanie sali konferencyjnej	data.folder.boardRoomSign	boolean	Określa, czy tryb podpisywania sali konferencyjnej jest włączony.
Dołącz logo	data.folder.includeLogo	boolean	Czy logo firmy jest zawarte w wiadomościach e-mail.
Kolor tła przycisku	data.folder.email_btnBgColor	string	Kolor tła przycisku akcji wiadomości e-mail.
Kolor tekstu przycisku	data.folder.email_btnTxtColor	string	Kolor tekstu przycisku akcji wiadomości e-mail.
Logo poczty e-mail	data.folder.emailTemplateLogo	string	Adres URL logo używany w szablonie wiadomości e-mail.
Identyfikator szablonu wiadomości e-mail	data.folder.emailTemplateId	integer	Identyfikator użytego szablonu wiadomości e-mail.
Nagłówek wiadomości e-mail	data.folder.emailHeader	string	Tekst nagłówka w wiadomościach e-mail z powiadomieniami.
Stopka wiadomości e-mail	data.folder.emailFooter	string	Tekst stopki w wiadomościach e-mail z powiadomieniami.
Przeczyść zaplanowane	data.folder.purgeFlag	boolean	Czy koperta ma być czyszczenie.
Data rozpoczęcia przeczyszczania	data.folder.purgeStartDate	string	Data rozpoczęcia harmonogramu przeczyszczania.
Data zakończenia przeczyszczania	data.folder.purgeEndDate	string	Data zakończenia harmonogramu przeczyszczania.
Identyfikator zbiorczy	data.folder.bulkId	integer	Identyfikator operacji wysyłania zbiorczego, jeśli ma to zastosowanie.
Wymuszanie kolejności podpisywania	data.folder.enforceSignWorkflow	boolean	Czy adresaci muszą się zalogować w zdefiniowanej kolejności.
Bieżący krok przepływu pracy	data.folder.currentWorkflowStep	integer	Bieżący krok w przepływie pracy podpisywania.
Źródło transakcji	data.folder.transactionSource	string	System źródłowy, który zainicjował tę transakcję.
Można edytować	data.folder.editable	boolean	Czy koperta jest edytowalna.
podpisywanie In-Person	data.folder.inPersonSignable	boolean	Czy koperta obsługuje podpisywanie osobiście.
Przesłanianie przypomnień	data.folder.overrideAccountReminders	boolean	Czy ustawienia przypomnienia na poziomie konta są zastępowane.
Zastępowanie delegowania	data.folder.overrideAccountRecipientDelegation	boolean	Czy ustawienia delegowania na poziomie konta są zastępowane.
Zezwalaj na delegowanie	data.folder.allowRecipientsToDelegate	boolean	Czy adresaci mogą delegować podpisywanie.
identyfikator	data.folder.envelopeId	integer	Unikatowy identyfikator koperty (alias folderuId).
Name	data.folder.envelopeName	string	Nazwa koperty (alias folderuName).
Identyfikator obiektu źródłowego	data.folder.envelopeOriginatorId	integer	Identyfikator użytkownika, który utworzył kopertę.
Identyfikator firmy	data.folder.envelopeCompanyId	integer	Identyfikator firmy, który jest właścicielem koperty.
Date	data.folder.envelopeDate	integer	Data utworzenia koperty (sygnatura czasowa systemu Unix w milisekundach).
Data udostępnienia	data.folder.envelopeSharedDate	integer	Data udostępnienia koperty (sygnatura czasowa systemu Unix w milisekundach).
Status	data.folder.envelopeStatus	string	Bieżący stan koperty.
Identyfikatory kontraktów	data.folder.envelopeContractIds	array of integer	Identyfikatory kontraktów skojarzone z tą kopertą.
Uprawnienia jednostki	data.folder.envelopePartyPermissions	array of object	Lista uprawnień adresata (taka sama struktura jak adresaci).
Identyfikator adresata	data.folder.envelopePartyPermissions.partyId	integer	Unikatowy identyfikator odbiorcy.
Identyfikator adresata	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
Imię	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Nazwisko	data.folder.envelopePartyPermissions.partyDetails.lastName	string
Email	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Placeholder	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Address	data.folder.envelopePartyPermissions.partyDetails.address	string
Data utworzenia	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
Rezygnacja z wiadomości e-mail	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
Unikatowy identyfikator	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Poziom uwierzytelniania	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Data aktualizacji hasła	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
Stan hasła	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
Kod wybierania numerów	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
Typ podpisu	data.folder.envelopePartyPermissions.signerSignatureType	string
uprawnienia	data.folder.envelopePartyPermissions.contractPermissions	string
Kolejność podpisywania	data.folder.envelopePartyPermissions.partySequence	integer
Sekwencja przepływu pracy	data.folder.envelopePartyPermissions.workflowSignSequence	integer
Identyfikator koperty	data.folder.envelopePartyPermissions.envelopeId	integer
Identyfikator firmy odbiorcy	data.folder.envelopePartyPermissions.partyCompanyId	integer
Tryb udostępniania	data.folder.envelopePartyPermissions.sharingMode	string
Adres URL podpisywania adresata	data.folder.envelopePartyPermissions.folderAccessURL	string
Tryb zabezpieczeń	data.folder.envelopePartyPermissions.securityMode	string
Comments	data.folder.envelopePartyPermissions.extraComments	string
Zezwalaj na zmianę nazwy	data.folder.envelopePartyPermissions.allowNameChange	boolean
Nazwa zaktualizowana	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Poziom uwierzytelniania logowania	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
Kod dostępu	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
Identyfikator podpisu	data.folder.envelopePartyPermissions.signatureId	string
roli	data.folder.envelopePartyPermissions.partyRole	string
Pole firmy	data.folder.envelopePartyPermissions.companyFieldValue	string
Pole tytułu	data.folder.envelopePartyPermissions.titleFieldValue	string
Przyczyna podpisywania	data.folder.envelopePartyPermissions.reasonSigning	string
Dodano pole płatności	data.folder.envelopePartyPermissions.payFieldAdded	boolean
Odbiorcy	data.folder.envelopePartyPermissions.payee	boolean
Płatność cykliczna	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
Drukowanie i podpisywanie gotowe	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Opcjonalny podpisz	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Opcjonalne osoby podpisujących	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Paid	data.folder.envelopePartyPermissions.paid	boolean
Poziom uwierzytelniania	data.folder.envelopeAuthenticationLevel	string	Poziom uwierzytelniania wymagany dla koperty.
Zbiorcze logowanie jednokrotne	data.folder.allowSingleSignerInBulk	boolean	Czy logowanie jednokrotne jest dozwolone w trybie zbiorczym.
nazwa folderu File-Based	data.folder.folderNameBasedOnFileNaming	boolean
nazwa dokumentu File-Based	data.folder.documentNameBasedOnFileNaming	boolean
nazwa certyfikatu File-Based	data.folder.certificateNameBasedOnFileNaming	boolean
Nazewnictwo plików pre-exec	data.folder.enableFileNamingBeforeExecution	boolean
Płatność dodana	data.folder.payeeAddedd	boolean
Self-Signing włączone	data.folder.selfSignerEnabled	boolean
Włączone notary	data.folder.notaryEnabled	boolean
Ograniczona widoczność	data.folder.limitedVisibilityFlag	boolean
Widoczność po znaku	data.folder.postSigningVisibility	boolean
Podpis mokry	data.folder.wetSignatureEnabled	boolean
Scalanie włączone	data.folder.mergeEnabled	boolean

binarny

Jest to podstawowy typ danych "binary".