Identyfikator elementu członkowskiego

Określa format odpowiedzi. Służy pdf do binarnego pliku PDF i base64 odpowiedzi zakodowanej w formacie Base64. Przykładowa base64 odpowiedź: json { "base64": "JVBERi0xLjQKJe..." }

Określ liczbę wpisów na stronę.

Określ numer strony.

Określ filtr dokumentu.

Sortowanie dokumentów. Dołącz ciąg ":true" do sortowania malejącego.

Wyszukaj zapytanie o różne informacje.

Zachowanie:

• Zazwyczaj bez uwzględniania wielkości liter
• Jedno słowo lub fraza cytowana (np. "Raport kwartalny") wykonuje dopasowanie podciągów
• Wiele wyrazów rozdzielonych spacjami (np. kwartalny raport Q1) musi być zgodny z podciągami (AND)
• Przeszukane pola: nazwa dokumentu, wiadomości e-mail członków, imię/nazwisko członka, nazwa folderu
• Symbole wieloznaczne/wyrażenia regularne nie są obsługiwane
• Jeśli wewnętrzny indeks wyszukiwania nie został jeszcze zaktualizowany, przeszukiwana jest tylko nazwa dokumentu

Filtruj dokumenty według nazwy etykiety.

Filtruje wyniki rozpoczynające się od określonej wartości utworzonej Data i godzina w formacie UTC ( nie filtruje według wartości updatedAt). Użyj tego parametru w połączeniu z parametrem "endDate", aby zdefiniować zakres czasu.

Filtruje wyniki kończące się na określonej wartości createdAt daty i godziny w formacie UTC ( nie filtruje według wartości updatedAt). Użyj tego parametru w połączeniu z parametrem "startDate", aby zdefiniować zakres czasu.

Adres e-mail nadawcy. Musi należeć do członka planu.

Imię nadawcy.

Nazwisko nadawcy.

Rola nadawcy we wszystkich dokumentach.

Adres e-mail odbiorcy.

Imię odbiorcy.

Nazwisko odbiorcy.

Jeśli ustawiono true wartość na żadną wiadomość e-mail, zostanie wysłana do adresata.

Do użycia tylko wtedy, gdy adres e-mail adresata jest nieznany w momencie zapraszania. Działa to tylko wtedy, gdy zapraszasz adresatów (nie do przygotowywania tras) i chcesz użyć funkcji fastlane. Element customId umożliwia wstępne wygenerowanie unikatowego linku podpisywania dla adresata przed wysłaniem zaproszenia. Musi być unikatowym, alfanumerycznym ciągiem o długości co najmniej 70 znaków.

Uwaga: identyfikator customId może służyć tylko do kompilowania linku odbiorcy do dokumentu. Nie można go używać dla innych żądań zamiast identyfikatora memberId. Aby uzyskać szczegółowe informacje na temat budowy adresu URL, zobacz Otwieranie dokumentu przy użyciu identyfikatora niestandardowego

Jeśli jest ustawiona true wartość signer, otrzyma link Fastlane w wiadomości e-mail z zaproszeniem.

Numer telefonu tego adresata. Jest to używane do weryfikacji wiadomości SMS. (np. +43 699 1234 1234).

Prywatna wiadomość dla tego konkretnego adresata.

Po włączeniu tej opcji adresat żądania podpisu będzie musiał podpisać dokument osobiście i nie zostanie wysłana żadna wiadomość e-mail. Ten tryb jest dostępny tylko przy użyciu typu podpisu SES

Typ podpisu dozwolony dla tego adresata. Obsługiwana jest co najwyżej jedna wartość. Opcje: "advanced", "advancedPlus", "qualified", "qualifiedPlusIdent", "simple"

Ten tag określa dostawcę tożsamości, który będzie używany do procesu podpisywania. Wybierz spośród wstępnie zdefiniowanego zestawu obsługiwanych dostawców.

Uwaga1: Niektórzy dostawcy są dostępni tylko dla niektórych parametrów signatureTypes, na przykład onetimeqes będą wymagać "signatureType" : ["qualifiedPlusIdent"]

Uwaga2: W przypadku używania sproof-qualified jako domyślnego dostawcy odbiorca musi mieć aktywne konto odporne na działanie licencji User+ .

Wartość logiczna określająca, czy zaproszony odbiorca powinien mieć możliwość zmiany dostawcy podpisu

Domyślny kraj, jeśli jest pusty dla wszystkich, zostanie zwrócony błąd z wybranym tagiem dostawcy

Data podpisania dokumentu. Ta data ukończenia jest wyświetlana adresatowi w wiadomości e-mail z zaproszeniem i jest również widoczna w sekcji szczegółów dokumentu pulpitu nawigacyjnego. Służy jako termin ukończenia procesu podpisywania.

Określa liczbę dni między wiadomościami e-mail z przypomnieniami.

Data wysłania przypomnień

Określa język wiadomości e-mail wysyłanych do anonimowych użytkowników, którzy nie mają konta. W przypadku użytkowników z kontem zostanie użyty język wybrany w swoim profilu.

Wiadomość niestandardowa wysłana do adresatów w wiadomości e-mail.

Wiersz tematu wiadomości e-mail wysłanej do adresatów.

Jeśli ustawiono wartość true, plik PDF zostanie wysłany jako załącznik do wszystkich adresatów dokumentu (jeśli jest mniejszy niż 5 MB).

Po włączeniu tej opcji adresat żądania podpisu będzie ograniczony do podpisywania lub odrzucania dokumentu i nie będzie mógł przejść z dala od strony.

Zezwalaj na przekazywanie zaproszenia.

Obiekt, w którym każdy klucz reprezentuje rundę podpisywania, a jego odpowiadająca wartość wskazuje, czy podpisywanie współpracy jest włączone dla tej rundy. Jeśli wartość ma wartość true, wymagany jest tylko jeden podpis, aby ukończyć określoną rundę podpisywania i przejść do następnej rundy. Na przykład { "1": true } oznacza, że w rundzie podpisywania "1" wymagany jest tylko jeden podpis.

Jeśli wartość true, symbole zastępcze/pola tekstowe przechowywane w dokumencie będą używane do zapraszania adresatów.

Jeśli to prawda, odbiorca otrzymuje wyskakujące okienko, w którym musi ręcznie narysować podpis

Jeśli zostanie podana, zostanie utworzona koperta zawierająca wszystkie dokumenty w dokumencieDataArray. (Wymagane w przypadku wysłania więcej niż jednego dokumentu)

Żądanie POST, w tym dokument, zostanie wysłane do tego adresu URL po utworzeniu nowego podpisu lub odrzuceniu dokumentu przez adresata. W przypadku awarii istnieje mechanizm ponawiania prób, aby upewnić się, że żądanie zostanie ponowione.

Link przycisku powrotu po podpisaniu dokumentu

Tekst przycisku powrotu po podpisaniu dokumentu

Dane dokumentu (PDF lub DOCX) w formacie base64.

Typ MIME zakodowanych danych base64 PDF lub DOCX, wymagany, jeśli dokument nie jest plikiem PDF

Nazwa pliku

Etykieta niestandardowa, którą można wysłać w celu organizowania dokumentów.

Liczba stron, na których znajduje się pole, a pierwsza strona wynosi 0.

Dowolna wartość całkowita opisująca szerokość strony. Większa liczba, tym większa precyzja podczas pozycjonowania pola w x y spacji. Na stronie A4 mamy 478 jako wartość domyślną.

Dowolna wartość całkowita opisująca wysokość strony. Większa liczba, tym większa precyzja podczas pozycjonowania pola w x y spacji. Na stronie A4 mamy 676 jako wartość domyślną.

Reprezentuje położenie poziome pola jako procent szerokości strony. Źródło (0,0) znajduje się w lewym górnym rogu strony. Wartość 0,1 oznacza, że pole jest ustawione na 10% szerokości strony po lewej stronie.

Przedstawia położenie pola w pionie jako procent wysokości strony. Źródło (0,0) znajduje się w lewym górnym rogu strony. Wartość 0,1 oznacza, że pole jest umieszczone na 10% wysokości strony od góry.

Szerokość pola na podstawie wymiarów strony, podobnie jak współrzędne x i y. Jest to zmiennoprzecinkowa reprezentująca procent stronyWidth.

Wysokość pola na podstawie wymiarów strony, podobnie jak współrzędnych x i y. Jest to zmiennoprzecinkowy reprezentujący procent stronyHeight.

Unikatowy identyfikator tego pola wygenerowany w dowolny sposób.

Tekst zastępczy, taki jak nazwa pola, np. "Data urodzenia".

Wartość domyślna pola. Może mieć wartość null. Jeśli pole ma typ "chooseBox", wartość może mieć wartość null lub jeden z ciągów zdefiniowanych w opcjach.

Stabilny identyfikator pola skonfigurowany w interfejsie użytkownika. Służy do wstępnego wypełniania pól formularza przepływu pracy za pośrednictwem żądań interfejsu API.

Jeśli ustawiono wartość true, zaproszona osoba nie może zmodyfikować wartości tego pola.

Jeśli ustawiono wartość true, zaproszona osoba nie może podpisać dokumentu bez wypełniania tego pola.

Określa, czy wiele wierszy jest dozwolonych.

Każde pole radiowe można przypisać do grupy.

Typ podpisu dozwolony dla tego dokumentu może zostać zastąpiony przez typ podpisu adresata. Obsługiwana jest co najwyżej jedna wartość. Opcje: "advanced", "advancedPlus", "qualified", "simple", "qualifiedPlusIdent"

Identyfikator refId jest opcjonalnym polem używanym do krzyżowego odwoływanie się do przekazanego dokumentu. Jeśli zostanie podana, umożliwia przypisanie niestandardowego identyfikatora odwołania do dokumentu, który zostanie zwrócony jako część obiektu dokumentu w przyszłych odpowiedziach interfejsu API. Może to być przydatne do śledzenia lub organizowania dokumentów przez system zewnętrzny lub przepływ pracy.

Język dokumentów.

Identyfikator folderu, do którego należy wstawić dokumenty. Jest to możliwe tylko wtedy, gdy zarówno inviteData, jak i folderName są niezdefiniowane.

Usługa isAttachment nie jest wymagana w tym przypadku.

Szczegóły adresata są kluczem wiadomości e-mail adresata. Przykład: {""mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.0.08}]}}.

Jeśli jest ustawiona true wartość signer, otrzyma link Fastlane w wiadomości e-mail z zaproszeniem.

Określ profil rozwiązania Fastlane, który ma być używany z tym dokumentem. (parametr useFastlane musi być ustawiony na wartość true).

Adres e-mail nadawcy. Musi należeć do członka planu.

Imię nadawcy.

Nazwisko nadawcy.

Rola nadawcy we wszystkich dokumentach.

Adres e-mail odbiorcy.

Imię odbiorcy.

Nazwisko odbiorcy.

Jeśli ustawiono true wartość na żadną wiadomość e-mail, zostanie wysłana do adresata.

Do użycia tylko wtedy, gdy adres e-mail adresata jest nieznany w momencie zapraszania. Działa to tylko wtedy, gdy zapraszasz adresatów (nie do przygotowywania tras) i chcesz użyć funkcji fastlane. Element customId umożliwia wstępne wygenerowanie unikatowego linku podpisywania dla adresata przed wysłaniem zaproszenia. Musi być unikatowym, alfanumerycznym ciągiem o długości co najmniej 70 znaków.

Uwaga: identyfikator customId może służyć tylko do kompilowania linku odbiorcy do dokumentu. Nie można go używać dla innych żądań zamiast identyfikatora memberId. Aby uzyskać szczegółowe informacje na temat budowy adresu URL, zobacz Otwieranie dokumentu przy użyciu identyfikatora niestandardowego

Jeśli jest ustawiona true wartość signer, otrzyma link Fastlane w wiadomości e-mail z zaproszeniem.

Numer telefonu tego adresata. Jest to używane do weryfikacji wiadomości SMS. (np. +43 699 1234 1234).

Prywatna wiadomość dla tego konkretnego adresata.

Po włączeniu tej opcji adresat żądania podpisu będzie musiał podpisać dokument osobiście i nie zostanie wysłana żadna wiadomość e-mail. Ten tryb jest dostępny tylko przy użyciu typu podpisu SES

Typ podpisu dozwolony dla tego adresata. Obsługiwana jest co najwyżej jedna wartość. Opcje: "advanced", "advancedPlus", "qualified", "qualifiedPlusIdent", "simple"

Ten tag określa dostawcę tożsamości, który będzie używany do procesu podpisywania. Wybierz spośród wstępnie zdefiniowanego zestawu obsługiwanych dostawców.

Uwaga1: Niektórzy dostawcy są dostępni tylko dla niektórych parametrów signatureTypes, na przykład onetimeqes będą wymagać "signatureType" : ["qualifiedPlusIdent"]

Uwaga2: W przypadku używania sproof-qualified jako domyślnego dostawcy odbiorca musi mieć aktywne konto odporne na działanie licencji User+ .

Wartość logiczna określająca, czy zaproszony odbiorca powinien mieć możliwość zmiany dostawcy podpisu

Domyślny kraj, jeśli jest pusty dla wszystkich, zostanie zwrócony błąd z wybranym tagiem dostawcy

Data podpisania dokumentu. Ta data ukończenia jest wyświetlana adresatowi w wiadomości e-mail z zaproszeniem i jest również widoczna w sekcji szczegółów dokumentu pulpitu nawigacyjnego. Służy jako termin ukończenia procesu podpisywania.

Określa liczbę dni między wiadomościami e-mail z przypomnieniami.

Data wysłania przypomnień

Określa język wiadomości e-mail wysyłanych do anonimowych użytkowników, którzy nie mają konta. W przypadku użytkowników z kontem zostanie użyty język wybrany w swoim profilu.

Wiadomość niestandardowa wysłana do adresatów w wiadomości e-mail.

Wiersz tematu wiadomości e-mail wysłanej do adresatów.

Jeśli ustawiono wartość true, plik PDF zostanie wysłany jako załącznik do wszystkich adresatów dokumentu (jeśli jest mniejszy niż 5 MB).

Po włączeniu tej opcji adresat żądania podpisu będzie ograniczony do podpisywania lub odrzucania dokumentu i nie będzie mógł przejść z dala od strony.

Zezwalaj na przekazywanie zaproszenia.

Obiekt, w którym każdy klucz reprezentuje rundę podpisywania, a jego odpowiadająca wartość wskazuje, czy podpisywanie współpracy jest włączone dla tej rundy. Jeśli wartość ma wartość true, wymagany jest tylko jeden podpis, aby ukończyć określoną rundę podpisywania i przejść do następnej rundy. Na przykład { "1": true } oznacza, że w rundzie podpisywania "1" wymagany jest tylko jeden podpis.

Jeśli wartość true, symbole zastępcze/pola tekstowe przechowywane w dokumencie będą używane do zapraszania adresatów.

Jeśli to prawda, odbiorca otrzymuje wyskakujące okienko, w którym musi ręcznie narysować podpis

Jeśli zostanie podana, zostanie utworzona koperta zawierająca wszystkie dokumenty w dokumencieDataArray. (Wymagane w przypadku wysłania więcej niż jednego dokumentu)

Żądanie POST, w tym dokument, zostanie wysłane do tego adresu URL po utworzeniu nowego podpisu lub odrzuceniu dokumentu przez adresata. W przypadku awarii istnieje mechanizm ponawiania prób, aby upewnić się, że żądanie zostanie ponowione.

Link przycisku powrotu po podpisaniu dokumentu

Tekst przycisku powrotu po podpisaniu dokumentu

Dane dokumentu (PDF lub DOCX) w formacie base64.

Typ MIME zakodowanych danych base64 PDF lub DOCX, wymagany, jeśli dokument nie jest plikiem PDF

Nazwa pliku

Etykieta niestandardowa, którą można wysłać w celu organizowania dokumentów.

Liczba stron, na których znajduje się pole, a pierwsza strona wynosi 0.

Dowolna wartość całkowita opisująca szerokość strony. Większa liczba, tym większa precyzja podczas pozycjonowania pola w x y spacji. Na stronie A4 mamy 478 jako wartość domyślną.

Dowolna wartość całkowita opisująca wysokość strony. Większa liczba, tym większa precyzja podczas pozycjonowania pola w x y spacji. Na stronie A4 mamy 676 jako wartość domyślną.

Reprezentuje położenie poziome pola jako procent szerokości strony. Źródło (0,0) znajduje się w lewym górnym rogu strony. Wartość 0,1 oznacza, że pole jest ustawione na 10% szerokości strony po lewej stronie.

Przedstawia położenie pola w pionie jako procent wysokości strony. Źródło (0,0) znajduje się w lewym górnym rogu strony. Wartość 0,1 oznacza, że pole jest umieszczone na 10% wysokości strony od góry.

Szerokość pola na podstawie wymiarów strony, podobnie jak współrzędne x i y. Jest to zmiennoprzecinkowa reprezentująca procent stronyWidth.

Wysokość pola na podstawie wymiarów strony, podobnie jak współrzędnych x i y. Jest to zmiennoprzecinkowy reprezentujący procent stronyHeight.

Unikatowy identyfikator tego pola wygenerowany w dowolny sposób.

Tekst zastępczy, taki jak nazwa pola, np. "Data urodzenia".

Wartość domyślna pola. Może mieć wartość null. Jeśli pole ma typ "chooseBox", wartość może mieć wartość null lub jeden z ciągów zdefiniowanych w opcjach.

Stabilny identyfikator pola skonfigurowany w interfejsie użytkownika. Służy do wstępnego wypełniania pól formularza przepływu pracy za pośrednictwem żądań interfejsu API.

Jeśli ustawiono wartość true, zaproszona osoba nie może zmodyfikować wartości tego pola.

Jeśli ustawiono wartość true, zaproszona osoba nie może podpisać dokumentu bez wypełniania tego pola.

Określa, czy wiele wierszy jest dozwolonych.

Każde pole radiowe można przypisać do grupy.

Typ podpisu dozwolony dla tego dokumentu może zostać zastąpiony przez typ podpisu adresata. Obsługiwana jest co najwyżej jedna wartość. Opcje: "advanced", "advancedPlus", "qualified", "simple", "qualifiedPlusIdent"

Identyfikator refId jest opcjonalnym polem używanym do krzyżowego odwoływanie się do przekazanego dokumentu. Jeśli zostanie podana, umożliwia przypisanie niestandardowego identyfikatora odwołania do dokumentu, który zostanie zwrócony jako część obiektu dokumentu w przyszłych odpowiedziach interfejsu API. Może to być przydatne do śledzenia lub organizowania dokumentów przez system zewnętrzny lub przepływ pracy.

Język dokumentów.

Identyfikator folderu, do którego należy wstawić dokumenty. Jest to możliwe tylko wtedy, gdy zarówno inviteData, jak i folderName są niezdefiniowane.

Usługa isAttachment nie jest wymagana w tym przypadku.

Szczegóły adresata są kluczem wiadomości e-mail adresata. Przykład: {""mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.0.08}]}}.

Jeśli jest ustawiona true wartość signer, otrzyma link Fastlane w wiadomości e-mail z zaproszeniem.

Określ profil rozwiązania Fastlane, który ma być używany z tym dokumentem. (parametr useFastlane musi być ustawiony na wartość true).

Adres e-mail nadawcy. Musi należeć do członka planu.

Imię nadawcy.

Nazwisko nadawcy.

Rola nadawcy we wszystkich dokumentach.

Adres e-mail odbiorcy.

Imię odbiorcy.

Nazwisko odbiorcy.

Jeśli ustawiono true wartość na żadną wiadomość e-mail, zostanie wysłana do adresata.

Do użycia tylko wtedy, gdy adres e-mail adresata jest nieznany w momencie zapraszania. Działa to tylko wtedy, gdy zapraszasz adresatów (nie do przygotowywania tras) i chcesz użyć funkcji fastlane. Element customId umożliwia wstępne wygenerowanie unikatowego linku podpisywania dla adresata przed wysłaniem zaproszenia. Musi być unikatowym, alfanumerycznym ciągiem o długości co najmniej 70 znaków.

Uwaga: identyfikator customId może służyć tylko do kompilowania linku odbiorcy do dokumentu. Nie można go używać dla innych żądań zamiast identyfikatora memberId. Aby uzyskać szczegółowe informacje na temat budowy adresu URL, zobacz Otwieranie dokumentu przy użyciu identyfikatora niestandardowego

Jeśli jest ustawiona true wartość signer, otrzyma link Fastlane w wiadomości e-mail z zaproszeniem.

Numer telefonu tego adresata. Jest to używane do weryfikacji wiadomości SMS. (np. +43 699 1234 1234).

Prywatna wiadomość dla tego konkretnego adresata.

Po włączeniu tej opcji adresat żądania podpisu będzie musiał podpisać dokument osobiście i nie zostanie wysłana żadna wiadomość e-mail. Ten tryb jest dostępny tylko przy użyciu typu podpisu SES

Typ podpisu dozwolony dla tego adresata. Obsługiwana jest co najwyżej jedna wartość. Opcje: "advanced", "advancedPlus", "qualified", "qualifiedPlusIdent", "simple"

Ten tag określa dostawcę tożsamości, który będzie używany do procesu podpisywania. Wybierz spośród wstępnie zdefiniowanego zestawu obsługiwanych dostawców.

Uwaga1: Niektórzy dostawcy są dostępni tylko dla niektórych parametrów signatureTypes, na przykład onetimeqes będą wymagać "signatureType" : ["qualifiedPlusIdent"]

Uwaga2: W przypadku używania sproof-qualified jako domyślnego dostawcy odbiorca musi mieć aktywne konto odporne na działanie licencji User+ .

Wartość logiczna określająca, czy zaproszony odbiorca powinien mieć możliwość zmiany dostawcy podpisu

Domyślny kraj, jeśli jest pusty dla wszystkich, zostanie zwrócony błąd z wybranym tagiem dostawcy

Data podpisania dokumentu. Ta data ukończenia jest wyświetlana adresatowi w wiadomości e-mail z zaproszeniem i jest również widoczna w sekcji szczegółów dokumentu pulpitu nawigacyjnego. Służy jako termin ukończenia procesu podpisywania.

Określa liczbę dni między wiadomościami e-mail z przypomnieniami.

Data wysłania przypomnień

Określa język wiadomości e-mail wysyłanych do anonimowych użytkowników, którzy nie mają konta. W przypadku użytkowników z kontem zostanie użyty język wybrany w swoim profilu.

Wiadomość niestandardowa wysłana do adresatów w wiadomości e-mail.

Wiersz tematu wiadomości e-mail wysłanej do adresatów.

Jeśli ustawiono wartość true, plik PDF zostanie wysłany jako załącznik do wszystkich adresatów dokumentu (jeśli jest mniejszy niż 5 MB).

Po włączeniu tej opcji adresat żądania podpisu będzie ograniczony do podpisywania lub odrzucania dokumentu i nie będzie mógł przejść z dala od strony.

Zezwalaj na przekazywanie zaproszenia.

Obiekt, w którym każdy klucz reprezentuje rundę podpisywania, a jego odpowiadająca wartość wskazuje, czy podpisywanie współpracy jest włączone dla tej rundy. Jeśli wartość ma wartość true, wymagany jest tylko jeden podpis, aby ukończyć określoną rundę podpisywania i przejść do następnej rundy. Na przykład { "1": true } oznacza, że w rundzie podpisywania "1" wymagany jest tylko jeden podpis.

Jeśli to prawda, odbiorca otrzymuje wyskakujące okienko, w którym musi ręcznie narysować podpis

Jeśli zostanie podana, zostanie utworzona koperta zawierająca wszystkie dokumenty w dokumencieDataArray. (Wymagane w przypadku wysłania więcej niż jednego dokumentu)

Żądanie POST, w tym dokument, zostanie wysłane do tego adresu URL po utworzeniu nowego podpisu lub odrzuceniu dokumentu przez adresata. W przypadku awarii istnieje mechanizm ponawiania prób, aby upewnić się, że żądanie zostanie ponowione.

Link przycisku powrotu po podpisaniu dokumentu

Tekst przycisku powrotu po podpisaniu dokumentu

Dane dokumentu (PDF lub DOCX) w formacie base64.

Typ MIME zakodowanych danych base64 PDF lub DOCX, wymagany, jeśli dokument nie jest plikiem PDF

Nazwa pliku

Etykieta niestandardowa, którą można wysłać w celu organizowania dokumentów.

Liczba stron, na których znajduje się pole, a pierwsza strona wynosi 0.

Dowolna wartość całkowita opisująca szerokość strony. Większa liczba, tym większa precyzja podczas pozycjonowania pola w x y spacji. Na stronie A4 mamy 478 jako wartość domyślną.

Dowolna wartość całkowita opisująca wysokość strony. Większa liczba, tym większa precyzja podczas pozycjonowania pola w x y spacji. Na stronie A4 mamy 676 jako wartość domyślną.

Reprezentuje położenie poziome pola jako procent szerokości strony. Źródło (0,0) znajduje się w lewym górnym rogu strony. Wartość 0,1 oznacza, że pole jest ustawione na 10% szerokości strony po lewej stronie.

Przedstawia położenie pola w pionie jako procent wysokości strony. Źródło (0,0) znajduje się w lewym górnym rogu strony. Wartość 0,1 oznacza, że pole jest umieszczone na 10% wysokości strony od góry.

Szerokość pola na podstawie wymiarów strony, podobnie jak współrzędne x i y. Jest to zmiennoprzecinkowa reprezentująca procent stronyWidth.

Wysokość pola na podstawie wymiarów strony, podobnie jak współrzędnych x i y. Jest to zmiennoprzecinkowy reprezentujący procent stronyHeight.

Unikatowy identyfikator tego pola wygenerowany w dowolny sposób.

Tekst zastępczy, taki jak nazwa pola, np. "Data urodzenia".

Wartość domyślna pola. Może mieć wartość null. Jeśli pole ma typ "chooseBox", wartość może mieć wartość null lub jeden z ciągów zdefiniowanych w opcjach.

Stabilny identyfikator pola skonfigurowany w interfejsie użytkownika. Służy do wstępnego wypełniania pól formularza przepływu pracy za pośrednictwem żądań interfejsu API.

Jeśli ustawiono wartość true, zaproszona osoba nie może zmodyfikować wartości tego pola.

Jeśli ustawiono wartość true, zaproszona osoba nie może podpisać dokumentu bez wypełniania tego pola.

Określa, czy wiele wierszy jest dozwolonych.

Każde pole radiowe można przypisać do grupy.

Typ podpisu dozwolony dla tego dokumentu może zostać zastąpiony przez typ podpisu adresata. Obsługiwana jest co najwyżej jedna wartość. Opcje: "advanced", "advancedPlus", "qualified", "simple", "qualifiedPlusIdent"

Identyfikator refId jest opcjonalnym polem używanym do krzyżowego odwoływanie się do przekazanego dokumentu. Jeśli zostanie podana, umożliwia przypisanie niestandardowego identyfikatora odwołania do dokumentu, który zostanie zwrócony jako część obiektu dokumentu w przyszłych odpowiedziach interfejsu API. Może to być przydatne do śledzenia lub organizowania dokumentów przez system zewnętrzny lub przepływ pracy.

Język dokumentów.

Identyfikator folderu, do którego należy wstawić dokumenty. Jest to możliwe tylko wtedy, gdy zarówno inviteData, jak i folderName są niezdefiniowane.

Usługa isAttachment nie jest wymagana w tym przypadku.

Jeśli jest ustawiona true wartość signer, otrzyma link Fastlane w wiadomości e-mail z zaproszeniem.

Określ profil rozwiązania Fastlane, który ma być używany z tym dokumentem. (parametr useFastlane musi być ustawiony na wartość true).

Identyfikator elementu członkowskiego

Dotyczy tylko pojedynczych dokumentów, gdy podany memberId element należy do nadawcy. Jeśli ustawiono truewartość , dokument zostanie usunięty dla nadawcy i wszystkich adresatów. Jeśli ustawiono falsewartość , dokument zostanie usunięty tylko dla nadawcy i pozostanie dostępny dla innych adresatów. Ten parametr nie ma wpływu na dokumenty w kopercie (wartość domyślna = true) lub gdy podana memberId wartość należy do adresata.

Identyfikator elementu członkowskiego