Udostępnij przez


Znak usługi OoDrive (wersja zapoznawcza)

Połącz się z usługą podpisywania usługi Oodrive i korzystaj z nich za pośrednictwem przepływów pracy.

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 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 Znak usługi Oodrive
adres URL https://www.oodrive.com/products/oodrive-sign/
Email support-sign@oodrive.com
Metadane łącznika
Publisher Znak usługi Oodrive
Witryna internetowa https://www.oodrive.com/products/oodrive-sign/
Zasady ochrony prywatności https://www.oodrive.com/privacy-policy/
Kategorie Operacje IT; Produktywność

Łącznik usługi Oodrive Sign umożliwia automatyzowanie zadań i łatwe zarządzanie procesami dotyczącymi ekosystemu podpisu elektronicznego. Zautomatyzowany przepływ pracy może być przeznaczony do tworzenia nowego kontraktu za pomocą szablonu, automatycznego dodawania adresatów i wysyłania kontraktu do podpisu. Możesz również zarządzać wszystkimi pakietami, adresatami, kluczowymi parametrami i nie tylko. Oferuje klientom możliwość skrócenia czasu używanego do ręcznego wykonywania akcji po zakończeniu całego procesu podpisywania. Wszystkie funkcje dostępne w aplikacji internetowej można odtworzyć w usłudze Power Automate przy użyciu łącznika.

Wymagania wstępne

Potrzebujesz konta z płatnym planem w usłudze Oodrive Sign.

Jak uzyskać poświadczenia

Musisz również uzyskać token interfejsu API, który może być proszony o usługę pomocy technicznej lub można go pobrać w przyjaznej wiadomości e-mail, która została wysłana do skrzynki pocztowej po zastosowaniu do usługi Sign.

Note: If you are a employee, you can get the token by contacting your IT service.

Wprowadzenie do łącznika

Aby rozpocząć korzystanie z łącznika, najpierw musisz otworzyć usługę Power Automate przy użyciu konta platformy Power Platform.

Note: you'll need to be premium on Power Automate in order to use the connector.

Wykonaj następujące kroki, aby utworzyć nowy przepływ pracy i użyć naszego łącznika:

  1. W środowisku usługi Power Automate kliknij kartę "utwórz".
  2. Wybierz pozycję "Zautomatyzowany przepływ chmury" lub "Błyskawiczny przepływ chmury", zgodnie z potrzebami.
  3. Nadaj nazwę nowemu przepływowi pracy i wybierz wyzwalacz pasujący do Twoich potrzeb. Możesz użyć jednego z podpisów usługi Oodrive.
  4. Zacznij korzystać z łącznika, dodając z niego akcję, po prostu wyszukując ciąg "Logowanie Oodrive" w katalogu.
  5. Przy pierwszym dodaniu akcji lub wyzwalacza z naszego łącznika usługa Power Automate poprosi Cię o połączenie ze środowiskiem: jest to, że użyjesz tokenu interfejsu API dostarczonego przez nas.
  6. Następnie kliknij pozycję Połącz: wszystko jest gotowe, możesz użyć jak największej liczby akcji z żądanego łącznika.

Znane problemy i ograniczenia

W przypadku problemów z podpisywaniem usługi Oodrive skontaktuj się z usługą pomocy technicznej.

Typowe błędy i środki zaradcze

BŁĄD HTTP 404

Ogólnie rzecz biorąc, gdy zostanie wyświetlony błąd 404 z podpisem Oodrive, oznacza to, że źródło, które próbujesz znaleźć, nie istnieje w środowisku. Zazwyczaj może to być błąd w identyfikatorze podanym dla określonej umowy lub określonego adresata, który nie istnieje. Aby rozwiązać ten problem, spróbuj użyć akcji ze znanym identyfikatorem zasobu, który próbujesz uzyskać.

BŁĄD HTTP 501

Błąd HTTP 501 wskazuje, że usługa Oodrive Sign nie rozpoznała dobrze zapotrzebowania lub że przekazano niewłaściwy typ danych do usługi. Spróbuj zbadać, czytając dokumentację znaku, na danych przekazanych do akcji lub wyzwalacza.

Często zadawane pytania

1. Jak mogę przekazać dokument do określonej umowy?

Korzystając z akcji "Przekaż dokument i dołącz go do kontraktu", można łatwo przekazać plik PDF, który jest zapisywany zdalnie.

Pierwszy krok wymaga pobrania zawartości pliku, który chcesz przekazać. Można go pobrać przy użyciu wielu łączników. Na przykład zawartość pliku można pobrać za pomocą akcji "Pobierz zawartość pliku" łącznika programu SharePoint.

  1. Pobierz zawartość pliku, który chcesz przekazać jako dokument dla określonego kontraktu. W tym przykładzie używamy akcji "Pobierz zawartość pliku" łącznika usługi SharePoint Online.
  2. Następnie dodaj nową akcję "redaguj". Użyj treści wyjściowej akcji "Pobierz zawartość pliku" jako dane wejściowe dla redagowania.
  3. Dodaj akcję o nazwie "Przekaż dokument i dodaj go do kontraktu" z łącznika podpisywania usługi Oodrive.
    • W danych wejściowych "Identyfikator kontraktu" określ identyfikator kontraktu, dla którego chcesz dołączyć dokument.
    • W danych wejściowych "Pliki" wstaw dane wyjściowe poprzedniej akcji "Redaguj"
    • W danych wejściowych "Pliki (nazwa pliku)" wstaw nazwę dokumentu, który zostanie przekazany.
  4. Zakończono przekazywanie dokumentu!

2. Czy widzę wszystkie kontrakty w moim środowisku?

Jeśli token jest tokenem "administrator", tak. W przeciwnym razie wyświetlisz tylko umowę, do której masz dostęp normalnie.

3. Mam sugestię dotyczącą łącznika. Gdzie mogę go przesłać?

Wszelkie sugestie dotyczące łącznika można przesłać, kontaktując się z pomocą techniczną. Będziemy naprawdę wdzięczni za Twój wkład!

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.

To nie jest połączenie, którego można udostępniać. Jeśli aplikacja Power App zostanie udostępniona innemu użytkownikowi, inny użytkownik zostanie poproszony o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Klucz interfejsu API securestring Klucz interfejsu API dla tego interfejsu API Prawda

Limity ograniczania

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

Akcje

Dodawanie adresata do kontraktu

Dołącz istniejącego adresata do umowy.

Dodawanie kontraktu do pakietu

Dodaj istniejący kontrakt do istniejącego pakietu.

Pobieranie dokumentów kontraktu

Pobierz plik PDF zawierający wszystkie dokumenty z kontraktu.

Pobieranie listy wszystkich kontraktów

Pobierz wszystkie kontrakty ze skojarzonej licencji.

Pobieranie określonego adresata

Pobierz określonego adresata na zapisanej liście adresatów bieżącego środowiska.

Pobieranie pliku dowodowego kontraktu

Pobierz plik dowodowy kontraktu.

Pobieranie podpisanego dokumentu umowy

Pobierz plik PDF z podpisanego dokumentu umowy.

Pobieranie podpisów kontraktu

Wyświetl listę wszystkich informacji o podpisach z określonej umowy.

Przekazywanie dokumentu i dołączanie go do kontraktu

Przekaż dokument do środowiska i dołącz go do określonego kontraktu.

Przekazywanie załącznika i dodawanie go do kontraktu

Przekaż nowy załącznik do środowiska i dołącz go do określonej umowy.

Tworzenie kontraktu

Utwórz nowy kontrakt w środowisku.

Tworzenie kontraktu i wysyłanie go do podpisu

Wszystko w jednej operacji. Utwórz kontrakt, dodaj adresatów, dokumenty i wyślij go do adresatów.

Tworzenie pakietu

Utwórz nowy pakiet z co najmniej jednym istniejącym kontraktem.

Usuwanie adresata dla kontraktu

Usuń adresata z umowy według jego adresata w celu uzyskania identyfikatora kontraktu. Więcej informacji znajduje się w dokumentacji.

Uzyskiwanie określonej umowy

Pobieranie metadanych określonego kontraktu.

Uzyskiwanie stanu kontraktu

Sprawdź stan określonego kontraktu.

Weryfikowanie kontraktu

Zweryfikuj (kontrasygnał) kontrakt.

Weryfikowanie kontraktów w pakiecie

Znak licznika (zweryfikuj) wszystkie kontrakty w pakiecie.

Wycofanie umowy

Ustaw stan kontraktu na WARTOŚĆ PORZUCONE, nawet jeśli umowa została wysłana do podpisu.

Wycofywanie pakietu

Wycofaj całą umowę w pakiecie.

Wysyłanie pakietu do podpisu

Wyślij pakiet do podpisu.

Wysyłanie umowy do podpisania

Wyślij określoną umowę i wszystkie jego dokumenty, które mają być podpisane przez adresatów.

Wyślij ponownie wiadomość e-mail z powiadomieniem do adresata

Wyślij wiadomość e-mail z powiadomieniem do określonego adresata umowy.

Wyślij ponownie wiadomość e-mail z powiadomieniem do wszystkich adresatów

Wyślij wiadomość e-mail z powiadomieniem do wszystkich adresatów określonej umowy.

Wyświetl listę wszystkich adresatów

Pobierz wszystkich adresatów skojarzonych z bieżącą licencją.

Wyświetlanie listy adresatów kontraktu

Pobierz wszystkich adresatów dla określonej umowy.

Wyświetlanie listy dokumentów kontraktu

Pobierz wszystkie dokumenty powiązane z kontraktem.

Wyświetlanie listy kontraktów pakietu

Pobierz wszystkie kontrakty z określonego pakietu.

Wyświetlanie listy wszystkich obwodów

Pobierz wszystkie obwody skojarzone z połączonym środowiskiem.

Zatrzymywanie transakcji kontraktu

Zatrzymaj transakcję umowy, aby można było modyfikować dokumenty umowy i/lub sygnatariuszy.

Zatrzymywanie transakcji pakietu

Zatrzymaj transakcję pakietu.

Dodawanie adresata do kontraktu

Dołącz istniejącego adresata do umowy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do dołączenia adresata.

Identyfikator adresata
recipient_id integer

Identyfikator odbiorcy, który ma zostać dołączony do umowy.

Tryb podpisu
signature_mode integer

Tryb podpisu. Aby uzyskać więcej informacji, zobacz dokumentację.

Tytuł wiadomości
message_title string

Tytuł wiadomości do wysłania pocztą e-mail, jeśli będzie jeden.

Zawartość wiadomości
message_body string

Treść wiadomości do wysłania pocztą e-mail, jeśli zostanie wysłana.

Ranga
rank integer

Miejsce adresata w procesie podpisu. Rank i Smartrole wzajemnie się wykluczają. Wybierz tylko jedną z nich lub nie w ogóle.

Nazwa roli inteligentnej
smartrole string

Inteligentna rola, która ma nadać adresatowi. Aby uzyskać więcej informacji, zobacz dokumentację.

Tryb transportu
transport_mode integer

Tryb transportu podpisu. Aby uzyskać więcej informacji, zobacz dokumentację.

Zwraca

Dodawanie kontraktu do pakietu

Dodaj istniejący kontrakt do istniejącego pakietu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pakietu
id True string

Identyfikator pakietu do dodania kontraktu.

Identyfikator kontraktu
contract_id integer

Identyfikator kontraktu, który ma zostać dodany do pakietu.

Zwraca

Pobieranie dokumentów kontraktu

Pobierz plik PDF zawierający wszystkie dokumenty z kontraktu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do pobrania pliku pdf.

Nazwa pliku wyjściowego
filename string

Nazwa pliku, który zostanie pobrany.

Zwraca

Plik binarny dokumentu PDF
file

Pobieranie listy wszystkich kontraktów

Pobierz wszystkie kontrakty ze skojarzonej licencji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Rozmiar zwracanej tablicy
size integer

Maksymalny rozmiar zwracanej tablicy kontraktu.

Pomiń pierwsze n kontraktów
offset integer

Numer sekwencji kontraktu, który zostanie pominięty.

Pokaż właściwości kontraktu
get_properties boolean

Jeśli wartość true, właściwości kontraktu zostaną wyświetlone w odpowiedzi.

Pokaż obwody kontraktu
get_perimeters boolean

Jeśli to prawda, obwody kontraktu będą wyświetlane w odpowiedzi.

Utworzone przed
before integer

Spowoduje wyświetlenie listy kontraktu utworzonego przed daną datą.

Utworzone po
after integer

Spowoduje wyświetlenie listy kontraktu utworzonego po podanej dacie.

Tylko z obwodem
perimeter string

Wyświetlanie listy kontraktów tylko w danym obwodzie.

Tylko ze stanem
status array

Pobierz kontrakt tylko z określonym stanem.

Zwraca

Przedmioty
ArrayOfContract

Pobieranie określonego adresata

Pobierz określonego adresata na zapisanej liście adresatów bieżącego środowiska.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator adresata
id True string

Identyfikator odbiorcy do pobrania.

Zwraca

Body
Recipient

Pobieranie pliku dowodowego kontraktu

Pobierz plik dowodowy kontraktu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do pobrania pliku dowodowego.

Nazwa pliku wyjściowego
filename string

Nazwa pliku, który zostanie pobrany.

Zwraca

response
file

Pobieranie podpisanego dokumentu umowy

Pobierz plik PDF z podpisanego dokumentu umowy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True integer

Identyfikator kontraktu zawierającego dokumenty.

Nazwa pliku
filename string

Nazwa, którą chcesz nadać pobranemu dokumentowi.

Zwraca

Zawartość binarna pliku PDF.

Plik binarny dokumentu
file

Pobieranie podpisów kontraktu

Wyświetl listę wszystkich informacji o podpisach z określonej umowy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu, aby wyświetlić listę wszystkich podpisów.

Zwraca

Przekazywanie dokumentu i dołączanie go do kontraktu

Przekaż dokument do środowiska i dołącz go do określonego kontraktu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do dołączenia nowego dokumentu.

File
file file

Plik binarny do przekazania.

Zwraca

Przekazywanie załącznika i dodawanie go do kontraktu

Przekaż nowy załącznik do środowiska i dołącz go do określonej umowy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu w celu dodania załącznika.

Identyfikator definicji kontraktu
contract_definition_id integer

Identyfikator definicji kontraktu zdefiniowany w środowisku. Wartość domyślna to pdfadhoc.

Nazwa definicji opcji
option_definition_name string

Nazwa definicji.

Files
file array

Pliki do dodania jako załączniki

Zwraca

Tworzenie kontraktu

Utwórz nowy kontrakt w środowisku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa kontraktu
name string

Nazwa nowo utworzonego kontraktu (wymagane).

Identyfikator definicji kontraktu
contract_definition_id integer

Identyfikator definicji kontraktu. Zapoznaj się ze zmienną interfejsu API licencji. Domyślnie jest to szablon AdHoc w formacie PDF.

Adres e-mail dostawcy
vendor_email string

Adres e-mail właściciela licencji.

Data utworzenia
date integer

Data umowy. Wartość domyślna to Date.Now(). Musi być w milisekundach.

Tytuł wiadomości
message_title string

Obiekt wysłanej wiadomości e-mail. Pozostaw pusty tytuł domyślny.

Treść wiadomości
message_body string

Treść wysłanej wiadomości e-mail. Pozostaw wartość pustą dla komunikatu domyślnego.

Kontynuuj w ruchu
keep_on_move boolean

Aktywowanie lub niezawieranie podpisu poza wierszem na urządzeniu przenośnym

Automatyczne zamykanie
auto_close integer

Określ, czy kontrapis jest wykonywany bez interwencji człowieka.

Sekwencyjny
sequential boolean

Określ, czy sekwencyjne, czy nie.

Numer odbiorcy
customer_number string

Tylko w przypadku starszych aplikacji mobilnych.

Lista obwodów
perimeters array of string
Identyfikator definicji elementu
element_definition_id integer

Identyfikator definicji elementu.

Wartość
value string

Wartość opcji elementu.

Identyfikator właściwości
id integer

Identyfikator właściwości niestandardowej.

Klucz właściwości
key string

Klucz właściwości niestandardowej.

Symbol zastępczy właściwości
placeholder string

Etykieta wyświetlana adresatowi po zaproszeniu do wypełnienia właściwości.

Wartość właściwości
value string

Wartość właściwości niestandardowej.

Identyfikator kontraktu właściwości
contract_id integer

Identyfikator kontraktu skojarzonego z tą właściwością niestandardową.

Właściwość jest wymagana
to_fill_by_user boolean

Określ, czy użytkownik musi wypełnić właściwość, czy nie.

Typ właściwości
field_type string

Określ typ właściwości niestandardowej. Więcej informacji znajduje się w dokumentacji.

Opcje właściwości
input_filter string

Lista możliwych wyborów dla właściwości.

Właściwość jest używana przez kontrakt
used_by_contract boolean

Ustaw wartość true, jeśli informacje muszą pojawić się w dokumencie kontraktu.

Właściwość jest wymagana
required boolean

Określ, czy właściwość jest wymagana, czy nie.

Zwraca

Body
Contract

Tworzenie kontraktu i wysyłanie go do podpisu

Wszystko w jednej operacji. Utwórz kontrakt, dodaj adresatów, dokumenty i wyślij go do adresatów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
contract_id integer

Identyfikator kontraktu.

Data utworzenia
date integer

Data utworzenia kontraktu.

Adres e-mail dostawcy
vendor_email string

Adres e-mail właściciela licencji usługi Oodrive.

Identyfikator definicji kontraktu
contract_definition_id integer

Identyfikator definicji kontraktu używanej dla tego kontraktu.

Temat wiadomości
message_title string

Temat wiadomości e-mail po wysłaniu do podpisu.

Treść wiadomości
message_body string

Treść wiadomości e-mail po wysłaniu do podpisu.

Nazwa kontraktu
name True string

Główna nazwa dokumentu kontraktu.

Aktywowano podpis w trybie offline
keep_on_move boolean

Ustal, czy podpis offline na urządzeniu przenośnym jest aktywowany.

Data zamknięcia kontraktu
closed_date integer

Data zamknięcia umowy, jeśli istnieje.

Przyczyna anulowania umowy
canceled_reason string

Przyczyna anulowania, jeśli istnieje.

Włączone automatyczne zamykanie
auto_close integer

Określ, czy umowa zostanie podpisana automatycznie, czy potrzebna jest interwencja człowieka.

Jest usuwany
deleted integer

Określ, czy umowa została usunięta, czy nie.

Klucz obwodowy
Perimeters string

Klucz obwodu.

Identyfikator opcji
id integer

Identyfikator opcji kontraktu.

Identyfikator kontraktu
contract_id integer

Identyfikator kontraktu powiązanego z tą opcją.

Identyfikator definicji elementu
element_definition_id integer

Identyfikator definicji elementu opcji.

Czasomierz synchronizacji
sync_timer integer

Czasomierz używany na potrzeby problemu z synchronizacją.

Wartość opcji
value string

Wartość opcji.

Miejsce ostatniej modyfikacji
last_modification_place string

Wskazuje miejsce ostatniej modyfikacji.

Kontrolka opcji
control string

Pole sterujące.

Identyfikator właściwości
id integer

Identyfikator właściwości niestandardowej.

Klucz właściwości
key string

Klucz właściwości niestandardowej.

Symbol zastępczy właściwości
placeholder string

Etykieta wyświetlana adresatowi po zaproszeniu do wypełnienia właściwości.

Wartość właściwości
value string

Wartość właściwości niestandardowej.

Identyfikator kontraktu właściwości
contract_id integer

Identyfikator kontraktu skojarzonego z tą właściwością niestandardową.

Właściwość jest wymagana
to_fill_by_user boolean

Określ, czy użytkownik musi wypełnić właściwość, czy nie.

Typ właściwości
field_type string

Określ typ właściwości niestandardowej. Więcej informacji znajduje się w dokumentacji.

Opcje właściwości
input_filter string

Lista możliwych wyborów dla właściwości.

Właściwość jest używana przez kontrakt
used_by_contract boolean

Ustaw wartość true, jeśli informacje muszą pojawić się w dokumencie kontraktu.

Właściwość jest wymagana
required boolean

Określ, czy właściwość jest wymagana, czy nie.

Tryb podpisu
signature_mode integer
imię
firstname string
nazwisko
lastname string
e-mail
email string
cell_phone
cell_phone string
pliki pdfpart
pdfparts string
dodatekparts
appendixparts string

Zwraca

Nazwa Ścieżka Typ Opis
recipients
recipients array of Recipient
recipientForcontract
recipientForcontract array of ContractRecipient
kontrakt
contract Contract
PDF
pdfparts array of object

Tablica plików PDF powiązanych z kontraktem.

Identyfikator pliku PDF
pdfparts.id integer

Identyfikator pliku PDF.

Ranga pliku PDF
pdfparts.rank integer

Ranga pliku PDF.

Ma pola SmartFields
pdfparts.has_smart_field boolean

Określ, czy w kontrakcie znajdują się pola inteligentne.

Rozmiar pliku PDF
pdfparts.size integer

Rozmiar dokumentu.

Nazwa pliku
pdfparts.filename string

Nazwa pliku PDF.

dodatekparts
appendixparts array of object
id
appendixparts.id integer

Tworzenie pakietu

Utwórz nowy pakiet z co najmniej jednym istniejącym kontraktem.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
contract_id integer

Identyfikator pierwszego kontraktu pakietu.

Ten sam sygnatariusz
same_signatories boolean

Ustaw wartość false, jeśli umowy w pakiecie nie mają tego samego zestawu sygnatariuszy.

Zwraca

Usuwanie adresata dla kontraktu

Usuń adresata z umowy według jego adresata w celu uzyskania identyfikatora kontraktu. Więcej informacji znajduje się w dokumentacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Odbiorca identyfikatora kontraktu
cfc_id True string

Identyfikator adresata obiektu kontraktu do usunięcia.

Zwraca

Nazwa Ścieżka Typ Opis
odnieść sukces
succeed boolean

Określ, czy został pomyślnie usunięty.

Uzyskiwanie określonej umowy

Pobieranie metadanych określonego kontraktu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do pobrania.

Zwraca

Body
Contract

Uzyskiwanie stanu kontraktu

Sprawdź stan określonego kontraktu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True integer

Identyfikator kontraktu do pobrania stanu.

Zwraca

Weryfikowanie kontraktu

Zweryfikuj (kontrasygnał) kontrakt.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do zweryfikowania.

Siła
force boolean

Określ, czy weryfikacja umowy musi być wymuszona, nawet jeśli niektórzy sygnatariusze jeszcze nie podpisali.

Zwraca

Nazwa Ścieżka Typ Opis
Data weryfikacji
date string

Data weryfikacji.

Identyfikator transakcji
id string

Identyfikator transakcji urzędu certyfikacji.

Weryfikowanie kontraktów w pakiecie

Znak licznika (zweryfikuj) wszystkie kontrakty w pakiecie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pakietu
id True string

Identyfikator pakietu w celu zweryfikowania wszystkich kontraktów.

Wymuszanie walidacji
force boolean

Wymuś weryfikację umów, jeśli niektórzy sygnatariusze jeszcze nie podpisali (lub odmówili podpisania).

Zwraca

Nazwa Ścieżka Typ Opis
array of object
date
date string

Data zamknięcia.

Identyfikator kontraktu
id string

Identyfikator kontraktu został zatrzymany.

Wycofanie umowy

Ustaw stan kontraktu na WARTOŚĆ PORZUCONE, nawet jeśli umowa została wysłana do podpisu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator umowy do wycofania.

Przyczyna
reason string

Przyczyna wycofania.

Zwraca

Nazwa Ścieżka Typ Opis
odnieść sukces
succeed boolean

Określ, czy umowa została anulowana.

Wycofywanie pakietu

Wycofaj całą umowę w pakiecie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pakietu
id True string

Identyfikator pakietu do wycofania całej umowy.

Zwraca

Nazwa Ścieżka Typ Opis
odnieść sukces
succeed boolean

Mówi, czy pakiet został wycofany.

Wysyłanie pakietu do podpisu

Wyślij pakiet do podpisu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pakietu
id True string

Identyfikator pakietu do wysłania do podpisu.

Zwraca

Nazwa Ścieżka Typ Opis
odnieść sukces
succeed boolean

Mówi, czy transakcja została wysłana, czy nie.

Wysyłanie umowy do podpisania

Wyślij określoną umowę i wszystkie jego dokumenty, które mają być podpisane przez adresatów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do wysłania do podpisu.

Zwraca

Wyślij ponownie wiadomość e-mail z powiadomieniem do adresata

Wyślij wiadomość e-mail z powiadomieniem do określonego adresata umowy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do ponownego wysłanie powiadomienia.

Odbiorca identyfikatora kontraktu
cfc_id True string

Identyfikator adresata obiektu kontraktu w celu wysłania powiadomienia.

Zwraca

Nazwa Ścieżka Typ Opis
odnieść sukces
succeed boolean

Określ, czy powiadomienie zostało pomyślnie ponownie wysyłane.

Wyślij ponownie wiadomość e-mail z powiadomieniem do wszystkich adresatów

Wyślij wiadomość e-mail z powiadomieniem do wszystkich adresatów określonej umowy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do ponownego wysłanie powiadomienia.

Zwraca

Nazwa Ścieżka Typ Opis
odnieść sukces
succeed boolean

Określ, czy powiadomienie zostało pomyślnie ponownie wysyłane.

Wyświetl listę wszystkich adresatów

Pobierz wszystkich adresatów skojarzonych z bieżącą licencją.

Parametry

Nazwa Klucz Wymagane Typ Opis
Rozmiar
size integer

Maksymalny rozmiar zwracanej tablicy.

Przesunięcie
offset integer

Numer sekwencji pierwszego adresata na liście.

Obwód
perimeter string

Wyszukaj tylko w danym obwodzie.

Pobieranie niestandardowych rekwizytów
get_custom_props boolean

Wyświetlanie listy właściwości niestandardowych adresatów (zwiększa czas odpowiedzi).

Uzyskiwanie obwodów
get_perimeters boolean

Wyświetl listę obwodów adresata w odpowiedziach (zwiększa czas odpowiedzi).

Nazwisko filtru (zawiera)
name string

Odfiltruj nazwisko.

Filtruj wiadomość e-mail (zawiera)
email string

Odfiltruj wiadomość e-mail.

Zwraca

Adresatów
array of Recipient

Wyświetlanie listy adresatów kontraktu

Pobierz wszystkich adresatów dla określonej umowy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu w celu pobrania wszystkich adresatów.

Zwraca

Wyświetlanie listy dokumentów kontraktu

Pobierz wszystkie dokumenty powiązane z kontraktem.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do pobierania dokumentów.

Zwraca

Wyświetlanie listy kontraktów pakietu

Pobierz wszystkie kontrakty z określonego pakietu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pakietu
id True string

Identyfikator pakietu do pobierania kontraktów.

Zwraca

Wyświetlanie listy wszystkich obwodów

Pobierz wszystkie obwody skojarzone z połączonym środowiskiem.

Zwraca

Zatrzymywanie transakcji kontraktu

Zatrzymaj transakcję umowy, aby można było modyfikować dokumenty umowy i/lub sygnatariuszy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator kontraktu
id True string

Identyfikator kontraktu do zatrzymania.

Siła
force boolean

Wymuś zamknięcie transakcji, nawet jeśli sygnatariusze już podpisali.

Zwraca

Nazwa Ścieżka Typ Opis
odnieść sukces
succeed boolean

Określ, czy umowa została anulowana.

Zatrzymywanie transakcji pakietu

Zatrzymaj transakcję pakietu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pakietu
id True string

Identyfikator pakietu do zatrzymania transakcji.

Wymuś zamknięcie
force boolean

Wymuś zamknięcie transakcji, nawet jeśli sygnatariusze już podpisali.

Zwraca

Nazwa Ścieżka Typ Opis
odnieść sukces
succeed boolean

Mówi, że pakiet został pomyślnie zatrzymany.

Wyzwalacze

Zmiana stanu kontraktu

Ta operacja jest wyzwalana za każdym razem, gdy stan kontraktu uległ zmianie.

Zmiana stanu kontraktu

Ta operacja jest wyzwalana za każdym razem, gdy stan kontraktu uległ zmianie.

Parametry

Nazwa Klucz Wymagane Typ Opis
opis
description string

opis

events
events array of string

events

contractDefinition
contractDefinition array of integer

contractDefinition

obwód
perimeter array of integer

obwód

zaniepokojonyUserEmail
concernedUserEmail string

zaniepokojonyUserEmail

Zwraca

Nazwa Ścieżka Typ Opis
typ
type string

typ

contractId
contractId integer

contractId

sygnatura czasowa
timestamp integer

sygnatura czasowa

contractStatus
contractStatus string

contractStatus

Definicje

ArrayOfContract

Nazwa Ścieżka Typ Opis
Przedmioty
Contract

Contract

Nazwa Ścieżka Typ Opis
Identyfikator kontraktu
contract_id integer

Identyfikator kontraktu.

Data utworzenia
date integer

Data utworzenia kontraktu.

Token dokumentu
document_token string

Token głównego dokumentu kontraktu.

Adres e-mail dostawcy
vendor_email string

Adres e-mail właściciela licencji usługi Oodrive.

Jest zamknięty
closed boolean

Określ, czy kontrakt jest zamknięty, czy nie.

Stan kontraktu
status string

Bieżący stan kontraktu.

Identyfikator definicji kontraktu
contract_definition_id integer

Identyfikator definicji kontraktu używanej dla tego kontraktu.

Temat wiadomości
message_title string

Temat wiadomości e-mail po wysłaniu do podpisu.

Treść wiadomości
message_body string

Treść wiadomości e-mail po wysłaniu do podpisu.

Nazwa kontraktu
name string

Główna nazwa dokumentu kontraktu.

Aktywowano podpis w trybie offline
keep_on_move boolean

Ustal, czy podpis offline na urządzeniu przenośnym jest aktywowany.

Data zamknięcia kontraktu
closed_date integer

Data zamknięcia umowy, jeśli istnieje.

Przyczyna anulowania umowy
canceled_reason string

Przyczyna anulowania, jeśli istnieje.

Numer wersji kontraktu
version_number integer

Numer wersji kontraktu.

Rozmiar kontraktu
size integer

Pełny rozmiar kontraktu.

Włączone automatyczne zamykanie
auto_close integer

Określ, czy umowa zostanie podpisana automatycznie, czy potrzebna jest interwencja człowieka.

Jest usuwany
deleted integer

Określ, czy umowa została usunięta, czy nie.

Obwodów
perimeters array of ContractPerimeterKey

Lista wszystkich obwodów kontraktu (w przypadku zapytania).

Opcje
options array of ContractOption

Lista wszystkich określonych opcji kontraktu (w przypadku zapytania).

Właściwości niestandardowe
contract_properties array of ContractProperty

Lista wszystkich opcjonalnych właściwości kontraktu (jeśli jest to zapytanie).

ContractOption

Nazwa Ścieżka Typ Opis
Identyfikator opcji
id integer

Identyfikator opcji kontraktu.

Identyfikator kontraktu
contract_id integer

Identyfikator kontraktu powiązanego z tą opcją.

Identyfikator definicji elementu
element_definition_id integer

Identyfikator definicji elementu opcji.

Czasomierz synchronizacji
sync_timer integer

Czasomierz używany na potrzeby problemu z synchronizacją.

Wartość opcji
value string

Wartość opcji.

Miejsce ostatniej modyfikacji
last_modification_place string

Wskazuje miejsce ostatniej modyfikacji.

Kontrolka opcji
control string

Pole sterujące.

ContractProperty

Nazwa Ścieżka Typ Opis
Identyfikator właściwości
id integer

Identyfikator właściwości niestandardowej.

Klucz właściwości
key string

Klucz właściwości niestandardowej.

Symbol zastępczy właściwości
placeholder string

Etykieta wyświetlana adresatowi po zaproszeniu do wypełnienia właściwości.

Wartość właściwości
value string

Wartość właściwości niestandardowej.

Identyfikator kontraktu właściwości
contract_id integer

Identyfikator kontraktu skojarzonego z tą właściwością niestandardową.

Właściwość jest wymagana
to_fill_by_user boolean

Określ, czy użytkownik musi wypełnić właściwość, czy nie.

Typ właściwości
field_type string

Określ typ właściwości niestandardowej. Więcej informacji znajduje się w dokumentacji.

Opcje właściwości
input_filter string

Lista możliwych wyborów dla właściwości.

Właściwość jest używana przez kontrakt
used_by_contract boolean

Ustaw wartość true, jeśli informacje muszą pojawić się w dokumencie kontraktu.

Właściwość jest wymagana
required boolean

Określ, czy właściwość jest wymagana, czy nie.

ContractPerimeterKey

Klucz obwodu.

Klucz obwodu.

Klucz obwodowy
string

ContractRecipient

Nazwa Ścieżka Typ Opis
Odbiorca identyfikatora kontraktu
recipient_for_contract_id integer

Unikatowy identyfikator kontraktu i odbiorcy pary.

Identyfikator adresata
recipient_id integer

Identyfikator odbiorcy.

Identyfikator kontraktu
contract_id integer

Identyfikator kontraktu.

Stan podpisu
signature_status string

Stan znaku.

Data podpisu
signature_date integer

Sygnatura czasowa daty znaku.

Tryb podpisu
signature_mode integer

Tryb znaku.

Tytuł wiadomości
message_title string

Tytuł wiadomości.

Zawartość wiadomości
message_body string

Treść wiadomości.

Ranga
rank integer

Klasyfikacja w procesie podpisywania.

Rola inteligentna
smartrole string

Rola inteligentna skojarzona z adresatem.

Tryb transportu
transport_mode integer

Tryb transportu.

Identyfikator podpisu
signature_id string

Identyfikator podpisu od adresata.

DocumentAdded

Nazwa Ścieżka Typ Opis
Identyfikator dokumentu
id integer

Identyfikator dokumentu.

Ranga
rank integer

Umieść na liście dokumentów.

Ma pole SmartField
has_smart_field boolean

Określ, czy dokument ma pola SmartFields.

Rozmiar dokumentu
size integer

Rozmiar dokumentu w bajtach.

Nazwa dokumentu
filename string

Nazwa dokumentu.

Transakcja

Nazwa Ścieżka Typ Opis
Identyfikator transakcji kontraktu
transaction_id string

Określ identyfikator transakcji powiązany z kontraktem.

Jest zamknięty
is_closed boolean

Określ, czy kontrakt został zamknięty.

Nazwa kontraktu
contract_name string

Nazwa kontraktu.

Stan kontraktu
status string

Określ stan kontraktu.

Obwód

Nazwa Ścieżka Typ Opis
Identyfikator obwodu
id integer

Identyfikator obwodu.

Klucz obwodowy
key string

Klucz obwodu (używany przez kontrakty).

opis
description string

Opis obwodu.

OdbiorcaForContractWithRefusal

Nazwa Ścieżka Typ Opis
Odbiorca identyfikatora kontraktu
recipient_for_contract_id integer

Identyfikator obiektu, który powiązał kontrakt i adresata.

Identyfikator adresata
recipient_id integer

Identyfikator adresata podpisu.

Stan podpisu
signature_status string

Stan podpisu.

Data podpisu
signature_date integer

Data ostatnich zmian podpisu.

Tryb podpisu
signature_mode integer

Tryb podpisu.

Tytuł wiadomości
message_title string

Tytuł wiadomości powiązanej z podpisem kontraktu.

Zawartość wiadomości
message_body string

Treść wiadomości powiązanej z podpisem kontraktu.

Ranga
rank integer

Ranga adresata podpisu w procesie kontraktu.

Nazwa roli inteligentnej
smartrole string

Rola adresata podpisu w umowie.

Tryb transportu
transport_mode integer

Tryb transportu kontraktu powiązanego z podpisem.

Identyfikator podpisu
signature_id string

Identyfikator podpisu.

Ma odmowę
has_refusal boolean

Określ, czy odbiorca odmówił umowy.

Data ostatniej odmowy
last_refusal_date integer

Określ datę odmowy.

Ostatnia wiadomość o odmowie
last_refusal_message string

Określ komunikat o odmowie.

ContractInBundle

Nazwa Ścieżka Typ Opis
Identyfikator kontraktu
id integer

Identyfikator kontraktu.

Nazwa kontraktu
name string

Nazwa kontraktu.

Typ definicji kontraktu
contract_definition_type string

Typ definicji kontraktu.

Identyfikator definicji kontraktu
contract_definition_id integer

Identyfikator definicji kontraktu.

Nazwa firmy
company_name string

Nazwa firmy powiązanej z umową.

Recipient

Nazwa Ścieżka Typ Opis
Identyfikator adresata
id integer

Identyfikator odbiorcy.

Cywilizacja
civility string

Cywilizacja odbiorcy

Imię
firstname string

Imię adresata.

Nazwisko
lastname string

Nazwisko odbiorcy.

Adres główny
address_1 string

Główny adres pocztowy odbiorcy.

Kod pocztowy
postal_code string

Kod pocztowy odbiorcy.

Miejscowość
city string

Miasto odbiorcy.

Numer telefonu komórkowego
cell_phone string

Numer telefonu komórkowego odbiorcy.

Adres e-mail
email string

Adres e-mail adresata.

Country
country string

Kraj odbiorcy.

Adres pomocniczy
address_2 string

Pomocniczy adres pocztowy odbiorcy.

Nazwa firmy
company_name string

Nazwa firmy odbiorcy.

Numer telefonu
phone string

Numer telefonu odbiorcy.

Stanowisko
job_title string

Stanowisko odbiorcy.

Urodziny
birthdate integer

Data urodzenia (sygnatura czasowa) odbiorcy.

Miejsce urodzenia
birthplace string

Miejsce urodzenia odbiorcy.

custom_properties
custom_properties array of RecipientProperty
Obwodów
perimeters array of string

OdbiorcaWłaściwość

Nazwa Ścieżka Typ Opis
Identyfikator właściwości
id integer

Identyfikator właściwości.

Klucz właściwości
key string

Klucz właściwości.

Wartość właściwości
value string

Wartość właściwości.

Identyfikator wykonawcy
contractor_id integer

Identyfikator wykonawcy.

Czasomierz synchronizacji
sync_timer integer

Czasomierz ostatniej synchronizacji.

Miejsce ostatniej modyfikacji
last_modification_place string

Lokalizacja ostatniej modyfikacji.

DodatekDodawany

Nazwa Ścieżka Typ Opis
Identyfikator dodatku
id integer

Identyfikator dodatku.

Nazwa dodatku
filename string

Nazwa dodatku.

Identyfikator opcji dodatku
option_id integer

Identyfikator opcji dodatku

Typ zawartości dodatku
content_type string

Typ zawartości dodatku (na przykład image/jpeg).

BundleResponse

Nazwa Ścieżka Typ Opis
Identyfikator pakietu
id integer

Identyfikator pakietu.

Identyfikator autora
actor_id integer

Identyfikator twórcy pakietu.

Identyfikator pierwszego kontraktu
contract_id integer

Identyfikator pierwszego kontraktu utworzonego pakietu.

Stan pakietu
status integer

Stan pakietu.

Wzorzec pakietu
master integer

Wzorzec pakietu.

plik

Jest to podstawowy typ danych "file".