Adobe Acrobat Sign

Adobe to najbardziej zaufana usługa cyfrowego podpisywania dokumentów na świecie. Program Adobe Acrobat Sign umożliwia przekształcanie procesów ręcznych w środowiska cyfrowe. Uwzględnij funkcje programu Adobe Acrobat Sign w ulubionych aplikacjach, aby tworzyć, wysyłać i monitorować stan umów.

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

Usługa	Class	Regions
Copilot Studio	Standard	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Logic Apps	Standard	Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD)
Power Apps	Standard	Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Power Automate	Standard	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)

Kontakt
Name	Pomoc techniczna programu Adobe Acrobat Sign
adres URL	https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
Email	support@echosign.zendesk.com

Metadane łącznika
Publisher	ADOBE INC.
Witryna internetowa	https://acrobat.adobe.com/us/en/sign.html
Zasady ochrony prywatności	https://www.adobe.com/privacy/policy.html
Kategorie	Witryna internetowa

Adobe Acrobat Sign

Wydawca: Adobe, Inc.

Wymagania wstępne

Wymagane jest konto programu Adobe Acrobat Sign.

Jak uzyskać poświadczenia

N/A

Wprowadzenie do łącznika

Podręcznik użytkownika łącznika https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

Znane problemy i ograniczenia

N/A

Typowe błędy i środki zaradcze

N/A

Często zadawane pytania

Podręcznik użytkownika łącznika https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

Limity ograniczania

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

Akcje

Anulowanie umowy	Anuluje umowę zidentyfikowaną przez identyfikator agreementId w ścieżce.
Pobieranie adresu URL podpisywania	Ta operacja pobiera adres URL strony logowania elektronicznego dla bieżących sygnatariuszy umowy.
Pobieranie danych pola formularza umowy (stare) [PRZESTARZAŁE]	Pobiera dane wprowadzone w polach formularza interaktywnego umowy.
Pobieranie danych pola formularza umowy w formacie CSV	Pobiera dane wprowadzone w polach formularza interaktywnego umowy.
Pobieranie danych pola formularza umowy w formacie JSON	Pobiera dane wprowadzone w polach formularza interaktywnego umowy.
Pobieranie dokumentu z umowy	Ta operacja pobiera strumień plików określonego dokumentu umowy.
Pobieranie dokumentu z umowy [PRZESTARZAŁE]	Ta akcja została przestarzała. Zamiast tego użyj polecenia Pobierz dokument z umowy . ~~Ta operacja pobiera strumień plików określonego dokumentu umowy.~~
Pobieranie listy wszystkich formularzy internetowych	Ta operacja pobiera listę wszystkich formularzy internetowych użytkownika.
Pobieranie listy wszystkich grup, do których należy użytkownik	Ta operacja pobiera listę wszystkich grup, do których należy użytkownik.
Pobieranie listy wszystkich identyfikatorów dokumentów z umowy	Ta operacja pobiera identyfikatory wszystkich dokumentów i dokumentów pomocniczych umowy.
Pobieranie listy wszystkich przepływów pracy	Ta operacja pobiera listę wszystkich przepływów pracy użytkownika.
Pobieranie listy wszystkich szablonów bibliotek	Ta operacja pobiera listę wszystkich dokumentów przechowywanych jako szablony w bibliotece Adobe Acrobat Sign użytkownika.
Pobieranie listy wszystkich umów	Ta operacja pobiera listę wszystkich umów użytkownika.
Pobieranie listy wszystkich umów na podstawie kryteriów wyszukiwania	Ta operacja wyszukuje umowy według kryteriów, takich jak identyfikator przepływu pracy itp.
Pobieranie pliku PDF podpisanej umowy	Ta operacja pobiera strumień plików PDF połączonej lub podpisanej umowy. Należy pamiętać, że strumień plików powinien być przechowywany z nazwą pliku kończącą się rozszerzeniem .pdf.
Pobierz listę wszystkich identyfikatorów dokumentów z umowy [PRZESTARZAŁE]	Ta akcja została przestarzała. Zamiast tego użyj pozycji Pobierz listę wszystkich identyfikatorów dokumentów z umowy . ~~Ta operacja pobiera identyfikatory wszystkich dokumentów i dokumentów pomocniczych umowy.~~
Pobierz listę wszystkich szablonów bibliotek (stary) [PRZESTARZAŁE]	Ta operacja pobiera listę wszystkich dokumentów przechowywanych jako szablony w bibliotece Adobe Acrobat Sign użytkownika.
Pobierz listę wszystkich umów (stare) [PRZESTARZAŁE]	Ta operacja pobiera listę wszystkich umów użytkownika.
Pobierz plik PDF dziennika inspekcji umowy	Ta operacja pobiera strumień plików PDF dziennika inspekcji umowy. Należy pamiętać, że strumień plików powinien być przechowywany z nazwą pliku kończącą się rozszerzeniem .pdf.
Pobierz plik PDF podpisanej umowy [PRZESTARZAŁE]	Ta akcja została przestarzała. Zamiast tego użyj polecenia Pobierz plik PDF podpisanej umowy . ~~Ta operacja pobiera strumień plików PDF połączonej lub podpisanej umowy. Należy pamiętać, że strumień plików powinien być przechowywany z nazwą pliku kończącą się rozszerzeniem .pdf.~~
Przekazywanie dokumentu i pobieranie identyfikatora dokumentu	Ta operacja przekazuje dokument na koncie programu Adobe Acrobat Sign i zwraca dla niego identyfikator dokumentu. Ten dokument jest tymczasowo przechowywany w programie Adobe Acrobat Sign, a identyfikator dokumentu może służyć do dalszych operacji, takich jak tworzenie umowy.
Przekaż dokument i pobierz identyfikator dokumentu (stary) [PRZESTARZAŁE]	Ta operacja przekazuje dokument na koncie programu Adobe Acrobat Sign i zwraca dla niego identyfikator dokumentu. Ten dokument jest tymczasowo przechowywany w programie Adobe Acrobat Sign, a identyfikator dokumentu może służyć do dalszych operacji, takich jak tworzenie umowy.
Tworzenie szablonu biblioteki na podstawie adresu URL dokumentu	Ta operacja tworzy szablon w bibliotece Adobe Acrobat Sign na podstawie adresu URL dokumentu. Użyj tego szablonu do wysyłania umów
Tworzenie szablonu biblioteki na podstawie adresu URL dokumentu (stary) [PRZESTARZAŁE]	Ta operacja tworzy szablon w bibliotece Adobe Acrobat Sign na podstawie adresu URL dokumentu. Użyj tego szablonu do wysyłania umów
Tworzenie szablonu biblioteki na podstawie przekazanego dokumentu	Ta operacja tworzy szablon w bibliotece Adobe Acrobat Sign z przekazanego dokumentu. Użyj tego szablonu do wysyłania umów.
Tworzenie szablonu biblioteki na podstawie przekazanego dokumentu (stary) [PRZESTARZAŁE]	Ta operacja tworzy szablon w bibliotece Adobe Acrobat Sign z przekazanego dokumentu. Użyj tego szablonu do wysyłania umów.
Tworzenie umowy na podstawie adresu URL dokumentu i wysyłanie do podpisu	Ta operacja tworzy umowę na podstawie dokumentu przekazanego w programie Adobe Acrobat Sign i wysyła ją do podpisu.
Tworzenie umowy na podstawie przekazanego dokumentu i wysyłanie do podpisu	Ta operacja tworzy umowę na podstawie dokumentu przekazanego w programie Adobe Acrobat Sign i wysyła ją do podpisu.
Tworzenie umowy na podstawie przepływu pracy i wysyłanie do podpisu	Ta operacja tworzy umowę na podstawie przepływu pracy w programie Adobe Acrobat Sign i wysyła ją do podpisu.
Tworzenie umowy na podstawie szablonu biblioteki i wysyłanie do podpisu	Ta operacja tworzy umowę na podstawie szablonu przechowywanego w bibliotece Adobe Acrobat Sign użytkownika i wysyła ją do podpisu.
Tworzenie umowy na podstawie szablonu biblioteki i wysyłanie do podpisu (stary) [PRZESTARZAŁE]	Ta operacja tworzy umowę na podstawie szablonu przechowywanego w bibliotece Adobe Acrobat Sign użytkownika i wysyła ją do podpisu.
Tworzenie umowy na podstawie zawartości pliku i wysyłanie do podpisu	Ta operacja tworzy umowę z pliku w programie Adobe Acrobat Sign i wysyła ją do podpisu.
Utwórz umowę na podstawie adresu URL dokumentu i wyślij do podpisu (stary) [PRZESTARZAŁE]	Ta operacja tworzy umowę na podstawie dokumentu przekazanego w programie Adobe Acrobat Sign i wysyła ją do podpisu.
Utwórz umowę na podstawie przekazanego dokumentu i wyślij do podpisu (stary) [PRZESTARZAŁE]	Ta operacja tworzy umowę na podstawie dokumentu przekazanego w programie Adobe Acrobat Sign i wysyła ją do podpisu.
Uzyskiwanie adresu URL widoku umowy	Pobiera najnowszy adres URL widoku stanu umowy.
Uzyskiwanie stanu umowy	Ta operacja pobiera wszystkie bieżące informacje o umowie, takie jak stan.
Uzyskiwanie stanu umowy [PRZESTARZAŁE]	Ta akcja została przestarzała. Zamiast tego użyj pozycji Pobierz stan umowy . ~~Ta operacja pobiera wszystkie bieżące informacje o umowie, takie jak stan.~~
Uzyskiwanie szczegółowych informacji o przepływie pracy	Ta operacja pobiera szczegółowe informacje o przepływie pracy.

Anulowanie umowy

Identyfikator operacji:: CancelAgreement

Anuluje umowę zidentyfikowaną przez identyfikator agreementId w ścieżce.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, która ma zostać anulowana.
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Stan agrementu	state		string	Państwo, w którym umowa powinna wylądować.
Comment	comment		string	Opcjonalny komentarz opisujący przyczynę anulowania adresatów.
Inne	notifyOthers		boolean	Niezależnie od tego, czy chcesz, aby adresaci otrzymywali powiadomienia.

Pobieranie adresu URL podpisywania

Identyfikator operacji:: GetSigningUrls

Ta operacja pobiera adres URL strony logowania elektronicznego dla bieżących sygnatariuszy umowy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy podany przez akcję tworzącą umowę
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com

Zwraca

Body: SigningUrlResponse

Pobieranie danych pola formularza umowy (stare) [PRZESTARZAŁE]

Identyfikator operacji:: GetAgreementFormFieldData

Pobiera dane wprowadzone w polach formularza interaktywnego umowy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której informacje są potrzebne

Zwraca

response: file

Pobieranie danych pola formularza umowy w formacie CSV

Identyfikator operacji:: GetAgreementFormFieldData_V2

Pobiera dane wprowadzone w polach formularza interaktywnego umowy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której informacje są potrzebne
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com

Zwraca

Zawartość danych formularza

Zawartość danych formularza: binary

Pobieranie danych pola formularza umowy w formacie JSON

Identyfikator operacji:: GetAgreementFormFieldData_V3

Pobiera dane wprowadzone w polach formularza interaktywnego umowy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której informacje są potrzebne
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com

Zwraca

Zawartość danych formularza

Zawartość danych formularza: object

Pobieranie dokumentu z umowy

Identyfikator operacji:: GetDocument_V2

Ta operacja pobiera strumień plików określonego dokumentu umowy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której dokument jest potrzebny
Identyfikator dokumentu	documentId	True	string	Identyfikator dokumentu określonego dokumentu umowy
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com

Zwraca

Strumień plików dokumentu

response: DocumentResponse

Pobieranie dokumentu z umowy [PRZESTARZAŁE]

Identyfikator operacji:: GetDocument

Ta akcja została przestarzała. Zamiast tego użyj polecenia Pobierz dokument z umowy .

~~Ta operacja pobiera strumień plików określonego dokumentu umowy.~~

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której dokument jest potrzebny
Identyfikator dokumentu	documentId	True	string	Identyfikator dokumentu określonego dokumentu umowy

Zwraca

Strumień plików dokumentu

response: DocumentResponse

Pobieranie listy wszystkich formularzy internetowych

Identyfikator operacji:: GetAllWebForms

Ta operacja pobiera listę wszystkich formularzy internetowych użytkownika.

Parametry

Nazwa	Klucz	Typ	Opis
Cursor	cursor	string	Służy do nawigowania po stronach. Jeśli nie zostanie podana, zwraca pierwszą stronę.
Rozmiar strony	pageSize	integer	Liczba elementów na stronie odpowiedzi. Domyślnie: 100; Maksymalna: 10000
W nazwie	x-api-user	string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa/identyfikator grupy	groupId	string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"

Zwraca

Kod JSON zawierający obiekt tablicy formularzy internetowych użytkownika

Body: userWidgetListV6

Pobieranie listy wszystkich grup, do których należy użytkownik

Identyfikator operacji:: GetAllUserGroups

Ta operacja pobiera listę wszystkich grup, do których należy użytkownik.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Identyfikator użytkownika	userId	True	string	Aby uzyskać wynik dla autoryzowanego użytkownika, identyfikator użytkownika może zostać zastąpiony przez "me" bez cudzysłowów.

Zwraca

Kod JSON zawierający listę grup dla danego użytkownika

Body: UserGroupsInfoV6

Pobieranie listy wszystkich identyfikatorów dokumentów z umowy

Identyfikator operacji:: GetAllDocumentsofAnAgreement_V2

Ta operacja pobiera identyfikatory wszystkich dokumentów i dokumentów pomocniczych umowy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której dokumenty są potrzebne
Dokumenty pomocnicze — typ zawartości	supportingDocumentContentFormat		string	Typ zawartości dokumentów pomocniczych umowy
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com

Zwraca

Kod JSON zawierający zarówno dokumenty, jak i obiekty tablicowe dokumentów pomocniczych

Body: AgreementDocumentsV6

Pobieranie listy wszystkich przepływów pracy

Identyfikator operacji:: GetAllWorkflows

Ta operacja pobiera listę wszystkich przepływów pracy użytkownika.

Parametry

Nazwa	Klucz	Typ	Opis
Uwzględnij robocze przepływy pracy	includeDraftWorkflows	boolean	Uwzględnianie roboczych przepływów pracy
Uwzględnij nieaktywne przepływy pracy	includeInactiveWorkflows	boolean	Uwzględnianie nieaktywnych przepływów pracy
W nazwie	x-api-user	string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa/identyfikator grupy	groupId	string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"

Zwraca

Kod JSON zawierający obiekt tablicy przepływu pracy użytkownika

Body: userWorkflowListV6

Pobieranie listy wszystkich szablonów bibliotek

Identyfikator operacji:: GetLibraryDocuments_V2

Ta operacja pobiera listę wszystkich dokumentów przechowywanych jako szablony w bibliotece Adobe Acrobat Sign użytkownika.

Parametry

Nazwa	Klucz	Typ	Opis
Cursor	cursor	string	Służy do nawigowania po stronach. Jeśli nie zostanie podana, zwraca pierwszą stronę.
Rozmiar strony	pageSize	integer	Liczba elementów na stronie odpowiedzi. Domyślnie: 100; Maksymalna: 10000
W nazwie	x-api-user	string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa/identyfikator grupy	groupId	string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"

Zwraca

Kod JSON zawierający obiekt tablicy szablonów biblioteki

Body: LibraryDocuments

Pobieranie listy wszystkich umów

Identyfikator operacji:: GetAllAgreements_V2

Ta operacja pobiera listę wszystkich umów użytkownika.

Parametry

Nazwa	Klucz	Typ	Opis
Cursor	cursor	string	Służy do nawigowania po stronach. Jeśli nie zostanie podana, zwraca pierwszą stronę.
Rozmiar strony	pageSize	integer	Liczba elementów na stronie odpowiedzi. Domyślnie: 100; Maksymalna: 10000
W nazwie	x-api-user	string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa/identyfikator grupy	groupId	string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"

Zwraca

Kod JSON zawierający obiekt tablicy umowy użytkownika

Body: userAgreementListV6

Pobieranie listy wszystkich umów na podstawie kryteriów wyszukiwania

Identyfikator operacji:: SearchAgreements

Ta operacja wyszukuje umowy według kryteriów, takich jak identyfikator przepływu pracy itp.

Parametry

Nazwa	Klucz	Typ	Opis
W nazwie	x-api-user	string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa/identyfikator grupy	groupId	string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"
Nazwa/identyfikator przepływu pracy	workflowId	string	Wybierz niestandardowy przepływ pracy z listy lub wprowadź niestandardowy identyfikator przepływu pracy.
Utworzone po	gt	string	Minimalna dozwolona data/godzina. Przykład: 2020-12-31T23:59:00Z
Utworzone przed	lt	string	Maksymalna dozwolona data/godzina. Przykład: 2023-12-31T23:59:00Z
Rozmiar strony	pageSize	integer	Liczba elementów na stronie odpowiedzi. Domyślnie: 50; Maksymalna: 500
Indeks początkowy	startIndex	integer	0-oparty na pierwszym wierszu (przesunięcie) wyników wyszukiwania do zwrócenia.

Zwraca

Kod JSON zawierający obiekt tablicy umowy użytkownika

Body: userAgreementListV6

Pobieranie pliku PDF podpisanej umowy

Identyfikator operacji:: GetCombinedDocument_V2

Ta operacja pobiera strumień plików PDF połączonej lub podpisanej umowy. Należy pamiętać, że strumień plików powinien być przechowywany z nazwą pliku kończącą się rozszerzeniem .pdf.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy podany przez akcję tworzącą umowę
Czy dołączyć dokumenty pomocnicze?	attachSupportingDocuments		boolean	W przypadku wartości true dołącz dokumenty pomocnicze do podpisanej umowy PDF
Czy dołączyć raport inspekcji?	attachAuditReport		boolean	Jeśli to prawda, dołącz raport inspekcji do podpisanej umowy PDF
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com

Zwraca

Strumień plików dokumentu

response: CombinedDocumentResponse

Pobierz listę wszystkich identyfikatorów dokumentów z umowy [PRZESTARZAŁE]

Identyfikator operacji:: GetAllDocumentsofAnAgreement

Ta akcja została przestarzała. Zamiast tego użyj pozycji Pobierz listę wszystkich identyfikatorów dokumentów z umowy .

~~Ta operacja pobiera identyfikatory wszystkich dokumentów i dokumentów pomocniczych umowy.~~

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której dokumenty są potrzebne
Dokumenty pomocnicze — typ zawartości	supportingDocumentContentFormat		string	Typ zawartości dokumentów pomocniczych umowy

Zwraca

Kod JSON zawierający zarówno dokumenty, jak i obiekty tablicowe dokumentów pomocniczych

Body: AgreementDocuments

Pobierz listę wszystkich szablonów bibliotek (stary) [PRZESTARZAŁE]

Identyfikator operacji:: GetLibraryDocuments

Ta operacja pobiera listę wszystkich dokumentów przechowywanych jako szablony w bibliotece Adobe Acrobat Sign użytkownika.

Zwraca

Kod JSON zawierający obiekt tablicy szablonów biblioteki

Body: DocumentLibraryItems

Pobierz listę wszystkich umów (stare) [PRZESTARZAŁE]

Identyfikator operacji:: GetAllAgreements

Ta operacja pobiera listę wszystkich umów użytkownika.

Zwraca

Kod JSON zawierający obiekt tablicy umowy użytkownika

Body: UserAgreements

Pobierz plik PDF dziennika inspekcji umowy

Identyfikator operacji:: GetAgreementAuditTrail

Ta operacja pobiera strumień plików PDF dziennika inspekcji umowy. Należy pamiętać, że strumień plików powinien być przechowywany z nazwą pliku kończącą się rozszerzeniem .pdf.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której informacje są potrzebne

Zwraca

Strumień plików dziennika inspekcji umowy

response: AgreementAuditTrailResponse

Pobierz plik PDF podpisanej umowy [PRZESTARZAŁE]

Identyfikator operacji:: GetCombinedDocument

Ta akcja została przestarzała. Zamiast tego użyj polecenia Pobierz plik PDF podpisanej umowy .

~~Ta operacja pobiera strumień plików PDF połączonej lub podpisanej umowy. Należy pamiętać, że strumień plików powinien być przechowywany z nazwą pliku kończącą się rozszerzeniem .pdf.~~

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy podany przez akcję tworzącą umowę
Czy dołączyć dokumenty pomocnicze?	attachSupportingDocuments		boolean	W przypadku wartości true dołącz dokumenty pomocnicze do podpisanej umowy PDF
Czy dołączyć raport inspekcji?	auditReport		boolean	Jeśli to prawda, dołącz raport inspekcji do podpisanej umowy PDF

Zwraca

Strumień plików dokumentu

response: CombinedDocumentResponse

Przekazywanie dokumentu i pobieranie identyfikatora dokumentu

Identyfikator operacji:: CreateTransientDocument_V2

Ta operacja przekazuje dokument na koncie programu Adobe Acrobat Sign i zwraca dla niego identyfikator dokumentu. Ten dokument jest tymczasowo przechowywany w programie Adobe Acrobat Sign, a identyfikator dokumentu może służyć do dalszych operacji, takich jak tworzenie umowy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa pliku	File-Name	True	string	Nazwa dokumentu, który ma zostać przekazany, z rozszerzeniem
Zawartość pliku	File	True	contentOnly	Strumień plików dokumentu, który ma zostać przekazany
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com

Zwraca

Kod JSON zawierający identyfikator przekazanego dokumentu

Body: TransientDocumentResponse

Przekaż dokument i pobierz identyfikator dokumentu (stary) [PRZESTARZAŁE]

Identyfikator operacji:: CreateTransientDocument

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa pliku	File-Name	True	string	Nazwa dokumentu, który ma zostać przekazany, z rozszerzeniem
Zawartość pliku	File	True	contentOnly	Strumień plików dokumentu, który ma zostać przekazany

Zwraca

Kod JSON zawierający identyfikator przekazanego dokumentu

Body: TransientDocumentResponse

Tworzenie szablonu biblioteki na podstawie adresu URL dokumentu

Identyfikator operacji:: CreateLibraryDocumentByUrl_V2

Ta operacja tworzy szablon w bibliotece Adobe Acrobat Sign na podstawie adresu URL dokumentu. Użyj tego szablonu do wysyłania umów

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa szablonu	name	True	string	Nazwa umowy używana do identyfikowania szablonu
Typ szablonu	templateTypes	True	array of string	Lista co najmniej jednego typu szablonu biblioteki
Tryb udostępniania	sharingMode	True	string	Określa, kto powinien mieć dostęp do tego dokumentu biblioteki
adres URL	url	True	string	Publicznie dostępny adres URL pobierania nieprzetworzonej zawartości pliku
Name	name	True	string	Oryginalna nazwa pliku systemowego wysyłanego dokumentu
Typ	mimeType	True	string	Typ mime pliku, do których odwołuje się odwołanie, np. application/pdf
Stan szablonu	state	True	string	Stan dokumentu biblioteki.
Nazwa/identyfikator grupy	groupId		string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"

Zwraca

Obiekt JSON opisujący szablon biblioteki

Body: LibraryDocumentCreationResponseV6

Tworzenie szablonu biblioteki na podstawie adresu URL dokumentu (stary) [PRZESTARZAŁE]

Identyfikator operacji:: CreateLibraryDocumentByUrl

Ta operacja tworzy szablon w bibliotece Adobe Acrobat Sign na podstawie adresu URL dokumentu. Użyj tego szablonu do wysyłania umów

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa szablonu	name	True	string	Nazwa umowy używana do identyfikowania szablonu
Typ szablonu	libraryTemplateTypes	True	string	Lista co najmniej jednego typu szablonu biblioteki
Udostępnianie za pomocą	librarySharingMode	True	string	Określa, kto powinien mieć dostęp do tego dokumentu biblioteki
adres URL	url	True	string	Publicznie dostępny adres URL do pobierania dokumentu
Name	name	True	string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (2)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (2)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (3)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (3)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (4)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (4)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (5)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (5)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (6)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (6)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (7)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (7)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (8)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (8)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (9)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (9)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (10)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (10)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem

Zwraca

Obiekt JSON opisujący szablon biblioteki

Body: LibraryDocumentCreationResponse

Tworzenie szablonu biblioteki na podstawie przekazanego dokumentu

Identyfikator operacji:: CreateLibraryDocumentById_V2

Ta operacja tworzy szablon w bibliotece Adobe Acrobat Sign z przekazanego dokumentu. Użyj tego szablonu do wysyłania umów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa szablonu	name	True	string	Nazwa umowy używana do identyfikowania szablonu
Typ szablonu	templateTypes	True	array of string	Lista co najmniej jednego typu szablonu biblioteki
Tryb udostępniania	sharingMode	True	string	Określa, kto powinien mieć dostęp do tego dokumentu biblioteki
identyfikator	transientDocumentId	True	string	Identyfikator dokumentu odebrany przez przekazanie dokumentu przejściowego
Stan szablonu	state	True	string	Stan dokumentu biblioteki.
Nazwa/identyfikator grupy	groupId		string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"

Zwraca

Obiekt JSON opisujący szablon biblioteki

Body: LibraryDocumentCreationResponseV6

Tworzenie szablonu biblioteki na podstawie przekazanego dokumentu (stary) [PRZESTARZAŁE]

Identyfikator operacji:: CreateLibraryDocumentById

Ta operacja tworzy szablon w bibliotece Adobe Acrobat Sign z przekazanego dokumentu. Użyj tego szablonu do wysyłania umów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa szablonu	name	True	string	Nazwa umowy używana do identyfikowania szablonu
Typ szablonu	libraryTemplateTypes	True	string	Lista co najmniej jednego typu szablonu biblioteki
Udostępnianie za pomocą	librarySharingMode	True	string	Określa, kto powinien mieć dostęp do tego dokumentu biblioteki
Identyfikator dokumentu	transientDocumentId	True	string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (2)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (3)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (4)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (5)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (6)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (7)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (8)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (9)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (10)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu

Zwraca

Obiekt JSON opisujący szablon biblioteki

Body: LibraryDocumentCreationResponse

Tworzenie umowy na podstawie adresu URL dokumentu i wysyłanie do podpisu

Identyfikator operacji:: CreateAgreementByUrl_V2

Ta operacja tworzy umowę na podstawie dokumentu przekazanego w programie Adobe Acrobat Sign i wysyła ją do podpisu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa umowy	name	True	string	Nazwa umowy
adres URL	url	True	string	Publicznie dostępny adres URL pobierania nieprzetworzonej zawartości pliku
Name	name	True	string	Oryginalna nazwa pliku systemowego wysyłanego dokumentu
Typ	mimeType	True	string	Typ mime pliku, do których odwołuje się odwołanie, np. application/pdf
Typ podpisu	signatureType	True	string	Określa żądany typ podpisu — podpis e-podpis lub zapis
Email	email	True	string	Wiadomość e-mail uczestnika
Authentication	authenticationMethod		string	Uwierzytelnianie domyślne: wiadomość e-mail (brak)
Hasło	password		string	Hasło wymagane dla uczestnika
Kod kraju	countryCode		string	Kod kraju odbiorcy wymagany do wyświetlania i podpisywania dokumentu
Numer telefonu.	phone		string	Numer telefonu odbiorcy wymagany do wyświetlenia i podpisania umowy
Identyfikator dostawcy	providerId		string	Identyfikator dostawcy usługi Digital Identity Gateway.
Zamówienie	order	True	integer	Indeks rozpoczynający się od 1 wskazujący pozycję, w której grupa podpisywania musi się podpisać.
Role	role	True	string	Bieżące role zestawu uczestników (osoba podpisjąca, osoba zatwierdzająca itp.).
Nazwa/identyfikator grupy	groupId		string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"
Message	message		string	Opcjonalna wiadomość do adresatów żądających ich akcji
Typ wysyłania	sendType		string	Typ środowiska używanego przez inicjatora do wysłania umowy
Email	email		string	Adres e-mail CC umowy
Czas wygaśnięcia	expirationTime		string	Czas po wygaśnięciu umowy. Przykład: 2020-12-31T23:59:00Z
Tożsamość zewnętrzna	externalId		string	Dowolna wartość z systemu
Częstotliwość przypomnienia	reminderFrequency		string	Jak często chcesz wysyłać przypomnienia?
Hasło dokumentu	openPassword		string	Hasło, które powinno być używane do szyfrowania podpisanej umowy PDF
Name	fieldName		string	Nazwa pola
Wartość	defaultValue		string	Wartość domyślna pola
Opóźnienie przekierowania	redirectDelay		string	Opóźnienie (w sekundach) przed przejściem użytkownika na stronę sukcesu.
Adres URL przekierowania	redirectUrl		string	Adres URL przekierowania po zakończeniu procesu podpisywania, np. https://adobe.com
Początkowe wiadomości e-mail	initEmails		string	Kontroluj wiadomości e-mail z powiadomieniami dotyczącymi zdarzeń inicjowania umowy.
State	state	True	string	Państwo, w którym umowa powinna wylądować.

Zwraca

Kod JSON zawierający identyfikator nowo utworzonej umowy

Body: AgreementCreationResponseV6

Tworzenie umowy na podstawie przekazanego dokumentu i wysyłanie do podpisu

Identyfikator operacji:: CreateAgreementById_V2

Ta operacja tworzy umowę na podstawie dokumentu przekazanego w programie Adobe Acrobat Sign i wysyła ją do podpisu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa umowy	name	True	string	Nazwa umowy
identyfikator	transientDocumentId	True	string	Identyfikator dokumentu odebrany przez przekazanie dokumentu przejściowego
Typ podpisu	signatureType	True	string	Typ podpisu, którego chcesz zażądać — podpis e-podpis lub zapis
Email	email	True	string	Wiadomość e-mail uczestnika
Authentication	authenticationMethod		string	Uwierzytelnianie domyślne: wiadomość e-mail (brak)
Hasło	password		string	Hasło wymagane dla uczestnika
Kod kraju	countryCode		string	Kod kraju odbiorcy wymagany do wyświetlania i podpisywania dokumentu
Numer telefonu.	phone		string	Numer telefonu odbiorcy wymagany do wyświetlenia i podpisania umowy
Identyfikator dostawcy	providerId		string	Identyfikator dostawcy usługi Digital Identity Gateway.
Zamówienie	order	True	integer	Indeks rozpoczynający się od 1 wskazujący pozycję, w której grupa podpisywania musi się podpisać.
Role	role	True	string	Bieżące role zestawu uczestników (osoba podpisjąca, osoba zatwierdzająca itp.).
Nazwa/identyfikator grupy	groupId		string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"
Message	message		string	Opcjonalna wiadomość do adresatów żądających ich akcji
Typ wysyłania	sendType		string	Typ środowiska używanego przez inicjatora do wysłania umowy
Email	email		string	Adres e-mail CC umowy
Czas wygaśnięcia	expirationTime		string	Czas po wygaśnięciu umowy. Przykład: 2020-12-31T23:59:00Z
Tożsamość zewnętrzna	externalId		string	Dowolna wartość z systemu
Częstotliwość przypomnienia	reminderFrequency		string	Jak często chcesz wysyłać przypomnienia?
Hasło dokumentu	openPassword		string	Hasło, które powinno być używane do szyfrowania podpisanej umowy PDF
Name	fieldName		string	Nazwa pola
Wartość	defaultValue		string	Wartość domyślna pola
Opóźnienie przekierowania	redirectDelay		string	Opóźnienie (w sekundach) przed przejściem użytkownika na stronę sukcesu.
Adres URL przekierowania	redirectUrl		string	Adres URL przekierowania po zakończeniu procesu podpisywania, np. https://adobe.com
Początkowe wiadomości e-mail	initEmails		string	Kontroluj wiadomości e-mail z powiadomieniami dotyczącymi zdarzeń inicjowania umowy.
State	state	True	string	Państwo, w którym umowa powinna wylądować.

Zwraca

Kod JSON zawierający identyfikator nowo utworzonej umowy

Body: AgreementCreationResponseV6

Tworzenie umowy na podstawie przepływu pracy i wysyłanie do podpisu

Identyfikator operacji:: CreateAgreementFromWorkflow

Ta operacja tworzy umowę na podstawie przepływu pracy w programie Adobe Acrobat Sign i wysyła ją do podpisu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
W nazwie	x-api-user	True	string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa/identyfikator grupy	groupId	True	string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"
Nazwa/identyfikator przepływu pracy	workflowIdParam	True	string	Wybierz niestandardowy przepływ pracy z listy lub wprowadź niestandardowy identyfikator przepływu pracy.
agreementWorkflowSchema	agreementWorkflowSchema	True	dynamic	Szczegóły wybranego zdarzenia.

Zwraca

Kod JSON zawierający identyfikator nowo utworzonej umowy

Body: AgreementCreationResponseV6

Tworzenie umowy na podstawie szablonu biblioteki i wysyłanie do podpisu

Identyfikator operacji:: CreateAgreementByTemplate_V2

Ta operacja tworzy umowę na podstawie szablonu przechowywanego w bibliotece Adobe Acrobat Sign użytkownika i wysyła ją do podpisu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa umowy	name	True	string	Nazwa umowy
Template	libraryDocumentId	True	string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Typ podpisu	signatureType	True	string	Typ podpisu, którego chcesz zażądać — podpis e-podpis lub zapis
Email	email	True	string	Wiadomość e-mail uczestnika
Authentication	authenticationMethod		string	Uwierzytelnianie domyślne: wiadomość e-mail (brak)
Hasło	password		string	Hasło wymagane dla uczestnika
Kod kraju	countryCode		string	Kod kraju odbiorcy wymagany do wyświetlania i podpisywania dokumentu
Numer telefonu.	phone		string	Numer telefonu odbiorcy wymagany do wyświetlenia i podpisania umowy
Identyfikator dostawcy	providerId		string	Identyfikator dostawcy usługi Digital Identity Gateway.
Zamówienie	order	True	integer	Indeks rozpoczynający się od 1 wskazujący pozycję, w której grupa podpisywania musi się podpisać.
Role	role	True	string	Bieżące role zestawu uczestników (osoba podpisjąca, osoba zatwierdzająca itp.).
Nazwa/identyfikator grupy	groupId		string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"
Message	message		string	Opcjonalna wiadomość do adresatów żądających ich akcji
Typ wysyłania	sendType		string	Typ środowiska używanego przez inicjatora do wysłania umowy
Email	email		string	Adres e-mail CC umowy
Czas wygaśnięcia	expirationTime		string	Czas po wygaśnięciu umowy. Przykład: 2020-12-31T23:59:00Z
Tożsamość zewnętrzna	externalId		string	Dowolna wartość z systemu
Częstotliwość przypomnienia	reminderFrequency		string	Jak często chcesz wysyłać przypomnienia?
Hasło dokumentu	openPassword		string	Hasło, które powinno być używane do szyfrowania podpisanej umowy PDF
Name	fieldName		string	Nazwa pola
Wartość	defaultValue		string	Wartość domyślna pola
Opóźnienie przekierowania	redirectDelay		string	Opóźnienie (w sekundach) przed przejściem użytkownika na stronę sukcesu.
Adres URL przekierowania	redirectUrl		string	Adres URL przekierowania po zakończeniu procesu podpisywania, np. https://adobe.com
Początkowe wiadomości e-mail	initEmails		string	Kontroluj wiadomości e-mail z powiadomieniami dotyczącymi zdarzeń inicjowania umowy.
State	state	True	string	Państwo, w którym umowa powinna wylądować.

Zwraca

Kod JSON zawierający identyfikator nowo utworzonej umowy

Body: AgreementCreationResponseV6

Tworzenie umowy na podstawie szablonu biblioteki i wysyłanie do podpisu (stary) [PRZESTARZAŁE]

Identyfikator operacji:: CreateAgreementByTemplate

Ta operacja tworzy umowę na podstawie szablonu przechowywanego w bibliotece Adobe Acrobat Sign użytkownika i wysyła ją do podpisu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa umowy	name	True	string	Nazwa umowy
Szablon biblioteki dokumentów	libraryDocumentId	True	string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Typ podpisu	signatureType	True	string	Typ podpisu, którego chcesz zażądać — podpis e-podpis lub zapis
Adres e-mail adresata	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata	recipientSetRole	True	string	Określanie roli adresata
Message	message		string	Opcjonalna wiadomość do adresatów żądających ich akcji
Dni do terminu ostatecznego	daysUntilSigningDeadline		integer	Liczba dni pozostałych przed wygaśnięciem dokumentu
Częstotliwość przypomnienia	reminderFrequency		string	Jak często chcesz wysyłać przypomnienia?
Hasło dokumentu	openPassword		string	Hasło, które powinno być używane do szyfrowania podpisanej umowy PDF
Szablon biblioteki dokumentów (2)	libraryDocumentId		string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Szablon biblioteki dokumentów (3)	libraryDocumentId		string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Szablon biblioteki dokumentów (4)	libraryDocumentId		string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Szablon biblioteki dokumentów (5)	libraryDocumentId		string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Szablon biblioteki dokumentów (6)	libraryDocumentId		string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Szablon biblioteki dokumentów (7)	libraryDocumentId		string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Szablon biblioteki dokumentów (8)	libraryDocumentId		string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Szablon biblioteki dokumentów (9)	libraryDocumentId		string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Szablon biblioteki dokumentów (10)	libraryDocumentId		string	Wybieranie dokumentu z szablonów przechowywanych w bibliotece
Adres e-mail adresata (2)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (2)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (2)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (3)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (3)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (3)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (4)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (4)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (4)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (5)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (5)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (5)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (6)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (6)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (6)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (7)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (7)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (7)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (8)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (8)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (8)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (9)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (9)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (9)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (10)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (10)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (10)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (11)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (11)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (11)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (12)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (12)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (12)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (13)	email	True	string	Adres e-mail odbiorcy
Zamówienie podpisania adresata (13)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (13)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (14)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (14)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (14)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (15)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (15)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (15)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (16)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (16)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (16)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail odbiorcy (17)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (17)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (17)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail odbiorcy (18)	email	True	string	Adres e-mail odbiorcy
Zamówienie podpisania adresata (18)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (18)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (19)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (19)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (19)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (20)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (20)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (20)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (21)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (21)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (21)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (22)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (22)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (22)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (23)	email	True	string	Adres e-mail odbiorcy
Zamówienie podpisania adresata (23)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (23)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (24)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (24)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (24)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (25)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (25)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (25)	recipientSetRole	True	string	Określanie roli adresata
Nazwa pola formularza (1)	fieldName		string	Nazwa pola
Wartość pola formularza (1)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (2)	fieldName		string	Nazwa pola
Wartość pola formularza (2)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (3)	fieldName		string	Nazwa pola
Wartość pola formularza (3)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (4)	fieldName		string	Nazwa pola
Wartość pola formularza (4)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (5)	fieldName		string	Nazwa pola
Wartość pola formularza (5)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (6)	fieldName		string	Nazwa pola
Wartość pola formularza (6)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (7)	fieldName		string	Nazwa pola
Wartość pola formularza (7)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (8)	fieldName		string	Nazwa pola
Wartość pola formularza (8)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (9)	fieldName		string	Nazwa pola
Wartość pola formularza (9)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (10)	fieldName		string	Nazwa pola
Wartość pola formularza (10)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (11)	fieldName		string	Nazwa pola
Wartość pola formularza (11)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (12)	fieldName		string	Nazwa pola
Wartość pola formularza (12)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (13)	fieldName		string	Nazwa pola
Wartość pola formularza (13)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (14)	fieldName		string	Nazwa pola
Wartość pola formularza (14)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (15)	fieldName		string	Nazwa pola
Wartość pola formularza (15)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (16)	fieldName		string	Nazwa pola
Wartość pola formularza (16)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (17)	fieldName		string	Nazwa pola
Wartość pola formularza (17)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (18)	fieldName		string	Nazwa pola
Wartość pola formularza (18)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (19)	fieldName		string	Nazwa pola
Wartość pola formularza (19)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (20)	fieldName		string	Nazwa pola
Wartość pola formularza (20)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (21)	fieldName		string	Nazwa pola
Wartość pola formularza (21)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (22)	fieldName		string	Nazwa pola
Wartość pola formularza (22)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (23)	fieldName		string	Nazwa pola
Wartość pola formularza (23)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (24)	fieldName		string	Nazwa pola
Wartość pola formularza (24)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (25)	fieldName		string	Nazwa pola
Wartość pola formularza (25)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (26)	fieldName		string	Nazwa pola
Wartość pola formularza (26)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (27)	fieldName		string	Nazwa pola
Wartość pola formularza (27)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (28)	fieldName		string	Nazwa pola
Wartość pola formularza (28)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (29)	fieldName		string	Nazwa pola
Wartość pola formularza (29)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (30)	fieldName		string	Nazwa pola
Wartość pola formularza (30)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (31)	fieldName		string	Nazwa pola
Wartość pola formularza (31)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (32)	fieldName		string	Nazwa pola
Wartość pola formularza (32)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (33)	fieldName		string	Nazwa pola
Wartość pola formularza (33)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (34)	fieldName		string	Nazwa pola
Wartość pola formularza (34)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (35)	fieldName		string	Nazwa pola
Wartość pola formularza (35)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (36)	fieldName		string	Nazwa pola
Wartość pola formularza (36)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (37)	fieldName		string	Nazwa pola
Wartość pola formularza (37)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (38)	fieldName		string	Nazwa pola
Wartość pola formularza (38)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (39)	fieldName		string	Nazwa pola
Wartość pola formularza (39)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (40)	fieldName		string	Nazwa pola
Wartość pola formularza (40)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (41)	fieldName		string	Nazwa pola
Wartość pola formularza (41)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (42)	fieldName		string	Nazwa pola
Wartość pola formularza (42)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (43)	fieldName		string	Nazwa pola
Wartość pola formularza (43)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (44)	fieldName		string	Nazwa pola
Wartość pola formularza (44)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (45)	fieldName		string	Nazwa pola
Wartość pola formularza (45)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (46)	fieldName		string	Nazwa pola
Wartość pola formularza (46)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (47)	fieldName		string	Nazwa pola
Wartość pola formularza (47)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (48)	fieldName		string	Nazwa pola
Wartość pola formularza (48)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (49)	fieldName		string	Nazwa pola
Wartość pola formularza (49)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (50)	fieldName		string	Nazwa pola
Wartość pola formularza (50)	defaultValue		string	Wartość domyślna pola

Zwraca

Kod JSON zawierający identyfikator nowo utworzonej umowy

Body: AgreementCreationResponse

Tworzenie umowy na podstawie zawartości pliku i wysyłanie do podpisu

Identyfikator operacji:: CreateAgreementByFileStream

Ta operacja tworzy umowę z pliku w programie Adobe Acrobat Sign i wysyła ją do podpisu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa umowy	name	True	string	Nazwa umowy
Name	fileName	True	string	Nazwa dokumentu, który ma zostać przekazany, z rozszerzeniem
Content	formData	True	byte	Strumień plików dokumentu, który ma zostać przekazany
Typ podpisu	signatureType	True	string	Typ podpisu, którego chcesz zażądać — podpis e-podpis lub zapis
Email	email	True	string	Wiadomość e-mail uczestnika
Authentication	authenticationMethod		string	Uwierzytelnianie domyślne: wiadomość e-mail (brak)
Hasło	password		string	Hasło wymagane dla uczestnika
Kod kraju	countryCode		string	Kod kraju odbiorcy wymagany do wyświetlania i podpisywania dokumentu
Numer telefonu.	phone		string	Numer telefonu odbiorcy wymagany do wyświetlenia i podpisania umowy
Identyfikator dostawcy	providerId		string	Identyfikator dostawcy usługi Digital Identity Gateway.
Zamówienie	order	True	integer	Indeks rozpoczynający się od 1 wskazujący pozycję, w której grupa podpisywania musi się podpisać.
Role	role	True	string	Bieżące role zestawu uczestników (osoba podpisjąca, osoba zatwierdzająca itp.).
Nazwa/identyfikator grupy	groupId		string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"
Message	message		string	Opcjonalna wiadomość do adresatów żądających ich akcji
Typ wysyłania	sendType		string	Typ środowiska używanego przez inicjatora do wysłania umowy
Email	email		string	Adres e-mail CC umowy
Czas wygaśnięcia	expirationTime		string	Czas po wygaśnięciu umowy. Przykład: 2020-12-31T23:59:00Z
Tożsamość zewnętrzna	externalId		string	Dowolna wartość z systemu
Częstotliwość przypomnienia	reminderFrequency		string	Jak często chcesz wysyłać przypomnienia?
Hasło dokumentu	openPassword		string	Hasło, które powinno być używane do szyfrowania podpisanej umowy PDF
Name	fieldName		string	Nazwa pola
Wartość	defaultValue		string	Wartość domyślna pola
Opóźnienie przekierowania	redirectDelay		string	Opóźnienie (w sekundach) przed przejściem użytkownika na stronę sukcesu.
Adres URL przekierowania	redirectUrl		string	Adres URL przekierowania po zakończeniu procesu podpisywania, np. https://adobe.com
Początkowe wiadomości e-mail	initEmails		string	Kontroluj wiadomości e-mail z powiadomieniami dotyczącymi zdarzeń inicjowania umowy.
State	state	True	string	Państwo, w którym umowa powinna wylądować.

Zwraca

Kod JSON zawierający identyfikator nowo utworzonej umowy

Body: AgreementCreationResponseV6

Utwórz umowę na podstawie adresu URL dokumentu i wyślij do podpisu (stary) [PRZESTARZAŁE]

Identyfikator operacji:: CreateAgreementByUrl

Ta operacja tworzy umowę na podstawie dokumentu przekazanego w programie Adobe Acrobat Sign i wysyła ją do podpisu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa umowy	name	True	string	Nazwa umowy
adres URL	url	True	string	Publicznie dostępny adres URL do pobierania dokumentu
Name	name	True	string	Nazwa przywoływnego dokumentu z rozszerzeniem
Typ podpisu	signatureType	True	string	Typ podpisu, którego chcesz zażądać — podpis e-podpis lub zapis
Adres e-mail adresata	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata	recipientSetRole	True	string	Określanie roli adresata
Message	message		string	Opcjonalna wiadomość do adresatów żądających ich akcji
Dni do terminu ostatecznego	daysUntilSigningDeadline		integer	Liczba dni pozostałych przed wygaśnięciem dokumentu
Częstotliwość przypomnienia	reminderFrequency		string	Jak często chcesz wysyłać przypomnienia?
Hasło dokumentu	openPassword		string	Hasło, które powinno być używane do szyfrowania podpisanej umowy PDF
Adres URL (2)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (2)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (3)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (3)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (4)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (4)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (5)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (5)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (6)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (6)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (7)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (7)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (8)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (8)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (9)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (9)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres URL (10)	url		string	Publicznie dostępny adres URL do pobierania dokumentu
Nazwa (10)	name		string	Nazwa przywoływnego dokumentu z rozszerzeniem
Adres e-mail adresata (2)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (2)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (2)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (3)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (3)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (3)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (4)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (4)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (4)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (5)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (5)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (5)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (6)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (6)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (6)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (7)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (7)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (7)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (8)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (8)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (8)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (9)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (9)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (9)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (10)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (10)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (10)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (11)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (11)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (11)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (12)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (12)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (12)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (13)	email	True	string	Adres e-mail odbiorcy
Zamówienie podpisania adresata (13)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (13)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (14)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (14)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (14)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (15)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (15)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (15)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (16)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (16)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (16)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail odbiorcy (17)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (17)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (17)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail odbiorcy (18)	email	True	string	Adres e-mail odbiorcy
Zamówienie podpisania adresata (18)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (18)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (19)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (19)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (19)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (20)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (20)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (20)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (21)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (21)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (21)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (22)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (22)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (22)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (23)	email	True	string	Adres e-mail odbiorcy
Zamówienie podpisania adresata (23)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (23)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (24)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (24)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (24)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (25)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (25)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (25)	recipientSetRole	True	string	Określanie roli adresata
Nazwa pola formularza (1)	fieldName		string	Nazwa pola
Wartość pola formularza (1)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (2)	fieldName		string	Nazwa pola
Wartość pola formularza (2)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (3)	fieldName		string	Nazwa pola
Wartość pola formularza (3)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (4)	fieldName		string	Nazwa pola
Wartość pola formularza (4)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (5)	fieldName		string	Nazwa pola
Wartość pola formularza (5)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (6)	fieldName		string	Nazwa pola
Wartość pola formularza (6)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (7)	fieldName		string	Nazwa pola
Wartość pola formularza (7)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (8)	fieldName		string	Nazwa pola
Wartość pola formularza (8)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (9)	fieldName		string	Nazwa pola
Wartość pola formularza (9)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (10)	fieldName		string	Nazwa pola
Wartość pola formularza (10)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (11)	fieldName		string	Nazwa pola
Wartość pola formularza (11)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (12)	fieldName		string	Nazwa pola
Wartość pola formularza (12)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (13)	fieldName		string	Nazwa pola
Wartość pola formularza (13)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (14)	fieldName		string	Nazwa pola
Wartość pola formularza (14)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (15)	fieldName		string	Nazwa pola
Wartość pola formularza (15)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (16)	fieldName		string	Nazwa pola
Wartość pola formularza (16)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (17)	fieldName		string	Nazwa pola
Wartość pola formularza (17)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (18)	fieldName		string	Nazwa pola
Wartość pola formularza (18)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (19)	fieldName		string	Nazwa pola
Wartość pola formularza (19)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (20)	fieldName		string	Nazwa pola
Wartość pola formularza (20)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (21)	fieldName		string	Nazwa pola
Wartość pola formularza (21)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (22)	fieldName		string	Nazwa pola
Wartość pola formularza (22)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (23)	fieldName		string	Nazwa pola
Wartość pola formularza (23)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (24)	fieldName		string	Nazwa pola
Wartość pola formularza (24)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (25)	fieldName		string	Nazwa pola
Wartość pola formularza (25)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (26)	fieldName		string	Nazwa pola
Wartość pola formularza (26)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (27)	fieldName		string	Nazwa pola
Wartość pola formularza (27)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (28)	fieldName		string	Nazwa pola
Wartość pola formularza (28)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (29)	fieldName		string	Nazwa pola
Wartość pola formularza (29)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (30)	fieldName		string	Nazwa pola
Wartość pola formularza (30)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (31)	fieldName		string	Nazwa pola
Wartość pola formularza (31)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (32)	fieldName		string	Nazwa pola
Wartość pola formularza (32)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (33)	fieldName		string	Nazwa pola
Wartość pola formularza (33)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (34)	fieldName		string	Nazwa pola
Wartość pola formularza (34)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (35)	fieldName		string	Nazwa pola
Wartość pola formularza (35)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (36)	fieldName		string	Nazwa pola
Wartość pola formularza (36)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (37)	fieldName		string	Nazwa pola
Wartość pola formularza (37)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (38)	fieldName		string	Nazwa pola
Wartość pola formularza (38)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (39)	fieldName		string	Nazwa pola
Wartość pola formularza (39)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (40)	fieldName		string	Nazwa pola
Wartość pola formularza (40)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (41)	fieldName		string	Nazwa pola
Wartość pola formularza (41)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (42)	fieldName		string	Nazwa pola
Wartość pola formularza (42)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (43)	fieldName		string	Nazwa pola
Wartość pola formularza (43)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (44)	fieldName		string	Nazwa pola
Wartość pola formularza (44)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (45)	fieldName		string	Nazwa pola
Wartość pola formularza (45)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (46)	fieldName		string	Nazwa pola
Wartość pola formularza (46)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (47)	fieldName		string	Nazwa pola
Wartość pola formularza (47)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (48)	fieldName		string	Nazwa pola
Wartość pola formularza (48)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (49)	fieldName		string	Nazwa pola
Wartość pola formularza (49)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (50)	fieldName		string	Nazwa pola
Wartość pola formularza (50)	defaultValue		string	Wartość domyślna pola

Zwraca

Kod JSON zawierający identyfikator nowo utworzonej umowy

Body: AgreementCreationResponse

Utwórz umowę na podstawie przekazanego dokumentu i wyślij do podpisu (stary) [PRZESTARZAŁE]

Identyfikator operacji:: CreateAgreementById

Ta operacja tworzy umowę na podstawie dokumentu przekazanego w programie Adobe Acrobat Sign i wysyła ją do podpisu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa umowy	name	True	string	Nazwa umowy
Identyfikator dokumentu	transientDocumentId	True	string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Typ podpisu	signatureType	True	string	Typ podpisu, którego chcesz zażądać — podpis e-podpis lub zapis
Adres e-mail adresata	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata	recipientSetRole	True	string	Określanie roli adresata
Message	message		string	Opcjonalna wiadomość do adresatów żądających ich akcji
Dni do terminu ostatecznego	daysUntilSigningDeadline		integer	Liczba dni pozostałych przed wygaśnięciem dokumentu
Częstotliwość przypomnienia	reminderFrequency		string	Jak często chcesz wysyłać przypomnienia?
Hasło dokumentu	openPassword		string	Hasło, które powinno być używane do szyfrowania podpisanej umowy PDF
Identyfikator dokumentu (2)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (3)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (4)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (5)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (6)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (7)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (8)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (9)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Identyfikator dokumentu (10)	transientDocumentId		string	Identyfikator dokumentu odebrany przez przekazanie dokumentu
Adres e-mail adresata (2)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (2)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (2)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (3)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (3)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (3)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (4)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (4)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (4)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (5)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (5)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (5)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (6)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (6)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (6)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (7)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (7)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (7)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (8)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (8)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (8)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (9)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (9)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (9)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (10)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (10)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (10)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (11)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (11)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (11)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (12)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (12)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (12)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (13)	email	True	string	Adres e-mail odbiorcy
Zamówienie podpisania adresata (13)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (13)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (14)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (14)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (14)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (15)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (15)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (15)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (16)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (16)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (16)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail odbiorcy (17)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (17)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (17)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail odbiorcy (18)	email	True	string	Adres e-mail odbiorcy
Zamówienie podpisania adresata (18)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (18)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (19)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (19)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (19)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (20)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (20)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (20)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (21)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (21)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (21)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (22)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (22)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (22)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (23)	email	True	string	Adres e-mail odbiorcy
Zamówienie podpisania adresata (23)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (23)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (24)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (24)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (24)	recipientSetRole	True	string	Określanie roli adresata
Adres e-mail adresata (25)	email	True	string	Adres e-mail odbiorcy
Kolejność podpisywania adresata (25)	signingOrder	True	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Rola adresata (25)	recipientSetRole	True	string	Określanie roli adresata
Nazwa pola formularza (1)	fieldName		string	Nazwa pola
Wartość pola formularza (1)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (2)	fieldName		string	Nazwa pola
Wartość pola formularza (2)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (3)	fieldName		string	Nazwa pola
Wartość pola formularza (3)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (4)	fieldName		string	Nazwa pola
Wartość pola formularza (4)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (5)	fieldName		string	Nazwa pola
Wartość pola formularza (5)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (6)	fieldName		string	Nazwa pola
Wartość pola formularza (6)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (7)	fieldName		string	Nazwa pola
Wartość pola formularza (7)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (8)	fieldName		string	Nazwa pola
Wartość pola formularza (8)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (9)	fieldName		string	Nazwa pola
Wartość pola formularza (9)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (10)	fieldName		string	Nazwa pola
Wartość pola formularza (10)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (11)	fieldName		string	Nazwa pola
Wartość pola formularza (11)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (12)	fieldName		string	Nazwa pola
Wartość pola formularza (12)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (13)	fieldName		string	Nazwa pola
Wartość pola formularza (13)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (14)	fieldName		string	Nazwa pola
Wartość pola formularza (14)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (15)	fieldName		string	Nazwa pola
Wartość pola formularza (15)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (16)	fieldName		string	Nazwa pola
Wartość pola formularza (16)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (17)	fieldName		string	Nazwa pola
Wartość pola formularza (17)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (18)	fieldName		string	Nazwa pola
Wartość pola formularza (18)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (19)	fieldName		string	Nazwa pola
Wartość pola formularza (19)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (20)	fieldName		string	Nazwa pola
Wartość pola formularza (20)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (21)	fieldName		string	Nazwa pola
Wartość pola formularza (21)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (22)	fieldName		string	Nazwa pola
Wartość pola formularza (22)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (23)	fieldName		string	Nazwa pola
Wartość pola formularza (23)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (24)	fieldName		string	Nazwa pola
Wartość pola formularza (24)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (25)	fieldName		string	Nazwa pola
Wartość pola formularza (25)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (26)	fieldName		string	Nazwa pola
Wartość pola formularza (26)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (27)	fieldName		string	Nazwa pola
Wartość pola formularza (27)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (28)	fieldName		string	Nazwa pola
Wartość pola formularza (28)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (29)	fieldName		string	Nazwa pola
Wartość pola formularza (29)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (30)	fieldName		string	Nazwa pola
Wartość pola formularza (30)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (31)	fieldName		string	Nazwa pola
Wartość pola formularza (31)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (32)	fieldName		string	Nazwa pola
Wartość pola formularza (32)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (33)	fieldName		string	Nazwa pola
Wartość pola formularza (33)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (34)	fieldName		string	Nazwa pola
Wartość pola formularza (34)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (35)	fieldName		string	Nazwa pola
Wartość pola formularza (35)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (36)	fieldName		string	Nazwa pola
Wartość pola formularza (36)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (37)	fieldName		string	Nazwa pola
Wartość pola formularza (37)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (38)	fieldName		string	Nazwa pola
Wartość pola formularza (38)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (39)	fieldName		string	Nazwa pola
Wartość pola formularza (39)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (40)	fieldName		string	Nazwa pola
Wartość pola formularza (40)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (41)	fieldName		string	Nazwa pola
Wartość pola formularza (41)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (42)	fieldName		string	Nazwa pola
Wartość pola formularza (42)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (43)	fieldName		string	Nazwa pola
Wartość pola formularza (43)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (44)	fieldName		string	Nazwa pola
Wartość pola formularza (44)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (45)	fieldName		string	Nazwa pola
Wartość pola formularza (45)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (46)	fieldName		string	Nazwa pola
Wartość pola formularza (46)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (47)	fieldName		string	Nazwa pola
Wartość pola formularza (47)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (48)	fieldName		string	Nazwa pola
Wartość pola formularza (48)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (49)	fieldName		string	Nazwa pola
Wartość pola formularza (49)	defaultValue		string	Wartość domyślna pola
Nazwa pola formularza (50)	fieldName		string	Nazwa pola
Wartość pola formularza (50)	defaultValue		string	Wartość domyślna pola

Zwraca

Kod JSON zawierający identyfikator nowo utworzonej umowy

Body: AgreementCreationResponse

Uzyskiwanie adresu URL widoku umowy

Identyfikator operacji:: PostAgreementViews

Pobiera najnowszy adres URL widoku stanu umowy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której informacje są potrzebne
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa widoku	name	True	string	Nazwa żądanego widoku umowy
Automatyczne logowanie	autoLoginUser		boolean	Jeśli wartość true, zwrócony adres URL automatycznie zarejestruje użytkownika w
Brak flagi chrome	noChrome		boolean	Jeśli wartość true, osadzona strona jest wyświetlana bez nagłówka lub stopki
Ramka nadrzędna	frameParent		string	rozdzielona przecinkami lista adresów URL domeny, w których adresy URL mogą być elementami iframe

Zwraca

Lista widoków umów

Body: AgreementViews

Uzyskiwanie stanu umowy

Identyfikator operacji:: GetAgreementInfo_V2

Ta operacja pobiera wszystkie bieżące informacje o umowie, takie jak stan.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której informacje są potrzebne
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com

Zwraca

Szczegóły pełnej umowy

Body: AgreementInfoV6

Uzyskiwanie stanu umowy [PRZESTARZAŁE]

Identyfikator operacji:: GetAgreementInfo

Ta akcja została przestarzała. Zamiast tego użyj pozycji Pobierz stan umowy .

~~Ta operacja pobiera wszystkie bieżące informacje o umowie, takie jak stan.~~

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator umowy	agreementId	True	string	Identyfikator umowy, której informacje są potrzebne

Zwraca

Pełne szczegóły umowy

Body: AgreementInfo

Uzyskiwanie szczegółowych informacji o przepływie pracy

Identyfikator operacji:: GetWorkflowInfo

Ta operacja pobiera szczegółowe informacje o przepływie pracy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator przepływu pracy	workflowId	True	string	Identyfikator przepływu pracy przepływu pracy, którego informacje są potrzebne
W nazwie	x-api-user		string	Adres e-mail obiektu wywołującego interfejs API w formacie: wiadomość e-mail:adobesignuser@domain.com
Nazwa/identyfikator grupy	groupId		string	Identyfikator grupy. Aby użyć tego — należy wybrać pole "W nazwie of"

Zwraca

Kod JSON zawierający szczegółowe informacje o przepływie pracy

Body: WorkflowDescriptionV6

Wyzwalacze

Gdy stan umowy ulegnie zmianie	Wyzwala nowy przepływ, gdy stan umowy ulegnie zmianie. Obejmuje najbardziej typowe zdarzenia umowy, takie jak tworzenie, uzupełnianie itp.
Gdy wystąpi zdarzenie	Wyzwala nowy przepływ po wystąpieniu zdarzenia. Obejmuje wszystkie zdarzenia Umowy, Mega Sign i Formularza internetowego.
Gdy wystąpi zdarzenie grupy	Wyzwala nowy przepływ po wystąpieniu zdarzenia grupy. Obejmuje wszystkie zdarzenia Umowy, Mega Sign i Formularza internetowego.
Gdy wystąpi zdarzenie umowy formularza internetowego	Wyzwala nowy przepływ po wystąpieniu zdarzenia umowy formularza internetowego. Obejmuje najbardziej typowe zdarzenia umowy, takie jak tworzenie, uzupełnianie itp.
Po pomyślnym zakończeniu przepływu pracy umowy	Wyzwala nowy przepływ po pomyślnym ukończeniu przepływu pracy umowy
Po utworzeniu nowej umowy	Wyzwala nowy przepływ po utworzeniu nowej umowy.
Po wysłaniu umowy do uczestnika	Wyzwala nowy przepływ po wysłaniu umowy do uczestnika.

Gdy stan umowy ulegnie zmianie

Identyfikator operacji:: CreateWebhookForAgreementStatusUpdated

Wyzwala nowy przepływ, gdy stan umowy ulegnie zmianie. Obejmuje najbardziej typowe zdarzenia umowy, takie jak tworzenie, uzupełnianie itp.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa wyzwalacza
Scope	scope	True	string	Zakres wyzwalacza
Nazwa/identyfikator umowy	resourceId		string	Określ tylko wtedy, gdy wartość "Zakres" to "Określona umowa". Wybierz umowę z listy lub wprowadź identyfikator umowy.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Zdarzenia, dla których powinien zostać wyzwolony przepływ
Uwzględnij informacje o umowie?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o umowie?
Uwzględnij informacje o uczestnikach umowy?	includeParticipantsInfo		boolean	Czy informacje o uczestnikach umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o dokumencie umowy?	includeDocumentsInfo		boolean	Czy informacje o dokumencie umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o podpisanym dokumencie umowy?	includeSignedDocuments		boolean	Czy ostateczna kopia podpisanego dokumentu powinna zostać wysłana w powiadomieniu o zakończeniu umowy?

Zwraca

Body: WebhookPayloadWithSignedDocumentForStatusChange

Gdy wystąpi zdarzenie

Identyfikator operacji:: CreateWebhookGeneric

Wyzwala nowy przepływ po wystąpieniu zdarzenia. Obejmuje wszystkie zdarzenia Umowy, Mega Sign i Formularza internetowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa wyzwalacza
Scope	scope	True	string	Zakres wyzwalacza
Typ zasobu	resourceType		string	Określ tylko wtedy, gdy wartość "Zakres" to "Określony zasób". Wybierz typ zasobu, dla którego powinien zostać wyzwolony przepływ.
Identyfikator zasobu	resourceId		string	Określ tylko wtedy, gdy wartość "Zakres" to "Określony zasób". Wprowadź umowę lub mega podpis lub formularz internetowy lub identyfikator grupy, dla którego powinien zostać wyzwolony przepływ.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Zdarzenia, dla których powinien zostać wyzwolony przepływ
Uwzględnij informacje o umowie?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o umowie?
Uwzględnij informacje o uczestnikach umowy?	includeParticipantsInfo		boolean	Czy informacje o uczestnikach umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o dokumencie umowy?	includeDocumentsInfo		boolean	Czy informacje o dokumencie umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o podpisanym dokumencie umowy?	includeSignedDocuments		boolean	Czy ostateczna kopia podpisanego dokumentu po zakończeniu umowy powinna zostać wysłana w powiadomieniu?
Uwzględnij informacje o megasign?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o znakach mega?
Dołącz informacje o formularzu sieci Web?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o formularzu internetowym?
Uwzględnij informacje o uczestnikach formularza internetowego?	includeParticipantsInfo		boolean	Czy informacje o uczestnikach formularza internetowego powinny być wysyłane w powiadomieniu?
Dołącz informacje o dokumentach formularza sieci Web?	includeDocumentsInfo		boolean	Czy informacje o dokumencie formularza internetowego powinny być wysyłane w powiadomieniu?

Zwraca

Body: WebhookPayloadGeneric

Gdy wystąpi zdarzenie grupy

Identyfikator operacji:: CreateWebhookForGroupEvent

Wyzwala nowy przepływ po wystąpieniu zdarzenia grupy. Obejmuje wszystkie zdarzenia Umowy, Mega Sign i Formularza internetowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa wyzwalacza
Nazwa/identyfikator grupy	resourceId		string	Identyfikator grupy
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Zdarzenia, dla których powinien zostać wyzwolony przepływ
Uwzględnij informacje o umowie?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o umowie?
Uwzględnij informacje o uczestnikach umowy?	includeParticipantsInfo		boolean	Czy informacje o uczestnikach umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o dokumencie umowy?	includeDocumentsInfo		boolean	Czy informacje o dokumencie umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o podpisanym dokumencie umowy?	includeSignedDocuments		boolean	Czy ostateczna kopia podpisanego dokumentu po zakończeniu umowy powinna zostać wysłana w powiadomieniu?
Uwzględnij informacje o megasign?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o znakach mega?
Dołącz informacje o formularzu sieci Web?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o formularzu internetowym?
Uwzględnij informacje o uczestnikach formularza internetowego?	includeParticipantsInfo		boolean	Czy informacje o uczestnikach formularza internetowego powinny być wysyłane w powiadomieniu?
Dołącz informacje o dokumentach formularza sieci Web?	includeDocumentsInfo		boolean	Czy informacje o dokumencie formularza internetowego powinny być wysyłane w powiadomieniu?

Zwraca

Body: GroupWebhookEventPayload

Gdy wystąpi zdarzenie umowy formularza internetowego

Identyfikator operacji:: CreateWebhookForWebFormAgreementEvent

Wyzwala nowy przepływ po wystąpieniu zdarzenia umowy formularza internetowego. Obejmuje najbardziej typowe zdarzenia umowy, takie jak tworzenie, uzupełnianie itp.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa wyzwalacza
Rozmiar strony formularzy sieci Web	pageSize		integer	Wybierz liczbę formularzy internetowych do wyświetlenia na liście rozwijanej
Nazwa/identyfikator formularza sieci Web	resourceId	True	string	Wybierz formularz internetowy z listy lub wprowadź identyfikator formularza internetowego.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Zdarzenia, dla których powinien zostać wyzwolony przepływ
Uwzględnij informacje o umowie?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o umowie?
Uwzględnij informacje o uczestnikach umowy?	includeParticipantsInfo		boolean	Czy informacje o uczestnikach umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o dokumencie umowy?	includeDocumentsInfo		boolean	Czy informacje o dokumencie umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o podpisanym dokumencie umowy?	includeSignedDocuments		boolean	Czy ostateczna kopia podpisanego dokumentu powinna zostać wysłana w powiadomieniu o zakończeniu umowy?

Zwraca

Body: WebFormWebhookAgreementEventPayload

Po pomyślnym zakończeniu przepływu pracy umowy

Identyfikator operacji:: CreateWebhookForAgreementSignedEvent

Wyzwala nowy przepływ po pomyślnym ukończeniu przepływu pracy umowy

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa wyzwalacza
Scope	scope	True	string	Zakres wyzwalacza
Nazwa/identyfikator umowy	resourceId		string	Określ tylko wtedy, gdy wartość "Zakres" to "Określona umowa". Wybierz umowę z listy lub wprowadź identyfikator umowy.
Subscription	webhookSubscriptionEvents	True	array of string	Zdarzenia, dla których powinien zostać wyzwolony przepływ
Uwzględnij informacje o umowie?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o umowie?
Uwzględnij informacje o uczestnikach umowy?	includeParticipantsInfo		boolean	Czy informacje o uczestnikach umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o dokumencie umowy?	includeDocumentsInfo		boolean	Czy informacje o dokumencie umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o podpisanym dokumencie umowy?	includeSignedDocuments		boolean	Czy ostateczna kopia podpisanego dokumentu po zakończeniu umowy powinna zostać wysłana w powiadomieniu?

Zwraca

Body: WebhookPayloadWithSignedDocument

Po utworzeniu nowej umowy

Identyfikator operacji:: CreateWebhookForAgreementCreatedEvent

Wyzwala nowy przepływ po utworzeniu nowej umowy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa wyzwalacza
Scope	scope	True	string	Zakres wyzwalacza
Subscription	webhookSubscriptionEvents	True	array of string	Zdarzenia, dla których powinien zostać wyzwolony przepływ
Uwzględnij informacje o umowie?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o umowie?
Uwzględnij informacje o uczestnikach umowy?	includeParticipantsInfo		boolean	Czy informacje o uczestnikach umowy powinny być wysyłane w powiadomieniu?

Zwraca

Body: WebhookPayloadWithoutNextParticipantSet

Po wysłaniu umowy do uczestnika

Identyfikator operacji:: CreateWebhookForAgreementSignatureRequestedEvent

Wyzwala nowy przepływ po wysłaniu umowy do uczestnika.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa wyzwalacza
Scope	scope	True	string	Zakres wyzwalacza
Nazwa/identyfikator umowy	resourceId		string	Określ tylko wtedy, gdy wartość "Zakres" to "Określona umowa". Wybierz umowę z listy lub wprowadź identyfikator umowy.
Subscription	webhookSubscriptionEvents	True	array of string	Zdarzenia, dla których powinien zostać wyzwolony przepływ
Uwzględnij informacje o umowie?	includeDetailedInfo		boolean	Czy w powiadomieniu powinny być wysyłane szczegółowe informacje o umowie?
Uwzględnij informacje o uczestnikach umowy?	includeParticipantsInfo		boolean	Czy informacje o uczestnikach umowy powinny być wysyłane w powiadomieniu?
Uwzględnij informacje o dokumencie umowy?	includeDocumentsInfo		boolean	Czy informacje o dokumencie umowy powinny być wysyłane w powiadomieniu?

Zwraca

Body: WebhookPayload

Definicje

AgreementCreationResponse

Kod JSON zawierający identyfikator nowo utworzonej umowy

Nazwa	Ścieżka	Typ	Opis
Identyfikator umowy	agreementId	string	Unikatowy identyfikator umowy, który może służyć do wykonywania zapytań o stan i pobierania podpisanych dokumentów

AgreementCreationResponseV6

Kod JSON zawierający identyfikator nowo utworzonej umowy

Nazwa	Ścieżka	Typ	Opis
Identyfikator umowy	id	string	Unikatowy identyfikator umowy, który może służyć do wykonywania zapytań o stan i pobierania podpisanych dokumentów

AgreementDocuments

Kod JSON zawierający zarówno dokumenty, jak i obiekty tablicowe dokumentów pomocniczych

Nazwa	Ścieżka	Typ	Opis
Documents	documents	array of Document	Lista obiektów reprezentujących dokumenty
Dokumenty pomocnicze	supportingDocuments	array of SupportingDocument	Lista dokumentów pomocniczych. Jest to zwracane tylko wtedy, gdy w umowie znajdują się jakiekolwiek dokumenty pomocnicze

AgreementDocumentsV6

Kod JSON zawierający zarówno dokumenty, jak i obiekty tablicowe dokumentów pomocniczych

Nazwa	Ścieżka	Typ	Opis
Documents	documents	array of DocumentV6	Lista obiektów reprezentujących dokumenty
Dokumenty pomocnicze	supportingDocuments	array of SupportingDocumentV6	Lista dokumentów pomocniczych. Jest to zwracane tylko wtedy, gdy w umowie znajdują się jakiekolwiek dokumenty pomocnicze

Informacje o umowie

Pełne szczegóły umowy

Nazwa	Ścieżka	Typ	Opis
Identyfikator umowy	agreementId	string	Unikatowy identyfikator, który może służyć do unikatowego identyfikowania umowy
Events	events	array of DocumentHistoryEvent	Uporządkowana lista zdarzeń w dzienniku inspekcji tego dokumentu
Data wygaśnięcia	expiration	date	Data, po której nie można już podpisać umowy
Identyfikator najnowszej wersji	latestVersionId	string	Unikatowy identyfikator, który jednoznacznie identyfikuje bieżącą wersję umowy
Message	message	string	Komunikat skojarzony z umową podaną przez nadawcę
Nazwa umowy	name	string	Nazwa umowy określona przez nadawcę
Następne zestawy uczestników	nextParticipantSetInfos	array of NextParticipantSetInfo	Informacje o tym, kto musi działać dalej w tej umowie
Zestawy uczestników	participantSetInfos	array of ParticipantSetInfo	Informacje o wszystkich zestawach uczestników tego dokumentu
Typ podpisu	signatureType	string	Określa żądany typ podpisu — podpis e-podpis lub zapis
Ochrona dokumentów	securityOptions	string	Informacje o zabezpieczeniach dokumentu określające, czy hasło jest wymagane do wyświetlenia i podpisania go
Status	status	string	Bieżący stan umowy

AgreementInfoV6

Szczegóły pełnej umowy

Nazwa	Ścieżka	Typ	Opis
Identyfikator umowy	id	string	Unikatowy identyfikator, który może służyć do unikatowego identyfikowania umowy
Data utworzenia	createdDate	date	Data utworzenia umowy
Opóźnienie pierwszego przypomnienia	firstReminderDelay	integer	Liczba całkowita określająca opóźnienie w godzinach przed wysłaniem pierwszego przypomnienia.
Częstotliwość przypomnienia	reminderFrequency	string	Jak często chcesz wysyłać przypomnienia?
Data wygaśnięcia	expiration	date	Data, po której nie można już podpisać umowy
Lokalizacja	locale	string	Ustawienia regionalne skojarzone z tą umową — na przykład en_US lub fr_FR
Message	message	string	Komunikat skojarzony z umową podaną przez nadawcę
Nazwa umowy	name	string	Nazwa umowy określona przez nadawcę
Widoczność dokumentu?	documentVisibilityEnabled	boolean	Czy widoczność dokumentu jest włączona?
Zestawy uczestników	participantSetsInfo	array of ParticipantSetInfoV6	Informacje o wszystkich zestawach uczestników tego dokumentu
Typ podpisu	signatureType	string	Określa żądany typ podpisu — podpis e-podpis lub zapis
Opcje zabezpieczeń	securityOptions	string	Informacje o zabezpieczeniach dokumentu określające, czy hasło jest wymagane do wyświetlenia i podpisania go
Status	status	string	Bieżący stan umowy
Adres e-mail nadawcy	senderEmail	string	Wiadomość e-mail nadawcy
Identyfikator przepływu pracy	workflowId	string	Identyfikator niestandardowego przepływu pracy, który definiuje ścieżkę routingu umowy.
Ccs	ccs	array of CcInfo	Lista co najmniej jednego CC, który zostanie skopiowany w transakcji umowy.
Identyfikator grupy	groupId	string	Unikatowy identyfikator grupy, do której należy umowa.

CombinedDocumentResponse

Strumień plików dokumentu

Zawartość pliku: binary

AgreementAuditTrailResponse

Strumień plików dziennika inspekcji umowy

Zawartość dziennika inspekcji umowy: binary

DisplayUserInfo

Nazwa	Ścieżka	Typ	Opis
Firma	company	string	Wyświetla nazwę firmy użytkownika, jeśli jest dostępna
Email	email	string	Wyświetla adres e-mail użytkownika
Pełna nazwa	fullName	string	Wyświetla pełną nazwę użytkownika, jeśli jest dostępny.

DisplayUserSetInfo

Nazwa	Ścieżka	Typ	Opis
Wyświetlanie informacji o zestawie użytkowników	displayUserSetMemberInfos	array of DisplayUserInfo	Wyświetla informacje o zestawie użytkowników
Wyświetl nazwę zestawu użytkowników	displayUserSetName	string

Dokument

Informacje o dokumencie

Nazwa	Ścieżka	Typ	Opis
Identyfikator dokumentu	documentId	string	Unikatowy identyfikator dokumentu
Typ mime	mimeType	string	Typ mime dokumentu
Name	name	string	Nazwa dokumentu
Liczba stron	numPages	integer	Liczba stron w dokumencie

DocumentV6

Informacje o dokumencie

Nazwa	Ścieżka	Typ	Opis
Identyfikator dokumentu	id	string	Unikatowy identyfikator dokumentu
Typ mime	mimeType	string	Typ mime dokumentu
Name	name	string	Nazwa dokumentu
Liczba stron	numPages	integer	Liczba stron w dokumencie

DocumentHistoryEvent

Nazwa	Ścieżka	Typ	Opis
Inicjator zdarzeń	actingUserEmail	string	Adres e-mail użytkownika, który zainicjował zdarzenie
Data zdarzenia	date	date	Data zdarzenia inspekcji
Opis wydarzenia	description	string	Opis zdarzenia inspekcji
Adres e-mail uczestnika	participantEmail	string	Adres e-mail użytkownika, który zainicjował zdarzenie
Typ zdarzenia	type	string	Typ zdarzenia umowy

DocumentLibraryItem

Nazwa	Ścieżka	Typ	Opis
Identyfikator szablonu biblioteki	libraryDocumentId	string	Unikatowy identyfikator dokumentu biblioteki używany podczas wysyłania dokumentu do podpisania
Typy szablonów biblioteki	libraryTemplateTypes	array of string	Lista co najmniej jednego typu szablonu biblioteki
Data modyfikacji	modifiedDate	date	Dzień ostatniej modyfikacji szablonu biblioteki
Nazwa szablonu biblioteki	name	string	Nazwa szablonu biblioteki
Tryb udostępniania szablonu	scope	string	Zakres widoczności szablonu biblioteki

DocumentLibraryItems

Kod JSON zawierający obiekt tablicy szablonów biblioteki

Nazwa	Ścieżka	Typ	Opis
Lista szablonów bibliotek	libraryDocumentList	array of DocumentLibraryItem	Lista elementów szablonu biblioteki

DocumentResponse

Strumień plików dokumentu

Zawartość pliku: binary

LibraryDocumentCreationResponse

Obiekt JSON opisujący szablon biblioteki

Nazwa	Ścieżka	Typ	Opis
Identyfikator szablonu biblioteki	libraryDocumentId	string	Unikatowy identyfikator, którego można użyć do odwoływania się do szablonu biblioteki

NextParticipantInfo

Nazwa	Ścieżka	Typ	Opis
Email	email	string	Adres e-mail następnego uczestnika
Name	name	string	Nazwa następnego uczestnika, jeśli jest dostępna
Oczekiwanie od	waitingSince	date	Data, od której dokument czeka na podjęcie działań przez uczestnika

NextParticipantSetInfo

Nazwa	Ścieżka	Typ	Opis
Informacje o elemencie członkowskim zestawu następnych uczestników	nextParticipantSetMemberInfos	array of NextParticipantInfo	Informacje o członkach następnego zestawu uczestników

Informacje o uczestnikach

Nazwa	Ścieżka	Typ	Opis
Firma	company	string	Firma uczestnika, jeśli jest dostępna
Email	email	string	Adres e-mail uczestnika
Name	name	string	Nazwa uczestnika, jeśli jest dostępna
Identyfikator uczestnika	participantId	string	Unikatowy identyfikator uczestnika
Opcje zabezpieczeń	securityOptions	array of string	Opcje zabezpieczeń, które mają zastosowanie do uczestnika
Title	title	string	Tytuł uczestnika, jeśli jest dostępny

Informacje o uczestniku

Nazwa	Ścieżka	Typ	Opis
Identyfikator zestawu uczestników	participantSetId	string	Unikatowy identyfikator zestawu uczestników
Informacje o elemencie członkowskim zestawu uczestników	participantSetMemberInfos	array of ParticipantInfo	Informacje o członkach zestawu adresatów
Wiadomość prywatna	privateMessage	string	Prywatna wiadomość dla uczestników w zestawie
Role	roles	array of string	Bieżące role zestawu uczestników. Zestaw uczestników może mieć co najmniej jedną rolę
securityOptions	securityOptions	array of string	Opcje zabezpieczeń, które mają zastosowanie do uczestnika
Kolejność podpisywania	signingOrder	integer	Indeks rozpoczynający się od 1, który informuje kolejność, w której ten odbiorca podpisuje
Stan zestawu uczestników	status	string	Stan zestawu uczestników w odniesieniu do dokumentu

UczestnikSetInfoV6

Nazwa	Ścieżka	Typ	Opis
Informacje o elemencie członkowskim zestawu uczestników	memberInfos	array of MemberInfosV6	Informacje o członkach zestawu adresatów
Zamówienie	order	integer	Indeks wskazujący pozycję, w której grupa podpisywania musi się podpisać.
Role	role	string	Bieżące role zestawu uczestników (osoba podpisjąca, osoba zatwierdzająca itp.).
Nazwa zestawu uczestników	name	string	Nazwa zestawu uczestników
Zestaw prywatnych bałaganów dla uczestników	privateMessage	string	Prywatna wiadomość dla uczestników w zestawie
Zestaw widocznych stron uczestnika	visiblePages	array of string	Strony widoczne dla zestawu uczestników

MemberInfosV6

Nazwa	Ścieżka	Typ	Opis
Email	email	string	Wiadomość e-mail uczestnika
Authentication	securityOption.authenticationMethod	string	Uwierzytelnianie domyślne: wiadomość e-mail (brak)
Hasło	securityOption.password	string	Hasło wymagane dla uczestnika
Kod kraju	securityOption.phoneInfo.countryCode	string	Kod kraju odbiorcy wymagany do wyświetlania i podpisywania dokumentu
Numer telefonu.	securityOption.phoneInfo.phone	string	Numer telefonu odbiorcy wymagany do wyświetlenia i podpisania umowy
Identyfikator dostawcy	securityOption.digAuthInfo.providerId	string	Identyfikator dostawcy usługi Digital Identity Gateway.

SigningUrl

Nazwa	Ścieżka	Typ	Opis
Adres e-mail dotyczący adresu URL podpisywania	email	string	Adres e-mail sygnatariusza skojarzony z tym adresem URL podpisywania
Adres URL podpisywania	esignUrl	string	Adres URL sygnatariusza skojarzonego z tym adresem URL podpisywania

SigningUrlResponse

Nazwa	Ścieżka	Typ	Opis
Tablica adresów URL zestawów osób podpisujących	signingUrlSetInfos	array of SigningUrlSetInfo	Tablica adresów URL zestawów osób podpisujących zaangażowanych w niniejszą umowę

SigningUrlSetInfo

Nazwa	Ścieżka	Typ	Opis
- Tablica adresów URL podpisywania	signingUrls	array of SigningUrl	Tablica adresów URL dla bieżącego zestawu osób podpisujących
— Nazwa zestawu adresów URL podpisywania	signingUrlSetName	string	Nazwa bieżącego zestawu podpisów

Obsługa dokumentu

Informacje o dokumencie pomocniczym

Nazwa	Ścieżka	Typ	Opis
Nazwa dokumentu pomocniczego	displayLabel	string	Nazwa wyświetlana dokumentu pomocniczego
Nazwa pola dokumentu pomocniczego	fieldName	string	Nazwa pola dokumentu pomocniczego
Obsługa typu mime dokumentu	mimeType	string	Typ mime dokumentu pomocniczego
Strony dokumentów pomocniczych	numPages	integer	Liczba stron w dokumencie pomocniczym
Identyfikator dokumentu pomocniczego	supportingDocumentId	string	Unikatowy identyfikator reprezentujący dokument pomocniczy

Obsługa dokumentuV6

Informacje o dokumencie pomocniczym

Nazwa	Ścieżka	Typ	Opis
Nazwa dokumentu pomocniczego	displayLabel	string	Nazwa wyświetlana dokumentu pomocniczego
Nazwa pola dokumentu pomocniczego	fieldName	string	Nazwa pola dokumentu pomocniczego
Obsługa typu mime dokumentu	mimeType	string	Typ mime dokumentu pomocniczego
Strony dokumentów pomocniczych	numPages	integer	Liczba stron w dokumencie pomocniczym
Identyfikator dokumentu pomocniczego	id	string	Unikatowy identyfikator reprezentujący dokument pomocniczy

TransientDocumentResponse

Kod JSON zawierający identyfikator przekazanego dokumentu

Nazwa	Ścieżka	Typ	Opis
Identyfikator dokumentu	transientDocumentId	string	Identyfikator przekazanego dokumentu

UserAgreement

Nazwa	Ścieżka	Typ	Opis
Identyfikator umowy	agreementId	string	Unikatowy identyfikator, który może służyć do unikatowego identyfikowania umowy
Wyświetlanie informacji o zestawie użytkowników	displayUserSetInfos	array of DisplayUserSetInfo	Najbardziej odpowiedni bieżący użytkownik ustawiony dla umowy. Zazwyczaj jest to następny sygnatariusz, jeśli umowa pochodzi od bieżącego użytkownika lub nadawcy, jeśli otrzymasz od innego użytkownika
Data wyświetlania	displayDate	date	Data wyświetlania umowy
Esign	esign	boolean	Prawda, jeśli jest to dokument z podpisem e-sign
Identyfikator najnowszej wersji	latestVersionId	string	Identyfikator wersji, który jednoznacznie identyfikuje bieżącą wersję umowy
Name	name	string	Nazwa umowy
Status	status	string	Bieżący stan umowy

UserAgreements

Kod JSON zawierający obiekt tablicy umowy użytkownika

Nazwa	Ścieżka	Typ	Opis
Lista umów	userAgreementList	array of UserAgreement	Tablica elementów umowy

UserAgreementV6

Nazwa	Ścieżka	Typ	Opis
Wyświetlanie informacji o zestawie użytkowników	displayParticipantSetInfos	array of DisplayUserSetInfo	Najbardziej odpowiedni bieżący użytkownik ustawiony dla umowy. Zazwyczaj jest to następny sygnatariusz, jeśli umowa pochodzi od bieżącego użytkownika lub nadawcy, jeśli otrzymasz od innego użytkownika
Data wyświetlania	displayDate	string	Data wyświetlania umowy
Esign	esign	boolean	Prawda, jeśli jest to dokument z podpisem e-sign
Ukryty	hidden	boolean	Prawda, jeśli umowa jest ukryta dla użytkownika
Identyfikator grupy	groupId	string	Unikatowy identyfikator grupy
Identyfikator najnowszej wersji	latestVersionId	string	Identyfikator wersji, który jednoznacznie identyfikuje bieżącą wersję umowy
Name	name	string	Nazwa umowy
Identyfikator nadrzędny	parentId	string	Identyfikator nadrzędny elementu podrzędnego megaSign LUB identyfikator źródłowy wystąpienia umowy internetowej
Identyfikator umowy	id	string	Unikatowy identyfikator umowy
Status	status	string	Bieżący stan umowy
Typ	type	string	Rodzaj umowy

userAgreementListV6

Kod JSON zawierający obiekt tablicy umowy użytkownika

Nazwa	Ścieżka	Typ	Opis
page	page	page	Informacje o stronicowaniu na potrzeby nawigowania po odpowiedzi
Lista umów	userAgreementList	array of UserAgreementV6	Tablica elementów umowy

page

Informacje o stronicowaniu na potrzeby nawigowania po odpowiedzi

Nazwa	Ścieżka	Typ	Opis
nextCursor	nextCursor	string	Służy do przechodzenia do następnej strony. Jeśli nie zostaną zwrócone, nie ma żadnych dalszych stron.

WebhookPayload

Nazwa	Ścieżka	Typ	Opis
Event	event	string	Zdarzenie, które wystąpiło w zasobie.
Data zdarzenia	eventDate	date	Data zdarzenia. Formatem będzie rrrr-MM-dd'T'HH:mm:ssZ. Na przykład 2016-02-25T18:46:19Z reprezentuje czas UTC
Typ zasobu zdarzenia	eventResourceType	string	Zasób, na którym wystąpiło zdarzenie.
Typ nadrzędny umowy	eventResourceParentType	string	Informacje o zasobie, z którego jest tworzona umowa. Możliwe wartości: Formularz internetowy lub Mega Znak
Identyfikator nadrzędny umowy	eventResourceParentId	string	Unikatowy identyfikator zasobu, z którego utworzono tę umowę
Rola uczestnika zdarzenia	participantRole	string	Rola uczestnika wydarzenia.
Identyfikator uczestnika zdarzenia	participantUserId	string	Identyfikator uczestnika wydarzenia.
Wiadomość e-mail uczestnika zdarzenia	participantUserEmail	string	Adres e-mail uczestnika wydarzenia.
Zdarzenie pełniące rolę identyfikatora użytkownika	actingUserId	string	Identyfikator użytkownika, który utworzył zdarzenie.
Wiadomość e-mail użytkownika działająca na zdarzeniach	actingUserEmail	string	Adres e-mail użytkownika, który utworzył zdarzenie.
Zdarzenie działające pod adresem IP użytkownika	actingUserIpAddress	string	Adres IP użytkownika, który utworzył zdarzenie
Zdarzenie inicjujące identyfikator użytkownika	initiatingUserId	string	Identyfikator użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika.
Zdarzenie inicjujące wiadomość e-mail użytkownika	initiatingUserEmail	string	Adres e-mail użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika.
Powiadamianie odpowiednich użytkowników	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista użytkowników, dla których to powiadomienie ma zastosowanie
Agreement	agreement	WebhookAgreementInfo	Pełne informacje o umowie

Dotyczyużytkowników

Informacje o użytkownikach, dla których to powiadomienie ma zastosowanie

Nazwa	Ścieżka	Typ	Opis
Identyfikator użytkownika odpowiedniego powiadomienia	id	string	Unikatowy identyfikator użytkownika, dla którego to powiadomienie ma zastosowanie
Powiadomienie dotyczy adresu e-mail użytkownika	email	string	Adres e-mail użytkownika, dla którego to powiadomienie ma zastosowanie
Powiadomienie dotyczy roli użytkownika	role	string	Rola użytkownika w przepływie pracy, dla którego jest generowane to powiadomienie
Czy ładunek dotyczy użytkownika	payloadApplicable	boolean	Czy dane podane w tym powiadomieniu mają zastosowanie dla tego użytkownika, czy nie

WebhookPayloadWithoutNextParticipantSet

Nazwa	Ścieżka	Typ	Opis
Event	event	string	Zdarzenie, które wystąpiło w zasobie.
Data zdarzenia	eventDate	date	Data zdarzenia. Formatem będzie rrrr-MM-dd'T'HH:mm:ssZ. Na przykład 2016-02-25T18:46:19Z reprezentuje czas UTC
Typ zasobu zdarzenia	eventResourceType	string	Zasób, na którym wystąpiło zdarzenie.
Typ nadrzędny umowy	eventResourceParentType	string	Informacje o zasobie, z którego jest tworzona umowa. Możliwe wartości: Formularz internetowy lub Mega Znak
Identyfikator nadrzędny umowy	eventResourceParentId	string	Unikatowy identyfikator zasobu, z którego utworzono tę umowę
Identyfikator uczestnika zdarzenia	participantUserId	string	Identyfikator uczestnika wydarzenia.
Wiadomość e-mail uczestnika zdarzenia	participantUserEmail	string	Adres e-mail uczestnika wydarzenia.
Zdarzenie pełniące rolę identyfikatora użytkownika	actingUserId	string	Identyfikator użytkownika, który utworzył zdarzenie.
Wiadomość e-mail użytkownika działająca na zdarzeniach	actingUserEmail	string	Adres e-mail użytkownika, który utworzył zdarzenie.
Zdarzenie działające pod adresem IP użytkownika	actingUserIpAddress	string	Adres IP użytkownika, który utworzył zdarzenie
Zdarzenie inicjujące identyfikator użytkownika	initiatingUserId	string	Identyfikator użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika
Zdarzenie inicjujące wiadomość e-mail użytkownika	initiatingUserEmail	string	Adres e-mail użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika.
Powiadamianie odpowiednich użytkowników	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista użytkowników, dla których to powiadomienie ma zastosowanie
Agreement	agreement	WebhookAgreementInfoWithoutNextParticipantSet	Pełne informacje o umowie

WebhookPayloadWithSignedDocumentForStatusChange

Nazwa	Ścieżka	Typ	Opis
Event	event	string	Zdarzenie, które wystąpiło w zasobie.
Data zdarzenia	eventDate	date	Data zdarzenia. Formatem będzie rrrr-MM-dd'T'HH:mm:ssZ. Na przykład 2016-02-25T18:46:19Z reprezentuje czas UTC
Zdarzenie podrzędne	subEvent	string	Zdarzenie podrzędne, które wystąpiło w zasobie.
Typ nadrzędny umowy	eventResourceParentType	string	Informacje o zasobie, z którego jest tworzona umowa. Możliwe wartości: Formularz internetowy lub Mega Znak
Identyfikator nadrzędny umowy	eventResourceParentId	string	Unikatowy identyfikator zasobu, z którego utworzono tę umowę
Identyfikator uczestnika zdarzenia	participantUserId	string	Identyfikator uczestnika wydarzenia.
Wiadomość e-mail uczestnika zdarzenia	participantUserEmail	string	Adres e-mail uczestnika wydarzenia.
Zdarzenie pełniące rolę identyfikatora użytkownika	actingUserId	string	Identyfikator użytkownika, który utworzył zdarzenie.
Wiadomość e-mail użytkownika działająca na zdarzeniach	actingUserEmail	string	Adres e-mail użytkownika, który utworzył zdarzenie.
Zdarzenie działające pod adresem IP użytkownika	actingUserIpAddress	string	Adres IP użytkownika, który utworzył zdarzenie
Typ akcji	actionType	string	Akcja, dla której wystąpiło zdarzenie.
Zdarzenie inicjujące identyfikator użytkownika	initiatingUserId	string	Identyfikator użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika
Zdarzenie inicjujące wiadomość e-mail użytkownika	initiatingUserEmail	string	Adres e-mail użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika.
Typ zasobu zdarzenia	eventResourceType	string	Zasób, na którym wystąpiło zdarzenie.
Rola uczestnika zdarzenia	participantRole	string	Rola uczestnika wydarzenia.
Powiadamianie odpowiednich użytkowników	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista użytkowników, dla których to powiadomienie ma zastosowanie
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	Pełne informacje o umowie

WebhookPayloadWithSignedDocument

Nazwa	Ścieżka	Typ	Opis
Event	event	string	Zdarzenie, które wystąpiło w zasobie.
Data zdarzenia	eventDate	date	Data zdarzenia. Formatem będzie rrrr-MM-dd'T'HH:mm:ssZ. Na przykład 2016-02-25T18:46:19Z reprezentuje czas UTC
Typ nadrzędny umowy	eventResourceParentType	string	Informacje o zasobie, z którego jest tworzona umowa. Możliwe wartości: Formularz internetowy lub Mega Znak
Identyfikator nadrzędny umowy	eventResourceParentId	string	Unikatowy identyfikator zasobu, z którego utworzono tę umowę
Typ zasobu zdarzenia	eventResourceType	string	Zasób, na którym wystąpiło zdarzenie.
Rola uczestnika zdarzenia	participantRole	string	Rola uczestnika wydarzenia.
Identyfikator uczestnika zdarzenia	participantUserId	string	Identyfikator uczestnika wydarzenia.
Wiadomość e-mail uczestnika zdarzenia	participantUserEmail	string	Adres e-mail uczestnika wydarzenia.
Zdarzenie pełniące rolę identyfikatora użytkownika	actingUserId	string	Identyfikator użytkownika, który utworzył zdarzenie.
Wiadomość e-mail użytkownika działająca na zdarzeniach	actingUserEmail	string	Adres e-mail użytkownika, który utworzył zdarzenie.
Zdarzenie działające pod adresem IP użytkownika	actingUserIpAddress	string	Adres IP użytkownika, który utworzył zdarzenie
Zdarzenie inicjujące identyfikator użytkownika	initiatingUserId	string	Identyfikator użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika
Zdarzenie inicjujące wiadomość e-mail użytkownika	initiatingUserEmail	string	Adres e-mail użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika.
Powiadamianie odpowiednich użytkowników	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista użytkowników, dla których to powiadomienie ma zastosowanie
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	Pełne informacje o umowie

Element webhookPayloadGeneric

Nazwa	Ścieżka	Typ	Opis
Event	event	string	Zdarzenie, które wystąpiło w zasobie.
Data zdarzenia	eventDate	date	Data zdarzenia. Formatem będzie rrrr-MM-dd'T'HH:mm:ssZ. Na przykład 2016-02-25T18:46:19Z reprezentuje czas UTC
Zdarzenie podrzędne	subEvent	string	Zdarzenie podrzędne, które wystąpiło w zasobie.
Typ nadrzędny umowy	eventResourceParentType	string	Informacje o zasobie, z którego jest tworzona umowa. Możliwe wartości: Formularz internetowy lub Mega Znak
Identyfikator nadrzędny umowy	eventResourceParentId	string	Unikatowy identyfikator zasobu, z którego utworzono tę umowę
Typ zasobu zdarzenia	eventResourceType	string	Zasób, na którym wystąpiło zdarzenie.
Rola uczestnika zdarzenia	participantRole	string	Rola uczestnika wydarzenia.
Identyfikator uczestnika zdarzenia	participantUserId	string	Identyfikator uczestnika wydarzenia.
Wiadomość e-mail uczestnika zdarzenia	participantUserEmail	string	Adres e-mail uczestnika wydarzenia.
Zdarzenie pełniące rolę identyfikatora użytkownika	actingUserId	string	Identyfikator użytkownika, który utworzył zdarzenie.
Wiadomość e-mail użytkownika działająca na zdarzeniach	actingUserEmail	string	Adres e-mail użytkownika, który utworzył zdarzenie.
Zdarzenie inicjujące identyfikator użytkownika	initiatingUserId	string	Identyfikator użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika
Zdarzenie inicjujące wiadomość e-mail użytkownika	initiatingUserEmail	string	Adres e-mail użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika.
Typ akcji	actionType	string	Akcja, dla której wystąpiło zdarzenie.
Zdarzenie działające pod adresem IP użytkownika	actingUserIpAddress	string	Adres IP użytkownika, który utworzył zdarzenie
Powiadamianie odpowiednich użytkowników	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista użytkowników, dla których to powiadomienie ma zastosowanie
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	Pełne informacje o umowie
Znak mega	megaSign	WebhookMegaSignInfo	Pełne informacje o mega znaku
Formularz internetowy	widget	WebhookWidgetInfo	Pełne informacje o formularzu internetowym

WebFormWebhookAgreementEventPayload

Nazwa	Ścieżka	Typ	Opis
Event	event	string	Zdarzenie umowy, które wystąpiło w formularzu internetowym.
Data zdarzenia	eventDate	date	Data zdarzenia. Formatem będzie rrrr-MM-dd'T'HH:mm:ssZ. Na przykład 2016-02-25T18:46:19Z reprezentuje czas UTC
Zdarzenie podrzędne	subEvent	string	Zdarzenie podrzędne, które wystąpiło w formularzu internetowym.
Typ nadrzędny umowy — formularz internetowy	eventResourceParentType	string	Wartość wskazująca, że umowa jest tworzona na podstawie formularza internetowego.
Identyfikator formularza sieci Web	eventResourceParentId	string	Unikatowy identyfikator formularza internetowego, z którego utworzono tę umowę
Typ zasobu zdarzenia — umowa	eventResourceType	string	Zasób, na którym wystąpiło zdarzenie.
Rola uczestnika zdarzenia	participantRole	string	Rola uczestnika wydarzenia.
Identyfikator uczestnika zdarzenia	participantUserId	string	Identyfikator uczestnika wydarzenia.
Wiadomość e-mail uczestnika zdarzenia	participantUserEmail	string	Adres e-mail uczestnika wydarzenia.
Zdarzenie pełniące rolę identyfikatora użytkownika	actingUserId	string	Identyfikator użytkownika, który utworzył zdarzenie.
Wiadomość e-mail użytkownika działająca na zdarzeniach	actingUserEmail	string	Adres e-mail użytkownika, który utworzył zdarzenie.
Zdarzenie inicjujące identyfikator użytkownika	initiatingUserId	string	Identyfikator użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika
Zdarzenie inicjujące wiadomość e-mail użytkownika	initiatingUserEmail	string	Adres e-mail użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika.
Typ akcji	actionType	string	Akcja, dla której wystąpiło zdarzenie.
Zdarzenie działające pod adresem IP użytkownika	actingUserIpAddress	string	Adres IP użytkownika, który utworzył zdarzenie
Powiadamianie odpowiednich użytkowników	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista użytkowników, dla których to powiadomienie ma zastosowanie
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	Pełne informacje o umowie

GroupWebhookEventPayload

Nazwa	Ścieżka	Typ	Opis
Event	event	string	Zdarzenie, które miało miejsce dla grupy.
Data zdarzenia	eventDate	date	Data zdarzenia. Formatem będzie rrrr-MM-dd'T'HH:mm:ssZ. Na przykład 2016-02-25T18:46:19Z reprezentuje czas UTC
Zdarzenie podrzędne	subEvent	string	Zdarzenie podrzędne, które wystąpiło dla grupy.
Typ nadrzędny umowy — formularz internetowy	eventResourceParentType	string	Informacje o grupie, z której utworzono umowę.
Identyfikator formularza sieci Web	eventResourceParentId	string	Unikatowy identyfikator grupy, z której utworzono tę umowę
Typ zasobu zdarzenia — umowa	eventResourceType	string	Grupa, dla której wystąpiło zdarzenie.
Rola uczestnika zdarzenia	participantRole	string	Rola uczestnika wydarzenia.
Identyfikator uczestnika zdarzenia	participantUserId	string	Identyfikator uczestnika wydarzenia.
Wiadomość e-mail uczestnika zdarzenia	participantUserEmail	string	Adres e-mail uczestnika wydarzenia.
Zdarzenie pełniące rolę identyfikatora użytkownika	actingUserId	string	Identyfikator użytkownika, który utworzył zdarzenie.
Wiadomość e-mail użytkownika działająca na zdarzeniach	actingUserEmail	string	Adres e-mail użytkownika, który utworzył zdarzenie.
Zdarzenie inicjujące identyfikator użytkownika	initiatingUserId	string	Identyfikator użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika
Zdarzenie inicjujące wiadomość e-mail użytkownika	initiatingUserEmail	string	Adres e-mail użytkownika, który zainicjował zdarzenie w imieniu działającego użytkownika.
Typ akcji	actionType	string	Akcja, dla której wystąpiło zdarzenie.
Zdarzenie działające pod adresem IP użytkownika	actingUserIpAddress	string	Adres IP użytkownika, który utworzył zdarzenie
Powiadamianie odpowiednich użytkowników	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista użytkowników, dla których to powiadomienie ma zastosowanie
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	Pełne informacje o umowie
Znak mega	megaSign	WebhookMegaSignInfo	Pełne informacje o mega znaku
Formularz internetowy	widget	WebhookWidgetInfo	Pełne informacje o formularzu internetowym

WebhookAgreementInfo

Pełne informacje o umowie

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator umowy
Name	name	string	Nazwa umowy
Typ podpisu	signatureType	string	Określa żądany typ podpisu — podpis e-podpis lub zapis
Status	status	string	Bieżący stan umowy
Ccs	ccs	array of CcInfo	Lista co najmniej jednego CC, który zostanie skopiowany w transakcji umowy.
Data utworzenia	createdDate	date	Data utworzenia umowy
Czas wygaśnięcia	expirationTime	string	Czas po wygaśnięciu umowy i musi zostać podpisany przed jej podpisaniem
Tożsamość zewnętrzna	externalId.id	string	Dowolna wartość z systemu, którą można określić w czasie wysyłania, a następnie później zwróconą lub odpytowaną
Grupa zewnętrzna	externalId.group	string	Dowolna wartość z systemu, którą można określić w czasie wysyłania, a następnie później zwróconą lub odpytowaną
Opóźnienie pierwszego przypomnienia	firstReminderDelay	integer	Liczba całkowita określająca opóźnienie w godzinach przed wysłaniem pierwszego przypomnienia.
Lokalizacja	locale	string	Ustawienia regionalne skojarzone z tą umową
Message	message	string	Opcjonalna wiadomość do uczestników, opisująca, co jest wysyłane lub dlaczego ich podpis jest wymagany
Częstotliwość przypomnienia	reminderFrequency	string	Opcjonalny parametr określający częstotliwość wysyłania przypomnień do uczestników. Jeśli nie zostanie określony, zostanie użyta domyślna częstotliwość ustawiona dla konta
Adres e-mail nadawcy	senderEmail	string	Adres e-mail nadawcy umowy
Czy magazyn jest włączony?	vaultingInfo.enabled	boolean	W przypadku kont skonfigurowanych na potrzeby przechowywania dokumentów i opcji włączenia dla umowy określa, czy dokument ma być magazynowany
Widoczność dokumentu?	documentVisibilityEnabled	boolean	Czy widoczność dokumentu jest włączona
Identyfikator przepływu pracy	workflowId	string	Identyfikator niestandardowego przepływu pracy, który definiuje ścieżkę routingu umowy.
Adres URL przekierowania po znaku	postSignOption.redirectUrl	string	Publicznie dostępny adres URL, do którego użytkownik zostanie wysłany po pomyślnym ukończeniu procesu podpisywania
Zestawy uczestników	participantSetsInfo.participantSets	array of WebhookParticipantSets	Informacje o ustawianiu uczestników
Następne zestawy uczestników	participantSetsInfo.nextParticipantSets	array of WebhookParticipantSets	Informacje o następnym uczestniku są ustawiane
Documents	documentsInfo.documents	array of WebhookDocument	Lista obiektów reprezentujących dokumenty
Dokumenty pomocnicze	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Lista dokumentów pomocniczych

WebhookAgreementInfoWithoutNextParticipantSet

Pełne informacje o umowie

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator umowy
Name	name	string	Nazwa umowy
Typ podpisu	signatureType	string	Określa żądany typ podpisu — podpis e-podpis lub zapis
Status	status	string	Bieżący stan umowy
Ccs	ccs	array of CcInfo	Lista co najmniej jednego CC, który zostanie skopiowany w transakcji umowy.
Data utworzenia	createdDate	date	Data utworzenia umowy
Widoczność dokumentu?	documentVisibilityEnabled	boolean	Czy widoczność dokumentu jest włączona
Czas wygaśnięcia	expirationTime	string	Czas po wygaśnięciu umowy i musi zostać podpisany przed jej podpisaniem
Tożsamość zewnętrzna	externalId.id	string	Dowolna wartość z systemu, którą można określić w czasie wysyłania, a następnie później zwróconą lub odpytowaną
Grupa zewnętrzna	externalId.group	string	Dowolna wartość z systemu, którą można określić w czasie wysyłania, a następnie później zwróconą lub odpytowaną
Opóźnienie pierwszego przypomnienia	firstReminderDelay	integer	Liczba całkowita określająca opóźnienie w godzinach przed wysłaniem pierwszego przypomnienia.
Lokalizacja	locale	string	Ustawienia regionalne skojarzone z tą umową
Message	message	string	Opcjonalna wiadomość do uczestników, opisująca, co jest wysyłane lub dlaczego ich podpis jest wymagany
Częstotliwość przypomnienia	reminderFrequency	string	Opcjonalny parametr określający częstotliwość wysyłania przypomnień do uczestników. Jeśli nie zostanie określony, zostanie użyta domyślna częstotliwość ustawiona dla konta
Adres e-mail nadawcy	senderEmail	string	Adres e-mail nadawcy umowy
Czy magazyn jest włączony?	vaultingInfo.enabled	boolean	W przypadku kont skonfigurowanych na potrzeby przechowywania dokumentów i opcji włączenia dla umowy określa, czy dokument ma być magazynowany
Adres URL przekierowania po znaku	postSignOption.redirectUrl	string	Publicznie dostępny adres URL, do którego użytkownik zostanie wysłany po pomyślnym ukończeniu procesu podpisywania
Identyfikator przepływu pracy	workflowId	string	Identyfikator niestandardowego przepływu pracy, który definiuje ścieżkę routingu umowy.
Zestawy uczestników	participantSetsInfo.participantSets	array of WebhookParticipantSets	Informacje o ustawianiu uczestników

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Pełne informacje o umowie

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator umowy
Name	name	string	Nazwa umowy
Typ podpisu	signatureType	string	Określa żądany typ podpisu — podpis e-podpis lub zapis
Status	status	string	Bieżący stan umowy
Ccs	ccs	array of CcInfo	Lista co najmniej jednego CC, który zostanie skopiowany w transakcji umowy.
Data utworzenia	createdDate	date	Data utworzenia umowy
Czas wygaśnięcia	expirationTime	string	Czas po wygaśnięciu umowy i musi zostać podpisany przed jej podpisaniem
Tożsamość zewnętrzna	externalId.id	string	Dowolna wartość z systemu, którą można określić w czasie wysyłania, a następnie później zwróconą lub odpytowaną
Grupa zewnętrzna	externalId.group	string	Dowolna wartość z systemu, którą można określić w czasie wysyłania, a następnie później zwróconą lub odpytowaną
Opóźnienie pierwszego przypomnienia	firstReminderDelay	integer	Liczba całkowita określająca opóźnienie w godzinach przed wysłaniem pierwszego przypomnienia.
Lokalizacja	locale	string	Ustawienia regionalne skojarzone z tą umową
Message	message	string	Opcjonalna wiadomość do uczestników, opisująca, co jest wysyłane lub dlaczego ich podpis jest wymagany
Częstotliwość przypomnienia	reminderFrequency	string	Opcjonalny parametr określający częstotliwość wysyłania przypomnień do uczestników. Jeśli nie zostanie określony, zostanie użyta domyślna częstotliwość ustawiona dla konta
Adres URL przekierowania po znaku	postSignOption.redirectUrl	string	Publicznie dostępny adres URL, do którego użytkownik zostanie wysłany po pomyślnym ukończeniu procesu podpisywania
Identyfikator przepływu pracy	workflowId	string	Identyfikator niestandardowego przepływu pracy, który definiuje ścieżkę routingu umowy.
Adres e-mail nadawcy	senderEmail	string	Adres e-mail nadawcy umowy
Widoczność dokumentu?	documentVisibilityEnabled	boolean	Czy widoczność dokumentu jest włączona
Czy magazyn jest włączony?	vaultingInfo.enabled	boolean	W przypadku kont skonfigurowanych na potrzeby przechowywania dokumentów i opcji włączenia dla umowy określa, czy dokument ma być magazynowany
Zestawy uczestników	participantSetsInfo.participantSets	array of WebhookParticipantSets	Informacje o ustawianiu uczestników
Następne zestawy uczestników	participantSetsInfo.nextParticipantSets	array of WebhookParticipantSets	Informacje o następnym uczestniku są ustawiane
Documents	documentsInfo.documents	array of WebhookDocument	Lista obiektów reprezentujących dokumenty
Dokumenty pomocnicze	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Lista dokumentów pomocniczych Jest zwracana tylko wtedy, gdy w umowie znajduje się jakikolwiek dokument pomocniczy
Informacje o podpisanym dokumencie	signedDocumentInfo.document	string	Ciąg zakodowany w formacie base64 podpisanego dokumentu

WebhookAgreementInfoWithSignedDocument

Pełne informacje o umowie

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator umowy
Name	name	string	Nazwa umowy
Typ podpisu	signatureType	string	Określa żądany typ podpisu — podpis e-podpis lub zapis
Status	status	string	Bieżący stan umowy
Ccs	ccs	array of CcInfo	Lista co najmniej jednego CC, który zostanie skopiowany w transakcji umowy
Data utworzenia	createdDate	date	Data utworzenia umowy
Widoczność dokumentu?	documentVisibilityEnabled	boolean	Czy widoczność dokumentu jest włączona
Czas wygaśnięcia	expirationTime	string	Czas po wygaśnięciu umowy i musi zostać podpisany przed jej podpisaniem
Tożsamość zewnętrzna	externalId.id	string	Dowolna wartość z systemu, którą można określić w czasie wysyłania, a następnie później zwróconą lub odpytowaną
Grupa zewnętrzna	externalId.group	string	Dowolna wartość z systemu, którą można określić w czasie wysyłania, a następnie później zwróconą lub odpytowaną
Opóźnienie pierwszego przypomnienia	firstReminderDelay	integer	Liczba całkowita określająca opóźnienie w godzinach przed wysłaniem pierwszego przypomnienia.
Lokalizacja	locale	string	Ustawienia regionalne skojarzone z tą umową
Message	message	string	Opcjonalna wiadomość do uczestników, opisująca, co jest wysyłane lub dlaczego ich podpis jest wymagany
Częstotliwość przypomnienia	reminderFrequency	string	Opcjonalny parametr określający częstotliwość wysyłania przypomnień do uczestników. Jeśli nie zostanie określony, zostanie użyta domyślna częstotliwość ustawiona dla konta
Adres e-mail nadawcy	senderEmail	string	Adres e-mail nadawcy umowy
Czy magazyn jest włączony?	vaultingInfo.enabled	boolean	W przypadku kont skonfigurowanych na potrzeby przechowywania dokumentów i opcji włączenia dla umowy określa, czy dokument ma być magazynowany
Adres URL przekierowania po znaku	postSignOption.redirectUrl	string	Publicznie dostępny adres URL, do którego użytkownik zostanie wysłany po pomyślnym ukończeniu procesu podpisywania
Identyfikator przepływu pracy	workflowId	string	Identyfikator niestandardowego przepływu pracy, który definiuje ścieżkę routingu umowy.
Zestawy uczestników	participantSetsInfo.participantSets	array of WebhookParticipantSets	Informacje o ustawianiu uczestników
Documents	documentsInfo.documents	array of WebhookDocument	Lista obiektów reprezentujących dokumenty
Dokumenty pomocnicze	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Lista dokumentów pomocniczych Jest zwracana tylko wtedy, gdy w umowie znajduje się jakikolwiek dokument pomocniczy
Informacje o podpisanym dokumencie	signedDocumentInfo.document	string	Ciąg zakodowany w formacie base64 podpisanego dokumentu

Element webhookMegaSignInfo

Pełne informacje o mega znaku

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator megasign
Name	name	string	Nazwa megapodpisu
Status	status	string	Stan megasign
Ccs	ccs	array of MegaSignCcInfo	Lista co najmniej jednego adresu e-mail, który chcesz skopiować na ten megasign.
Tożsamość zewnętrzna	externalId.id	string	Dowolna wartość z systemu, którą można określić w czasie wysyłania, a następnie później zwróconą lub odpytowaną
Opóźnienie pierwszego przypomnienia	firstReminderDelay	integer	Liczba całkowita określająca opóźnienie w godzinach przed wysłaniem pierwszego przypomnienia.
Lokalizacja	locale	string	Ustawienia regionalne skojarzone z tą umową
Message	message	string	Opcjonalna wiadomość do uczestników, opisująca, co jest wysyłane lub dlaczego ich podpis jest wymagany
Adres URL przekierowania po znaku	postSignOption.redirectUrl	string	Publicznie dostępny adres URL, do którego użytkownik zostanie wysłany po pomyślnym ukończeniu procesu podpisywania
Adres e-mail nadawcy	senderEmail	string	Wiadomość e-mail twórcy megasign
Typ podpisu	signatureType	string	Określa żądany typ podpisu — podpis e-podpis lub zapis
Czy magazyn jest włączony?	vaultingInfo.enabled	boolean	W przypadku kont skonfigurowanych na potrzeby przechowywania dokumentów i opcji włączenia dla umowy określa, czy dokument ma być magazynowany
Informacje o plikach umów podrzędnych	childAgreementsInfo.fileInfo	MegaSignChildAgreementsFileInfo	Informacje o pliku zawierające informacje o umowie podrzędnej megaSign.

WebhookWidgetInfo

Pełne informacje o formularzu internetowym

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator formularza internetowego
Name	name	string	Nazwa formularza internetowego
Status	status	string	Stan formularza internetowego
Informacje o niepowodzeniu uwierzytelniania	authFailureInfo	AuthFailureWidgetRedirectionInfo	Adres URL i skojarzone właściwości strony błędu, które użytkownik podpisuje formularz internetowy po nieudanym uwierzytelnieniu
Ccs	ccs	array of WidgetCcInfo	Lista co najmniej jednego adresu e-mail, który chcesz skopiować w tym formularzu internetowym.
Data utworzenia	createdDate	date	Data utworzenia formularza internetowego
Informacje o ukończeniu	completionInfo	WidgetCompletionRedirectionInfo	Adres URL i skojarzone właściwości strony powodzenia, do którego zostanie podjęty podpisywanie formularza internetowego po wykonaniu żądanej akcji w formularzu internetowym
Adres e-mail twórcy	creatorEmail	string	Adres e-mail twórcy formularza internetowego
Czy magazyn jest włączony?	vaultingInfo.enabled	boolean	W przypadku kont skonfigurowanych na potrzeby przechowywania dokumentów i opcji włączenia dla umowy określa, czy dokument ma być magazynowany
Dodatkowe informacje o zestawach uczestników	participantSetsInfo.additionalParticipantSets	array of WidgetParticipantSetInfo	Lista wszystkich uczestników formularza internetowego z wyjątkiem osoby podpisujących formularz internetowy
Pierwsza rola zestawu uczestników	participantSetsInfo.widgetParticipantSet.role	string	Rola założona przez wszystkich uczestników zestawu (osoba podpisjąca, osoba zatwierdzająca itp.)
Kolejność pierwszego zestawu uczestników	participantSetsInfo.widgetParticipantSet.order	integer	Indeks wskazujący sekwencyjną grupę podpisywania (określoną dla routingu hybrydowego)
Documents	documentsInfo.documents	array of WidgetWebhookDocument	Lista obiektów reprezentujących dokumenty

AuthFailureWidgetRedirectionInfo

Adres URL i skojarzone właściwości strony błędu, które użytkownik podpisuje formularz internetowy po nieudanym uwierzytelnieniu

Nazwa	Ścieżka	Typ	Opis
Opóźnienie przekierowania niepowodzenia uwierzytelniania	delay	integer	Opóźnienie (w sekundach) przed przejściem użytkownika do wynikowej strony
Deframe przekierowania przekierowania uwierzytelniania	deframe	boolean	Jeśli deframe ma wartość false, wynikowa strona zostanie wyświetlona wewnątrz ramki formularza internetowego
Adres URL przekierowania niepowodzenia uwierzytelniania	url	string	Publicznie dostępny adres URL, do którego użytkownik zostanie wysłany po pomyślnym ukończeniu formularza internetowego

WidgetCompletionRedirectionInfo

Adres URL i skojarzone właściwości strony powodzenia, do którego zostanie podjęty podpisywanie formularza internetowego po wykonaniu żądanej akcji w formularzu internetowym

Nazwa	Ścieżka	Typ	Opis
Opóźnienie przekierowania ukończenia	delay	integer	Opóźnienie (w sekundach) przed przejściem użytkownika do wynikowej strony
Deframe przekierowania ukończenia	deframe	boolean	Jeśli deframe ma wartość false, wynikowa strona zostanie wyświetlona wewnątrz ramki formularza internetowego
Adres URL przekierowania ukończenia	url	string	Publicznie dostępny adres URL, do którego użytkownik zostanie wysłany po pomyślnym ukończeniu formularza internetowego

Zestawy webhookParticipantSet

Nazwa	Ścieżka	Typ	Opis
Informacje o członkach	memberInfos	array of MemberInfos	Informacje o członkach uczestników
Zamówienie	order	integer	Indeks wskazujący pozycję, w której grupa podpisywania musi się podpisać.
Role	role	string	Rola założona przez wszystkich uczestników zestawu (osoba podpisjąca, osoba zatwierdzająca itp.)
Status	status	string	Bieżący stan umowy z perspektywy użytkownika
identyfikator	id	string	Identyfikator zestawu uczestników
Name	name	string	Nazwa zestawu uczestników
Wiadomość prywatna	privateMessage	string	Prywatna wiadomość dla uczestników w zestawie

MegaSignChildAgreementsFileInfo

Informacje o pliku zawierające informacje o umowie podrzędnej megaSign.

Nazwa	Ścieżka	Typ	Opis
Identyfikator pliku umów podrzędnych	childAgreementsInfoFileId	string	Identyfikator pliku zawierającego informacje o istniejącym childAgreementsInfo megaSign.

WidgetWebhookDocument

Informacje o dokumencie formularza internetowego

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator dokumentu
Name	name	string	Nazwa dokumentu

WebhookDocument

Informacje o dokumencie umowy

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator dokumentu
Name	name	string	Nazwa dokumentu

WebhookSupportingDocument

Informacje o dokumencie pomocniczym

Nazwa	Ścieżka	Typ	Opis
Name	displayLabel	string	Nazwa wyświetlana dokumentu pomocniczego
Nazwa pola	fieldName	string	Nazwa pola dokumentu pomocniczego
identyfikator	id	string	Unikatowy identyfikator reprezentujący dokument pomocniczy

WidgetCcInfo

Informacje o cc formularza internetowego

Nazwa	Ścieżka	Typ	Opis
Email	email	string	Wiadomość e-mail uczestnika cc formularza internetowego

MegaSignCcInfo

Informacje o CC znaku mega

Nazwa	Ścieżka	Typ	Opis
Email	email	string	Adres e-mail uczestnika CC megapodpisu

Informacje o ccinfo

Informacje o CC umowy

Nazwa	Ścieżka	Typ	Opis
Email	email	string	Adres e-mail CC umowy
Etykieta	label	string	Etykieta listy CC zwrócona w opisie przepływu pracy
Widoczne strony	visiblePages	array of string	Strony widoczne dla cc

WidgetParticipantSetInfo

Nazwa	Ścieżka	Typ	Opis
Role	role	string	Rola założona przez wszystkich uczestników zestawu (osoba podpisjąca, osoba zatwierdzająca itp.)
identyfikator	id	string	Unikatowy identyfikator zestawu uczestników
Informacje o członkach	memberInfos	array of MemberInfos	Informacje o członkach uczestnika
Zamówienie	order	integer	Indeks wskazujący sekwencyjną grupę podpisywania (określoną dla routingu hybrydowego)

Informacje o elemencie członkowskim

Nazwa	Ścieżka	Typ	Opis
identyfikator	id	string	Unikatowy identyfikator uczestnika
Email	email	string	Wiadomość e-mail uczestnika
Firma	company	string	Firma uczestnika
Name	name	string	Nazwa uczestnika
Wiadomość prywatna	privateMessage	string	Prywatna wiadomość uczestnika
Status	status	string	Stan uczestnika

LibraryDocumentCreationResponseV6

Obiekt JSON opisujący szablon biblioteki

Nazwa	Ścieżka	Typ	Opis
Identyfikator szablonu biblioteki	id	string	Unikatowy identyfikator, którego można użyć do odwoływania się do szablonu biblioteki

BibliotekaDokument

Nazwa	Ścieżka	Typ	Opis
Identyfikator szablonu biblioteki	id	string	Unikatowy identyfikator używany do odwoływania się do szablonu biblioteki
Ukryty	hidden	boolean	Prawda, jeśli dokument biblioteki jest ukryty
Typy szablonów	templateTypes	array of string	Lista co najmniej jednego typu szablonu biblioteki
Data modyfikacji	modifiedDate	date	Dzień ostatniej modyfikacji szablonu biblioteki
Nazwa szablonu biblioteki	name	string	Nazwa szablonu biblioteki
Tryb udostępniania szablonu	sharingMode	string	Zakres widoczności szablonu biblioteki
Adres e-mail twórcy	creatorEmail	string	Adres e-mail twórcy dokumentów biblioteki.
Identyfikator grupy	groupId	string	Unikatowy identyfikator grupy, do której należy szablon biblioteki.
Status	status	string	Stan dokumentu biblioteki

BibliotekaDokumenty

Kod JSON zawierający obiekt tablicy szablonów biblioteki

Nazwa	Ścieżka	Typ	Opis
page	page	page	Informacje o stronicowaniu na potrzeby nawigowania po odpowiedzi
Lista szablonów bibliotek	libraryDocumentList	array of LibraryDocument	Lista elementów szablonu biblioteki

UserWidgetV6

Nazwa	Ścieżka	Typ	Opis
Identyfikator formularza sieci Web	id	string	Unikatowy identyfikator formularza internetowego
Data modyfikacji	modifiedDate	string	Data ostatniej modyfikacji formularza internetowego
Ukryty	hidden	boolean	Prawda, jeśli umowa jest ukryta dla użytkownika
Identyfikator grupy	groupId	string	Unikatowy identyfikator grupy
Name	name	string	Nazwa formularza internetowego
Status	status	string	Stan formularza internetowego
URL	url	string	Hostowany adres URL formularza internetowego
JavaScript	javascript	string	Osadzony kod javascript formularza internetowego

userWidgetListV6

Kod JSON zawierający obiekt tablicy formularzy internetowych użytkownika

Nazwa	Ścieżka	Typ	Opis
page	page	page	Informacje o stronicowaniu na potrzeby nawigowania po odpowiedzi
Lista formularzy sieci Web	userWidgetList	array of UserWidgetV6	Tablica elementów formularza internetowego

UserWorkflowV6

Nazwa	Ścieżka	Typ	Opis
Identyfikator przepływu pracy	id	string	Unikatowy identyfikator przepływu pracy
Description	description	string	Opis podany dla tego przepływu pracy w momencie jego utworzenia
Data utworzenia	created	string	Data utworzenia przepływu pracy. Format to rrrr-MM-dd'T'HH:mm:ssZ
Data modyfikacji	modified	string	Data modyfikacji przepływu pracy. Format to rrrr-MM-dd'T'HH:mm:ssZ
Name	name	string	Nazwa przepływu pracy
Wyświetlana nazwa	displayName	string	Nazwa wyświetlana przepływu pracy
Status	status	string	Stan przepływu pracy
Scope	scope	string	Zakres przepływu pracy
Identyfikator obiektu źródłowego	originatorId	string	Początkowa inicjator przepływu pracy
Identyfikator zakresu	scopeId	string	Identyfikator zakresu. Obecnie ma zastosowanie tylko dla zakresu GROUP, a wartość będzie groupId.

userWorkflowListV6

Kod JSON zawierający obiekt tablicy przepływu pracy użytkownika

Nazwa	Ścieżka	Typ	Opis
Lista przepływów pracy	userWorkflowList	array of UserWorkflowV6	Tablica elementów przepływu pracy

WorkflowDefaultParamsV6

Kod JSON zawierający domyślny obiekt parametrów przepływu pracy

Nazwa	Ścieżka	Typ	Opis
Wartość domyślna	defaultValue	string	Wartość domyślna pola, jeśli dane wejściowe dla tego pola nie są podane i to pole jest wymagane
Można edytować	editable	boolean	Czy można edytować bieżące pole. Jeśli edytowalny atrybut dla tego pola ma wartość false, to pole nie powinno być podane w żądaniu utworzenia umowy, a wartość domyślna tego pola będzie używana podczas tworzenia umowy
Wymagane	required	boolean	Czy to pole jest wymagane, czy opcjonalne
Widoczny	visible	boolean	Czy bieżące pole jest widoczne, czy nie. Jeśli widoczny atrybut dla tego pola ma wartość false, to pole nie powinno być widoczne w interfejsie użytkownika tworzenia umowy przy użyciu tego przepływu pracy dla użytkownika

CCsListInfoDescriptionV6

Kod JSON zawierający szczegółowe informacje o przepływie pracy

Nazwa	Ścieżka	Typ	Opis
Wartości domyślne	defaultValues	array of string	Tablica domyślnych wiadomości e-mail, które będą używane, jeśli nie podano żadnych danych wejściowych dla tego elementu listy
Można edytować	editable	boolean	Czy można edytować bieżące pole. Jeśli edytowalny atrybut dla tego pola ma wartość false, to pole nie powinno być podane w żądaniu utworzenia umowy, a wartość domyślna tego pola będzie używana podczas tworzenia umowy
Etykieta	label	string	Tekst wyświetlany dla użytkownika przepływu pracy, który może być używany dla bieżącej listy CC
Maksymalna liczba wpisów CC	maxListCount	integer	Maksymalna liczba wpisów dozwolonych na bieżącej liście CC
Minimalna liczba wpisów CC	minListCount	integer	Minimalna liczba wpisów dozwolonych na bieżącej liście CC
Nazwa listy DW	name	string	Nazwa bieżącej listy CC
Wymagane	required	boolean	Czy to pole jest wymagane, czy opcjonalne
Widoczny	visible	boolean	Czy bieżące pole jest widoczne, czy nie. Jeśli widoczny atrybut dla tego pola ma wartość false, to pole nie powinno być wyświetlane na stronie tworzenia umowy przy użyciu tego przepływu pracy

ExpirationFieldInfoDescriptionV6

Kod JSON zawierający informacje o wygaśnięciu

Nazwa	Ścieżka	Typ	Opis
Wartość domyślna	defaultValue	string	Wartość domyślna pola, jeśli dane wejściowe dla tego pola nie są podane i to pole jest wymagane
Można edytować	editable	boolean	Czy można edytować bieżące pole. Jeśli edytowalny atrybut dla tego pola ma wartość false, to pole nie powinno być podane w żądaniu utworzenia umowy, a wartość domyślna tego pola będzie używana podczas tworzenia umowy
Maksymalna liczba dni wygaśnięcia umowy	maxDays	integer	Maksymalna liczba dni wygaśnięcia umowy
Wymagane	required	boolean	Czy to pole jest wymagane, czy opcjonalne
Widoczny	visible	boolean	Czy bieżące pole jest widoczne, czy nie. Jeśli widoczny atrybut dla tego pola ma wartość false, to pole nie powinno być wyświetlane na stronie tworzenia umowy przy użyciu tego przepływu pracy

FileInfosDescriptionV6

Kod JSON zawierający informacje o plikach

Nazwa	Ścieżka	Typ	Opis
Etykieta	label	string	Wyświetl etykietę tego pola dla użytkowników zewnętrznych
Name	name	string	Nazwa elementu fileInfo
Wymagane	required	boolean	Czy to pole jest wymagane, czy opcjonalne
Dokumenty biblioteki przepływu pracy	workflowLibraryDocumentSelectorList	array of WorkflowLibraryDocumentV6	Lista dokumentów biblioteki przepływu pracy, z których można wybrać jeden dokument biblioteki przepływu pracy z tym obiektem fileInfo

WorkflowLibraryDocumentV6

Kod JSON zawierający informacje o dokumencie biblioteki przepływu pracy

Nazwa	Ścieżka	Typ	Opis
Etykieta	label	string	Tekst wyświetlany dla tego formularza dla użytkowników przepływu pracy
Data modyfikacji	modifiedDate	string	Data ostatniej modyfikacji dokumentu biblioteki. Formatem będzie rrrr-MM-dd'T'HH:mm:ssZ. Na przykład 2016-02-25T18:46:19Z reprezentuje czas UTC
Tryb udostępniania	sharingMode	string	Określa, kto powinien mieć dostęp do tego dokumentu biblioteki. Udostępnianie globalne to operacja ograniczona
Typy szablonów	templateTypes	array of	Lista co najmniej jednego typu szablonu biblioteki
Identyfikator dokumentu biblioteki przepływu pracy	workflowLibDoc	string	Identyfikator dokumentu biblioteki przepływu pracy, który można podać jako plik wejściowy w niestandardowym żądaniu utworzenia umowy przepływu pracy

LocaleFieldInfoDescriptionV6

Kod JSON zawierający szczegółowe informacje o ustawieniach regionalnych przepływu pracy

Nazwa	Ścieżka	Typ	Opis
Dostępne ustawienia regionalne	availableLocales	array of string	Które ustawienia regionalne można wybrać dla tego przepływu pracy
Wartość domyślna	defaultValue	string	Wartość domyślna pola, jeśli dane wejściowe dla tego pola nie są podane i to pole jest wymagane
Można edytować	editable	boolean	Czy można edytować bieżące pole. Jeśli edytowalny atrybut dla tego pola ma wartość false, to pole nie powinno być podane w żądaniu utworzenia umowy, a wartość domyślna tego pola będzie używana podczas tworzenia umowy
Wymagane	required	boolean	Czy to pole jest wymagane, czy opcjonalne
Widoczny	visible	boolean	Czy bieżące pole jest widoczne, czy nie. Jeśli widoczny atrybut dla tego pola ma wartość false, to pole nie powinno być widoczne w interfejsie użytkownika tworzenia umowy przy użyciu tego przepływu pracy dla użytkownika

MergeFieldInfoDescriptionV6

Kod JSON zawierający szczegółowe informacje o polu scalania

Nazwa	Ścieżka	Typ	Opis
Wartość domyślna	defaultValue	string	Wartość domyślna pola, jeśli dane wejściowe dla tego pola nie są podane i to pole jest wymagane
Wyświetlana nazwa	displayName	string	Tekst wyświetlany, który można wyświetlić dla tego pola niestandardowego
Można edytować	editable	boolean	Czy można edytować bieżące pole. Jeśli edytowalny atrybut dla tego pola ma wartość false, to pole nie powinno być podane w żądaniu utworzenia umowy, a wartość domyślna tego pola będzie używana podczas tworzenia umowy
Nazwa pola niestandardowego	fieldName	string	Nazwa pola niestandardowego w tym przepływie pracy
Wymagane	required	boolean	Czy to pole jest wymagane, czy opcjonalne
Widoczny	visible	boolean	Czy bieżące pole powinno być widoczne na stronie tworzenia umowy. Jeśli widoczny atrybut dla tego pola ma wartość false, to pole nie powinno być wyświetlane na stronie tworzenia umowy przy użyciu tego przepływu pracy

PasswordFieldInfoDescriptionV6

Kod JSON zawierający szczegółowe informacje o haśle

Nazwa	Ścieżka	Typ	Opis
Hasło	defaultValue	string	Wartość domyślna pola informacji o haśle
Można edytować	editable	boolean	Czy można edytować bieżące pole. Jeśli edytowalny atrybut dla tego pola ma wartość false, to pole nie powinno być podane w żądaniu utworzenia umowy, a wartość domyślna tego pola będzie używana podczas tworzenia umowy
Etykieta	label	string	Etykieta pola hasła
Name	name	string	Nazwa pola hasła
Wymagane	required	boolean	Czy to pole jest wymagane, czy opcjonalne
Widoczny	visible	boolean	Czy pole informacji o haśle jest widoczne na stronie tworzenia umowy

RecipientsListInfoDescriptionV6

Kod JSON zawierający szczegółowe informacje o liście adresatów

Nazwa	Ścieżka	Typ	Opis
Zezwalaj nadawcy	allowSender	boolean	Czy nadawca jest dozwolony jako odbiorca
Zezwalaj nadawcy	allowfax	boolean	Czy faks jest dozwolony, czy nie
Metoda uwierzytelniania	authenticationMethod	string	Metoda uwierzytelniania dla bieżącej listy adresatów, aby mieć dostęp do wyświetlania i podpisywania dokumentu,
Domyślna wartość wiadomości e-mail/faksu	defaultValue	string	Domyślny adres e-mail lub numer faksu
Można edytować	editable	boolean	Czy można edytować bieżące pole. Jeśli edytowalny atrybut dla tego pola ma wartość false, to pole nie powinno być podane w żądaniu utworzenia umowy, a wartość domyślna tego pola będzie używana podczas tworzenia umowy
Etykieta	label	string	Tekst wyświetlany dla użytkownika przepływu pracy, który może być używany dla bieżącej listy adresatów
Maksymalna liczba adresatów	maxListCount	integer	Maksymalna liczba wpisów dozwolonych na bieżącej liście adresatów
Minimalni adresaci	minListCount	integer	Minimalna liczba wpisów dozwolonych na bieżącej liście adresatów
Nazwa listy informacji o adresatach	name	string	Nazwa bieżącej listy informacji o odbiorcy
Rola uczestnika	role	string	Bieżąca rola uczestnika
Widoczny	visible	boolean	Czy bieżące pole jest widoczne. Jeśli widoczny atrybut dla tego pola ma wartość false, to pole nie powinno być wyświetlane w interfejsie użytkownika tworzenia umowy przy użyciu tego przepływu pracy dla użytkownika

WorkflowDescriptionV6

Kod JSON zawierający szczegółowe informacje o przepływie pracy

Nazwa	Ścieżka	Typ	Opis
agreementNameInfo	agreementNameInfo	WorkflowDefaultParamsV6	Kod JSON zawierający domyślny obiekt parametrów przepływu pracy
authoringInfo	authoringInfo	WorkflowDefaultParamsV6	Kod JSON zawierający domyślny obiekt parametrów przepływu pracy
Informacje o liście CC	ccsListInfo	array of CCsListInfoDescriptionV6	Informacje o polu wejściowym listy CC w żądaniu utworzenia umowy
Data utworzenia przepływu pracy	created	string	Dzień utworzenia przepływu pracy
Opis przepływu pracy	description	string	Opis podany dla tego przepływu pracy w momencie jego utworzenia
Nazwa wyświetlana przepływu pracy	displayName	string	Nazwa wyświetlana przepływu pracy
expirationInfo	expirationInfo	ExpirationFieldInfoDescriptionV6	Kod JSON zawierający informacje o wygaśnięciu
Informacje o plikach	fileInfos	array of FileInfosDescriptionV6	Informacje o polu wejściowym informacji o pliku w żądaniu utworzenia umowy
localeInfo	localeInfo	LocaleFieldInfoDescriptionV6	Kod JSON zawierający szczegółowe informacje o ustawieniach regionalnych przepływu pracy
Scal informacje o polach	mergeFieldsInfo	array of MergeFieldInfoDescriptionV6	Informacje o polu wejściowym informacji niestandardowych w żądaniu utworzenia umowy
messageInfo	messageInfo	WorkflowDefaultParamsV6	Kod JSON zawierający domyślny obiekt parametrów przepływu pracy
Data modyfikacji	modified	string	Dzień ostatniej modyfikacji przepływu pracy
Nazwa przepływu pracy	name	string	Nazwa przepływu pracy
passwordInfo	passwordInfo	PasswordFieldInfoDescriptionV6	Kod JSON zawierający szczegółowe informacje o haśle
Informacje o liście adresatów	recipientsListInfo	array of RecipientsListInfoDescriptionV6	Informacje o polu wejściowym informacji o recepients w żądaniu utworzenia umowy
Zakres przepływu pracy	scope	string	Zakres przepływu pracy
Stan przepływu pracy	status	string	Stan przepływu pracy
Identyfikator inicjatora przepływu pracy	originatorId	string	Początkowa inicjator przepływu pracy
Identyfikator zakresu przepływu pracy	scopeId	string	Identyfikator zakresu. Obecnie ma zastosowanie tylko do grupy zakresu, a wartość będzie groupId

Wartość logicznaSettingInfoV6

Nazwa	Ścieżka	Typ	Opis
Wartość	value	boolean	Wartość ustawienia
Odziedziczono	inherited	boolean	Prawda, jeśli ustawienie jest dziedziczone z wartości grupy lub konta

SettingsInfoV6

Nazwa	Ścieżka	Typ
libaryDocumentCreationVisible	libaryDocumentCreationVisible	BooleanSettingInfoV6
sendRestrictedToWorkflows	sendRestrictedToWorkflows	BooleanSettingInfoV6
userCanSend	userCanSend	BooleanSettingInfoV6
widgetCreationVisible	widgetCreationVisible	BooleanSettingInfoV6

UserGroupInfoV6

Nazwa	Ścieżka	Typ	Opis
Identyfikator grupy	id	string	Unikatowy identyfikator grupy
Jest administratorem grupy	isGroupAdmin	boolean	Prawda, jeśli użytkownik jest administratorem grupy
Jest grupą podstawową	isPrimaryGroup	boolean	Prawda, jeśli grupa jest grupą podstawową użytkownika
Status	status	string	Stan członkostwa w grupie
Data utworzenia	createdDate	date	Grupa dat została utworzona
Nazwa grupy	name	string	Nazwa grupy
ustawienia	settings	SettingsInfoV6

UserGroupsInfoV6

Kod JSON zawierający listę grup dla danego użytkownika

Nazwa	Ścieżka	Typ	Opis
Lista grup użytkowników	groupInfoList	array of UserGroupInfoV6	Tablica elementów informacji o grupie użytkowników

Kontrolki AgreementView

Lista widoków umów

Nazwa	Ścieżka	Typ	Opis
Lista widoków umowy	agreementViewList	array of AgreementView	Widoki umowy

AgreementView

Nazwa wymaganego widoku i żądanej konfiguracji.

Nazwa	Ścieżka	Typ	Opis
Wyświetl adres URL	url	string	Adres URL lokalizacji zasobu
Kod osadzony	embeddedCode	string	Osadzony kod adresu URL zasobu
Wygaśnięcie	expiration	string	Wygaśnięcie adresu URL użytkownika
Jest bieżącym widokiem	isCurrent	boolean	Prawda, jeśli ten widok jest bieżącym widokiem

binarny

Jest to podstawowy typ danych "binary".

obiekt

Jest to typ 'obiekt'.

plik

Jest to podstawowy typ danych "file".

Udostępnij przez

Adobe Acrobat Sign

Adobe Acrobat Sign

Wydawca: Adobe, Inc.

Wymagania wstępne

Jak uzyskać poświadczenia

Wprowadzenie do łącznika

Znane problemy i ograniczenia

Typowe błędy i środki zaradcze

Często zadawane pytania

Limity ograniczania

Akcje

Anulowanie umowy

Parametry

Pobieranie adresu URL podpisywania

Parametry

Zwraca

Pobieranie danych pola formularza umowy (stare) [PRZESTARZAŁE]

Parametry

Zwraca

Pobieranie danych pola formularza umowy w formacie CSV

Parametry

Zwraca

Pobieranie danych pola formularza umowy w formacie JSON

Parametry

Zwraca

Pobieranie dokumentu z umowy

Parametry

Zwraca

Pobieranie dokumentu z umowy [PRZESTARZAŁE]

Parametry

Zwraca

Pobieranie listy wszystkich formularzy internetowych

Parametry

Zwraca

Pobieranie listy wszystkich grup, do których należy użytkownik

Parametry

Zwraca

Pobieranie listy wszystkich identyfikatorów dokumentów z umowy

Parametry

Zwraca

Pobieranie listy wszystkich przepływów pracy

Parametry

Zwraca

Pobieranie listy wszystkich szablonów bibliotek

Parametry

Zwraca

Pobieranie listy wszystkich umów

Parametry

Zwraca

Pobieranie listy wszystkich umów na podstawie kryteriów wyszukiwania

Parametry

Zwraca

Pobieranie pliku PDF podpisanej umowy

Parametry

Zwraca

Pobierz listę wszystkich identyfikatorów dokumentów z umowy [PRZESTARZAŁE]

Parametry

Zwraca

Pobierz listę wszystkich szablonów bibliotek (stary) [PRZESTARZAŁE]

Zwraca

Pobierz listę wszystkich umów (stare) [PRZESTARZAŁE]

Zwraca

Pobierz plik PDF dziennika inspekcji umowy

Parametry

Zwraca

Pobierz plik PDF podpisanej umowy [PRZESTARZAŁE]

Parametry

Zwraca

Przekazywanie dokumentu i pobieranie identyfikatora dokumentu

Parametry

Zwraca

Przekaż dokument i pobierz identyfikator dokumentu (stary) [PRZESTARZAŁE]

Parametry

Zwraca

Tworzenie szablonu biblioteki na podstawie adresu URL dokumentu

Parametry

Zwraca

Tworzenie szablonu biblioteki na podstawie adresu URL dokumentu (stary) [PRZESTARZAŁE]

Parametry