Udostępnij przez


Egnyte

Egnyte to usługa, która zapewnia bezpieczeństwo, synchronizowanie i łatwe udostępnianie plików. Połącz się z usługą Egnyte, aby zarządzać plikami. W aplikacji Egnyte można wykonywać różne akcje, takie jak przekazywanie, aktualizowanie, pobieranie i usuwanie plikó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 Obsługa aplikacji Egnyte
adres URL https://helpdesk.egnyte.com
Email support@egnyte.com
Metadane łącznika
Publisher Egnyte
Witryna internetowa https://egnyte.com/
Zasady ochrony prywatności https://www.egnyte.com/privacy-policy
Kategorie Kolaboracja; Produktywność

Egnyte

Egnyte to platforma współpracy zawartości, która zapewnia bezpieczeństwo, synchronizowanie i łatwe udostępnianie plików. Połącz się z usługą Egnyte, aby zarządzać plikami. W aplikacji Egnyte można wykonywać różne akcje, takie jak przekazywanie, przenoszenie, pobieranie i usuwanie plików.

Pre-requisites

Aby użyć łącznika, musisz być użytkownikiem aplikacji Egnyte.

Obsługiwane akcje

Łącznik obsługuje następujące akcje:

Obsługiwane wyzwalacze

Łącznik obsługuje następujące wyzwalacze:

  • When a file is locked: Ta operacja wyzwala przepływ, gdy plik jest zablokowany
  • When a file is unlocked: Ta operacja wyzwala przepływ po odblokowaniu pliku
  • When a file is updated: Ta operacja wyzwala przepływ po zaktualizowaniu pliku w określonym folderze
  • When a file is created (webhook): Ta operacja wyzwala przepływ, gdy plik zostanie utworzony w określonym folderze
  • When a share link is created: Ta operacja wyzwala przepływ po utworzeniu łącza udziału
  • When a share link is deleted: Ta operacja wyzwala przepływ po usunięciu łącza udziału
  • When the file or folder permission changes: Ta operacja wyzwala przepływ, gdy zmiany uprawnień pliku lub folderu
  • When the file or folder metadata changes: Ta operacja wyzwala przepływ po zmianie metadanych pliku lub folderu
  • When a project folder is created: Ta operacja wyzwala przepływ podczas tworzenia folderu projektu lub gdy istniejący folder jest oznaczony jako folder projektu
  • When a folder is unmarked as a project: Ta operacja wyzwala przepływ, gdy folder jest nieoznakowany jako projekt
  • When a project is updated: Ta operacja wyzwala przepływ po zaktualizowaniu projektu
  • When a workflow is created: Ta operacja wyzwala przepływ po utworzeniu przepływu pracy
  • When a workflow is completed: Ta operacja wyzwala przepływ po zakończeniu przepływu pracy
  • When an approval type workflow is approved: Ta operacja wyzwala przepływ po zatwierdzeniu przepływu pracy typu zatwierdzenia
  • When an approval type workflow is rejected: Ta operacja wyzwala przepływ po odrzuceniu przepływu pracy typu zatwierdzenia
  • When a group is created: Ta operacja wyzwala przepływ po utworzeniu grupy
  • When a group is updated: Ta operacja wyzwala przepływ po zaktualizowaniu grupy
  • When a group is deleted: Ta operacja wyzwala przepływ po usunięciu grupy
  • When a file is created (polling): Ta operacja wyzwala przepływ po utworzeniu nowego pliku w folderze.
  • When a folder is created: Ta operacja wyzwala przepływ po utworzeniu podfolderu w folderze.
  • When a file is deleted: Ta operacja wyzwala przepływ po usunięciu pliku w folderze.
  • When a folder is deleted: Ta operacja wyzwala przepływ po usunięciu podfolderu w folderze.
  • When a file is renamed: Ta operacja wyzwala przepływ po zmianie nazwy pliku w folderze.
  • When a folder is renamed: Ta operacja wyzwala przepływ po zmianie nazwy podfolderu w folderze.
  • When a file is moved: Ta operacja wyzwala przepływ po przeniesieniu pliku w folderze.
  • When a folder is moved: Ta operacja wyzwala przepływ po przeniesieniu podfolderu w folderze.
  • When a file is copied: Ta operacja wyzwala przepływ, gdy plik jest kopiowany w folderze.
  • When a folder is copied: Ta operacja wyzwala przepływ, gdy podfolder jest kopiowany w folderze.

Limity ograniczania

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

Akcje

[AI] Generowanie podsumowania dokumentu

Wygeneruj podsumowanie dla danego dokumentu, podając odpowiedź opartą na sztucznej inteligencji na podstawie zawartości dokumentu. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document

[AI] Zadaj pytanie dotyczące dokumentu

Zadaj pytania związane z danym dokumentem, podając odpowiedź opartą na sztucznej inteligencji na podstawie zawartości dokumentu. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question

[AI] Zadaj pytanie egnyte copilot

Zadawaj pytania do platformy copilot, zapewniając odpowiedź opartą na sztucznej inteligencji na podstawie zawartości globalnej w domenie Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot

Aktualizacja grupy częściowej

Aktualizowanie określonych atrybutów grupy. https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group

Aktualizowanie atrybutów przestrzeni nazw

Aktualizuje atrybuty przestrzeni nazw. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes

Aktualizowanie kluczy przestrzeni nazw

Zaktualizuj klucz metadanych niestandardowych dla domeny. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys

Aktualizowanie projektu według identyfikatora

Aktualizuje określone właściwości projektu zidentyfikowanego przez jego identyfikator. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project

Aktualizowanie użytkownika według identyfikatora

Zaktualizuj pojedynczego użytkownika. Dowiedz się więcej: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User

Blokowanie pliku według identyfikatora

Zablokuj plik przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

Blokowanie pliku według ścieżki

Zablokuj plik przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

Czyszczenie projektu według identyfikatora

Ten punkt końcowy inicjuje oczyszczanie w projekcie i opcjonalnie usuwa lub wyłącza określonych użytkowników. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project

Folder udostępniania

Udostępnij folder w aplikacji Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Kopiowanie folderu według identyfikatora

Skopiuj folder przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Kopiowanie pliku według identyfikatora

Skopiuj plik przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Kopiowanie pliku według ścieżki

Skopiuj plik przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Kopiuj folder według ścieżki

Skopiuj folder przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Link bezpośredni według identyfikatora

Utwórz link bezpośredni dla pliku lub folderu według identyfikatora. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

Link bezpośredni według ścieżki

Utwórz link bezpośredni dla pliku lub folderu według ścieżki. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

Modyfikowanie opcji folderów

Zmodyfikuj opcje folderów, takie jak opis, ustawienia udostępniania linków, uprawnienia linku publicznego, ograniczenia przenoszenia/usuwania i preferencje powiadomień e-mail. https://developers.egnyte.com/api-docs/read/folder-options-api

Odblokowywanie pliku według identyfikatora

Odblokuj plik przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

Odblokowywanie pliku według ścieżki

Odblokuj plik przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

Oznacz folder jako projekt

Oznacz istniejący folder jako projekt. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project

Pełna aktualizacja grupy

Zastąp wszystkie atrybuty grupy. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group

Pobieranie informacji o folderze według identyfikatora

Pobierz informacje o folderze przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Pobieranie informacji o folderze według ścieżki

Pobierz informacje o folderze przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Pobieranie informacji o pliku według identyfikatora

Pobieranie informacji o pliku przy użyciu identyfikatora pliku. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Pobieranie informacji o pliku według ścieżki

Pobierz informacje o pliku przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Pobieranie listy wszystkich grup

Pobierz listę grup. https://developers.egnyte.com/api-docs/read/group-management#List-Groups

Pobieranie listy wszystkich użytkowników

Pobierz informacje o użytkownikach. Dowiedz się więcej: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List

Pobieranie metadanych według identyfikatora folderu

Pobieranie metadanych z folderu przy użyciu identyfikatora folderu. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

Pobieranie metadanych według identyfikatora pliku

Pobieranie metadanych z pliku przy użyciu identyfikatora pliku. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

Pobieranie projektu według identyfikatora

Pobieranie projektu przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID

Pobieranie projektu według identyfikatora folderu głównego

Pobierz projekt na podstawie jego identyfikatora folderu głównego. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder

Pobieranie szczegółów użytkownika

Pobierz informacje o użytkowniku według identyfikatora. Dowiedz się więcej: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User

Pobieranie wszystkich projektów

Wyświetl listę wszystkich folderów projektu w domenie. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects

Pobieranie wszystkich przestrzeni nazw

Pobierz listę wszystkich niestandardowych przestrzeni nazw metadanych w domenie. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces

Pobieranie zawartości pliku według identyfikatora

Pobiera zawartość pliku z egnyte przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

Pobieranie zawartości pliku według ścieżki

Pobiera zawartość pliku z aplikacji Egnyte przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

Pobierz szczegóły grupy

Pobieranie informacji o grupie przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group

Pokaż szczegóły łącza

Wyświetl szczegóły linku. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details

Przenieś folder według identyfikatora

Przenieś folder przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Przenieś folder według ścieżki

Przenieś folder w aplikacji Egnyte przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Przenoszenie pliku według identyfikatora

Przenieś plik w aplikacji Egnyte przy użyciu identyfikatora pliku. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Przenoszenie pliku według ścieżki

Przenieś plik w aplikacji Egnyte przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Tworzenie grupy

Utwórz grupę w aplikacji Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group

Tworzenie klucza metadanych

Dodaj klucz metadanych do istniejącej przestrzeni nazw. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key

Tworzenie projektu na podstawie szablonu

Utwórz nowy projekt na podstawie szablonu folderu projektu. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template

Tworzenie przestrzeni nazw

Utwórz przestrzeń nazw w aplikacji Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace

Udział plików

Udostępnij plik w egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Ustawianie metadanych według identyfikatora folderu

Zapisywanie metadanych w folderze przy użyciu identyfikatora folderu. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

Ustawianie metadanych według identyfikatora pliku

Zapisywanie metadanych w pliku przy użyciu identyfikatora pliku. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

Ustawianie uprawnień do folderu

Ustaw uprawnienia dla folderu. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions

Usuwanie folderu według identyfikatora

Usuń folder przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Usuwanie folderu według ścieżki

Usuń folder przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Usuwanie grupy

Usuń grupę według identyfikatora. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group

Usuwanie klucza metadanych

Usuń klucz metadanych z istniejącej przestrzeni nazw. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key

Usuwanie pliku według identyfikatora

Usuń plik przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Usuwanie pliku według ścieżki

Usuń plik przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Usuwanie projektu według identyfikatora

Usuń projekt na podstawie jego identyfikatora. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project

Usuwanie przestrzeni nazw

Usuń określoną przestrzeń nazw. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace

Usuwanie użytkownika według identyfikatora

Usuń użytkownika z aplikacji Egnyte. Dowiedz się więcej: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User

Usuń łącze

Usuń łącze. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link

Utwórz folder

Utwórz folder w aplikacji Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder

Utwórz link

Utwórz link. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Utwórz plik

Przekazuje plik do aplikacji Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File

Utwórz użytkownika

Utwórz nowego użytkownika w aplikacji Egnyte. Dowiedz się więcej: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User

Uzyskiwanie obowiązujących uprawnień

Uzyskiwanie obowiązujących uprawnień dla użytkownika. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User

Uzyskiwanie przestrzeni nazw

Wyświetl listę wszystkich niestandardowych kluczy metadanych, które zostały utworzone w danej przestrzeni nazw. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace

Uzyskiwanie uprawnień do folderu

Uzyskiwanie uprawnień do folderu. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions

Wyszukaj metadane

Znajdź elementy z określonym polem lub wartością metadanych. https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata

Wyszukaj w wersji 1

Znajdź zawartość przechowywaną w aplikacji Egnyte na podstawie nazw plików, metadanych i zawartości tekstowej. https://developers.egnyte.com/api-docs/read/search-api#Search-v1

Wyszukiwanie w wersji 2

Znajdowanie zawartości z funkcjami wyszukiwania zaawansowanego. https://developers.egnyte.com/api-docs/read/search-api#Search-v2

Wyświetl listę wszystkich łączy

Wyświetla listę wszystkich łączy z wyjątkiem usuniętych łączy. Należy pamiętać, że jeśli użytkownik wykonujący tę metodę nie jest administratorem, zostaną wyświetlone tylko linki utworzone przez użytkownika. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links

Wyświetl listę wszystkich łączy w wersji 2

Wyświetla listę wszystkich łączy. Należy pamiętać, że jeśli użytkownik wykonujący tę metodę nie jest administratorem, zostaną wyświetlone tylko linki utworzone przez użytkownika. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2

[AI] Generowanie podsumowania dokumentu

Wygeneruj podsumowanie dla danego dokumentu, podając odpowiedź opartą na sztucznej inteligencji na podstawie zawartości dokumentu. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator wpisu pliku
entryId True string

Identyfikator konkretnej wersji pliku

Role
role string
Zawartość wiadomości
content string

Zwraca

[AI] Zadaj pytanie dotyczące dokumentu

Zadaj pytania związane z danym dokumentem, podając odpowiedź opartą na sztucznej inteligencji na podstawie zawartości dokumentu. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator wpisu pliku
entryId True string

Identyfikator konkretnej wersji pliku

Question
question True string

Konkretne pytanie, które chcesz zadać

Dołącz cytaty
includeCitations boolean

Czy odpowiedź powinna zawierać cytaty (domyślnie ma wartość false)

Role
role string
Zawartość wiadomości
content string

Zwraca

[AI] Zadaj pytanie egnyte copilot

Zadawaj pytania do platformy copilot, zapewniając odpowiedź opartą na sztucznej inteligencji na podstawie zawartości globalnej w domenie Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot

Parametry

Nazwa Klucz Wymagane Typ Opis
Question
question True string

Konkretne pytanie, które chcesz zadać

Identyfikator folderu
id string

Identyfikator wybranego folderu

Identyfikator wpisu pliku
entryId string

Identyfikator wpisu wybranego pliku

Dołącz cytaty
includeCitations boolean

Czy odpowiedź powinna zawierać cytaty (domyślnie ma wartość false)

Role
role string
Zawartość wiadomości
content string

Zwraca

Aktualizacja grupy częściowej

Aktualizowanie określonych atrybutów grupy. https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator grupy
id True string

Identyfikator utworzonej grupy.

nazwa wyświetlana
displayName string

Nazwa wyświetlana grupy.

Identyfikator użytkownika
value integer

Globalnie unikatowy identyfikator członka grupy.

operacja
operation string

Akcja, którą chcesz wykonać w grupie.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator grupy
id string

Identyfikator utworzonej grupy.

nazwa wyświetlana
displayName string

Nazwa wyświetlana grupy.

Członkowie
members array of object

Członkowie grupy

Nazwa użytkownika
members.username string

Nazwa użytkownika członka.

Identyfikator użytkownika
members.value number

Identyfikator użytkownika elementu członkowskiego.

Nazwa wyświetlana użytkownika
members.display string

Nazwa wyświetlana elementu członkowskiego.

Aktualizowanie atrybutów przestrzeni nazw

Aktualizuje atrybuty przestrzeni nazw. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa przestrzeni nazw
namespace True string

Unikatowy identyfikator przestrzeni nazw w egnyte.

nazwa wyświetlana
displayName string

Nazwa identyfikująca przestrzeń nazw w interfejsie użytkownika

Priorytety
priorities object

Określa priorytet (kolejność) dla kluczy. Klucze będą wyświetlane zgodnie z ich priorytetami w kolejności malejącej (klucze o wyższym priorytcie będą wyświetlane jako pierwsze)

Zwraca

Aktualizowanie kluczy przestrzeni nazw

Zaktualizuj klucz metadanych niestandardowych dla domeny. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa przestrzeni nazw
namespace True string

Unikatowy identyfikator przestrzeni nazw w egnyte.

Key
key True string

Unikatowy klucz w przestrzeni nazw

nazwa wyświetlana
displayName string

Określa nazwę wyświetlaną dla klucza

typ
type string

Określa typ danych klucza

priority
priority number

Określa priorytet (kolejność) dla kluczy. Klucze będą wyświetlane zgodnie z ich priorytetami w kolejności malejącej (klucze o wyższym priorytcie będą wyświetlane jako pierwsze)

dane
data string

Dla klucza typu wyliczenia określa wyliczone wartości

helpText
helpText string

Tekst instruktażowy wyświetlany podczas dodawania/edytowania właściwości w celu nadania kontekstu celowi właściwości

Zwraca

Nazwa Ścieżka Typ Opis
nazwa
name string

Nazwa przestrzeni nazw

klucz
key string

Nazwa klucza

nazwa wyświetlana
displayName string

Nazwa identyfikująca pole w interfejsie użytkownika

helpText
helpText string

Opis etykietki narzędzia dla pola metadanych

priority
priority number

Określa priorytet klucza (klucze o wyższym priorytcie będą wyświetlane jako pierwsze

Aktualizowanie projektu według identyfikatora

Aktualizuje określone właściwości projektu zidentyfikowanego przez jego identyfikator. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project

Parametry

Nazwa Klucz Wymagane Typ Opis
nazwa
name True string

Nowa nazwa folderu.

opis
description string

Nowy opis folderu.

identyfikator projektu
projectId True string

Identyfikator projektu.

customProjectId
customProjectId string

Niestandardowy identyfikator projektu.

NazwaKlienta
customerName string

Klient skojarzony z projektem.

ulicaAdres1
streetAddress1 string

Pierwszy wiersz adresu ulicy.

ulicaAdres2
streetAddress2 string

Drugi wiersz adresu ulicy.

city
city string

Miasto.

stan
state string

Stan lub prowincja.

postalCode
postalCode string

Kod pocztowy (zip code) lub kod pocztowy (postal code).

country
country string

przy użyciu 3-znakowego kodu kraju z profilu ISO 3166 GENC, na przykład: USA, GBR, POL.

stan
status True string

Bieżący stan projektu.

startDate
startDate string

Data rozpoczęcia projektu w formacie ISO 8601.

completionDate (data ukończenia)
completionDate string

Oczekiwana data zakończenia projektu w formacie ISO 8601.

Aktualizowanie użytkownika według identyfikatora

Zaktualizuj pojedynczego użytkownika. Dowiedz się więcej: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
id True integer

Unikatowy identyfikator użytkownika

Adres e-mail użytkownika
email string

Adres e-mail użytkownika.

Imię
givenName string

Imię użytkownika.

Nazwisko
familyName string

Nazwisko użytkownika.

Aktywna
active boolean

Niezależnie od tego, czy użytkownik jest aktywny, czy nieaktywny.

Wyślij zaproszenie
sendInvite boolean

W przypadku ustawienia wartości true zostanie wysłana wiadomość e-mail z zaproszeniem. Parametr nie może być jedynym zmodyfikowanym przez tę akcję.

Język
language string

Parametr "language" jest akceptowany tylko wtedy, gdy pakiet językowy został włączony dla domeny.

Typ uwierzytelniania
authType string

Typ uwierzytelniania użytkownika.

Typ użytkownika
userType string

Typ użytkownika.

Role
role string

Rola przypisana użytkownikowi. Dotyczy tylko użytkowników usługi Power Users.

Identyfikator użytkownika dostawcy tożsamości
idpUserId string

Wymagane tylko wtedy, gdy użytkownik jest uwierzytelniony za pomocą logowania jednokrotnego i nie używa domyślnego mapowania użytkowników

Główna nazwa użytkownika
userPrincipalName string

Nie należy określać, czy użytkownik nie jest uwierzytelniony w usłudze AD.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator użytkownika
id integer

Unikatowy identyfikator użytkownika

Adres e-mail użytkownika
email string

Adres e-mail użytkownika.

Nazwisko
familyName string

Nazwisko użytkownika.

Imię
givenName string

Imię użytkownika.

Aktywna
active boolean

Niezależnie od tego, czy użytkownik jest aktywny, czy nieaktywny.

Wyślij zaproszenie
sendInvite boolean

W przypadku ustawienia wartości true zostanie wysłana wiadomość e-mail z zaproszeniem.

Język
language string

Jest akceptowany tylko wtedy, gdy pakiet językowy został włączony.

Typ uwierzytelniania
authType string

Typ uwierzytelniania użytkownika.

Typ użytkownika
userType string

Typ użytkownika.

Role
role string

Rola przypisana użytkownikowi. Dotyczy tylko użytkowników usługi Power Users.

Identyfikator użytkownika dostawcy tożsamości
idpUserId string

Wymagane tylko wtedy, gdy użytkownik jest uwierzytelniony za pomocą logowania jednokrotnego

Główna nazwa użytkownika
userPrincipalName string

Nie należy określać, czy użytkownik nie jest uwierzytelniony w usłudze AD.

Blokowanie pliku według identyfikatora

Zablokuj plik przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
id True string

Unikatowy identyfikator pliku w egnyte.

Zwraca

Nazwa Ścieżka Typ Opis
Przerwa czasowa
timeout integer

Czas w sekundach, dla którego plik powinien być zablokowany.

Blokowanie tokenu
lock_token string

Token, który musi być używany do odblokowania pliku.

Blokowanie pliku według ścieżki

Zablokuj plik przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

Parametry

Nazwa Klucz Wymagane Typ Opis
Docelowa ścieżka pliku
path True string

Docelowa ścieżka pliku w aplikacji Egnyte, w tym nazwa pliku docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Przerwa czasowa
timeout integer

Czas w sekundach, dla którego plik powinien być zablokowany.

Blokowanie tokenu
lock_token string

Token, który musi być używany do odblokowania pliku.

Czyszczenie projektu według identyfikatora

Ten punkt końcowy inicjuje oczyszczanie w projekcie i opcjonalnie usuwa lub wyłącza określonych użytkowników. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator projektu
projectId True string

Identyfikator projektu

deleteLinks
deleteLinks True boolean

W przypadku ustawienia wartości true wszystkie istniejące aktywne linki w projekcie zostaną usunięte.

usersToDelete
usersToDelete array of integer

Lista identyfikatorów użytkowników do usunięcia.

usersToDisable
usersToDisable array of integer

Lista identyfikatorów użytkowników, które mają być wyłączone.

Zwraca

Nazwa Ścieżka Typ Opis
komunikat
message string

Folder udostępniania

Udostępnij folder w aplikacji Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
path True string

Ścieżka folderu w aplikacji Egnyte do udostępnienia.

Zwraca

Nazwa Ścieżka Typ Opis
links
links array of object

Links

Identyfikator łącza
links.id string

Identyfikator linku.

Adres URL łącza
links.url string

Pełny adres URL linku.

Adresatów
links.recipients array of string

Tablica prawidłowych adresów e-mail, do których wysłano link.

Ścieżka folderu
path string

Pełna ścieżka folderu udostępnionego.

Typ
type string

Typ łącza, plik, folder lub przekazywanie.

Accessibility
accessibility string

Kto link jest dostępny dla każdego użytkownika, hasła, domeny lub adresatów.

Powiadamianie twórcy po korzystaniu z dostępu
notify boolean

Czy twórca linku zostanie powiadomiony za pośrednictwem poczty e-mail po korzystaniu z linku.

Odnosi się do wersji
link_to_current boolean

Czy jest to bieżąca wersja? T lub F

Data wygaśnięcia
expiry_date string

Data i godzina wygaśnięcia linku.

Data utworzenia
creation_date string

Data i godzina utworzenia linku.

Utworzone przez
created_by string

Nazwa użytkownika, który utworzył link.

Kopiowanie folderu według identyfikatora

Skopiuj folder przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu
id True string

Unikatowy identyfikator folderu do skopiowania w aplikacji Egnyte.

Ścieżka folderu docelowego
destination_path True string

Ścieżka folderu docelowego w aplikacji Egnyte.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka folderu
path string

Pełna ścieżka skopiowanego folderu.

Identyfikator folderu
folder_id string

Unikatowy identyfikator skopiowanego folderu.

Kopiowanie pliku według identyfikatora

Skopiuj plik przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
id True string

Unikatowy identyfikator pliku do skopiowania w aplikacji Egnyte.

Docelowa ścieżka pliku
destination_path True string

Docelowa ścieżka pliku w aplikacji Egnyte, w tym nazwa pliku docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka pliku
path string

Pełna ścieżka skopiowanego pliku.

Identyfikator pliku
group_id string

Identyfikator do odwołowania się do pliku jako całości.

Kopiowanie pliku według ścieżki

Skopiuj plik przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Plik źródłowy
path True string

Ścieżka pliku źródłowego w aplikacji Egnyte, w tym nazwa pliku docelowego.

Plik docelowy
destination_path True string

Docelowa ścieżka pliku w aplikacji Egnyte, w tym nazwa pliku docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka pliku
path string

Pełna ścieżka skopiowanego pliku.

Identyfikator pliku
group_id string

Identyfikator do odwołowania się do pliku jako całości.

Kopiuj folder według ścieżki

Skopiuj folder przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu źródłowego
path True string

Ścieżka folderu źródłowego w aplikacji Egnyte.

Ścieżka folderu docelowego
destination_path True string

Ścieżka folderu docelowego w aplikacji Egnyte.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka folderu
path string

Pełna ścieżka skopiowanego folderu.

Identyfikator folderu
folder_id string

Unikatowy identyfikator skopiowanego folderu.

Utwórz link bezpośredni dla pliku lub folderu według identyfikatora. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

Parametry

Nazwa Klucz Wymagane Typ Opis
Id
id True string

Identyfikator pliku lub folderu

Typ
type True string

Typ łącza

Zwraca

Nazwa Ścieżka Typ Opis
URL
url string

Link bezpośredni

Utwórz link bezpośredni dla pliku lub folderu według ścieżki. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka
path True string

Ścieżka pliku lub folderu

Zwraca

Nazwa Ścieżka Typ Opis
URL
url string

Link bezpośredni

Modyfikowanie opcji folderów

Zmodyfikuj opcje folderów, takie jak opis, ustawienia udostępniania linków, uprawnienia linku publicznego, ograniczenia przenoszenia/usuwania i preferencje powiadomień e-mail. https://developers.egnyte.com/api-docs/read/folder-options-api

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
path True string

Unikatowa ścieżka do folderu w aplikacji Egnyte.

Opis folderu
folder_description string

Opis folderu.

Zezwalaj na łącza
allow_links boolean

Określ, czy łącza mogą być udostępniane plikom, czy podfolderom w tym folderze.

Łącza publiczne
public_links string

Określ, jakiego typu łącza publiczne są dozwolone. Możliwe wartości: files_folders, pliki, wyłączone.

Ograniczanie przenoszenia/usuwania
restrict_move_delete boolean

Ogranicz operacje przenoszenia i usuwania tylko do właścicieli folderów i administratorów.

Powiadomienia o aktualizacjach zawartości
content_updates boolean

Włącz powiadomienia e-mail dotyczące aktualizacji zawartości.

Powiadomienia z dostępem do zawartości
content_accessed boolean

Włącz powiadomienia e-mail dotyczące zawartości, do których uzyskiwano dostęp.

Zwraca

Nazwa Ścieżka Typ Opis
Name
name string

Nazwa folderu.

Ostatnia modyfikacja
lastModified integer

Ostatni raz, gdy dowolny plik w folderze (ale nie w podfolderach) został zmodyfikowany.

Ścieżka folderu
path string

Pełna ścieżka folderu.

Identyfikator folderu
folder_id string

Unikatowy identyfikator folderu.

Opis folderu
folder_description string

Opis folderu.

Jest folderem
is_folder boolean

Czy zasób jest folderem. Prawda czy Fałsz

Możliwe łącza publiczne
public_links string

Ustawienie opcji folderu dotyczące ustawienia "Zezwalaj na linki publiczne z tego folderu dla" zostało ustawione.

Można usunąć lub przenieść
restrict_move_delete boolean

Czy można usunąć lub przenieść? T lub F

Odblokowywanie pliku według identyfikatora

Odblokuj plik przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
id True string

Unikatowy identyfikator pliku w egnyte.

Blokowanie tokenu
lock_token True string

Bieżący token blokady dla pliku.

Odblokowywanie pliku według ścieżki

Odblokuj plik przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka pliku
path True string

Unikatowa ścieżka do pliku w aplikacji Egnyte.

Blokowanie tokenu
lock_token True string

Bieżący token blokady dla pliku.

Oznacz folder jako projekt

Oznacz istniejący folder jako projekt. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu głównego
rootFolderId True string

FolderId folderu głównego projektu

Name
name True string

Nazwa projektu

Description
description string

Opis folderu

Status
status True string

Stan projektu

Data rozpoczęcia (np. 2023-12-31T23:59:59)
startDate date-time

Data rozpoczęcia projektu.

Data ukończenia (np. 2023-12-31T23:59:59)
completionDate date-time

Data ukończenia projektu.

Zwraca

Nazwa Ścieżka Typ Opis
Id
id string

Identyfikator elementu

Pełna aktualizacja grupy

Zastąp wszystkie atrybuty grupy. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator grupy
id True string

Identyfikator utworzonej grupy.

nazwa wyświetlana
displayName True string

Nazwa wyświetlana grupy.

Identyfikator użytkownika
value integer

Globalnie unikatowy identyfikator członka grupy.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator grupy
id string

Identyfikator utworzonej grupy.

nazwa wyświetlana
displayName string

Nazwa wyświetlana grupy.

Członkowie
members array of object

Członkowie grupy

Nazwa użytkownika
members.username string

Nazwa użytkownika członka.

Identyfikator użytkownika
members.value number

Identyfikator użytkownika elementu członkowskiego.

Nazwa wyświetlana użytkownika
members.display string

Nazwa wyświetlana elementu członkowskiego.

Pobieranie informacji o folderze według identyfikatora

Pobierz informacje o folderze przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu
id True string

Unikatowy identyfikator folderu w egnyte.

Zwraca

Pobieranie informacji o folderze według ścieżki

Pobierz informacje o folderze przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
path True string

Unikatowa ścieżka do folderu w aplikacji Egnyte.

Zwraca

Pobieranie informacji o pliku według identyfikatora

Pobieranie informacji o pliku przy użyciu identyfikatora pliku. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
id True string

Unikatowy identyfikator pliku w egnyte.

Zwraca

Pobieranie informacji o pliku według ścieżki

Pobierz informacje o pliku przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka pliku
path True string

Unikatowa ścieżka do pliku w aplikacji Egnyte.

Zwraca

Pobieranie listy wszystkich grup

Pobierz listę grup. https://developers.egnyte.com/api-docs/read/group-management#List-Groups

Parametry

Nazwa Klucz Wymagane Typ Opis
Indeks początkowy
startIndex integer

Indeks 1 żądanego początkowego rekordu (liczba całkowita ≥ 1).

Liczba
count integer

Liczba wpisów na stronę (minimalna 1, maksymalna 100)

Filter
filter string

Umożliwia żądanie podzestawu grup. Te terminy nie są uwzględniane wielkości liter

Zwraca

Nazwa Ścieżka Typ Opis
Łączna liczba wyników
totalResults integer

Całkowita liczba wyników pasujących do zapytania.

Elementy na stronę
itemsPerPage integer

Liczba zwróconych wyników.

Rozpocznij indeks
startIndex integer

1-oparty na indeksie pierwszego wyniku w bieżącym zestawie wyników.

resources
resources array of object
Identyfikator grupy
resources.id string

Globalnie unikatowy identyfikator grupy.

Nazwa grupy
resources.displayName string

Nazwa grupy.

Pobieranie listy wszystkich użytkowników

Pobierz informacje o użytkownikach. Dowiedz się więcej: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List

Parametry

Nazwa Klucz Wymagane Typ Opis
Indeks początkowy
startIndex integer

1-oparty na indeksie pierwszego wyniku wyszukiwania.

Liczba
count integer

Określa żądaną maksymalną liczbę wyników wyszukiwania na stronę.

Filter
filter string

Umożliwia zażądanie podzbioru użytkowników. Zapoznaj się z dokumentacją w sekcji Informacje.

Zwraca

Uzyskiwanie odpowiedzi na listę użytkowników

Pobieranie metadanych według identyfikatora folderu

Pobieranie metadanych z folderu przy użyciu identyfikatora folderu. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu
folderId True string

Unikatowy identyfikator folderu w egnyte.

Nazwa przestrzeni nazw
namespace True string

Nazwa przestrzeni nazw.

Pobieranie metadanych według identyfikatora pliku

Pobieranie metadanych z pliku przy użyciu identyfikatora pliku. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
fileId True string

Unikatowy identyfikator pliku w egnyte.

Nazwa przestrzeni nazw
namespace True string

Nazwa przestrzeni nazw.

Pobieranie projektu według identyfikatora

Pobieranie projektu przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator projektu
projectId True string

Identyfikator projektu

Zwraca

Pobieranie projektu według identyfikatora folderu głównego

Pobierz projekt na podstawie jego identyfikatora folderu głównego. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu głównego
rootFolderId True string

Identyfikator folderu głównego

Zwraca

Pobieranie szczegółów użytkownika

Pobierz informacje o użytkowniku według identyfikatora. Dowiedz się więcej: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
id True integer

Identyfikator użytkownika

Zwraca

Informacje o użytkowniku

Pobieranie wszystkich projektów

Wyświetl listę wszystkich folderów projektu w domenie. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects

Zwraca

Pobieranie wszystkich przestrzeni nazw

Pobierz listę wszystkich niestandardowych przestrzeni nazw metadanych w domenie. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces

Zwraca

Pobieranie zawartości pliku według identyfikatora

Pobiera zawartość pliku z egnyte przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
fileId True string

Unikatowy identyfikator pliku w egnyte.

Pobieranie zawartości pliku według ścieżki

Pobiera zawartość pliku z aplikacji Egnyte przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka pliku
filePath True string

Unikatowa ścieżka do pliku w aplikacji Egnyte.

Pobierz szczegóły grupy

Pobieranie informacji o grupie przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator grupy
id True string

Identyfikator grupy.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator grupy
id string

Globalnie unikatowy identyfikator grupy.

Nazwa grupy
displayName string

Nazwa grupy.

Członkowie
members array of object

Członkowie grupy

Identyfikator grupy
members.username string

Nazwa użytkownika członka grupy

Identyfikator użytkownika
members.value number

Globalnie unikatowy identyfikator członka grupy.

Nazwa wyświetlana użytkownika
members.display string

Nazwa wyświetlana członka grupy.

Pokaż szczegóły łącza

Wyświetl szczegóły linku. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator łącza
linkId True string

Identyfikator linku

Zwraca

Nazwa Ścieżka Typ Opis
Links
links array of object

Tablica zawierająca pełne informacje JSON dla wszystkich linków dla domeny, które ten użytkownik może zobaczyć w dowolnych określonych zakresach

Id
links.id string

Identyfikator linku

URL
links.url string

Pełny adres URL linku

Adresatów
links.recipients array of string

Tablica prawidłowych adresów e-mail, do których wysłano link.

Ścieżka
path string

Ścieżka bezwzględna zasobu docelowego, pliku lub folderu.

Typ
type string

Typ łącza, plik, folder lub przekazywanie

Accessibility
accessibility string

Kto link jest dostępny dla każdego użytkownika, hasła, domeny lub adresatów.

Powiadom
notify boolean

Wartość logiczna określająca, czy twórca linku zostanie powiadomiony za pośrednictwem poczty e-mail po korzystaniu z linku.

Łącze do bieżącego
link_to_current boolean

Wartość logiczna określająca, czy link będzie zawsze odwoływać się do bieżącej wersji pliku. Dotyczy tylko łączy plików.

Data wygaśnięcia
expiry_date string

Data i godzina wygaśnięcia linku. To pole jest wyświetlane tylko wtedy, gdy łącze ma wygasnąć według daty

Data utworzenia
creation_date string

Data i godzina utworzenia linku

Utworzone przez
created_by string

Nazwa użytkownika, który utworzył link

Ostatni dostęp
last_accessed string

Data i godzina ostatniego dostępu do linku. To pole jest wyświetlane tylko wtedy, gdy link został wyświetlony co najmniej raz

Przenieś folder według identyfikatora

Przenieś folder przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu
id True string

Unikatowy identyfikator folderu w egnyte.

Ścieżka folderu docelowego
destination_path True string

Ścieżka folderu docelowego w aplikacji Egnyte.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka folderu
path string

Pełna ścieżka przeniesionego folderu.

Identyfikator folderu
folder_id string

Unikatowy identyfikator przeniesionego folderu.

Przenieś folder według ścieżki

Przenieś folder w aplikacji Egnyte przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka źródłowa
path True string

Ścieżka do folderu źródłowego.

Ścieżka folderu docelowego
destination_path True string

Ścieżka folderu docelowego w aplikacji Egnyte.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka folderu
path string

Pełna ścieżka przeniesionego folderu.

Identyfikator folderu
folder_id string

Unikatowy identyfikator przeniesionego folderu.

Przenoszenie pliku według identyfikatora

Przenieś plik w aplikacji Egnyte przy użyciu identyfikatora pliku. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
id True string

Unikatowy identyfikator pliku w egnyte.

Docelowa ścieżka pliku
destination_path True string

Docelowa ścieżka pliku w egnyte. Uwzględnianie nazwy pliku docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka pliku
path string

Pełna ścieżka przeniesionego pliku.

Identyfikator pliku
group_id string

Identyfikator do odwołowania się do pliku jako całości.

Przenoszenie pliku według ścieżki

Przenieś plik w aplikacji Egnyte przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka źródłowa
path True string

Ścieżka do pliku źródłowego.

Docelowa ścieżka pliku
destination_path True string

Docelowa ścieżka pliku w aplikacji Egnyte, w tym nazwa pliku docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka pliku
path string

Pełna ścieżka przeniesionego pliku.

Identyfikator pliku
group_id string

Identyfikator do odwołowania się do pliku jako całości.

Tworzenie grupy

Utwórz grupę w aplikacji Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group

Parametry

Nazwa Klucz Wymagane Typ Opis
nazwa wyświetlana
displayName True string

Nazwa wyświetlana grupy.

Identyfikator użytkownika
value string

Globalnie unikatowy identyfikator członka grupy.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator grupy
id string

Identyfikator utworzonej grupy.

nazwa wyświetlana
displayName string

Nazwa wyświetlana grupy.

Członkowie
members array of object

Członkowie grupy

Nazwa użytkownika
members.username string

Nazwa użytkownika członka.

Identyfikator użytkownika
members.value number

Identyfikator użytkownika elementu członkowskiego.

Nazwa wyświetlana użytkownika
members.display string

Nazwa wyświetlana elementu członkowskiego.

Tworzenie klucza metadanych

Dodaj klucz metadanych do istniejącej przestrzeni nazw. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa przestrzeni nazw
namespace True string

Unikatowy identyfikator przestrzeni nazw w egnyte.

Nazwa klucza
key True string

Nazwa tworzonego klucza.

Typ (w przypadku "wyliczenia": wymagany jest parametr danych)
type True string

Określa typ danych klucza.

nazwa wyświetlana
displayName string

Nazwa identyfikująca pole w interfejsie użytkownika.

Priority
priority number

Określa priorytet klucza (klucze o wyższym priorytcie będą wyświetlane jako pierwsze).

Tekst pomocy
helpText string

Opis etykietki narzędzia dla pola metadanych.

Dane
data array of string

W przypadku klucza typu wyliczenia określa wyliczone wartości.

Tworzenie projektu na podstawie szablonu

Utwórz nowy projekt na podstawie szablonu folderu projektu. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu nadrzędnego
parentFolderId True string

Identyfikator folderu nadrzędnego, w którym zostanie utworzony folder projektu

Identyfikator folderu szablonu
templateFolderId True string

Identyfikator folderu szablonu folderu projektu

Nazwa folderu
folderName True string

Nazwa nowego folderu, który zostanie utworzony

Name
name True string

Nazwa projektu

Description
description string

Opis folderu

Identyfikator projektu
projectId string

Identyfikator niestandardowy projektu

Nazwa klienta
customerName string

Klient skojarzony z projektem

Status
status True string

Stan projektu

Data rozpoczęcia (np. 2023-12-31T23:59:59)
startDate date-time

Data rozpoczęcia projektu.

Data ukończenia (np. 2023-12-31T23:59:59)
completionDate date-time

Data ukończenia projektu.

Adres ulicy 1
streetAddress1 string

Pierwszy wiersz adresu

Adres ulicy 2
streetAddress2 string

Drugi wiersz adresu

Miejscowość
city string

Miejscowość

Stan lub prowincja
state string

Stan lub prowincja

Country
country string

Country

Kod pocztowy lub kod pocztowy
postalCode string

Kod pocztowy lub kod pocztowy

Zwraca

Nazwa Ścieżka Typ Opis
grupyTworzenie
groupsCreated array of object
Identyfikator projektu
groupsCreated.id string

Identyfikator projektu

Nazwa projektu
groupsCreated.name string

Nazwa projektu

Tworzenie przestrzeni nazw

Utwórz przestrzeń nazw w aplikacji Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa przestrzeni nazw
name True string

Nazwa przestrzeni nazw

nazwa wyświetlana
displayName string

Nazwa identyfikująca przestrzeń nazw w interfejsie użytkownika

Scope
scope True string

Kto może wyświetlać i modyfikować przestrzeń nazw

Nazwa klucza
name True string

Nazwa klucza

Typ
type True string

Określa typ danych klucza

Wyświetlana nazwa
displayName string

Nazwa identyfikująca pole w interfejsie użytkownika

Tekst pomocy
helpText string

Opis etykietki narzędzia dla pola metadanych

Priority
priority number

Określa priorytet klucza (klucze o wyższym priorytcie będą wyświetlane jako pierwsze

Dane (dla typu wyliczenia)
data array of string

Dla klucza typu wyliczenia określa wyliczone wartości

Udział plików

Udostępnij plik w egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka pliku
path True string

Ścieżka pliku w aplikacji Egnyte, w tym nazwa pliku docelowego do udostępnienia.

Zwraca

Nazwa Ścieżka Typ Opis
links
links array of object

Links

Identyfikator łącza
links.id string

Identyfikator linku.

Adres URL łącza
links.url string

Pełny adres URL linku.

Adresatów
links.recipients array of string

Tablica prawidłowych adresów e-mail, do których wysłano link.

Ścieżka pliku
path string

Pełna ścieżka pliku udostępnionego.

Typ
type string

Typ łącza, plik, folder lub przekazywanie.

Accessibility
accessibility string

Kto link jest dostępny dla każdego użytkownika, hasła, domeny lub adresatów.

Powiadamianie twórcy po korzystaniu z dostępu
notify boolean

Czy twórca linku zostanie powiadomiony za pośrednictwem poczty e-mail po korzystaniu z linku.

Odnosi się do wersji
link_to_current boolean

Czy jest to bieżąca wersja? T lub F

Data wygaśnięcia
expiry_date string

Data i godzina wygaśnięcia linku.

Data utworzenia
creation_date string

Data i godzina utworzenia linku.

Stworzone przez
created_by string

Nazwa użytkownika, który utworzył link.

Ustawianie metadanych według identyfikatora folderu

Zapisywanie metadanych w folderze przy użyciu identyfikatora folderu. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu
folderId True string

Unikatowy identyfikator folderu w egnyte.

Nazwa przestrzeni nazw
namespaceName True string

Nazwa przestrzeni nazw.

Nazwa klucza metadanych
metadataName True string

Nazwa klucza, do którego chcesz przypisać wartość.

Wartość metadanych
metadataValue True string

Wartość metadanych, która ma zostać ustawiona.

Ustawianie metadanych według identyfikatora pliku

Zapisywanie metadanych w pliku przy użyciu identyfikatora pliku. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
fileId True string

Unikatowy identyfikator pliku w egnyte.

Nazwa przestrzeni nazw
namespaceName True string

Nazwa przestrzeni nazw.

Nazwa klucza metadanych
metadataName True string

Nazwa klucza, do którego chcesz przypisać wartość.

Wartość metadanych
metadataValue string

Wartość metadanych, która ma zostać ustawiona.

Ustawianie uprawnień do folderu

Ustaw uprawnienia dla folderu. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
path True string

Pełna ścieżka folderu.

Uprawnienia użytkownika
userPerms object

Mapa wartości uprawnień użytkownika.

Uprawnienia grupy
groupPerms object

Mapowanie nazwy grupy na wartość uprawnień

Dziedziczy uprawnienia
inheritsPermissions boolean

Określa, czy uprawnienia powinny być dziedziczone z folderu nadrzędnego.

Zachowaj uprawnienia nadrzędne (tylko wtedy, gdy dziedziczyWyprawnienia są fałszywe)
keepParentPermissions boolean

Czy uprawnienia z folderów nadrzędnych powinny mieć zastosowanie do tego folderu.

Usuwanie folderu według identyfikatora

Usuń folder przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu
id True string

Unikatowy identyfikator folderu do usunięcia z egnyte.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka folderu nadrzędnego
parent_folder_path string

Ścieżka do folderu nadrzędnego usuniętego folderu.

Usuwanie folderu według ścieżki

Usuń folder przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
path True string

Ścieżka folderu w aplikacji Egnyte, w tym nazwa folderu docelowego do usunięcia.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka folderu nadrzędnego
parent_folder_path string

Ścieżka do folderu nadrzędnego usuniętego folderu.

Usuwanie grupy

Usuń grupę według identyfikatora. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator grupy
id True string

Identyfikator grupy.

Usuwanie klucza metadanych

Usuń klucz metadanych z istniejącej przestrzeni nazw. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa przestrzeni nazw
namespace True string

Unikatowy identyfikator przestrzeni nazw w egnyte.

Name
key True string

Nazwa usuniętego klucza.

Wymuś usunięcie
force boolean

Usuń, nawet jeśli jest używany klucz metadanych.

Usuwanie pliku według identyfikatora

Usuń plik przy użyciu identyfikatora. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pliku
id True string

Unikatowy identyfikator pliku do usunięcia z egnyte.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka folderu nadrzędnego
parent_folder_path string

Ścieżka do folderu nadrzędnego usuniętego pliku.

Usuwanie pliku według ścieżki

Usuń plik przy użyciu ścieżki. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka pliku
path True string

Ścieżka pliku w aplikacji Egnyte, w tym nazwa pliku docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka folderu nadrzędnego
parent_folder_path string

Ścieżka do folderu nadrzędnego usuniętego pliku

Usuwanie projektu według identyfikatora

Usuń projekt na podstawie jego identyfikatora. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator projektu
projectId True string

Identyfikator usuniętego projektu

Usuwanie przestrzeni nazw

Usuń określoną przestrzeń nazw. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa przestrzeni nazw
namespace True string

Unikatowy identyfikator przestrzeni nazw w egnyte.

Wymuś usunięcie
force boolean

Usuń, nawet jeśli używana jest przestrzeń nazw

Usuwanie użytkownika według identyfikatora

Usuń użytkownika z aplikacji Egnyte. Dowiedz się więcej: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
id True integer

Identyfikator użytkownika do usunięcia

Usuń łącze

Usuń łącze. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator łącza
linkId True string

Identyfikator linku

Utwórz folder

Utwórz folder w aplikacji Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
path True string

Pełna ścieżka nowego folderu.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka folderu
path string

Pełna ścieżka utworzonego folderu

Identyfikator folderu
folder_id string

Unikatowy identyfikator utworzonego folderu

Utwórz link. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka
path True string

Ścieżka bezwzględna pliku lub folderu docelowego.

Typ
type True string

Określa typ łącza, który zostanie utworzony.

Accessibility
accessibility string

Określa, kto jest dostępny za pomocą linku. Wymagane z wyjątkiem linków przekazywania lub gdy wartość "useDefaultSettings" ma wartość true.

Użyj ustawień domyślnych
useDefaultSettings True boolean

Określa, czy używać domyślnych parametrów w domenie do tworzenia linków

Wyślij e-mail
send_email boolean

Jeśli ustawiono wartość true, link zostanie wysłany pocztą e-mail przez firmę Egnyte.

Adresatów
recipients array of string

Wyświetl listę adresów e-mail adresatów linku. Wymagane tylko wtedy, gdy wartość "Wyślij wiadomość e-mail" ma wartość true.

Wiadomość (ma zastosowanie tylko wtedy, gdy wartość "Wyślij wiadomość e-mail" ma wartość true).
message string

Wiadomość osobista do wysłania w wiadomości e-mail z linkiem.

Skopiuj mnie (dotyczy tylko tego, czy wartość "Wyślij wiadomość e-mail" ma wartość true)
copy_me boolean

Jeśli ustawiono wartość true, kopia wiadomości linku zostanie wysłana do twórcy linku.

Powiadom
notify boolean

Jeśli ustawiono wartość true, twórca linku zostanie powiadomiony za pośrednictwem poczty e-mail po korzystaniu z linku.

Łącze do bieżącego (dotyczy tylko łączy plików).
link_to_current boolean

Jeśli ustawiono wartość true, link będzie zawsze odwoływać się do bieżącej wersji pliku.

Data wygaśnięcia (np. 2023-12-31)
expiry_date string

Data wygaśnięcia łącza. Jeśli określono, nie można ustawić opcji "Kliknięcia wygasania".

Kliknięcia wygasania
expiry_clicks number

Liczba kliknięć, dla których link jest prawidłowy. Jeśli określono, nie można ustawić opcji "Data wygaśnięcia"

Dodaj nazwę pliku (dotyczy tylko łączy plików, a nie łączy folderów)
add_file_name boolean

Jeśli wartość true, nazwa pliku zostanie dołączona na końcu linku.

Hasło (gdy parametr "ułatwienia dostępu" jest ustawiony na "hasło")
password string

Jeśli nie zostanie określony, system automatycznie wygeneruje hasło.

Ochrona
protection string

Jeśli zostanie ustawiona wartość "WERSJA ZAPOZNAWCZA", zostanie utworzony link tylko do wersji zapoznawczej.

Folder na adresata (dotyczy tylko linków przekazywania).
folder_per_recipient boolean

Jeśli wartość true, dane przekazane przez każdego adresata zostaną umieszczone w osobnym folderze.

Zwraca

Nazwa Ścieżka Typ Opis
Links
links array of object

Tablica zawierająca pełne informacje JSON dla wszystkich linków dla domeny, które ten użytkownik może zobaczyć w dowolnych określonych zakresach

Id
links.id string

Identyfikator linku

URL
links.url string

Pełny adres URL linku

Adresatów
links.recipients array of string

Tablica prawidłowych adresów e-mail, do których wysłano link.

Ścieżka
path string

Ścieżka bezwzględna zasobu docelowego, pliku lub folderu.

Typ
type string

Typ łącza, plik, folder lub przekazywanie

Accessibility
accessibility string

Kto link jest dostępny dla każdego użytkownika, hasła, domeny lub adresatów.

Powiadom
notify boolean

Wartość logiczna określająca, czy twórca linku zostanie powiadomiony za pośrednictwem poczty e-mail po korzystaniu z linku.

Łącze do bieżącego
link_to_current boolean

Wartość logiczna określająca, czy link będzie zawsze odwoływać się do bieżącej wersji pliku. Dotyczy tylko łączy plików.

Data wygaśnięcia
expiry_date string

Data i godzina wygaśnięcia linku. To pole jest wyświetlane tylko wtedy, gdy łącze ma wygasnąć według daty

Data utworzenia
creation_date string

Data i godzina utworzenia linku

Utworzone przez
created_by string

Nazwa użytkownika, który utworzył link

Utwórz plik

Przekazuje plik do aplikacji Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa pliku
Name True string

Nazwa pliku do utworzenia w aplikacji Egnyte.

Ścieżka do folderu
Path True string

Ścieżka folderu do przekazania pliku do aplikacji Egnyte.

Zawartość pliku
body True binary

Zawartość pliku do przekazania do aplikacji Egnyte.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator wersji
id string

Identyfikator bieżącej wersji pliku.

Identyfikator pliku
group_id string

Identyfikator do odwołowania się do pliku jako całości.

Ścieżka pliku
path string

Pełna ścieżka przekazanego pliku.

Utwórz użytkownika

Utwórz nowego użytkownika w aplikacji Egnyte. Dowiedz się więcej: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa użytkownika
userName True string

Nazwa użytkownika egnyte. Musi zaczynać się literą lub cyfrą.

Email
email True string

Adres e-mail użytkownika (np. admin@acme.com).

Imię
givenName True string

Imię użytkownika.

Nazwisko
familyName True string

Nazwisko użytkownika.

Aktywna
active True boolean

Niezależnie od tego, czy użytkownik jest aktywny, czy nieaktywny.

Typ użytkownika
userType True string

Typ użytkownika.

Typ uwierzytelniania
authType True string

Typ uwierzytelniania użytkownika.

Tożsamość zewnętrzna
externalId string

Niezmienny unikatowy identyfikator dostarczony przez użytkownika interfejsu API.

Wyślij zaproszenie
sendInvite boolean

W przypadku ustawienia wartości true podczas tworzenia użytkownika zostanie wysłana wiadomość e-mail z zaproszeniem (jeśli użytkownik zostanie utworzony w stanie aktywnym).

Czy konto usługi
isServiceAccount boolean

W przypadku ustawienia wartości true podczas tworzenia użytkownika użytkownik zostanie utworzony jako konto usługi.

Język
language string

Parametr "language" jest akceptowany tylko wtedy, gdy pakiet językowy został włączony dla domeny.

Role
role string

Rola przypisana użytkownikowi. Dotyczy tylko użytkowników usługi Power Users.

Identyfikator użytkownika dostawcy tożsamości
idpUserId string

Wymagane tylko wtedy, gdy użytkownik jest uwierzytelniony za pomocą logowania jednokrotnego i nie używa domyślnego mapowania użytkownika. Nie należy określać, czy użytkownik nie jest uwierzytelniony za pomocą logowania jednokrotnego.

Główna nazwa użytkownika
userPrincipalName string

Nie należy określać, czy użytkownik nie jest uwierzytelniony w usłudze AD. Służy do powiązania zasad uwierzytelniania podrzędnego z użytkownikiem podczas korzystania z uwierzytelniania usługi Active Directory w konfiguracji z wieloma domenami.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator użytkownika
id integer

Unikatowy identyfikator nowo utworzonego użytkownika

Nazwa użytkownika
userName string

Nazwa użytkownika egnyte.

Tożsamość zewnętrzna
externalId string

Niezmienny unikatowy identyfikator dostarczony przez użytkownika interfejsu API.

Email
email string

Adres e-mail użytkownika.

Oczekiwanie na zmianę wiadomości e-mail
emailChangePending boolean

Czy zmiana wiadomości e-mail oczekuje.

Imię
name.givenName string

Imię użytkownika.

Nazwisko
name.familyName string

Nazwisko użytkownika.

Sformatowana nazwa
name.formatted string

Sformatowana pełna nazwa użytkownika.

Aktywna
active boolean

Czy użytkownik jest aktywny.

Zablokowane
locked boolean

Czy konto użytkownika jest zablokowane.

Typ uwierzytelniania
authType string

Typ uwierzytelniania użytkownika.

Typ użytkownika
userType string

Typ użytkownika.

Identyfikator użytkownika dostawcy tożsamości
idpUserId string

Sposób, w jaki użytkownik jest identyfikowany w odpowiedzi SAML od dostawcy tożsamości logowania jednokrotnego.

Główna nazwa użytkownika
userPrincipalName string

Służy do powiązania zasad uwierzytelniania podrzędnego z użytkownikiem podczas korzystania z uwierzytelniania usługi Active Directory.

Role
role string

Rola przypisana użytkownikowi. Dotyczy tylko użytkowników usługi Power Users.

Język
language string

Preferencje językowe użytkownika.

Data utworzenia
createdDate date-time

Data i godzina utworzenia użytkownika.

Data ostatniej modyfikacji
lastModificationDate date-time

Data i godzina ostatniej modyfikacji.

Ostatnia aktywna data
lastActiveDate date-time

Data i godzina ostatniego działania.

Data wygaśnięcia
expiryDate date-time

Data wygaśnięcia konta użytkownika.

Uzyskiwanie obowiązujących uprawnień

Uzyskiwanie obowiązujących uprawnień dla użytkownika. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
path True string

Pełna ścieżka folderu.

Nazwa użytkownika
username True string

Nazwa użytkownika

Zwraca

Nazwa Ścieżka Typ Opis
Pozwolenie
permission string

Wartość uprawnienia

Uzyskiwanie przestrzeni nazw

Wyświetl listę wszystkich niestandardowych kluczy metadanych, które zostały utworzone w danej przestrzeni nazw. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa przestrzeni nazw
namespace True string

Unikatowy identyfikator przestrzeni nazw w egnyte.

Zwraca

Uzyskiwanie uprawnień do folderu

Uzyskiwanie uprawnień do folderu. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
path True string

Pełna ścieżka folderu.

Zwraca

Nazwa Ścieżka Typ Opis
Uprawnienia użytkownika
userPerms object

Mapa wartości uprawnień użytkownika.

Uprawnienia grupy
groupPerms object

Mapowanie nazwy grupy na wartość uprawnień

Dziedziczy uprawnienia
inheritsPermissions boolean

Określa, czy uprawnienia powinny być dziedziczone z folderu nadrzędnego.

Zachowaj uprawnienia nadrzędne
keepParentPermissions boolean

Podczas wyłączania dziedziczenia uprawnień z dziedziczeniemPermisje ta opcja określa, czy wcześniej dziedziczone uprawnienia z folderów nadrzędnych powinny być kopiowane do tego folderu.

Wyszukaj metadane

Znajdź elementy z określonym polem lub wartością metadanych. https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata

Parametry

Nazwa Klucz Wymagane Typ Opis
Typ wyszukiwania
type string

Które typy elementów powinny być przeszukiwane.

Nazwa przestrzeni nazw
namespace True string

Nazwa przestrzeni nazw.

Klucz metadanych
keyName True string

Nazwa klucza metadanych.

Nazwa przestrzeni nazw
namespace True string

Nazwa przestrzeni nazw.

Klucz metadanych
keyName True string

Nazwa klucza metadanych.

Wartość metadanych
value True string

Wartość klucza metadanych.

Wyszukaj w wersji 1

Znajdź zawartość przechowywaną w aplikacji Egnyte na podstawie nazw plików, metadanych i zawartości tekstowej. https://developers.egnyte.com/api-docs/read/search-api#Search-v1

Parametry

Nazwa Klucz Wymagane Typ Opis
Kwerenda wyszukiwania
query True string

Ciąg wyszukiwania, który chcesz znaleźć.

Przesunięcie
offset integer

Indeks 0 żądanego początkowego rekordu.

Liczba
count integer

Liczba wpisów na stronę.

Folder
folder string

Ogranicz wyniki do elementów w określonym folderze i elementach potomnych.

Zmodyfikowano przed
modifiedBefore string

Ogranicz wyniki do elementów zmodyfikowanych przed tym znacznikem czasu ISO-8601.

Zmodyfikowane po
modifiedAfter string

Ogranicz wyniki do elementów zmodyfikowanych po tym znaczniku czasu ISO-8601.

Przekazane przed
uploadedBefore string

Ogranicz wyniki do elementów przekazanych przed tym znacznikem czasu ISO-8601.

Przekazane po
uploadedAfter string

Ogranicz wyniki do elementów przekazanych po tym znaczniku czasu ISO-8601.

Typ
type string

Które typy elementów powinny być przeszukiwane.

Zażądano fragmentu kodu
snippetRequested boolean

Określa, czy wyniki wyszukiwania powinny zawierać fragmenty kodu.

Sortuj wg
sortBy string

Pole, które powinno być używane do sortowania.

Kierunek sortowania
sortDirection string

Kierunek sortowania.

Pola kwerendy pliku
fileQueryFields string

Wyszukaj pliki przy użyciu określonych pól.

Pola zapytania folderu
folderQueryFields string

Wyszukaj foldery przy użyciu określonych pól.

Operator zapytania
queryOperator string

Wyszukaj wszystkie wyrazy lub dowolne wyrazy.

Zwraca

Nazwa Ścieżka Typ Opis
results
results array of object
Nazwa pliku
results.name string
Ścieżka pliku
results.path string
Typ MIME
results.type string
Rozmiar pliku
results.size integer
Fragment
results.snippet string
Fragment kodu HTML
results.snippet_html string
Identyfikator wpisu
results.entry_id string
Identyfikator grupy
results.group_id string
Ostatnia modyfikacja
results.last_modified string
Przekazane przez
results.uploaded_by string
Przekazane przez nazwę użytkownika
results.uploaded_by_username string
Liczba wersji
results.num_versions integer
Jest folderem
results.is_folder boolean
Łączna liczba
total_count integer
Przesunięcie
offset integer
Liczba
count integer

Wyszukiwanie w wersji 2

Znajdowanie zawartości z funkcjami wyszukiwania zaawansowanego. https://developers.egnyte.com/api-docs/read/search-api#Search-v2

Parametry

Nazwa Klucz Wymagane Typ Opis
Kwerenda wyszukiwania
query True string

Ciąg wyszukiwania, który chcesz znaleźć.

Przesunięcie
offset integer

Indeks 0 żądanego początkowego rekordu.

Liczba
count integer

Liczba wpisów na stronę.

Folder
folder string

Ogranicz wyniki do elementów w określonym folderze i elementach potomnych.

Zmodyfikowano przed
modifiedBefore integer

Ogranicz wyniki do elementów zmodyfikowanych przed tym znacznikami czasu systemu Unix w milisekundach.

Zmodyfikowane po
modifiedAfter integer

Ogranicz wyniki do elementów zmodyfikowanych po tym znaczniku czasu systemu Unix w milisekundach.

Przekazane przed
uploadedBefore integer

Ogranicz wyniki do elementów przekazanych przed tym znacznikami czasu systemu Unix w milisekundach.

Przekazane po
uploadedAfter integer

Ogranicz wyniki do elementów przekazanych po tym znaczniku czasu systemu Unix w milisekundach.

Typ
type string

Które typy elementów powinny być przeszukiwane.

Zażądano fragmentu kodu
snippetRequested boolean

Określa, czy wyniki wyszukiwania powinny zawierać fragmenty kodu.

Sortuj wg
sortBy string

Pole, które powinno być używane do sortowania.

Kierunek sortowania
sortDirection string

Kierunek sortowania.

Pola kwerendy pliku
fileQueryFields array of string

Wyszukaj pliki przy użyciu określonych pól.

Pola zapytania folderu
folderQueryFields array of string

Wyszukaj foldery przy użyciu określonych pól.

Operator zapytania
queryOperator string

Wyszukaj wszystkie wyrazy lub dowolne wyrazy.

Bardziej podobne do tego (identyfikatory dokumentów)
mlt array of string

Tablica identyfikatorów dokumentów do użycia jako odwołanie do podobnego wyszukiwania dokumentów.

Bardziej podobne do tego (tekst)
mltt array of string

Tablica zawartości tekstowej, która ma być używana jako odwołanie do podobnego wyszukiwania dokumentów.

Zwraca

Nazwa Ścieżka Typ Opis
results
results array of object
Nazwa pliku
results.name string
Ścieżka pliku
results.path string
Typ MIME
results.type string
Rozmiar pliku
results.size integer
Fragment
results.snippet string
Fragment kodu HTML
results.snippet_html string
Identyfikator wpisu
results.entry_id string
Identyfikator grupy
results.group_id string
Ostatnia modyfikacja
results.last_modified string
Przekazane przez
results.uploaded_by string
Przekazane przez nazwę użytkownika
results.uploaded_by_username string
Liczba wersji
results.num_versions integer
Jest folderem
results.is_folder boolean
Właściwości niestandardowe
results.custom_properties array of object
Scope
results.custom_properties.scope string
Namespace
results.custom_properties.namespace string
Key
results.custom_properties.key string
Wartość
results.custom_properties.value string
Wskaźnik istotności
results.score number
Łączna liczba
total_count integer
Liczba
count integer
Ma więcej wyników
hasMore boolean

Wyświetl listę wszystkich łączy

Wyświetla listę wszystkich łączy z wyjątkiem usuniętych łączy. Należy pamiętać, że jeśli użytkownik wykonujący tę metodę nie jest administratorem, zostaną wyświetlone tylko linki utworzone przez użytkownika. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka
path string

Wyświetl łącza do pliku lub folderu określonego przez pełną ścieżkę.

Nazwa użytkownika
username string

Lista łączy utworzonych przez tego użytkownika.

Utworzone przed
createdBefore string

Linki listy utworzone przed daną datą (ISO-8601 lub RRRR-MM-DD).

Utworzone po
createdAfter string

Linki listy utworzone po danej dacie (ISO-8601 lub RRRR-MM-DD).

Typ
type string

Filtruj tylko do elementów "file" lub "folder".

Accessibility
accessibility string

Wybierz typ ułatwień dostępu

Przesunięcie
offset string

Indeks 0 żądanego początkowego rekordu.

Liczba (domyślnie zwracane są 500 wpisów)
count string

Ogranicz liczbę wpisów na stronę.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikatory
ids array of string

Tablica zawierająca identyfikatory wszystkich linków dla domeny, którą może zobaczyć ten użytkownik.

Przesunięcie
offset number

Indeks 0 żądanego początkowego rekordu.

Liczba
count number

Liczba zwróconych elementów. Jeśli to pole nie zostanie określone, wartość licznika będzie wynosić 0.

Łączna liczba
total_count number

Liczba linków widocznych dla użytkownika w domenie.

Wyświetl listę wszystkich łączy w wersji 2

Wyświetla listę wszystkich łączy. Należy pamiętać, że jeśli użytkownik wykonujący tę metodę nie jest administratorem, zostaną wyświetlone tylko linki utworzone przez użytkownika. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka
path string

Wyświetl łącza do pliku lub folderu określonego przez pełną ścieżkę.

Nazwa użytkownika
username string

Lista łączy utworzonych przez tego użytkownika.

Utworzone przed
createdBefore string

Linki listy utworzone przed daną datą (ISO-8601 lub RRRR-MM-DD).

Utworzone po
createdAfter string

Linki listy utworzone po danej dacie (ISO-8601 lub RRRR-MM-DD).

Typ
type string

Filtruj tylko do elementów "file" lub "folder".

Accessibility
accessibility string

Wybierz typ ułatwień dostępu

Przesunięcie
offset string

Indeks 0 żądanego początkowego rekordu.

Liczba (domyślnie zwracane są 500 wpisów)
count string

Ogranicz liczbę wpisów na stronę.

Zwraca

Nazwa Ścieżka Typ Opis
Links
links array of object

Tablica zawierająca pełne informacje JSON dla wszystkich linków dla domeny, które ten użytkownik może zobaczyć w dowolnych określonych zakresach

Ścieżka
links.path string

Ścieżka bezwzględna zasobu docelowego, pliku lub folderu.

Typ
links.type string

Typ łącza, plik, folder lub przekazywanie

Accessibility
links.accessibility string

Kto link jest dostępny dla każdego użytkownika, hasła, domeny lub adresatów.

Ochrona
links.protection string

Jeśli link "WERSJA ZAPOZNAWCZA" dla pliku (lub folderu), jest to link tylko do podglądu z plikiem (folderem), w przeciwnym razie jest to "NONE"

Adresatów
links.recipients array of string

Tablica prawidłowych adresów e-mail, do których wysłano link.

Powiadom
links.notify boolean

Wartość logiczna określająca, czy twórca linku zostanie powiadomiony za pośrednictwem poczty e-mail po korzystaniu z linku.

URL
links.url string

Pełny adres URL linku

Id
links.id string

Identyfikator linku

Łącze do bieżącego
links.link_to_current boolean

Wartość logiczna określająca, czy link będzie zawsze odwoływać się do bieżącej wersji pliku. Dotyczy tylko łączy plików.

Data utworzenia
links.creation_date string

Data i godzina utworzenia linku

Utworzone przez
links.created_by string

Nazwa użytkownika, który utworzył link

Identyfikator zasobu
links.resource_id string

Identyfikator skojarzonego zasobu, identyfikator grupy, jeśli jest to link do pliku, lub identyfikator folderu, jeśli jest to folder lub link przekazywania

Kliknięcia wygasania
links.expiry_clicks number

Liczba kliknięć po lewej stronie łącza przed wygaśnięciem. To pole jest wyświetlane tylko wtedy, gdy link wygaśnie za pomocą kliknięć

Ostatni dostęp
links.last_accessed string

Data i godzina ostatniego dostępu do linku. To pole jest wyświetlane tylko wtedy, gdy link został wyświetlony co najmniej raz

Data wygaśnięcia
links.expiry_date string

Data i godzina wygaśnięcia linku. To pole jest wyświetlane tylko wtedy, gdy łącze ma wygasnąć według daty

Liczba
count number

Liczba linków widocznych dla użytkownika w domenie, które są zwracane

Wyzwalacze

Gdy folder jest nieoznakowany jako projekt

Ta operacja wyzwala przepływ, gdy folder jest nieoznakowany jako projekt

Gdy grupa zostanie usunięta

Ta operacja wyzwala przepływ po usunięciu grupy

Gdy plik jest zablokowany

Ta operacja wyzwala przepływ, gdy plik jest zablokowany

Gdy zmieni się uprawnienie do pliku lub folderu

Ta operacja wyzwala przepływ, gdy zmiany uprawnień pliku lub folderu

Gdy zmienią się metadane pliku lub folderu

Ta operacja wyzwala przepływ po zmianie metadanych pliku lub folderu

Po odblokowaniu pliku

Ta operacja wyzwala przepływ po odblokowaniu pliku

Po odrzuceniu przepływu pracy typu zatwierdzenia

Ta operacja wyzwala przepływ po odrzuceniu przepływu pracy typu zatwierdzenia

Po przeniesieniu folderu

Ta operacja wyzwala przepływ po przeniesieniu podfolderu w folderze.

Po przeniesieniu pliku

Ta operacja wyzwala przepływ po przeniesieniu pliku w folderze.

Po skopiowaniu folderu

Ta operacja wyzwala przepływ po skopiowaniu podfolderu w folderze.

Po skopiowaniu pliku

Ta operacja wyzwala przepływ, gdy plik jest kopiowany w folderze.

Po usunięciu folderu

Ta operacja wyzwala przepływ po usunięciu podfolderu w folderze.

Po usunięciu linku udziału

Ta operacja wyzwala przepływ po usunięciu łącza udziału

Po usunięciu pliku

Ta operacja wyzwala przepływ po usunięciu pliku w folderze.

Po utworzeniu folderu

Ta operacja wyzwala przepływ po utworzeniu podfolderu w folderze.

Po utworzeniu folderu projektu

Ta operacja wyzwala przepływ po utworzeniu folderu projektu lub oznaczeniu istniejącego folderu jako folderu projektu

Po utworzeniu grupy

Ta operacja wyzwala przepływ po utworzeniu grupy

Po utworzeniu pliku (element webhook)

Ta operacja wyzwala przepływ, gdy plik zostanie utworzony w określonym folderze

Po utworzeniu pliku (sondowanie)

Ta operacja wyzwala przepływ po utworzeniu nowego pliku w folderze.

Po utworzeniu przepływu pracy

Ta operacja wyzwala przepływ po utworzeniu przepływu pracy

Po utworzeniu łącza udziału

Ta operacja wyzwala przepływ po utworzeniu łącza udziału

Po zakończeniu przepływu pracy

Ta operacja wyzwala przepływ po zakończeniu przepływu pracy

Po zaktualizowaniu grupy

Ta operacja wyzwala przepływ po zaktualizowaniu grupy

Po zaktualizowaniu pliku

Ta operacja wyzwala przepływ po zaktualizowaniu pliku w określonym folderze

Po zaktualizowaniu projektu

Ta operacja wyzwala przepływ po zaktualizowaniu projektu

Po zatwierdzeniu przepływu pracy typu zatwierdzenia

Ta operacja wyzwala przepływ po zatwierdzeniu przepływu pracy typu zatwierdzenia

Zmiana nazwy folderu

Ta operacja wyzwala przepływ po zmianie nazwy podfolderu w folderze.

Zmiana nazwy pliku

Ta operacja wyzwala przepływ po zmianie nazwy pliku w folderze.

Gdy folder jest nieoznakowany jako projekt

Ta operacja wyzwala przepływ, gdy folder jest nieoznakowany jako projekt

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Gdy grupa zostanie usunięta

Ta operacja wyzwala przepływ po usunięciu grupy

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator użytkownika
user.id integer

Unikatowy identyfikator użytkownika.

Pełna nazwa
user.fullName string

Pełna nazwa użytkownika.

Nazwa użytkownika
user.userName string

Nazwa użytkownika.

Adres e-mail użytkownika
user.email string

Adres e-mail użytkownika.

Nazwa grupy
groupName string

Nazwa grupy.

Identyfikator grupy
groupId string

Unikatowy identyfikator grupy.

Gdy plik jest zablokowany

Ta operacja wyzwala przepływ, gdy plik jest zablokowany

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do pliku docelowego lub folderu.

Zwraca

Gdy zmieni się uprawnienie do pliku lub folderu

Ta operacja wyzwala przepływ, gdy zmiany uprawnień pliku lub folderu

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Cesjonariusza
assignee string
Identyfikator przypisywania
assigneeId number
Przypisywanie
assigner string
Identyfikator przypisywania
assignerId number
Ścieżka folderu
folderPath string
Nowe uprawnienia
newPrivilege string
Stary przywilej
oldPrivilege string
Nazwa grupy
groupName string

Gdy zmienią się metadane pliku lub folderu

Ta operacja wyzwala przepływ po zmianie metadanych pliku lub folderu

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Ścieżka docelowa
targetPath string
Identyfikator grupy docelowej
targetGroupId string
Namespace
namespace string
Key
key string
Akcja
action string

Po odblokowaniu pliku

Ta operacja wyzwala przepływ po odblokowaniu pliku

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do pliku docelowego lub folderu.

Zwraca

Po odrzuceniu przepływu pracy typu zatwierdzenia

Ta operacja wyzwala przepływ po odrzuceniu przepływu pracy typu zatwierdzenia

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Po przeniesieniu folderu

Ta operacja wyzwala przepływ po przeniesieniu podfolderu w folderze.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
id integer

Identyfikator pojedynczego zdarzenia.

Sygnatura czasowa
timestamp string

Sygnatura czasowa iso-8601 sformatowana podczas rejestrowania tego zdarzenia.

Identyfikator użytkownika
actor integer

Numeryczny identyfikator użytkownika, który wykonał akcję.

Akcja
action string

Akcja skojarzona z tym zdarzeniem.

Ścieżka folderu
data.target_path string

Pełna ścieżka docelowa do folderu.

Ścieżka folderu źródłowego
data.source_path string

Pełna oryginalna ścieżka do folderu.

Jest folderem
data.is_folder boolean

Czy zasób jest folderem. (Prawda lub fałsz)

Źródło akcji
action_source string

Źródło zdarzenia. Na przykład WebUI, Mobile itp.

Szczegóły obiektu
object_detail string

Szczegóły obiektu

Po przeniesieniu pliku

Ta operacja wyzwala przepływ po przeniesieniu pliku w folderze.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
id integer

Identyfikator pojedynczego zdarzenia.

Sygnatura czasowa
timestamp string

Sygnatura czasowa iso-8601 sformatowana podczas rejestrowania tego zdarzenia.

Identyfikator użytkownika
actor integer

Numeryczny identyfikator użytkownika, który wykonał akcję.

Akcja
action string

Akcja skojarzona z tym zdarzeniem.

Ścieżka pliku
data.target_path string

Pełna ścieżka do pliku.

Identyfikator wersji
data.target_id string

Identyfikator konkretnej wersji pliku.

Identyfikator pliku
data.target_group_id string

Identyfikator do odwołowania się do pliku jako całości.

Ścieżka pliku źródłowego
data.source_path string

Pełna oryginalna ścieżka do pliku.

Jest folderem
data.is_folder boolean

Czy zasób jest folderem. (Prawda lub fałsz)

Źródło akcji
action_source string

Źródło zdarzenia. Na przykład WebUI, Mobile itp.

Szczegóły obiektu
object_detail string

Szczegóły obiektu.

Po skopiowaniu folderu

Ta operacja wyzwala przepływ po skopiowaniu podfolderu w folderze.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
id integer

Identyfikator pojedynczego zdarzenia.

Sygnatura czasowa
timestamp string

Sygnatura czasowa iso-8601 sformatowana podczas rejestrowania tego zdarzenia.

Identyfikator użytkownika
actor integer

Numeryczny identyfikator użytkownika, który wykonał akcję.

Akcja
action string

Akcja skojarzona z tym zdarzeniem.

Ścieżka folderu
data.target_path string

Pełna ścieżka docelowa do folderu

Ścieżka folderu źródłowego
data.source_path string

Pełna oryginalna ścieżka do folderu

Jest folderem
data.is_folder boolean

Czy zasób jest folderem (prawda czy fałsz)

Źródło akcji
action_source string

Źródło zdarzenia. Na przykład WebUI, Mobile itp.

Szczegóły obiektu
object_detail string

Szczegóły obiektu

Po skopiowaniu pliku

Ta operacja wyzwala przepływ, gdy plik jest kopiowany w folderze.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
id integer

Identyfikator pojedynczego zdarzenia.

Sygnatura czasowa
timestamp string

Sygnatura czasowa iso-8601 sformatowana podczas rejestrowania tego zdarzenia.

Identyfikator użytkownika
actor integer

Numeryczny identyfikator użytkownika, który wykonał akcję.

Akcja
action string

Akcja skojarzona z tym zdarzeniem.

Ścieżka pliku
data.target_path string

Pełna ścieżka do pliku.

Identyfikator wersji
data.target_id string

Identyfikator konkretnej wersji pliku.

Identyfikator pliku
data.target_group_id string

Identyfikator do odwołowania się do pliku jako całości.

Ścieżka pliku źródłowego
data.source_path string

Pełna oryginalna ścieżka do pliku.

Identyfikator wersji pliku źródłowego
data.source_id string

Identyfikator wersji specyficznej dla pliku źródłowego.

Identyfikator pliku źródłowego
data.source_group_id string

Identyfikator pliku źródłowego, aby odwoływać się do pliku jako całości.

Jest folderem
data.is_folder boolean

Czy zasób jest folderem. (Prawda lub fałsz)

Źródło akcji
action_source string

Źródło zdarzenia. Na przykład WebUI, Mobile itp.

Szczegóły obiektu
object_detail string

Szczegóły obiektu.

Po usunięciu folderu

Ta operacja wyzwala przepływ po usunięciu podfolderu w folderze.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
id integer

Identyfikator zdarzenia.

Sygnatura czasowa
timestamp string

Sygnatura czasowa iso-8601 sformatowana podczas rejestrowania tego zdarzenia.

Identyfikator użytkownika
actor integer

Numeryczny identyfikator użytkownika, który wykonał akcję.

Akcja
action string

Akcja skojarzona z tym zdarzeniem.

Ścieżka folderu
data.target_path string

Pełna ścieżka do usuniętego folderu.

Jest folderem
data.is_folder boolean

Czy zasób jest folderem. (Prawda lub fałsz)

Źródło akcji
action_source string

Źródło zdarzenia. Na przykład WebUI, Mobile itp.

Po usunięciu linku udziału

Ta operacja wyzwala przepływ po usunięciu łącza udziału

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Po usunięciu pliku

Ta operacja wyzwala przepływ po usunięciu pliku w folderze.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
id integer

Identyfikator zdarzenia.

Sygnatura czasowa
timestamp string

Sygnatura czasowa iso-8601 sformatowana podczas rejestrowania tego zdarzenia.

Identyfikator użytkownika
actor integer

Numeryczny identyfikator użytkownika, który wykonał akcję.

Akcja
action string

Akcja skojarzona z tym zdarzeniem.

Ścieżka wersji
data.target_path string

Pełna ścieżka do określonej wersji pliku.

Identyfikator pliku
data.target_group_id string

Identyfikator do odwołowania się do pliku jako całości.

Jest folderem
data.is_folder boolean

Czy zasób jest folderem. (Prawda lub fałsz)

Źródło akcji
action_source string

Źródło zdarzenia. Na przykład WebUI, Mobile itp.

Po utworzeniu folderu

Ta operacja wyzwala przepływ po utworzeniu podfolderu w folderze.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
id integer

Identyfikator zdarzenia.

Sygnatura czasowa
timestamp string

Sygnatura czasowa iso-8601 sformatowana podczas rejestrowania tego zdarzenia.

Identyfikator użytkownika
actor integer

Numeryczny identyfikator użytkownika, który wykonał akcję.

Akcja
action string

Akcja skojarzona z tym zdarzeniem.

Ścieżka folderu
data.target_path string

Pełna ścieżka do folderu.

Jest folderem
data.is_folder boolean

Czy zasób jest folderem. (Prawda lub fałsz)

Źródło akcji
action_source string

Źródło zdarzenia. Na przykład WebUI, Mobile itp.

Szczegóły obiektu
object_detail string

Szczegóły obiektu.

Po utworzeniu folderu projektu

Ta operacja wyzwala przepływ po utworzeniu folderu projektu lub oznaczeniu istniejącego folderu jako folderu projektu

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Po utworzeniu grupy

Ta operacja wyzwala przepływ po utworzeniu grupy

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator użytkownika
user.id integer

Unikatowy identyfikator użytkownika.

Pełna nazwa
user.fullName string

Pełna nazwa użytkownika.

Nazwa użytkownika
user.userName string

Nazwa użytkownika.

Adres e-mail użytkownika
user.email string

Adres e-mail użytkownika.

Identyfikator użytkownika
owner.id integer

Unikatowy identyfikator użytkownika.

Pełna nazwa
owner.fullName string

Pełna nazwa użytkownika.

Nazwa użytkownika
owner.userName string

Nazwa użytkownika.

Adres e-mail użytkownika
owner.email string

Adres e-mail użytkownika.

Nazwa grupy
groupName string

Nazwa grupy.

Identyfikator grupy
groupId string

Unikatowy identyfikator grupy.

Członkowie
members array of GroupUser

Członkowie grupy.

Po utworzeniu pliku (element webhook)

Ta operacja wyzwala przepływ, gdy plik zostanie utworzony w określonym folderze

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do pliku docelowego lub folderu.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator wpisu pliku
targetEntryId string
Identyfikator pliku
targetGroupId string
Ścieżka pliku
targetPath string
Przekaż adres URL łącza
uploadLinkUrl string

Dostępne tylko wtedy, gdy plik został przekazany za pośrednictwem linku przekazywania

Po utworzeniu pliku (sondowanie)

Ta operacja wyzwala przepływ po utworzeniu nowego pliku w folderze.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
id integer

Identyfikator zdarzenia.

Sygnatura czasowa
timestamp string

Sygnatura czasowa iso-8601 sformatowana podczas rejestrowania tego zdarzenia.

Identyfikator użytkownika
actor integer

Numeryczny identyfikator użytkownika, który wykonał akcję.

Akcja
action string

Akcja skojarzona z tym zdarzeniem.

Ścieżka pliku
data.target_path string

Pełna ścieżka do pliku.

Identyfikator wersji
data.target_id string

Identyfikator konkretnej wersji pliku.

Identyfikator pliku
data.target_group_id string

Identyfikator do odwołowania się do pliku jako całości.

Jest folderem
data.is_folder boolean

Czy zasób jest folderem (prawda czy fałsz).

Źródło akcji
action_source string

Źródło zdarzenia. Na przykład WebUI, Mobile itp.

Szczegóły obiektu
object_detail string

Szczegóły obiektu.

Po utworzeniu przepływu pracy

Ta operacja wyzwala przepływ po utworzeniu przepływu pracy

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator przepływu pracy
workflow.id string
Nazwa przepływu pracy
workflow.name string
Identyfikator wyświetlania przepływu pracy
workflow.displayId number
Typ przepływu pracy
workflow.type string
Identyfikator szablonu przepływu pracy
workflow.templateId string
Stan akcji przepływu pracy
workflow.actionStatus string
Pierwszy typ jednostki
firstEntity.type string
Ścieżka pierwszej jednostki
firstEntity.filePath string
Identyfikator wpisu pierwszej jednostki
firstEntity.entryID string
Identyfikator grupy pierwszej jednostki
firstEntity.groupID string
Definicja JSON
definitionJson string

Po utworzeniu łącza udziału

Ta operacja wyzwala przepływ po utworzeniu łącza udziału

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Po zakończeniu przepływu pracy

Ta operacja wyzwala przepływ po zakończeniu przepływu pracy

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator przepływu pracy
workflow.id string
Nazwa przepływu pracy
workflow.name string
Identyfikator wyświetlania przepływu pracy
workflow.displayId number
Typ przepływu pracy
workflow.type string
Identyfikator szablonu przepływu pracy
workflow.templateId string
Stan akcji przepływu pracy
workflow.actionStatus string
Pierwszy typ jednostki
firstEntity.type string
Ścieżka pierwszej jednostki
firstEntity.filePath string
Identyfikator wpisu pierwszej jednostki
firstEntity.entryID string
Identyfikator grupy pierwszej jednostki
firstEntity.groupID string
Kod stanu ukończenia
completionStatusCode string
Łączna liczba kroków
totalNumberOfSteps number
Data ukończenia
completionDate number

Po zaktualizowaniu grupy

Ta operacja wyzwala przepływ po zaktualizowaniu grupy

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator użytkownika
user.id integer

Unikatowy identyfikator użytkownika.

Pełna nazwa
user.fullName string

Pełna nazwa użytkownika.

Nazwa użytkownika
user.userName string

Nazwa użytkownika.

Adres e-mail użytkownika
user.email string

Adres e-mail użytkownika.

Identyfikator użytkownika
owner.id integer

Unikatowy identyfikator użytkownika.

Pełna nazwa
owner.fullName string

Pełna nazwa użytkownika.

Nazwa użytkownika
owner.userName string

Nazwa użytkownika.

Adres e-mail użytkownika
owner.email string

Adres e-mail użytkownika.

Nazwa grupy
groupName string

Nazwa grupy.

Identyfikator grupy
groupId string

Unikatowy identyfikator grupy.

Akcja
action string

Konkretna akcja, która wyzwoliła aktualizację grupy.

Członkowie
members array of GroupUser

Członkowie grupy.

Po zaktualizowaniu pliku

Ta operacja wyzwala przepływ po zaktualizowaniu pliku w określonym folderze

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do pliku docelowego lub folderu.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator wpisu pliku
targetEntryId string
Identyfikator pliku
targetGroupId string
Ścieżka pliku
targetPath string

Po zaktualizowaniu projektu

Ta operacja wyzwala przepływ po zaktualizowaniu projektu

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator projektu
projectId string
projectRootFolderId
projectRootFolderId string
Nazwa projektu
name string
Lokalizacja projektu
location string
Stan projektu
status string

Stan projektu (OCZEKUJĄCE, W TOKU, WSTRZYMANE, UKOŃCZONE, ANULOWANE)

Po zatwierdzeniu przepływu pracy typu zatwierdzenia

Ta operacja wyzwala przepływ po zatwierdzeniu przepływu pracy typu zatwierdzenia

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Zmiana nazwy folderu

Ta operacja wyzwala przepływ po zmianie nazwy podfolderu w folderze.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
id integer

Identyfikator pojedynczego zdarzenia.

Sygnatura czasowa
timestamp string

Sygnatura czasowa iso-8601 sformatowana podczas rejestrowania tego zdarzenia.

Identyfikator użytkownika
actor integer

Numeryczny identyfikator użytkownika, który wykonał akcję.

Akcja
action string

Akcja skojarzona z tym zdarzeniem.

Ścieżka folderu
data.target_path string

Pełna ścieżka docelowa do folderu.

Ścieżka folderu źródłowego
data.source_path string

Pełna oryginalna ścieżka do folderu.

Jest folderem
data.is_folder boolean

Czy zasób jest folderem. (Prawda lub fałsz)

Źródło akcji
action_source string

Źródło zdarzenia. Na przykład WebUI, Mobile itp.

Szczegóły obiektu
object_detail string

Szczegóły obiektu

Zmiana nazwy pliku

Ta operacja wyzwala przepływ po zmianie nazwy pliku w folderze.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka folderu
FolderPath True string

Ścieżka do folderu docelowego.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator zdarzenia
id integer

Identyfikator pojedynczego zdarzenia.

Sygnatura czasowa
timestamp string

Sygnatura czasowa iso-8601 sformatowana podczas rejestrowania tego zdarzenia.

Identyfikator użytkownika
actor integer

Numeryczny identyfikator użytkownika, który wykonał akcję.

Akcja
action string

Akcja skojarzona z tym zdarzeniem.

Ścieżka pliku
data.target_path string

Pełna ścieżka do zmienionego pliku

Identyfikator wersji
data.target_id string

Identyfikator konkretnej wersji pliku.

Identyfikator pliku
data.target_group_id string

Identyfikator do odwołowania się do pliku jako całości.

Ścieżka pliku źródłowego
data.source_path string

Pełna oryginalna ścieżka do pliku.

Jest folderem
data.is_folder boolean

Czy zasób jest folderem. (Prawda lub fałsz)

Źródło akcji
action_source string

Źródło zdarzenia. Na przykład WebUI, Mobile itp.

Szczegóły obiektu
object_detail string

Szczegóły obiektu

Definicje

GrupaUżytkownik

Nazwa Ścieżka Typ Opis
Identyfikator użytkownika
id integer

Unikatowy identyfikator użytkownika.

Pełna nazwa
fullName string

Pełna nazwa użytkownika.

Nazwa użytkownika
userName string

Nazwa użytkownika.

Adres e-mail użytkownika
email string

Adres e-mail użytkownika.

LinkWebhookResponse

Nazwa Ścieżka Typ Opis
Ścieżka źródłowa
sourcePath string
Identyfikator łącza
linkId string
Typ łącza
linkType string

Folder lub plik

Adres URL linku
linkURL string

FileInfoResponse

Nazwa Ścieżka Typ Opis
Suma kontrolna
checksum string

Wartość sumy kontrolnej bieżącej wersji pliku używanej do określania zmian w pliku.

Rozmiar
size integer

Rozmiar pliku w bajtach.

Ścieżka pliku
path string

Pełna ścieżka pliku.

Name
name string

Nazwa pliku.

Jest zablokowany
locked boolean

Stan blokady w pliku.

Jest folderem
is_folder boolean

Czy zasób jest folderem. Prawda czy Fałsz

Identyfikator wersji
entry_id string

Identyfikator bieżącej wersji pliku.

Identyfikator pliku
group_id string

Identyfikator do odwołowania się do pliku jako całości.

Identyfikator folderu nadrzędnego
parent_id string

Identyfikator żądanego folderu nadrzędnego.

Ostatnia modyfikacja
last_modified string

Czas ostatniej modyfikacji bieżącej wersji pliku.

Przekazane przez
uploaded_by string

Nazwa użytkownika, który przesłał bieżącą wersję.

Przekazany znacznik czasu
uploaded integer

Przekazany czas bieżącej wersji pliku.

Liczba wersji
num_versions integer

Całkowita liczba wersji skojarzonych z określoną ścieżką pliku.

versions
versions array of object

Versions

Czy folder (wersja)
versions.is_folder boolean

Czy zasób jest folderem. Prawda czy Fałsz

Identyfikator wersji
versions.entry_id string

Identyfikator konkretnej wersji pliku.

Suma kontrolna (wersja)
versions.checksum string

Wartość sumy kontrolnej wersji pliku używanej do określania zmian w pliku.

Ostatnia modyfikacja (wersja)
versions.last_modified string

Czas ostatniej modyfikacji określonej wersji pliku.

Przekazane przez (wersja)
versions.uploaded_by string

Nazwa użytkownika, który przesłał wersję.

Przekazany znacznik czasu (wersja)
versions.uploaded integer

Czas przekazania określonej wersji pliku.

Rozmiar (wersja)
versions.size integer

Rozmiar pliku w bajtach dla określonej wersji.

UserInfoResponse

Informacje o użytkowniku

Nazwa Ścieżka Typ Opis
Identyfikator użytkownika
id integer

Identyfikator użytkownika

Nazwa użytkownika
userName string

Nazwa użytkownika

Tożsamość zewnętrzna
externalId string

Tożsamość zewnętrzna

Email
email string

Adres e-mail użytkownika

Nazwisko
name.familyName string

Nazwa rodziny użytkowników (nazwisko)

Imię
name.givenName string

Imię i nazwisko użytkownika

Aktywna
active boolean

Czy konto użytkownika jest aktywne

Data utworzenia
createdDate string

Data utworzenia użytkownika

Data ostatniej modyfikacji
lastModificationDate string

Data ostatniej modyfikacji użytkownika

Ostatnia aktywna data
lastActiveDate string

Ostatnia data, w przypadku którego użytkownik był aktywny

Zablokowane
locked boolean

Użytkownik jest zablokowany

Język
language string

Parametr "language" jest akceptowany tylko wtedy, gdy pakiet językowy został włączony dla domeny.

Typ uwierzytelniania
authType string

Typ uwierzytelniania użytkownika.

Typ użytkownika
userType string

Typ użytkownika.

Role
role string

Rola przypisana użytkownikowi. Dotyczy tylko użytkowników usługi Power Users.

Identyfikator użytkownika dostawcy tożsamości
idpUserId string

Identyfikator użytkownika dostawcy tożsamości

Czy konto usługi
isServiceAccount boolean

Czy konto jest używane jako konto usługi

Usuń po wygaśnięciu
deleteOnExpiry string

Czy konto zostanie usunięte po wygaśnięciu

Oczekiwanie na zmianę wiadomości e-mail
emailChangePending boolean

Czy oczekuje na zmianę wiadomości e-mail użytkownika

Data wygaśnięcia
expiryDate string

Wygaśnięcie konta

Główna nazwa użytkownika
userPrincipalName string
groups
groups array of object
nazwa wyświetlana
groups.displayName string

Nazwa grupy

Identyfikator grupy
groups.value string

Identyfikator grupy

UserListResponse

Uzyskiwanie odpowiedzi na listę użytkowników

Nazwa Ścieżka Typ Opis
Łączna liczba wyników
totalResults integer

Całkowita liczba wyników pasujących do zapytania.

Elementy na stronę
itemsPerPage integer

Liczba zwróconych wyników.

Rozpocznij indeks
startIndex integer

1-oparty na indeksie pierwszego wyniku w bieżącym zestawie wyników.

resources
resources array of object
Identyfikator użytkownika
resources.id integer

Identyfikator użytkownika

Nazwa użytkownika
resources.userName string

Nazwa użytkownika

Tożsamość zewnętrzna
resources.externalId string

Tożsamość zewnętrzna

Email
resources.email string

Adres e-mail użytkownika

Sformatowana nazwa
resources.name.formatted string

Nazwa sformatowana przez użytkownika

Nazwisko
resources.name.familyName string

Nazwa rodziny użytkowników (nazwisko)

Imię
resources.name.givenName string

Imię i nazwisko użytkownika

Aktywna
resources.active boolean

Czy konto użytkownika jest aktywne

Zablokowane
resources.locked boolean

Czy konto użytkownika jest zablokowane

Data utworzenia
resources.createdDate string

Data utworzenia użytkownika

Data ostatniej modyfikacji
resources.lastModificationDate string

Data ostatniej modyfikacji użytkownika

Ostatnia aktywna data
resources.lastActiveDate string

Ostatnia data, w przypadku którego użytkownik był aktywny

Język
resources.language string

Parametr "language" jest akceptowany tylko wtedy, gdy pakiet językowy został włączony dla domeny.

Typ uwierzytelniania
resources.authType string

Typ uwierzytelniania użytkownika.

Typ użytkownika
resources.userType string

Typ użytkownika.

Role
resources.role string

Rola przypisana użytkownikowi. Dotyczy tylko użytkowników usługi Power Users.

Identyfikator użytkownika dostawcy tożsamości
resources.idpUserId string

Identyfikator użytkownika dostawcy tożsamości

Czy konto usługi
resources.isServiceAccount boolean

Czy konto jest używane jako konto usługi

Usuń po wygaśnięciu
resources.deleteOnExpiry string

Czy konto zostanie usunięte po wygaśnięciu

Oczekiwanie na zmianę wiadomości e-mail
resources.emailChangePending boolean

Czy oczekuje na zmianę wiadomości e-mail użytkownika

Data wygaśnięcia
resources.expiryDate string

Wygaśnięcie konta

Główna nazwa użytkownika
resources.userPrincipalName string

FolderInfoResponse

Nazwa Ścieżka Typ Opis
Name
name string

Nazwa folderu.

Ostatnia modyfikacja
lastModified integer

Ostatni raz, gdy dowolny plik w folderze (ale nie w podfolderach) został zmodyfikowany.

Przekazany znacznik czasu
uploaded integer

Godzina przekazania lub utworzenia folderu.

Ścieżka folderu
path string

Pełna ścieżka folderu.

Identyfikator folderu
folder_id string

Unikatowy identyfikator folderu.

Identyfikator folderu nadrzędnego
parent_id string

Identyfikator folderu nadrzędnego.

Liczba elementów podrzędnych
total_count integer

Całkowita liczba elementów faktycznie dostępnych do zwrócenia.

Jest folderem
is_folder boolean

Czy zasób jest folderem. Prawda czy Fałsz

Możliwe łącza publiczne
public_links string

Ustawienie opcji folderu dotyczące ustawienia "Zezwalaj na linki publiczne z tego folderu dla" zostało ustawione.

Jest współużytkowalny
allow_links boolean

Czy można udostępnić? T lub F

Można usunąć lub przenieść
restrict_move_delete boolean

Czy można usunąć lub przenieść? T lub F

Folderów
folders array of object

Folderów

Nazwa (podfolder)
folders.name string

Nazwa folderu.

Ostatnia modyfikacja (podfolder)
folders.lastModified integer

Ostatni raz, gdy dowolny plik w folderze (ale nie w podfolderach) został zmodyfikowany.

Przekazany znacznik czasu (podfolder)
folders.uploaded integer

Godzina przekazania lub utworzenia folderu.

Ścieżka (podfolder)
folders.path string

Pełna ścieżka folderu zgodnie z żądaniem.

ID (podfolder)
folders.folder_id string

Identyfikator żądanego folderu.

Czy folder (podfolder)
folders.is_folder boolean

Czy zasób jest folderem. Prawda czy Fałsz

Identyfikator folderu nadrzędnego (podfolder)
folders.parent_id string

Identyfikator folderu nadrzędnego.

files
files array of object

Files

Suma kontrolna (plik)
files.checksum string

Wartość sumy kontrolnej bieżącej wersji pliku używanej do określania zmian w pliku.

Rozmiar (plik)
files.size integer

Rozmiar pliku w bajtach.

Ścieżka (plik)
files.path string

Pełna ścieżka pliku.

Nazwa (plik)
files.name string

Nazwa pliku.

Jest zablokowany (plik)
files.locked boolean

Stan blokady w pliku.

Czy folder (plik)
files.is_folder boolean

Czy zasób jest folderem. Prawda czy Fałsz

Identyfikator wersji (plik)
files.entry_id string

Identyfikator konkretnej wersji pliku.

Identyfikator (plik)
files.group_id string

Identyfikator do odwołowania się do pliku jako całości.

Identyfikator folderu nadrzędnego (plik)
files.parent_id string

Identyfikator folderu nadrzędnego.

Ostatnia modyfikacja (plik)
files.last_modified string

Czas ostatniej modyfikacji bieżącej wersji pliku.

Przekazane przez (plik)
files.uploaded_by string

Nazwa użytkownika, który przesłał wersję.

Przekazany znacznik czasu (plik)
files.uploaded integer

Przekazany czas bieżącej wersji pliku.

Liczba wersji (plik)
files.num_versions integer

Całkowita liczba wersji skojarzonych z określoną ścieżką pliku.

Przestrzeń nazwItem

Nazwa Ścieżka Typ Opis
Nazwa przestrzeni nazw
name string
Zakres przestrzeni nazw
scope string
keys
keys object
nazwa wyświetlana
displayName string

Nazwa identyfikująca przestrzeń nazw w interfejsie użytkownika

priority
priority number

Określa priorytet (kolejność) dla kluczy. Klucze będą wyświetlane zgodnie z ich priorytetami w kolejności malejącej (klucze o wyższym priorytcie będą wyświetlane jako pierwsze)

dziedziczny
inheritable boolean
schemaSystemGenerated
schemaSystemGenerated boolean
metadataScopeType
metadataScopeType string
edytowalny
editable boolean

ProjectItem

Nazwa Ścieżka Typ Opis
Id
id string

Identyfikator elementu

Identyfikator folderu głównego
rootFolderId string

Identyfikator folderu głównego

Name
name string

Nazwa projektu

Identyfikator projektu
projectId string

Identyfikator projektu

Nazwa klienta
customerName string

Klient skojarzony z projektem

Description
description string

Opis folderu

lokalizacja
location ProjectLocationItem
Status
status string

Stan projektu

Stworzone przez
createdBy number

Stworzone przez

Ostatnia aktualizacja według
lastUpdatedBy number

Ostatnia aktualizacja według

Czas utworzenia
creationTime string

Czas utworzenia

Godzina ostatniej modyfikacji
lastModifiedTime string

Godzina ostatniej modyfikacji

Data rozpoczęcia
startDate string

Data rozpoczęcia projektu.

Data ukończenia
completionDate string

Data ukończenia projektu.

ProjectLocationItem

Nazwa Ścieżka Typ Opis
Adres ulicy 1
streetAddress1 string

Pierwszy wiersz adresu

Adres ulicy 2
streetAddress2 string

Drugi wiersz adresu

Miejscowość
city string

Miejscowość

Stan lub prowincja
state string

Stan lub prowincja

Country
country string

Country

Kod pocztowy lub kod pocztowy
postalCode string

Kod pocztowy lub kod pocztowy

FileLockWebhookResponse

Nazwa Ścieżka Typ Opis
Identyfikator pliku
targetGroupId string
Suma kontrolna pliku
targetFileChecksum string
Ścieżka pliku
targetPath string

FolderProjectCommon

Nazwa Ścieżka Typ Opis
identyfikator projektu
projectId string
projectRootFolderId
projectRootFolderId string

WorkflowStepResponse

Nazwa Ścieżka Typ Opis
Identyfikator przepływu pracy
workflow.id string
Nazwa przepływu pracy
workflow.name string
Identyfikator wyświetlania przepływu pracy
workflow.displayId number
Typ przepływu pracy
workflow.type string
Identyfikator szablonu przepływu pracy
workflow.templateId string
Stan akcji przepływu pracy
workflow.actionStatus string
Pierwszy typ jednostki
firstEntity.type string
Ścieżka pierwszej jednostki
firstEntity.filePath string
Identyfikator wpisu pierwszej jednostki
firstEntity.entryID string
Identyfikator grupy pierwszej jednostki
firstEntity.groupID string
Identyfikator kroku
step.id string
Nazwa kroku
step.name string
Typ kroku
step.type string
Identyfikator przypisywania
assignee.id number
Nazwa wyświetlana osoby przypisanej
assignee.displayName string
Nazwa użytkownika przydzielić
assignee.username string
Adres e-mail przydzielić
assignee.email string
Łączna liczba kroków
totalNumberOfSteps number
Data ukończenia
completionDate number
Data utworzenia
creationDate number

AIQuestionResponse

Nazwa Ścieżka Typ Opis
response
response AIResponse
Cytatów
citations array of AICitation

Cytaty i odwołania używane podczas generowania odpowiedzi

AISummaryResponse

Nazwa Ścieżka Typ Opis
response
response AIResponse

AICopilotResponse

Nazwa Ścieżka Typ Opis
response
response AIResponse
Cytatów
citations array of AICitation

Cytaty i odwołania używane podczas generowania odpowiedzi

Identyfikator konwersacji
conversationId string

Unikatowy identyfikator konwersacji

AICitation

Nazwa Ścieżka Typ Opis
Filename
filename string

Nazwa pliku źródłowego

Identyfikator wpisu
entryId string

Identyfikator wpisu pliku źródłowego

Fragmenty tekstu
chunks array of object

Tablica fragmentów tekstu ze źródła

Identyfikator fragmentu
chunks.chunkId string

Identyfikator fragmentu tekstu

Tekst źródłowy
chunks.sourceText string

Zawartość tekstowa fragmentu

AIResponse

Nazwa Ścieżka Typ Opis
Tekst odpowiedzi
text string

Tekst odpowiedzi wygenerowanej przez sztuczną inteligencję