Sprawdzonych
Łącznik zweryfikowanego interfejsu API w celu umożliwienia tworzenia niestandardowych procesów podpisywania dokumentów.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate - narzędzie do automatyzacji procesów | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Sprawdzonych |
| adres URL | https://verified.eu/en/#about-us |
| support@verified.eu |
| Metadane łącznika | |
|---|---|
| Publisher | Crm - Konsulterna i Sverige AB |
| Witryna internetowa | https://verified.eu/ |
| Zasady ochrony prywatności | https://verified.eu/trust-center |
| Kategorie | Zawartość i pliki; Produktywność |
Zweryfikowano jest dostawcą oprogramowania jako usługi identyfikacji elektronicznej i podpisywania cyfrowego. Ten łącznik umożliwia integrację z interfejsem API zweryfikowanych oraz tworzenie prostych i intuicyjnych procesów podpisywania w aplikacji.
Wymagania wstępne
Aby kontynuować, musisz wykonać następujące czynności:
- Tworzenie konta zweryfikowanego
Jak uzyskać poświadczenia
Ten łącznik używa uwierzytelniania podstawowego. Użytkownik musi przedstawić nazwę użytkownika, hasło i identyfikator firmy podczas tworzenia połączenia. Nazwa użytkownika i hasło są takie same, jak w celu zalogowania się do portalu zweryfikowanego. Aby uzyskać identyfikator firmy, musisz zalogować się do portalu Zweryfikowane, wybierz poprawną firmę, jeśli masz kilka i skopiuj identyfikator firmy z adresu URL.
Wprowadzenie
Typowym przypadkiem użycia jest rozpoczęcie procesu podpisywania i zarządzanie nim, tj. skonfigurowanie automatyzacji wysyłania dokumentów do podpisania do zweryfikowanych i regularne pobieranie podpisanych dokumentów. Typowe akcje używane do rozpoczęcia procesu weryfikacji podpisywania obejmują tworzenie koperty — deskryptora lub Tworzenie koperty — ustawienie domyślne, Dodawanie dokumentu do koperty, Dodawanie pliku do dokumentu, Dodawanie adresata do koperty i Aktualizowanie stanu publikowania dla koperty. Typowe akcje, które są używane w celu sprawdzenia stanu Zweryfikowano dla dokumentów, to Pobierz kopertę według identyfikatora, Pobierz wszystkie dokumenty według identyfikatora koperty, Pobierz pliki według identyfikatora dokumentu, Pobierz adres URL pliku według identyfikatora. Pamiętaj, że akcja Wygeneruj token zabezpieczający jest zawsze używany jako pierwszy krok w celu uzyskania tokenu zabezpieczającego, który ma być używany w poniższych krokach.
Znane problemy i ograniczenia
Obecnie znane są następujące ograniczenia.
- Na początku każdego przepływu należy utworzyć token uwierzytelniania do ponownego użycia w każdym następnym kroku.
- Aby dodać dokument, należy wysłać żądanie HTTP do określonego adresu URL.
- Aby użyć nowego punktu końcowego wyszukiwania, należy go aktywować dla konta za pośrednictwem zweryfikowanej suppoert.
Często zadawane pytania
Jak przekazać dokument do zweryfikowanego?
Aby przekazać rzeczywisty dokument, musisz utworzyć plik w zweryfikowanym interfejsie API i przekazać skrót dokumentu do adresu URL obiektu blob, który odpowiedział za pomocą zweryfikowanego interfejsu API.
Jak mogę wstrzymać kopertę po użyciu akcji Pobierz kopertę?
Kroki, które tworzą kopertę, odpowiadają za pomocą identyfikatora uid, który jest pełną ścieżką do koperty (na przykład: "/koperty/ABCDE"). W przypadku innych kroków wystarczy tylko ostatnia część identyfikatora uid (która jest rzeczywistym identyfikatorem koperty, w naszym przykładzie "ABCDE").
Oto przykład dotyczący tego, jak to zrobić
substring(outputs('Create_new_default_envelope')?['body/uid'],11)
Jak mogę zatrzymać identyfikator dokumentu po użyciu akcji Dodaj dokument do koperty?
Kroki, które tworzą dokument, odpowiadają za pomocą pozycji Lokalizacja nowego dokumentu w nagłówku. Lokalizacja jest pełną ścieżką do dokumentu (na przykład: "/api/koperty/ABCDE/documents/FGHIJ"). Tylko identyfikator dokumentu (w naszym przypadku: FGHIJ) jest wymagany do wykonania następujących kroków.
Oto przykład dotyczący tego, jak to zrobić
substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))
Jak uzyskać blokadę identyfikatora przepływu z koperty?
Podczas ładowania informacji o kopercie powiązany przepływ będzie częścią odpowiedzi (na przykład: "/flow/default"). W odpowiedzi jest ona nazywana identyfikatorem przepływu, jednak jedna z nich wymaga tylko ostatniej części, gdy inny krok (na przykład Pobierz stan przepływu) prosi o identyfikator przepływu.
Oto przykład dotyczący tego, jak to zrobić
substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)
Jak mogę użyć nowej akcji Wyszukaj?
Aby można było użyć nowej akcji wyszukiwania, punkt końcowy wyszukiwania musi zostać aktywowany dla Zweryfikowana organizacja. Aby to zrobić, musisz napisać wiadomość e-mail do zweryfikowanego wsparcia, w tym identyfikator organizacji, aby umożliwić im aktywowanie punktu końcowego.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| nazwa użytkownika | securestring | Nazwa użytkownika dla tego interfejsu API | Prawda |
| hasło | securestring | Hasło dla tego interfejsu API | Prawda |
| Identyfikator firmy | ciąg | Identyfikator firmy jest dostarczany przez zweryfikowane. Adres URL można znaleźć, logując się do app.verified.eu | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie adresata według identyfikatora |
Aktualizuje adresata. |
| Aktualizowanie stanu publikowania dla koperty |
Aktualizuje stan publikowania danej koperty. |
| Aktualizowanie ustawień koperty |
Aktualizuje ustawienia danej koperty. |
| Dodawanie adresata do koperty |
Dodaje adresata do danej koperty. |
| Dodawanie dokumentu do koperty |
Dodaje nowy dokument do istniejącej koperty. |
| Dodawanie pliku do dokumentu |
Dodaje plik do istniejącego dokumentu. |
| Generowanie dokumentu na podstawie szablonu |
Generuje dokument na podstawie wstępnie skonfigurowanego szablonu. |
| Generowanie tokenu zabezpieczającego |
Pobiera token uwierzytelniania z zweryfikowanego interfejsu API. |
| Pobieranie adresu URL pliku według identyfikatora |
Pobiera adres URL do danego pliku. |
| Pobieranie deskryptora według identyfikatora |
Pobiera informacje o danym deskryptorze. |
| Pobieranie dokumentu według identyfikatora |
Pobiera informacje o danym dokumencie. |
| Pobieranie domyślnego deskryptora |
Pobiera domyślny deskryptor dla kopert. |
| Pobieranie firmy według identyfikatora |
Pobiera informacje o danej firmie. |
| Pobieranie konkretnego adresata dla koperty |
Pobiera określonego adresata dla danej koperty. |
| Pobieranie koperty według identyfikatora |
Pobiera szczegóły danej koperty. |
| Pobieranie pliku według identyfikatora |
Pobiera informacje o danym pliku. |
| Pobieranie plików według identyfikatora dokumentu |
Pobiera wszystkie pliki połączone z danym dokumentem. |
| Pobieranie stanu przepływu według identyfikatora koperty |
Pobiera bieżący stan przepływu danej koperty. |
| Pobieranie ustawień użytkownika |
Pobiera ustawienia danego użytkownika. |
| Pobieranie wszystkich adresatów koperty |
Pobiera wszystkich adresatów danej koperty. |
| Pobieranie wszystkich deskryptorów |
Pobiera listę wszystkich deskryptorów obecnych w bieżącej firmie. Listę można filtrować. |
| Pobieranie wszystkich dokumentów według identyfikatora koperty |
Pobiera wszystkie dokumenty związane z daną kopertą. |
| Przeszukaj wszystkie koperty |
Przeszukaj wszystkie koperty pasujące do danego filtru. |
| Tworzenie koperty — deskryptor |
Tworzy kopertę na podstawie określonego deskryptora. |
| Tworzenie koperty — ustawienie domyślne |
Tworzy nową kopertę przy użyciu deskryptora domyślnego. |
| Tworzenie linku podpisu |
Tworzy link podpisu. Implementacja jest specyficzna dla przepływu i może brakować określonego przepływu. |
| Ustaw stan przerwania koperty |
Ustawia stan danej koperty na przerwaną. |
| Ustawianie stanu kosza koperty |
Ustawia stan danej koperty do kosza. |
| Ustawianie stanu przerwania dokumentu |
Ustawia stan danego dokumentu na przerwany. |
| Usuwanie dokumentu według identyfikatora |
Usuwa dany dokument. |
| Usuwanie koperty według identyfikatora |
Usuwa daną kopertę. |
| Uzyskiwanie informacji o użytkowniku |
Pobiera informacje o aktualnie zalogowanym użytkowniku. |
| Wykonywanie zapytań względem wszystkich kopert (przestarzałe) |
Wykonuje zapytania dotyczące wszystkich kopert pasujących do danego filtru. (Przestarzałe) |
| Wysyłanie powiadomienia |
Wysyła powiadomienie na adresy e-mail danej koperty. |
Aktualizowanie adresata według identyfikatora
Aktualizuje adresata.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator adresata
|
recipient-id | True | string |
Identyfikator adresatów, o których mowa |
|
Imię
|
givenName | True | string | |
|
Nazwisko
|
familyName | True | string | |
|
Język
|
language | True | string | |
|
Metoda podpisywania
|
signingMethod | True | string | |
|
Notification, metoda
|
notificationMethod | string | ||
|
Poczta e-mail
|
True | string | ||
|
Telefon
|
telephone | string |
Format powinien mieć wartość +<countryCode><numer telefonu> |
|
|
Zamówienie
|
order | integer | ||
|
Akcja
|
action | True | string |
Nazwa zweryfikowanej akcji, jaką powinien wykonać odbiorca. |
|
Etykieta
|
label | True | string |
Etykieta roli/akcji odbiorcy |
|
Name
|
name | True | string |
Zweryfikowana nazwa roli adresata |
|
Bezpieczny
|
secure | boolean | ||
|
SMS
|
sms | boolean | ||
|
numer ubezpieczenia społecznego (SSN)
|
ssn | string | ||
|
Bank
|
bank | string |
Aktualizowanie stanu publikowania dla koperty
Aktualizuje stan publikowania danej koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Opublikowany
|
published | True | boolean |
Aktualizowanie ustawień koperty
Aktualizuje ustawienia danej koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Sekwencyjne podpisywanie
|
sequentialSigning | boolean | ||
|
Powitanie
|
greeting | string | ||
|
Wygaśnięcie
|
expiration | date |
Data w następującym formacie 2017-02-26T21:59:59.999Z |
|
|
Przypomnienia automatyczne
|
automaticReminders | number |
X dni przed wygaśnięciem |
Dodawanie adresata do koperty
Dodaje adresata do danej koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Imię
|
givenName | True | string | |
|
Nazwisko
|
familyName | True | string | |
|
Język
|
language | True | string | |
|
Metoda podpisywania
|
signingMethod | True | string | |
|
Notification, metoda
|
notificationMethod | string | ||
|
Poczta e-mail
|
True | string | ||
|
Telefon
|
telephone | string |
Format powinien mieć wartość +<countryCode><numer telefonu> |
|
|
Zamówienie
|
order | integer | ||
|
Akcja
|
action | True | string |
Nazwa zweryfikowanej akcji, jaką powinien wykonać odbiorca. |
|
Etykieta
|
label | True | string |
Etykieta roli/akcji odbiorcy |
|
Name
|
name | True | string |
Zweryfikowana nazwa roli adresata |
|
Bezpieczny
|
secure | boolean | ||
|
SMS
|
sms | boolean | ||
|
numer ubezpieczenia społecznego (SSN)
|
ssn | string | ||
|
Bank
|
bank | string |
Dodawanie dokumentu do koperty
Dodaje nowy dokument do istniejącej koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Hash
|
hash | integer | ||
|
Name
|
name | True | string | |
|
Źródło
|
source | string |
Dodawanie pliku do dokumentu
Dodaje plik do istniejącego dokumentu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator dokumentu
|
document-id | True | string |
Identyfikator danego dokumentu |
|
Name
|
name | True | string | |
|
FileType
|
fileType | True | string | |
|
Hash
|
hash | string |
Zwraca
- File
- File
Generowanie dokumentu na podstawie szablonu
Generuje dokument na podstawie wstępnie skonfigurowanego szablonu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator dokumentu
|
document-id | True | string |
Identyfikator danego dokumentu |
|
Identyfikator szablonu
|
template-id | True | string |
Identyfikator szablonu, który powinien być używany |
|
|
object |
Generowanie tokenu zabezpieczającego
Pobiera token uwierzytelniania z zweryfikowanego interfejsu API.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Bez blokady adresu IP
|
withoutIpLock | True | integer |
Czy zweryfikowano aktywuje blokadę adresu IP (0, wartość domyślna) lub nie (1) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Żeton
|
token | string |
Token dostępu |
Pobieranie adresu URL pliku według identyfikatora
Pobiera adres URL do danego pliku.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator dokumentu
|
document-id | True | string |
Identyfikator danego dokumentu |
|
Identyfikator pliku
|
file-id | True | string |
Identyfikator danego pliku |
|
Jako obiekt
|
asObject | boolean |
Określa, czy odpowiedź jest obiektem |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
adres URL
|
url | string |
Adres URL pliku |
Pobieranie deskryptora według identyfikatora
Pobiera informacje o danym deskryptorze.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator deskryptora koperty
|
envelope-descriptor-id | True | string |
Identyfikator deskryptora koperty |
Zwraca
- Deskryptora
- Descriptor
Pobieranie dokumentu według identyfikatora
Pobiera informacje o danym dokumencie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator dokumentu
|
document-id | True | string |
Identyfikator danego dokumentu |
Zwraca
- Dokument
- Document
Pobieranie domyślnego deskryptora
Pobiera domyślny deskryptor dla kopert.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Filtry
|
filters | string |
Filtrowanie zapytania w celu wybrania podinstalowania |
Zwraca
- Deskryptora
- Descriptor
Pobieranie firmy według identyfikatora
Pobiera informacje o danej firmie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
company-id | True | string |
Identyfikator danej firmy |
Zwraca
- Firma
- Company
Pobieranie konkretnego adresata dla koperty
Pobiera określonego adresata dla danej koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator adresata
|
recipient-id | True | string |
Identyfikator adresatów, o których mowa |
Zwraca
- Recipient
- Recipient
Pobieranie koperty według identyfikatora
Pobiera szczegóły danej koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
Zwraca
- Koperta
- Envelope
Pobieranie pliku według identyfikatora
Pobiera informacje o danym pliku.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator dokumentu
|
document-id | True | string |
Identyfikator danego dokumentu |
|
Identyfikator pliku
|
file-id | True | string |
Identyfikator danego pliku |
Zwraca
- File
- File
Pobieranie plików według identyfikatora dokumentu
Pobiera wszystkie pliki połączone z danym dokumentem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator dokumentu
|
document-id | True | string |
Identyfikator danego dokumentu |
Zwraca
- response
- array of File
Pobieranie stanu przepływu według identyfikatora koperty
Pobiera bieżący stan przepływu danej koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator przepływu
|
flow-id | True | string |
Identyfikator danego przepływu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Żeton
|
token | string |
Pobieranie ustawień użytkownika
Pobiera ustawienia danego użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
company-id | True | string |
Identyfikator danej firmy |
|
Identyfikator użytkownika
|
user-id | True | string |
Identyfikator danego użytkownika |
Zwraca
- Body
- Setting
Pobieranie wszystkich adresatów koperty
Pobiera wszystkich adresatów danej koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
Zwraca
- response
- array of Recipient
Pobieranie wszystkich deskryptorów
Pobiera listę wszystkich deskryptorów obecnych w bieżącej firmie. Listę można filtrować.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Filtry
|
filters | string |
Filtrowanie zapytania w celu wybrania podinstalowania |
Zwraca
- response
- array of Descriptor
Pobieranie wszystkich dokumentów według identyfikatora koperty
Pobiera wszystkie dokumenty związane z daną kopertą.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
Zwraca
- response
- array of Document
Przeszukaj wszystkie koperty
Przeszukaj wszystkie koperty pasujące do danego filtru.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Filtry
|
filters | string |
Filtrowanie zapytania w celu wybrania podinstalowania |
|
|
Źródło
|
from | integer |
Od daty |
|
|
Ograniczenie
|
limit | integer |
Kwota limitu |
|
|
Sortuj
|
sort | string |
Sortuj według |
Zwraca
- response
- array of EnvelopeDescriptorString
Tworzenie koperty — deskryptor
Tworzy kopertę na podstawie określonego deskryptora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator deskryptora koperty
|
envelope-descriptor-id | True | string |
Identyfikator deskryptora koperty |
|
Email
|
string | |||
|
Imię
|
givenName | string | ||
|
Nazwisko
|
familyName | string | ||
|
Przypomnienia automatyczne
|
automaticReminders | number | ||
|
Wygaśnięcie
|
expiration | string | ||
|
Hash
|
hash | string |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
uid
|
uid | string |
Tworzenie koperty — ustawienie domyślne
Tworzy nową kopertę przy użyciu deskryptora domyślnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Email
|
string | |||
|
Imię
|
givenName | string | ||
|
Nazwisko
|
familyName | string | ||
|
Przypomnienia automatyczne
|
automaticReminders | number | ||
|
Wygaśnięcie
|
expiration | string | ||
|
Hash
|
hash | string |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
uid
|
uid | string |
Tworzenie linku podpisu
Tworzy link podpisu. Implementacja jest specyficzna dla przepływu i może brakować określonego przepływu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Id
|
id | string | ||
|
Przekieruj do
|
redirectTo | uri |
Pełny adres URL umożliwiający przekierowanie użytkownika do adresu po zalogowaniu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
adres URL
|
getSignLink.recipient.{recipient-id}.url | string |
Ustaw stan przerwania koperty
Ustawia stan danej koperty na przerwaną.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
komentarz
|
comment | string |
Ustawianie stanu kosza koperty
Ustawia stan danej koperty do kosza.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Comment
|
comment | string |
Ustawianie stanu przerwania dokumentu
Ustawia stan danego dokumentu na przerwany.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator dokumentu
|
document-id | True | string |
Identyfikator danego dokumentu |
Usuwanie dokumentu według identyfikatora
Usuwa dany dokument.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Identyfikator dokumentu
|
document-id | True | string |
Identyfikator danego dokumentu |
Usuwanie koperty według identyfikatora
Usuwa daną kopertę.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
Uzyskiwanie informacji o użytkowniku
Pobiera informacje o aktualnie zalogowanym użytkowniku.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
Zwraca
- Body
- UserInfo
Wykonywanie zapytań względem wszystkich kopert (przestarzałe)
Wykonuje zapytania dotyczące wszystkich kopert pasujących do danego filtru. (Przestarzałe)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Filtry
|
filters | string |
Filtrowanie zapytania w celu wybrania podinstalowania |
|
|
Źródło
|
from | integer |
Od daty |
|
|
Ograniczenie
|
limit | integer |
Kwota limitu |
|
|
Sortuj
|
sort | string |
Sortuj według |
Zwraca
- response
- array of EnvelopeDescriptorString
Wysyłanie powiadomienia
Wysyła powiadomienie na adresy e-mail danej koperty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Żeton
|
token | True | string |
Token otrzymany z akcji "Generuj token zabezpieczający" |
|
Identyfikator firmy
|
x-namespace | string |
Identyfikator firmy, który powinien być używany dla akcji. Formatuj /companies/<company id>. Jeśli nie zostanie ustawiona wartość domyślna, domyślnie łączy się z identyfikatorem firmy. |
|
|
Identyfikator koperty
|
envelope-id | True | string |
Identyfikator danej koperty |
|
Powitanie
|
greeting | string | ||
|
Identyfikator adresata
|
id | True | string |
Identyfikator adresata, do których powinno zostać wysłane powiadomienie. |
Definicje
Setting
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Global
|
global | string | |
|
Język sygnatariuszy
|
preferences.signatoryLanguage | string | |
|
Powitanie
|
preferences.greeting | string | |
|
Metoda podpisywania
|
preferences.signingMethod | string | |
|
Przesunięcie przypomnienia
|
preferences.reminderOffset | string |
Informacje o użytkowniku
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Imię
|
givenName | string | |
|
Nazwisko
|
familyName | string | |
|
Email
|
string | ||
|
Język
|
metadata.language | string | |
|
Brak hasła
|
missingPassword | boolean | |
|
Jest włączona
|
isEnabled | boolean | |
|
Namespace
|
namespace | string | |
|
Włączona
|
enabled | boolean | |
|
UID
|
uid | string | |
|
Id
|
id | string | |
|
Role
|
roles | array of Role | |
|
Validated
|
validated | boolean |
Firma
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
name | string | |
|
Numer rejestru
|
regNumber | string | |
|
Created
|
created | string | |
|
Zmodyfikowane
|
modified | string | |
|
Address
|
address | string | |
|
Miejscowość
|
city | string | |
|
Kod pocztowy
|
zipCode | string | |
|
Logo
|
logo | string | |
|
Country
|
country | string | |
|
Uid
|
uid | string | |
|
Id
|
id | string |
Recipient
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
UID
|
uid | string |
Identyfikator UID odbiorcy |
|
Namespace
|
namespace | string |
Przestrzeń nazw adresatów |
|
Created
|
created | string |
Utworzono adresata |
|
Role
|
role | RoleActionString | |
|
Nazwisko
|
familyName | string |
Nazwisko adresata |
|
Imię
|
givenName | string |
Nazwa frist adresata |
|
Język
|
language | string |
Język adresata |
|
Email
|
string |
Adres e-mail adresata |
|
|
Metoda podpisywania
|
signingMethod | string |
Methid podpisywania adresata |
|
Notification, metoda
|
notificationMethod | string | |
|
Zamówienie
|
order | integer |
Kolejność adresatów |
|
Id
|
id | string |
Identyfikator adresata |
|
Zmodyfikowane
|
modified | string |
Zmodyfikowano adresata |
|
Powiadamiany
|
notified | boolean | |
|
Zakończone
|
completed | boolean | |
|
demandAttachment
|
demandAttachment | boolean | |
|
numer ubezpieczenia społecznego (SSN)
|
ssn | string | |
|
Bank
|
bank | string | |
|
Bezpieczny
|
secure | boolean | |
|
SMS
|
sms | boolean | |
|
Telefon
|
telephone | string | |
|
Podpisów
|
signatures | object | |
|
Notifications
|
notifications | array of Notification |
Role
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ
|
action.type | string | |
|
metody
|
action.methods | array of string | |
|
Etykieta
|
label | string |
Etykieta |
|
Num. Max
|
numMax | integer |
Num. Max |
|
Num. Minuta
|
numMin | integer |
Num. Minuta |
|
Nazwa roli
|
roleName | string |
RoleActionString
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Akcja
|
action | ActionString |
Akcja |
|
Etykieta
|
label | string |
Etykieta |
|
Num. Max
|
numMax | integer |
Num. Max |
|
Num. Minuta
|
numMin | integer |
Num. Minuta |
|
Nazwa roli
|
roleName | string |
Ciąg akcji
Koperta
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
id | string |
Identyfikator koperty |
|
UID
|
uid | string |
Identyfikator UID koperty |
|
Namespace
|
namespace | string |
Przestrzeń nazw koperty |
|
wersja
|
version | integer |
Wersja koperty |
|
Opublikowany
|
published | boolean |
Opublikowana koperta |
|
Complete
|
completed | boolean |
Ukończono kopertę |
|
Przerwana
|
aborted | boolean |
Koperta avorted |
|
Kosza
|
trashed | boolean |
Koperta z koszem |
|
Sekwencyjne podpisywanie
|
sequentialSigning | boolean | |
|
Przypomnienia autematyczne
|
automaticReminders | integer | |
|
Created
|
created | string |
Utworzono kopertę |
|
Zmodyfikowane
|
modified | string |
Zmodyfikowano kopertę |
|
Wygasła
|
expired | boolean |
Koperta wygasła |
|
Flow
|
flow | Flow | |
|
Deskryptora
|
descriptor | Descriptor | |
|
Osoba
|
sender | Person | |
|
Documents
|
documents | array of Document | |
|
Adresatów
|
recipients | array of Recipient | |
|
Etykiety
|
tags | array of object | |
|
Właściciele
|
owners | array of Person |
KopertaDescriptorString
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
id | string |
Identyfikator koperty |
|
UID
|
uid | string |
Identyfikator UID koperty |
|
Namespace
|
namespace | string |
Przestrzeń nazw koperty |
|
wersja
|
version | integer |
Wersja koperty |
|
Opublikowany
|
published | boolean |
Opublikowana koperta |
|
Complete
|
completed | boolean |
Ukończono kopertę |
|
Przerwana
|
aborted | boolean |
Koperta avorted |
|
Kosza
|
trashed | boolean |
Koperta z koszem |
|
Sekwencyjne podpisywanie
|
sequentialSigning | boolean | |
|
Przypomnienia autematyczne
|
automaticReminders | integer | |
|
Created
|
created | string |
Utworzono kopertę |
|
Zmodyfikowane
|
modified | string |
Zmodyfikowano kopertę |
|
Wygasła
|
expired | boolean |
Koperta wygasła |
|
Flow
|
flow | Flow | |
|
Deskryptora
|
descriptor | string |
Deskryptor koperty |
|
Osoba
|
sender | Person | |
|
Documents
|
documents | array of Document | |
|
Adresatów
|
recipients | array of Recipient | |
|
Etykiety
|
tags | array of object | |
|
Właściciele
|
owners | array of Person |
File
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
id | string |
Identyfikator pliku |
|
adres URL
|
url | string |
Adres URL pliku |
|
Name
|
name | string |
Nazwa pliku |
|
Typ MIME
|
mimeType | string | |
|
Typ pliku
|
fileType | string | |
|
Ścieżka magazynu
|
storagePath | string | |
|
Przekazano o
|
uploadedAt | string | |
|
Created
|
created | string |
Utworzony plik |
|
Właściciele
|
owners | array of object | |
|
UID
|
owners.uid | string |
Identyfikator UID właściciela pliku |
|
Id
|
owners._id | string |
Identyfikator właściciela pliku |
|
Namespace
|
namespace | string | |
|
UID
|
uid | string |
Identyfikator UID pliku |
Flow
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
id | string |
Identyfikator przepływu |
|
Name
|
name | string |
Nazwa przepływu |
Deskryptora
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Name
|
name | string |
Nazwa deskryptora |
|
wersja
|
version | integer |
Wersja deskryptora |
|
UID
|
uid | string |
Identyfikator UID deskryptora |
|
Usunięte
|
deleted | boolean |
Deskryptor usunięty |
|
Public
|
public | boolean |
Deskryptor publiczny |
|
Wygasła
|
expired | boolean |
Deskryptor wygasł |
|
Id
|
id | string |
Identyfikator deskryptora |
|
Mandatory
|
mandatory | boolean |
Deskryptor obowiązkowy |
|
Etykieta
|
label | string |
Etykieta deskryptora |
|
Typ
|
type | string |
Typ deskryptora |
|
Role
|
roles | array of Role | |
|
Właściciele
|
owners | array of Person | |
|
Flow
|
flow | Flow | |
|
defaultValues (wartości domyślne)
|
defaultValues | DefaultValues |
defaultValues (wartości domyślne) |
|
Przypadki
|
instances | array of object |
Osoba
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
UID
|
uid | string |
Identyfikator UID osoby |
|
Imię
|
givenName | string |
Imię i nazwisko osoby |
|
Nazwisko
|
familyName | string |
Nazwisko osoby |
|
Email
|
string |
Adres e-mail osoby |
|
|
Język
|
language | string |
Język osoby |
|
Zamówienie
|
order | integer |
Zamówienie osoby |
Dokument
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Etykieta
|
label | string |
Etykieta dokumentu |
|
Typ
|
type | string |
Typ dokumentu |
|
Hash
|
hash | integer |
Skrót dokumentu |
|
Num. Max
|
numMax | integer |
Numer dokumentu. Max |
|
Num. Minuta
|
numMin | integer |
Numer dokumentu. Minuta |
|
UID
|
uid | string |
Identyfikator UID dokumentu |
|
Namespace
|
namespace | string |
Przestrzeń nazw dokumentu |
|
Źródło
|
source | string |
Źródło dokumentu |
|
Created
|
created | string |
Utworzony dokument |
|
Name
|
name | string |
Nazwa dokumentu |
|
Id
|
id | string |
Identyfikator dokumentu |
|
Zmodyfikowane
|
modified | string |
Zmodyfikowano dokument |
|
Odrzucone
|
rejected | boolean |
Odrzucono dokument |
|
Podpisane
|
signed | boolean |
Podpisany dokument |
|
Kosza
|
trashed | boolean |
Dokument z kosza |
|
Przerwana
|
aborted | boolean |
Przerwany dokument |
|
wersja
|
version | integer |
Wersja dokumentu |
|
attachments
|
attachments | array of Attachment | |
|
Flow
|
flow | Flow | |
|
roles
|
roles | array of Role | |
|
Template
|
template | Template | |
|
Deskryptora
|
descriptor | Descriptor | |
|
Podpisów
|
signatures | array of Signature |
Attachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Etykieta
|
label | string |
Etykieta załącznika |
|
Num. Max
|
numMax | integer |
Numer załącznika. Max |
|
Num. Minuta
|
numMin | integer |
Liczba załączników |
|
Hash
|
hash | integer |
Skrót załącznika |
Template
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ
|
type | string |
Typ szablonu |
|
HTML
|
html | string | |
|
PDFHTML
|
pdfHtml | string | |
|
Id
|
id | string | |
|
UID
|
uid | string | |
|
Namespace
|
namespace | string | |
|
wersja
|
version | integer | |
|
Created
|
created | string | |
|
Zmodyfikowane
|
modified | string | |
|
Zmodyfikowane
|
published | boolean | |
|
Zakończone
|
completed | boolean | |
|
Przerwana
|
aborted | boolean |
Signature
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string | |
|
Pochodzenie
|
origin | string | |
|
Imię
|
givenName | string |
Imię |
|
Nazwisko
|
familyName | string |
Nazwisko |
|
Email
|
string |
|
|
|
IP
|
ip | string | |
|
Date
|
date | string | |
|
Status
|
status | string | |
|
Comment
|
comment | string |
Wartości domyślne
defaultValues (wartości domyślne)
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Osoba
|
signer | Person | |
|
Osoba
|
reviewer | Person |
Notification
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string | |
|
UID
|
uid | string | |
|
Namespace
|
namespace | string | |
|
Status
|
status | string | |
|
Zamówienie
|
order | integer | |
|
Szczegóły
|
details | object | |
|
Date
|
date | string |