NetDocuments
NetDocuments to usługa zarządzania zawartością w chmurze dla firm o wszystkich rozmiarach, która umożliwia bezpieczne tworzenie, przechowywanie i udostępnianie pracy dokumentów oraz zarządzanie nimi w dowolnym miejscu i czasie.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - 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 | Standard | 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 | Standard | 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 | |
|---|---|
| adres URL | https://support.netdocuments.com/hc/en-us |
| Metadane łącznika | |
|---|---|
| Publisher | NetDocuments Software, Inc. |
| Witryna internetowa | https://www.netdocuments.com/ |
| Zasady ochrony prywatności | https://www.netdocuments.com/privacy-policy/ |
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 |
|---|---|---|---|
| Region | ciąg | Region, w którym znajduje się dokument netto. | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie dokumentu |
Aktualizowanie zawartości dokumentu |
| Blokowanie dokumentu |
Blokowanie dokumentu |
| Dodawanie lub usuwanie członka grupy |
Dodawanie lub usuwanie członka grupy |
| Dodawanie lub usuwanie grupy z szafki |
Dodawanie grupy do szafki i domyślnych praw dostępu |
| Dodawanie użytkownika do repozytorium lub usuwanie go z repozytorium |
Dodawanie użytkownika do repozytorium lub usuwanie go z repozytorium |
| Historia dokumentów |
Pobieranie listy akcji wykonywanych w dokumencie |
| Obserwowanie dokumentu |
Otrzymywanie alertów po zaktualizowaniu dokumentu |
| Obserwowanie folderu |
Otrzymywanie alertów po dodaniu nowej zawartości do folderu |
| Odblokowywanie dokumentu |
Oddokuj dokument |
| Odświeżanie obszaru roboczego |
Odświeżanie obszaru roboczego |
| Plik lub cofnij plik dokumentu do folderu |
Utwórz element w folderze lub usuń plik elementu z folderu. |
| Pobieranie atrybutów niestandardowych cabinet |
Pobieranie atrybutów niestandardowych cabinet |
| Pobieranie bieżących informacji o użytkowniku |
Uzyskiwanie informacji o bieżącym użytkowniku, identyfikator nie jest wymagany |
| Pobieranie dziennika repozytorium |
Pobieranie dziennika repozytorium |
| Pobieranie elementów folderu |
Pobieranie zawartości folderu, w tym dokumentów i podfolderów |
| Pobieranie grup repozytorium |
Pobieranie grup repozytorium |
| Pobieranie grup szafek |
Pobieranie wszystkich grup dodanych do gabinetu |
| Pobieranie informacji o grupie |
Pobieranie informacji o grupie |
| Pobieranie informacji o obszarze roboczym |
Pobieranie informacji o obszarze roboczym |
| Pobieranie informacji o repozytorium |
Pobieranie informacji o repozytorium |
| Pobieranie informacji o szafie |
Pobieranie informacji o szafie |
| Pobieranie listy gabinetów użytkowników |
Pobieranie szafek użytkownika |
| Pobieranie lub tworzenie obszaru roboczego (z atrybutami nadrzędnymi i podrzędnymi) |
Pobieranie lub tworzenie obszaru roboczego (z atrybutami nadrzędnymi i podrzędnymi) |
| Pobieranie lub tworzenie obszaru roboczego (z jednym atrybutem) |
Pobieranie lub tworzenie obszaru roboczego (z jednym atrybutem) |
| Pobieranie podrzędnego wpisu tabeli odnośników |
Pobieranie podrzędnego wpisu tabeli odnośników |
| Pobieranie profilu dokumentu |
Uzyskiwanie informacji o dokumencie |
| Pobieranie ustawień szafy |
Pobieranie ustawień szafy |
| Pobieranie użytkowników repozytorium |
Pobieranie użytkowników repozytorium |
| Pobieranie wersji dokumentów |
Pobieranie wersji dokumentów |
| Pobieranie wpisu tabeli odnośników lub wyszukiwanie wpisów tabeli podrzędnej |
Pobieranie wpisu tabeli odnośników lub wyszukiwanie wpisów tabeli podrzędnej |
| Pobieranie zawartości dokumentu |
Pobieranie dokumentu |
| Pobieranie zawartości kontenera |
Pobieranie zawartości wybranego kontenera |
|
Tworzenie aplikacji Collab |
Tworzenie nowego collabSpace |
| Tworzenie dokumentu |
Utwórz nowy dokument |
| Tworzenie grupy repozytorium |
Tworzenie grupy repozytorium |
| Tworzenie grupy zewnętrznej cabinet |
Tworzenie grupy zewnętrznej cabinet |
| Tworzenie lub aktualizowanie podrzędnego wpisu tabeli odnośników |
Tworzenie lub aktualizowanie podrzędnego wpisu tabeli odnośników |
| Tworzenie lub aktualizowanie wpisu tabeli odnośników |
Tworzenie lub aktualizowanie wpisu tabeli odnośników |
| Tworzenie nowej wersji dokumentu |
Tworzenie nowej wersji dokumentu |
| Tworzenie zabezpieczonego linku |
Generowanie linku do dokumentu, do którego można uzyskać dostęp przez dowolną osobę |
| Usuwanie dokumentu |
Usuwanie dokumentu |
| Usuwanie grupy repozytorium |
Usuwanie grupy repozytorium |
| Usuwanie podrzędnego wpisu tabeli odnośników |
Usuwanie podrzędnego wpisu tabeli odnośników |
| Usuwanie wpisu tabeli odnośników |
Usuwanie wpisu tabeli odnośników |
| Usuń folder |
Usuwanie folderu |
| Utwórz folder |
Tworzenie nowego folderu |
| Utwórz użytkownika |
Tworzenie użytkownika w repozytorium |
| Uzyskiwanie członkostwa w grupie |
Uzyskiwanie członkostwa w grupie |
| Uzyskiwanie informacji o użytkowniku |
Uzyskiwanie informacji o użytkowniku |
| Uzyskiwanie ukrytych grup gabinetu praw dostępu |
Uzyskiwanie ukrytych grup gabinetu praw dostępu |
| Wyewidencjonuj dokument |
Wyewidencjonowywanie dokumentu |
| Wyszukiwanie co najmniej jednego gabinetu |
Wyszukiwanie co najmniej jednego gabinetu |
| Wyszukiwanie w szafie i modyfikowanie list ACL |
Wyszukiwanie w szafie i modyfikowanie list ACL |
| Wyszukiwanie wpisów tabeli odnośników |
Wyszukiwanie wpisów tabeli odnośników |
| Zablokuj wersję dokumentu |
Zablokuj wersję dokumentu |
| Zaewidencjonuj dokument |
Zaewidencjonuj dokument wyewidencjonowany |
| Zmienianie nazwy dokumentu |
Zmienianie nazwy dokumentu |
| Zmienianie nazwy folderu |
Zmienianie nazwy folderu |
Aktualizowanie dokumentu
Aktualizowanie zawartości dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Rozszerzenie dokumentu
|
extension | string |
Konieczne tylko w przypadku zmiany rozszerzenia dokumentu. Nie uwzględniaj okresu wiodącego. |
|
|
Kodowane w formacie Base64?
|
base64 | boolean |
Kodowane w formacie Base64? |
|
|
Zaktualizowana zawartość dokumentu
|
body | True | byte |
Zawartość dokumentu. |
Blokowanie dokumentu
Blokowanie dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
Identyfikator dokumentu |
|
Comment
|
comment | string |
Comment |
Dodawanie lub usuwanie członka grupy
Dodawanie lub usuwanie członka grupy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy
|
groupID | True | string |
(Zaczyna się od ug-) |
|
Dodawanie lub usuwanie użytkownika
|
action | True | string |
Dodawanie lub usuwanie użytkownika |
|
Identyfikator użytkownika
|
member | True | string |
(Musi być już członkiem repozytorium). |
Dodawanie lub usuwanie grupy z szafki
Dodawanie grupy do szafki i domyślnych praw dostępu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabinetID | True | string |
(Zaczyna się od NG-) |
|
Dodawanie lub usuwanie grupy
|
action | True | string |
Dodawanie lub usuwanie grupy |
|
Identyfikator grupy
|
id | True | string |
Identyfikator grupy (zaczyna się od ug-). |
|
Wyświetlanie praw
|
view | True | boolean |
Wyświetl prawa (V) — tylko w przypadku dodawania. |
|
Edytowanie praw
|
edit | True | boolean |
Edytuj prawa (E) — tylko w przypadku dodawania. |
|
Prawa do udostępniania
|
share | True | boolean |
Prawa udziału (S) — tylko w przypadku dodawania. |
|
Administrowanie prawami
|
administer | True | boolean |
Administrowanie prawami (A) — tylko w przypadku dodawania. |
|
Brak praw dostępu
|
noAccess | True | boolean |
Brak praw dostępu (N) — tylko do dodania. |
Dodawanie użytkownika do repozytorium lub usuwanie go z repozytorium
Dodawanie użytkownika do repozytorium lub usuwanie go z repozytorium
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Rozpoczyna się od urzędu certyfikacji) |
|
Dodawanie lub usuwanie użytkownika
|
action | True | string |
Dodawanie lub usuwanie użytkownika |
|
Identyfikator użytkownika
|
member | True | string |
Identyfikator użytkownika |
|
Użytkownik jest zewnętrzny
|
external | True | boolean |
Użytkownik jest zewnętrzny |
|
Usuwanie użytkownika (jeśli federacyjne)
|
deleteIfFederated | boolean |
(Dotyczy tylko usuwania) |
Historia dokumentów
Pobieranie listy akcji wykonywanych w dokumencie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
Obserwowanie dokumentu
Otrzymywanie alertów po zaktualizowaniu dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Adresatów
|
recipients | True | string |
Co najmniej jeden prawidłowy adres e-mail rozdzielony średnikami. Duplikaty ignorowane. |
|
Wyślij
|
send | string |
Która kategoria użytkowników powinna otrzymywać alert. |
Obserwowanie folderu
Otrzymywanie alertów po dodaniu nowej zawartości do folderu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator folderu
|
id | True | string |
12-cyfrowy identyfikator folderu. |
|
Adresatów
|
recipients | True | string |
Co najmniej jeden prawidłowy adres e-mail rozdzielony średnikami. Duplikaty ignorowane. |
|
Wyślij
|
send | string |
Która kategoria użytkowników powinna otrzymywać alert. |
Odblokowywanie dokumentu
Oddokuj dokument
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
Identyfikator dokumentu |
Odświeżanie obszaru roboczego
Odświeżanie obszaru roboczego
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator obszaru roboczego
|
workspaceID | True | string |
Identyfikator obszaru roboczego |
Plik lub cofnij plik dokumentu do folderu
Utwórz element w folderze lub usuń plik elementu z folderu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator folderu
|
id | True | string |
12-cyfrowy identyfikator folderu. |
|
Identyfikator dokumentu
|
item | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Plik lub cofnij plik
|
action | True | string |
Plik lub cofnij plik |
Pobieranie atrybutów niestandardowych cabinet
Pobieranie atrybutów niestandardowych cabinet
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabinetID | True | string |
(Zaczyna się od NG-) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
items
|
object |
Pobieranie bieżących informacji o użytkowniku
Uzyskiwanie informacji o bieżącym użytkowniku, identyfikator nie jest wymagany
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabGuid | string |
(Zaczyna się od NG-) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa wyświetlana
|
displayName | string | |
|
e-mail
|
|||
|
id
|
id | string | |
|
organizacja
|
organization | string | |
|
isRepositoryMember
|
isRepositoryMember | boolean | |
|
primaryCabinet
|
primaryCabinet | string | |
|
sortLookupBy
|
sortLookupBy | string | |
|
zewnętrzny
|
external | boolean |
Pobieranie dziennika repozytorium
Pobieranie dziennika repozytorium
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Rozpoczyna się od urzędu certyfikacji) |
|
Data/godzina rozpoczęcia
|
start | string |
(Domyślnie to 30 dni; format rrrr-MM-dd lub rrrr-MM-dd-ddThh:mm:ssZ) |
|
|
Data/godzina zakończenia
|
end | string |
(Taki sam format jak początek; wartości domyślne to dzisiaj) |
|
|
Typ dziennika
|
Logtype | True | string |
Typ dziennika |
Pobieranie elementów folderu
Pobieranie zawartości folderu, w tym dokumentów i podfolderów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator folderu
|
id | True | string |
12-cyfrowy identyfikator folderu. |
|
Atrybuty do zwrócenia
|
$select | string |
Rozdzielona przecinkami lista wartości atrybutów. Aby uzyskać więcej informacji, zobacz dokumentację interfejsu API REST. |
Pobieranie grup repozytorium
Pobieranie grup repozytorium
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Zaczyna się od urzędu certyfikacji) |
|
Filter
|
$filter | string |
(Zapoznaj się z dokumentacją dotyczącą kryteriów filtrowania) |
|
|
Liczba wyników
|
$top | string |
(Wartość domyślna to 5000. Maksymalna 10 000) |
|
|
Paging
|
paging | boolean |
(Zwróć wyniki na stronach; wartość domyślna to false) |
|
|
Token stronicowania
|
$skiptoken | string |
(W celach stronicowania; zwracane przez wcześniejsze wywołania jako "dalej") |
|
|
Informacje zwrotne
|
returnInfo | string |
wszystkie będą zwracać nazwy grup. Wartość domyślna jest pusta, aby zwrócić tylko identyfikatory |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of string |
Pobieranie grup szafek
Pobieranie wszystkich grup dodanych do gabinetu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabinetID | True | string |
(Zaczyna się od NG-) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
Id | string | |
|
Name
|
Name | string | |
|
External
|
External | boolean | |
|
Ukryty
|
Hidden | boolean |
Pobieranie informacji o grupie
Pobieranie informacji o grupie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy
|
groupID | True | string |
Identyfikator grupy (zaczyna się od ug-). |
|
Członkostwo w gabinecie grupy
|
cabMembership | boolean |
(W przypadku ustawienia wartości "true" gabinety są członkami tej grupy i zostaną uwzględnione domyślne prawa dostępu do dokumentów dla każdego gabinetu). |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zewnętrzny
|
external | boolean | |
|
ukryty
|
hidden | boolean | |
|
hideMembership
|
hideMembership | boolean | |
|
id
|
id | string | |
|
nazwa
|
name | string | |
|
cabMembership
|
cabMembership | array of object | |
|
id
|
cabMembership.id | string | |
|
nazwa
|
cabMembership.name | string | |
|
prawa
|
cabMembership.rights | string |
Pobieranie informacji o obszarze roboczym
Pobieranie informacji o obszarze roboczym
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator obszaru roboczego
|
workspaceID | True | string |
Identyfikator obszaru roboczego |
Pobieranie informacji o repozytorium
Pobieranie informacji o repozytorium
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Rozpoczyna się od urzędu certyfikacji) |
Pobieranie informacji o szafie
Pobieranie informacji o szafie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabinetID | True | string |
(Zaczyna się od NG-) |
Pobieranie listy gabinetów użytkowników
Pobieranie szafek użytkownika
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
isCollaborationSpacesEnabled
|
isCollaborationSpacesEnabled | string | |
|
nazwa
|
name | string | |
|
identyfikator repozytorium
|
repositoryId | string | |
|
repositoryName
|
repositoryName | string | |
|
wsAttrNum
|
wsAttrNum | integer | |
|
wsOrgAttrNum
|
wsOrgAttrNum | integer |
Pobieranie lub tworzenie obszaru roboczego (z atrybutami nadrzędnymi i podrzędnymi)
Pobieranie lub tworzenie obszaru roboczego (z atrybutami nadrzędnymi i podrzędnymi)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabinetID | True | string |
(Zaczyna się od NG-) |
|
Wartość nadrzędna
|
parentID | True | string |
Wartość nadrzędna używana do definiowania obszarów roboczych w szafie. |
|
Wartość podrzędna
|
childID | True | string |
Wartość podrzędna używana do definiowania obszarów roboczych w pliku cabinet. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
standardAttributes.id | string |
Pobieranie lub tworzenie obszaru roboczego (z jednym atrybutem)
Pobieranie lub tworzenie obszaru roboczego (z jednym atrybutem)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabinetID | True | string |
(Zaczyna się od NG-) |
|
Jedyna wartość
|
parentID | True | string |
Jedyną wartością używaną do definiowania obszarów roboczych w szafie. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
standardAttributes.id | string |
Pobieranie podrzędnego wpisu tabeli odnośników
Pobieranie podrzędnego wpisu tabeli odnośników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Zaczyna się od urzędu certyfikacji) |
|
Identyfikator atrybutu podrzędnego
|
childAttributeID | True | string |
(Usuń wiodące '10') |
|
Klucz nadrzędny
|
parentID | True | string |
Klucz nadrzędny |
|
Klucz podrzędny
|
childID | True | string |
Klucz podrzędny |
Pobieranie profilu dokumentu
Uzyskiwanie informacji o dokumencie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
Pobieranie ustawień szafy
Pobieranie ustawień szafy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabinetID | True | string |
(Zaczyna się od NG-) |
Pobieranie użytkowników repozytorium
Pobieranie użytkowników repozytorium
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Rozpoczyna się od urzędu certyfikacji) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
nazwa wyświetlana
|
displayName | string | |
|
e-mail
|
string | ||
|
zewnętrzny
|
external | boolean | |
|
id
|
id | string | |
|
lastLogin
|
lastLogin | string | |
|
Zarejestrowany
|
registered | string |
Pobieranie wersji dokumentów
Pobieranie wersji dokumentów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
documentID | True | string |
12-cyfrowy identyfikator dokumentu. |
Pobieranie wpisu tabeli odnośników lub wyszukiwanie wpisów tabeli podrzędnej
Pobieranie wpisu tabeli odnośników lub wyszukiwanie wpisów tabeli podrzędnej
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Zaczyna się od urzędu certyfikacji) |
|
Identyfikator atrybutu
|
attributeID | True | string |
(Usuń wiodące "10". Aby zwrócić pojedynczą wartość, wprowadź identyfikator atrybutu nadrzędnego lub wyszukaj wpisy podrzędne, wprowadź identyfikator atrybutu podrzędnego. |
|
Key
|
parentID | True | string |
(Aby zwrócić pojedynczą wartość, wprowadź klucz pojedynczego atrybutu lub wyszukaj wpisy podrzędne wprowadź klucz elementu nadrzędnego). |
|
Filtr (tylko podczas wyszukiwania)
|
$filter | string |
(Zapoznaj się z dokumentacją dostępnych filtrów) |
|
|
Pola do pobrania
|
$select | string |
(Dołącz rozdzielaną przecinkami listę: "key", "description", "parent", "hold", "closed", "defaulting", "type", "user" i/or "access") |
|
|
Liczba pasujących rekordów do pominięcia
|
$skip | integer |
(Jest to używane podczas pobierania wielu bloków wyników). |
|
|
Maksymalna liczba rekordów do zwrócenia
|
$top | integer |
Maksymalna liczba rekordów do zwrócenia |
|
|
Kolejność wyników według
|
$orderby | string |
Kolejność wyników według |
Pobieranie zawartości dokumentu
Pobieranie dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Kodowane w formacie Base64?
|
base64 | boolean |
Kodowane w formacie Base64? |
Pobieranie zawartości kontenera
Pobieranie zawartości wybranego kontenera
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator kontenera
|
containerID | True | string |
Identyfikator kontenera |
|
Informacje, które mają być zwracane
|
select | True | string |
(Zapoznaj się z dokumentacją dotyczącą formatu powrotu) |
|
Liczba wyników do zwrócenia (wartość domyślna to 50)
|
top | integer |
(Maksymalna 500 na stronę) |
|
|
Token używany do stronicowania wyników
|
skiptoken | string |
Token używany do stronicowania wyników |
|
|
Zamów według
|
orderby | string |
(Format: field#|desc or field#|asc) |
Tworzenie aplikacji CollabSpace
Tworzenie nowego collabSpace
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator obszaru roboczego
|
workspaceID | True | string |
Identyfikator obszaru roboczego |
|
Nazwa przestrzeni collabSpace
|
name | True | string |
Nazwa przestrzeni collabSpace |
|
Description
|
description | string |
Description |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
Id | string | |
|
EnvUrl
|
EnvUrl | string |
Tworzenie dokumentu
Utwórz nowy dokument
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Destynacja
|
destination | True | string |
12-cyfrowy identyfikator lub envID folderu, filtru lub obszaru roboczego. |
|
Zawartość dokumentu
|
file | True | file |
Umieść nazwę pliku plus rozszerzenie w towarzyszącym polu nazwy pliku. |
|
Dodaj do ostatnich
|
addToRecent | boolean |
Dodaj do ostatnich |
|
|
Profil dokumentu
|
profile | string |
Ustawianie profilu dokumentu (format JSON) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
rozszerzenie
|
extension | string | |
|
nazwa
|
name | string |
Tworzenie grupy repozytorium
Tworzenie grupy repozytorium
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Zaczyna się od urzędu certyfikacji) |
|
Nazwa grupy
|
name | True | string |
Nazwa grupy |
|
External
|
external | True | boolean |
External |
|
Ukryj na listach
|
hidden | True | boolean |
Ukryj na listach |
|
Ukryte członkostwo
|
hideMembership | True | boolean |
Ukryte członkostwo |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zewnętrzny
|
external | boolean | |
|
ukryty
|
hidden | boolean | |
|
hideMembership
|
hideMembership | boolean | |
|
id
|
id | string | |
|
nazwa
|
name | string |
Tworzenie grupy zewnętrznej cabinet
Tworzenie grupy zewnętrznej cabinet
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabinetID | True | string |
(Zaczyna się od NG-) |
|
Nazwa grupy
|
name | True | string |
Nazwa grupy |
|
Opcje grupy
|
options | string |
Opcje grupy |
|
|
Domyślny dostęp do pliku Cabinet
|
access | string |
Domyślny dostęp do pliku Cabinet |
|
|
Identyfikator collabSpace
|
collaborationSpaceId | string |
(Aby utworzyć tę grupę zewnętrzną CollabSpace-external) |
|
|
Dostęp do aplikacji CollabSpace
|
collaborationspaceaccess | string |
Dostęp do aplikacji CollabSpace |
|
|
Wartość atrybutu górnego obszaru roboczego
|
topwsattributegroupkey | string |
(W przypadku zwykłych grup zewnętrznych cabinet; aby skojarzyć grupę z określoną wartością atrybutu najwyższego obszaru roboczego) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ
|
Type | integer | |
|
Id
|
Id | string | |
|
Name
|
Name | string | |
|
Opcje
|
Options | string | |
|
Access
|
Access | string |
Tworzenie lub aktualizowanie podrzędnego wpisu tabeli odnośników
Tworzenie lub aktualizowanie podrzędnego wpisu tabeli odnośników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Zaczyna się od urzędu certyfikacji) |
|
Identyfikator atrybutu podrzędnego
|
childAttributeID | True | string |
(Usuń wiodące '10') |
|
Klucz nadrzędny
|
parentID | True | string |
Klucz nadrzędny |
|
Klucz podrzędny
|
childID | True | string |
Klucz podrzędny |
|
Description
|
description | string | ||
|
Typ
|
defaulting | string | ||
|
Blokada postępowania sądowego
|
hold | boolean | ||
|
Data zamknięcia
|
closed | string |
Formatuj format "/Date(Liczba milis z 1 stycznia 1970+-UTC", na przykład: "/Date(1582261200000-0500)/" |
|
|
Przefiltrowane uprawnienia
|
filtered_permissions | True | boolean | |
|
Wymuszanie permsji
|
force_permissions | True | boolean | |
|
View
|
view | True | boolean | |
|
Edytuj
|
edit | True | boolean | |
|
Share
|
share | True | boolean | |
|
Administrowanie
|
administer | True | boolean | |
|
Brak dostępu
|
noAccess | True | boolean | |
|
Domyślna wartość pliku Cabinet
|
cabDefault | True | boolean | |
|
Dyrektor
|
principal | True | string |
(Identyfikator użytkownika lub grupy) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
count
|
count | integer |
Tworzenie lub aktualizowanie wpisu tabeli odnośników
Tworzenie lub aktualizowanie wpisu tabeli odnośników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Zaczyna się od urzędu certyfikacji) |
|
Identyfikator atrybutu
|
attributeID | True | string |
(Usuń wiodące '10') |
|
Key
|
parentID | True | string |
Key |
|
Description
|
description | string | ||
|
Typ
|
defaulting | string | ||
|
Blokada postępowania sądowego
|
hold | boolean | ||
|
Data zamknięcia
|
closed | string |
Formatuj format "/Date(Liczba milis z 1 stycznia 1970+-UTC", na przykład: "/Date(1582261200000-0500)/" |
|
|
Przefiltrowane uprawnienia
|
filtered_permissions | True | boolean | |
|
Wymuszanie permsji
|
force_permissions | True | boolean | |
|
View
|
view | True | boolean | |
|
Edytuj
|
edit | True | boolean | |
|
Share
|
share | True | boolean | |
|
Administrowanie
|
administer | True | boolean | |
|
Brak dostępu
|
noAccess | True | boolean | |
|
Domyślna wartość pliku Cabinet
|
cabDefault | True | boolean | |
|
Dyrektor
|
principal | True | string |
(Identyfikator użytkownika lub grupy) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
count
|
count | integer |
Tworzenie nowej wersji dokumentu
Tworzenie nowej wersji dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Rozszerzenie dokumentu
|
extension | string |
Nie uwzględniaj okresu wiodącego. |
|
|
Opis wersji
|
version_description | string |
Opis wersji |
|
|
Nazwa nowej wersji
|
verName | string |
Nazwa nowej wersji |
|
|
Ustaw oficjalną wersję
|
official | boolean |
Nowa wersja nie będzie oficjalną wersją, jeśli ten parametr nie jest ustawiony. |
|
|
Dodawanie do ostatnich dokumentów
|
addToRecent | boolean |
Dodawanie do ostatnich dokumentów |
|
|
Numer wersji źródłowej
|
srcVer | string |
W przypadku kopiowania zawartości z wcześniejszej wersji, która wersja dokumentu ma być kopiowana. |
|
|
Tworzenie jako podwersja
|
allocatesubversion | boolean |
Utwórz jako podwersję zamiast jako pełną wersję. |
|
|
Zawartość dokumentu nowej wersji
|
body | binary |
Zawartość nowej wersji, jeśli nie kopiuje innej wersji lub oficjalnej wersji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
latestVersionNumber
|
latestVersionNumber | integer | |
|
newVer
|
newVer | integer | |
|
newVersionLabel
|
newVersionLabel | string | |
|
officialVer
|
officialVer | integer | |
|
officialVerName
|
officialVerName | string | |
|
versions
|
versions | integer |
Tworzenie zabezpieczonego linku
Generowanie linku do dokumentu, do którego można uzyskać dostęp przez dowolną osobę
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Hasło do zabezpieczonego linku
|
password | string |
W zależności od konfiguracji gabinetu hasło może być opcjonalne lub obowiązkowe. |
|
|
Data wygaśnięcia zabezpieczonego linku.
|
expirationdate | string |
Format danych wejściowych: rrrr-MM-dd. |
|
|
Wersja dokumentu
|
version | string |
Która wersja dokumentu ma być udostępniona. Jeśli jest pusta, oficjalna wersja zostanie udostępniona. |
|
|
Pobieranie dokumentu
|
download | boolean |
Jeśli to prawda, dokument może zostać pobrany przez adresata. |
|
|
Powiadom mnie
|
notifyme | boolean |
Jeśli to prawda, powiadom nadawcę, gdy jest uzyskiwany dostęp do zabezpieczonego linku. |
|
|
Blokowanie dokumentu
|
lock | boolean |
Opcjonalnie zablokuj wybraną wersję dokumentu. Wymaga to uprawnień do edycji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
widok
|
standardAttributes.view | string | |
|
pobierać
|
standardAttributes.download | string |
Usuwanie dokumentu
Usuwanie dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Trwałe usuwanie
|
permanent | boolean |
Wskazuje, że dokument powinien zostać trwale usunięty, a nie przeniesiony do usuniętych elementów. |
Usuwanie grupy repozytorium
Usuwanie grupy repozytorium
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Zaczyna się od urzędu certyfikacji) |
|
Identyfikator grupy
|
groupID | True | string |
(Zaczyna się od ug-) |
Usuwanie podrzędnego wpisu tabeli odnośników
Usuwanie podrzędnego wpisu tabeli odnośników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Zaczyna się od urzędu certyfikacji) |
|
Identyfikator atrybutu podrzędnego
|
childAttributeID | True | string |
(Usuń wiodące '10') |
|
Klucz nadrzędny
|
parentID | True | string |
Klucz nadrzędny |
|
Klucz podrzędny
|
childID | True | string |
Klucz podrzędny |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
count
|
count | integer |
Usuwanie wpisu tabeli odnośników
Usuwanie wpisu tabeli odnośników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Zaczyna się od urzędu certyfikacji) |
|
Identyfikator atrybutu
|
attributeID | True | string |
(Usuń wiodące '10') |
|
Key
|
parentID | True | string |
Key |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
count
|
count | integer |
Usuń folder
Usuwanie folderu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator folderu
|
id | True | string |
12-cyfrowy identyfikator folderu. |
|
Trwałe usuwanie
|
permanent | boolean |
Wskazuje, że folder powinien zostać trwale usunięty, a nie przeniesiony do usuniętych elementów. Zawartość folderu, w tym podfolderów potomnych, nie zostanie trwale usunięta. |
|
|
Usuń zawartość folderu
|
deleteContents | boolean |
Wskazuje, że dokumenty w usuniętym folderze (i w dowolnym podfolderze potomnym) powinny być również usuwane, a nie po prostu niefiltrowane. |
Utwórz folder
Tworzenie nowego folderu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa folderu
|
name | True | string |
Nazwa folderu. |
|
Identyfikator nadrzędny
|
parent | string |
12-cyfrowy identyfikator lub envID kontenera nadrzędnego nowego folderu. |
|
|
Identyfikator gabinetu
|
cabinet | string |
(Zaczyna się od NG-) Można pominąć, jeśli w obiekcie nadrzędnym określono identyfikator folderu lub obszaru roboczego. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
standardAttributes.id | string | |
|
nazwa
|
standardAttributes.name | string |
Utwórz użytkownika
Tworzenie użytkownika w repozytorium
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa użytkownika
|
username | True |
(Taki sam jak adres e-mail użytkownika) |
|
|
Imię
|
displayFirstName | True | string |
Imię |
|
Drugie imię
|
displayMiddleName | string |
Drugie imię |
|
|
Nazwisko
|
displayLastName | True | string |
Nazwisko |
|
Adres e-mail
|
True |
Adres e-mail |
||
|
Użytkownik jest zewnętrzny
|
external | True | boolean |
(Dotyczy tylko dodatku) |
|
Wyślij powitalny e-mail
|
sendWelcome | True | boolean |
Wyślij powitalny e-mail |
|
Identyfikator repozytorium
|
repository | True | string |
(Rozpoczyna się od urzędu certyfikacji) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa wyświetlana
|
displayName | string | |
|
e-mail
|
|||
|
id
|
id | string | |
|
zewnętrzny
|
external | boolean |
Uzyskiwanie członkostwa w grupie
Uzyskiwanie członkostwa w grupie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator grupy
|
groupID | True | string |
(Zaczyna się od ug-) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
nazwa wyświetlana
|
displayName | string | |
|
id
|
id | string |
Uzyskiwanie informacji o użytkowniku
Uzyskiwanie informacji o użytkowniku
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator użytkownika
|
id | True | string |
Identyfikator użytkownika przypisany przez netDocuments. |
|
Identyfikator gabinetu
|
cabGuid | string |
(Zaczyna się od NG-) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa wyświetlana
|
displayName | string | |
|
e-mail
|
|||
|
id
|
id | string | |
|
organizacja
|
organization | string | |
|
isRepositoryMember
|
isRepositoryMember | boolean | |
|
primaryCabinet
|
primaryCabinet | string | |
|
sortLookupBy
|
sortLookupBy | string | |
|
zewnętrzny
|
external | boolean |
Uzyskiwanie ukrytych grup gabinetu praw dostępu
Uzyskiwanie ukrytych grup gabinetu praw dostępu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabinetID | True | string |
(Zaczyna się od NG-) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
zarządzać
|
administer | boolean | |
|
cabDefault
|
cabDefault | boolean | |
|
edycja
|
edit | boolean | |
|
nazwa
|
name | string | |
|
noAccess
|
noAccess | boolean | |
|
podmiot zabezpieczeń
|
principal | string | |
|
udostępnić
|
share | boolean | |
|
widok
|
view | boolean |
Wyewidencjonuj dokument
Wyewidencjonowywanie dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Comment
|
comment | string |
Comment |
|
|
Pobieranie dokumentu
|
download | boolean |
Zwraca zawartość dokumentu. |
|
|
Wersja do pobrania
|
version | string |
Określa, która zawartość wersji ma zostać pobrana. Domyślnie jest to oficjalna wersja. |
|
|
Dodaj do ostatnich
|
addToRecent | boolean |
Dodaj do ostatnich |
Wyszukiwanie co najmniej jednego gabinetu
Wyszukiwanie co najmniej jednego gabinetu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Szafy
|
cabinets | True | string |
(rozdzielane przecinkami) |
|
Query
|
q | True | string |
(Przejrzyj dokumentację dla formatu zapytania) |
|
Informacje, które mają być zwracane
|
select | True | string |
(Zapoznaj się z dokumentacją dotyczącą formatu powrotu) |
|
Zamów według
|
orderby | string |
(Format: field#|desc or field#|asc) |
|
|
Liczba wyników do zwrócenia (wartość domyślna to 50)
|
top | integer |
(Maksymalna 500 na stronę) |
|
|
Liczba wyników do pominięcia
|
skip | integer |
Liczba wyników do pominięcia |
|
|
Token używany do stronicowania wyników
|
skiptoken | string |
Token używany do stronicowania wyników |
Wyszukiwanie w szafie i modyfikowanie list ACL
Wyszukiwanie w szafie i modyfikowanie list ACL
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabinetID | True | string |
(Zaczyna się od NG-) |
|
Query
|
q | True | string |
(Przejrzyj dokumentację dla formatu zapytania) |
|
Modyfikowanie trybu listy ACL
|
mode | True | string |
Modyfikowanie trybu listy ACL |
|
Nowa lista ACL
|
newAcl | True | string |
(Zapoznaj się z dokumentacją odpowiedniego formatu json) |
|
Adres e-mail
|
(Zamiast tego wyślij powiadomienie na ten adres) |
|||
|
Wysyłanie wiadomości e-mail z ukończeniem
|
completionEmail | string |
(true = send always (default), false = don't send, fail = send only on fail (Wysyłanie tylko w przypadku niepowodzenia) |
Wyszukiwanie wpisów tabeli odnośników
Wyszukiwanie wpisów tabeli odnośników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator repozytorium
|
repositoryID | True | string |
(Zaczyna się od urzędu certyfikacji) |
|
Identyfikator atrybutu
|
attributeID | True | string |
(Usuń wiodące '10') |
|
Filter
|
$filter | string |
(Zapoznaj się z dokumentacją dostępnych filtrów) |
|
|
Pola do pobrania
|
$select | string |
(Dołącz rozdzielaną przecinkami listę: "key", "description", "parent", "hold", "closed", "defaulting", "type", "user" i/or "access") |
|
|
Liczba pasujących rekordów do pominięcia
|
$skip | integer |
(Jest to używane podczas pobierania wielu bloków wyników). |
|
|
Maksymalna liczba rekordów do zwrócenia
|
$top | integer |
Maksymalna liczba rekordów do zwrócenia |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wierszy
|
rows | array of object | |
|
Zalegających
|
rows.defaulting | string | |
|
opis
|
rows.description | string | |
|
trzymać
|
rows.hold | boolean | |
|
klucz
|
rows.key | string | |
|
zamknięty
|
rows.closed | string | |
|
dostęp
|
rows.access | string |
Zablokuj wersję dokumentu
Zablokuj wersję dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Wersja dokumentu
|
version | True | integer |
Wersja dokumentu |
|
Opis wersji
|
description | string |
Opis wersji |
Zaewidencjonuj dokument
Zaewidencjonuj dokument wyewidencjonowany
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Rozszerzenie dokumentu
|
extension | string |
Nie uwzględniaj okresu wiodącego. |
|
|
Zawartość dokumentu
|
file | file |
Dokument w formie wieloczęściowej. |
|
|
Dodaj do ostatnich
|
addToRecent | boolean |
Dodaj do listy ostatnio używanych dokumentów użytkownika. |
Zmienianie nazwy dokumentu
Zmienianie nazwy dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator dokumentu
|
id | True | string |
12-cyfrowy identyfikator dokumentu. |
|
Nowa nazwa
|
name | True | string |
Zmienianie nazwy folderu
Zmienianie nazwy folderu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator folderu
|
id | True | string |
12-cyfrowy identyfikator folderu. |
|
Nowa nazwa
|
name | True | string |
Wyzwalacze
| Szafka wyszukiwania |
Przeszukaj określony gabinet |
Szafka wyszukiwania
Przeszukaj określony gabinet
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator gabinetu
|
cabId | True | string |
(Zaczyna się od NG-) |
|
Kryteria wyszukiwania
|
q | True | string |
Użyj tego samego formatu i operatorów co w interfejsie internetowym NetDocuments. |
|
Zamów według
|
$orderby | string |
Zamów według |
|
|
Maksymalna liczba wyników
|
$top | string |
Liczba całkowita z zakresu od 1 do 500. Wartość domyślna to 100. |
|
|
Atrybuty do zwrócenia
|
$select | string |
Rozdzielona przecinkami lista wartości atrybutów. Aby uzyskać więcej informacji, zobacz dokumentację interfejsu API REST. |