Egnyte
Egnyte is een service die uw bestanden veilig, gesynchroniseerd en gemakkelijk te delen houdt. Maak verbinding met Egnyte om uw bestanden te beheren. U kunt verschillende acties uitvoeren, zoals bestanden uploaden, bijwerken, ophalen en verwijderen in Egnyte.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Egnyte-ondersteuning |
| URL | https://helpdesk.egnyte.com |
| E-mailen | support@egnyte.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Egnyte |
| Webpagina | https://egnyte.com/ |
| Privacybeleid | https://www.egnyte.com/privacy-policy |
| Categorieën | Samenwerking; Productiviteit |
Egnyte
Egnyte is een platform voor samenwerking aan inhoud dat uw bestanden veilig, gesynchroniseerd en gemakkelijk te delen houdt. Maak verbinding met Egnyte om uw bestanden te beheren. U kunt verschillende acties uitvoeren, zoals uploaden, verplaatsen, downloaden en verwijderen van bestanden in Egnyte.
Pre-requisites
Als u de connector wilt gebruiken, moet u een Egnyte-gebruiker zijn.
Ondersteunde acties
De connector ondersteunt de volgende acties:
Create group: Maak een groep in Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-GroupGet group details: Groepsgegevens ophalen met id. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-GroupGet list of all groups: Haal de lijst met de groepen op. https://developers.egnyte.com/api-docs/read/group-management#List-GroupsGet user details: Haal de informatie over de gebruiker op id op. Meer informatie: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-UserGet list of all users: Haal de informatie over de gebruikers op. Meer informatie: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-ListUpdate user by ID: Werk de individuele gebruiker bij. Meer informatie: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-UserCreate user: Maak een nieuwe gebruiker in Egnyte. Meer informatie: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-UserDelete user by ID: Een gebruiker verwijderen uit Egnyte. Meer informatie: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-UserCreate folder: Maak een map in Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-FolderDelete file by path: Verwijder een bestand met behulp van een pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-FolderDelete folder by path: Verwijder een map met behulp van een pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-FolderDelete folder by ID: Verwijder een map met een id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-FolderDelete file by ID: Verwijder een bestand met een id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-FolderCopy file by path: Kopieer een bestand met behulp van een pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-FolderCopy folder by path: Kopieer een map met behulp van een pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-FolderFull group update: Overschrijf alle kenmerken van een groep. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-GroupPartial group update: Specifieke kenmerken van een groep bijwerken. https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-GroupDelete group: Verwijder een groep op id. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-GroupCopy file by ID: Kopieer een bestand met behulp van een id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-FolderCopy folder by ID: Kopieer een map met een id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-FolderMove file by path: Verplaats een bestand in Egnyte met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-FolderMove folder by path: Verplaats een map in Egnyte met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-FolderMove file by ID: Verplaats een bestand in Egnyte met behulp van de bestands-id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-FolderMove folder by ID: Verplaats een map met id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-FolderShare file: Deel een bestand in Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-LinkShare folder: Deel een map in Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-LinkGet file info by path: Bestandsgegevens ophalen met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentationGet folder info by path: Mapgegevens ophalen met behulp van pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentationModify folder options: Mapopties wijzigen, zoals beschrijving, instellingen voor het delen van koppelingen, machtigingen voor openbare koppelingen, beperkingen voor verplaatsen/verwijderen en voorkeuren voor e-mailmeldingen. https://developers.egnyte.com/api-docs/read/folder-options-apiGet file info by ID: bestandsgegevens ophalen met behulp van de bestands-id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentationGet folder info by ID: mapgegevens ophalen met id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentationLock file by path: Vergrendel het bestand met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-FileUnlock file by path: Ontgrendel het bestand met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-FileLock file by ID: Vergrendel het bestand met id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-FileUnlock file by ID: Ontgrendel het bestand met id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-FileGet file content by path: haalt de bestandsinhoud van Egnyte op met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-FileGet file content by ID: haalt de bestandsinhoud van Egnyte op met behulp van id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-FileCreate file: Uploadt een bestand naar Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-FileSet metadata by file ID: Schrijf metagegevens naar een bestand met behulp van de bestands-id. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-NamespaceSet metadata by folder ID: Schrijf metagegevens naar een map met behulp van map-id. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-NamespaceGet all namespaces: Haal een lijst op met alle aangepaste metagegevensnaamruimten in het domein. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-NamespacesCreate namespace: Maak een naamruimte in Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-NamespaceUpdate namespace attributes: werkt naamruimtekenmerken bij. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-AttributesUpdate namespace keys: Werk de sleutel van een aangepaste metagegevens voor een domein bij. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-KeysGet namespace: Geef alle aangepaste metagegevenssleutels weer die zijn gemaakt in een bepaalde naamruimte. https://developers.egnyte.com/api-docs/read/metadata-api#Get-NamespaceDelete namespace: Verwijder een opgegeven naamruimte. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-NamespaceGet all projects: Alle projectmappen in het domein weergeven. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-ProjectsMark folder as project: Een bestaande map markeren als een project. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-ProjectCreate project from template: Maak een nieuw project op basis van een projectmapsjabloon. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-TemplateGet project by ID: Haal een project op met id. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-IDUpdate project by ID: Hiermee worden de opgegeven eigenschappen van een project bijgewerkt dat is geïdentificeerd door de bijbehorende id. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-ProjectDelete project by ID: Een project verwijderen op basis van de id. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-ProjectGet project by root folder ID: Haal een project op op basis van de id van de hoofdmap. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-FolderClean up project by ID: Dit eindpunt initieert een opschoning in een project en kan eventueel opgegeven gebruikers verwijderen of uitschakelen. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-ProjectCreate metadata key: Voeg een metagegevenssleutel toe aan een bestaande naamruimte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-KeyDelete metadata key: Verwijder een metagegevenssleutel uit een bestaande naamruimte. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-KeyGet metadata by file ID: Metagegevens ophalen uit een bestand met behulp van de bestands-id. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-NamespaceGet metadata by folder ID: Metagegevens ophalen uit een map met behulp van map-id. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-NamespaceSearch V1: Inhoud zoeken die is opgeslagen in Egnyte op basis van bestandsnamen, metagegevens en tekstinhoud. https://developers.egnyte.com/api-docs/read/search-api#Search-v1Search V2: Inhoud zoeken met geavanceerde zoekmogelijkheden. https://developers.egnyte.com/api-docs/read/search-api#Search-v2Search metadata: Items zoeken met een specifiek metagegevensveld of -waarde. https://developers.egnyte.com/api-docs/read/metadata-api#Search-MetadataGet effective permissions: Effectieve machtigingen voor een gebruiker ophalen. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-UserSet folder permissions: Machtigingen instellen voor een map. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-PermissionsGet folder permissions: Machtigingen voor een map ophalen. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-PermissionsDeep link by ID: Maak een dieptekoppeling voor bestand of map op id. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-FoldersDeep link by path: Maak een dieptekoppeling voor bestand of map per pad. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-FoldersList all links: bevat alle koppelingen, met uitzondering van verwijderde koppelingen. Houd er rekening mee dat als de gebruiker die deze methode uitvoert geen beheerder is, alleen koppelingen worden vermeld die door de gebruiker zijn gemaakt. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-LinksList all links V2: geeft een lijst weer van alle koppelingen. Houd er rekening mee dat als de gebruiker die deze methode uitvoert geen beheerder is, alleen koppelingen worden vermeld die door de gebruiker zijn gemaakt. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2Show link details: Bekijk de details van een koppeling. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-DetailsCreate link: Maak een koppeling. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-LinkDelete link: Een koppeling verwijderen. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link[AI] Ask a question about a document: Stel vragen met betrekking tot een bepaald document en geef een AI-gestuurd antwoord op basis van de documentinhoud. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question[AI] Generate a summary for a document: Genereer een samenvatting voor een bepaald document en geef een AI-gestuurd antwoord op basis van de inhoud van het document. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document[AI] Ask a question to Egnyte Copilot: Stel vragen aan de copilot van het platform en geef een AI-gestuurd antwoord op basis van de globale inhoud binnen uw Egnyte-domein. https://developers.egnyte.com/api-docs/read/ai-api#Copilot
Ondersteunde triggers
De connector ondersteunt de volgende triggers:
-
When a file is locked: Met deze bewerking wordt een stroom geactiveerd wanneer een bestand is vergrendeld -
When a file is unlocked: Met deze bewerking wordt een stroom geactiveerd wanneer een bestand wordt ontgrendeld -
When a file is updated: Met deze bewerking wordt een stroom geactiveerd wanneer een bestand wordt bijgewerkt in een specifieke map -
When a file is created (webhook): Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een specifieke map wordt gemaakt -
When a share link is created: Met deze bewerking wordt een stroom geactiveerd wanneer er een sharekoppeling wordt gemaakt -
When a share link is deleted: Met deze bewerking wordt een stroom geactiveerd wanneer een sharekoppeling wordt verwijderd -
When the file or folder permission changes: Met deze bewerking wordt een stroom geactiveerd wanneer een bestand of mapmachtigingen worden gewijzigd -
When the file or folder metadata changes: Met deze bewerking wordt een stroom geactiveerd wanneer een bestand of mapmetagegevens worden gewijzigd -
When a project folder is created: Met deze bewerking wordt een stroom geactiveerd wanneer een projectmap wordt gemaakt of wanneer een bestaande map is gemarkeerd als een projectmap -
When a folder is unmarked as a project: Met deze bewerking wordt een stroom geactiveerd wanneer een map niet is gemarkeerd als een project -
When a project is updated: Met deze bewerking wordt een stroom geactiveerd wanneer een project wordt bijgewerkt -
When a workflow is created: Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom wordt gemaakt -
When a workflow is completed: Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom is voltooid -
When an approval type workflow is approved: Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom van het goedkeuringstype wordt goedgekeurd -
When an approval type workflow is rejected: Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom voor het goedkeuringstype wordt geweigerd -
When a group is created: Met deze bewerking wordt een stroom geactiveerd wanneer een groep wordt gemaakt -
When a group is updated: Met deze bewerking wordt een stroom geactiveerd wanneer een groep wordt bijgewerkt -
When a group is deleted: Met deze bewerking wordt een stroom geactiveerd wanneer een groep wordt verwijderd -
When a file is created (polling): Met deze bewerking wordt een stroom geactiveerd wanneer een nieuw bestand wordt gemaakt in een map. -
When a folder is created: Met deze bewerking wordt een stroom geactiveerd wanneer een submap wordt gemaakt in een map. -
When a file is deleted: Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een map wordt verwijderd. -
When a folder is deleted: Met deze bewerking wordt een stroom geactiveerd wanneer een submap in een map wordt verwijderd. -
When a file is renamed: Met deze bewerking wordt een stroom geactiveerd wanneer de naam van een bestand in een map wordt gewijzigd. -
When a folder is renamed: Met deze bewerking wordt een stroom geactiveerd wanneer de naam van een submap in een map wordt gewijzigd. -
When a file is moved: Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een map wordt verplaatst. -
When a folder is moved: Met deze bewerking wordt een stroom geactiveerd wanneer een submap wordt verplaatst in een map. -
When a file is copied: Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een map wordt gekopieerd. -
When a folder is copied: Met deze bewerking wordt een stroom geactiveerd wanneer een submap wordt gekopieerd in een map.
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
[AI] Een samenvatting voor een document genereren
Genereer een samenvatting voor een bepaald document en geef een AI-gestuurd antwoord op basis van de documentinhoud. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id van bestandsvermelding
|
entryId | True | string |
De id van de specifieke versie van het bestand |
|
Rol
|
role | string | ||
|
Berichtinhoud
|
content | string |
Retouren
- Body
- AISummaryResponse
[AI] Een vraag stellen over een document
Stel vragen met betrekking tot een bepaald document en geef een AI-gestuurd antwoord op basis van de inhoud van het document. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id van bestandsvermelding
|
entryId | True | string |
De id van de specifieke versie van het bestand |
|
Question
|
question | True | string |
De specifieke vraag die u wilt stellen |
|
Bronvermeldingen opnemen
|
includeCitations | boolean |
Of het antwoord bronvermeldingen moet bevatten (standaard ingesteld op onwaar) |
|
|
Rol
|
role | string | ||
|
Berichtinhoud
|
content | string |
Retouren
- Body
- AIQuestionResponse
[AI] Stel een vraag aan Egnyte Copilot
Stel vragen aan de copilot van het platform en geef een AI-gestuurd antwoord op basis van de globale inhoud binnen uw Egnyte-domein. https://developers.egnyte.com/api-docs/read/ai-api#Copilot
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Question
|
question | True | string |
De specifieke vraag die u wilt stellen |
|
Map-id
|
id | string |
Id van de geselecteerde map |
|
|
Id van bestandsvermelding
|
entryId | string |
Invoer-id van het geselecteerde bestand |
|
|
Bronvermeldingen opnemen
|
includeCitations | boolean |
Of het antwoord bronvermeldingen moet bevatten (standaard ingesteld op onwaar) |
|
|
Rol
|
role | string | ||
|
Berichtinhoud
|
content | string |
Retouren
- Body
- AICopilotResponse
Alle koppelingen weergeven
Een lijst met alle koppelingen, met uitzondering van verwijderde koppelingen. Houd er rekening mee dat als de gebruiker die deze methode uitvoert geen beheerder is, alleen koppelingen worden vermeld die door de gebruiker zijn gemaakt. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Path
|
path | string |
Een lijst met koppelingen naar een bestand of map die is opgegeven door het volledige pad. |
|
|
Gebruikersnaam
|
username | string |
Lijst met koppelingen die door deze gebruiker zijn gemaakt. |
|
|
Gemaakt voor
|
createdBefore | string |
Lijstkoppelingen die zijn gemaakt vóór een bepaalde datum (ISO-8601 of JJJJ-MM-DD). |
|
|
Gemaakt na
|
createdAfter | string |
Lijstkoppelingen die zijn gemaakt na een bepaalde datum (ISO-8601 of JJJJ-MM-DD). |
|
|
Typologie
|
type | string |
Filter alleen op 'bestand' of 'map'-items. |
|
|
Toegankelijkheid
|
accessibility | string |
Toegankelijkheidstype selecteren |
|
|
Offset
|
offset | string |
De index op basis van 0 van de eerste record die wordt aangevraagd. |
|
|
Aantal (standaard 500 vermeldingen worden geretourneerd)
|
count | string |
Aantal vermeldingen per pagina beperken. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Ids
|
ids | array of string |
Een matrix met de id's van alle koppelingen voor uw domein die deze gebruiker kan zien. |
|
Offset
|
offset | number |
De index op basis van 0 van de eerste record die wordt aangevraagd. |
|
Aantal
|
count | number |
Het aantal geretourneerde items. Als dit veld niet is opgegeven, is de tellingswaarde 0. |
|
Totaal aantal
|
total_count | number |
Het aantal koppelingen dat zichtbaar is voor de gebruiker in het domein. |
Alle koppelingen weergeven V2
Hiermee worden alle koppelingen weergegeven. Houd er rekening mee dat als de gebruiker die deze methode uitvoert geen beheerder is, alleen koppelingen worden vermeld die door de gebruiker zijn gemaakt. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Path
|
path | string |
Een lijst met koppelingen naar een bestand of map die is opgegeven door het volledige pad. |
|
|
Gebruikersnaam
|
username | string |
Lijst met koppelingen die door deze gebruiker zijn gemaakt. |
|
|
Gemaakt voor
|
createdBefore | string |
Lijstkoppelingen die zijn gemaakt vóór een bepaalde datum (ISO-8601 of JJJJ-MM-DD). |
|
|
Gemaakt na
|
createdAfter | string |
Lijstkoppelingen die zijn gemaakt na een bepaalde datum (ISO-8601 of JJJJ-MM-DD). |
|
|
Typologie
|
type | string |
Filter alleen op 'bestand' of 'map'-items. |
|
|
Toegankelijkheid
|
accessibility | string |
Toegankelijkheidstype selecteren |
|
|
Offset
|
offset | string |
De index op basis van 0 van de eerste record die wordt aangevraagd. |
|
|
Aantal (standaard 500 vermeldingen worden geretourneerd)
|
count | string |
Aantal vermeldingen per pagina beperken. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Links
|
links | array of object |
Een matrix met de volledige JSON-informatie voor alle koppelingen voor uw domein die deze gebruiker kan zien binnen opgegeven bereiken |
|
Path
|
links.path | string |
Het absolute pad van de doelresource, bestand of map. |
|
Typologie
|
links.type | string |
Het type koppeling, bestand, map of uploaden |
|
Toegankelijkheid
|
links.accessibility | string |
Wie een koppeling toegankelijk is voor iedereen, een wachtwoord, domein of geadresseerden. |
|
Beveiliging
|
links.protection | string |
Als de koppeling 'PREVIEW' voor een bestand (of map) is, is het een alleen-preview-koppeling naar het bestand (map), anders is het 'GEEN' |
|
Ontvangers
|
links.recipients | array of string |
Een matrix met geldige e-mailadressen waarnaar de koppeling is verzonden. |
|
Aankondigen
|
links.notify | boolean |
Booleaanse waarde die aangeeft of de maker van de koppeling via e-mail wordt gewaarschuwd wanneer de koppeling wordt geopend. |
|
URL
|
links.url | string |
De volledige URL van de koppeling |
|
Identiteitsbewijs
|
links.id | string |
De id van de koppeling |
|
Koppeling naar huidige
|
links.link_to_current | boolean |
Booleaanse waarde die aangeeft of de koppeling altijd verwijst naar de huidige versie van het bestand. Alleen van toepassing op bestandskoppelingen. |
|
Aanmaakdatum
|
links.creation_date | string |
Datum en tijd van het maken van de koppeling |
|
Gemaakt door
|
links.created_by | string |
Gebruikersnaam van de gebruiker die de koppeling heeft gemaakt |
|
Resource-id
|
links.resource_id | string |
Id van de gekoppelde resource, groeps-id als het een bestandskoppeling is, of de map-id als het een map is of een koppeling uploadt |
|
Verloopklikken
|
links.expiry_clicks | number |
Aantal klikken links op de koppeling voordat deze verloopt. Dit veld wordt alleen weergegeven als de koppeling verloopt via klikken |
|
Laatst geopend
|
links.last_accessed | string |
Datum en tijd van de laatste toegang tot de koppeling. Dit veld wordt alleen weergegeven als de koppeling ten minste eenmaal is geopend |
|
Vervaldatum
|
links.expiry_date | string |
Datum en tijd van de vervaldatum van de koppeling. Dit veld wordt alleen weergegeven als de koppeling verloopt op datum |
|
Aantal
|
count | number |
Het aantal koppelingen dat zichtbaar is voor de gebruiker in het domein dat wordt geretourneerd |
Alle naamruimten ophalen
Haal een lijst op met alle aangepaste metagegevensnaamruimten in het domein. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces
Retouren
- response
- array of NamespaceItem
Alle projecten ophalen
Geef alle projectmappen in het domein weer. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects
Retouren
- response
- array of ProjectItem
Bestand delen
Deel een bestand in Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestandspad
|
path | True | string |
Het bestandspad in Egnyte, inclusief de doelbestandsnaam die u wilt delen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
koppelingen
|
links | array of object |
Links |
|
Koppelings-id
|
links.id | string |
De id van de koppeling. |
|
Url van koppeling
|
links.url | string |
De volledige URL van de koppeling. |
|
Ontvangers
|
links.recipients | array of string |
Een matrix met geldige e-mailadressen waarnaar de koppeling is verzonden. |
|
Bestandspad
|
path | string |
Volledig pad naar het gedeelde bestand. |
|
Typologie
|
type | string |
Het type koppeling, bestand, map of upload. |
|
Toegankelijkheid
|
accessibility | string |
Wie een koppeling toegankelijk is voor iedereen, een wachtwoord, domein of geadresseerden. |
|
Maker waarschuwen wanneer deze wordt geopend
|
notify | boolean |
Of de maker van de koppeling via e-mail op de hoogte wordt gesteld wanneer de koppeling wordt geopend. |
|
Verwijst naar versie
|
link_to_current | boolean |
Is deze huidige versie? T of F |
|
Vervaldatum
|
expiry_date | string |
Datum en tijd van de vervaldatum van de koppeling. |
|
Aanmaakdatum
|
creation_date | string |
De datum en tijd waarop de koppeling is gemaakt. |
|
Gemaakt door
|
created_by | string |
Gebruikersnaam van de gebruiker die de koppeling heeft gemaakt. |
Bestand kopiëren op id
Kopieer een bestand met behulp van een id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestands-id
|
id | True | string |
De unieke id van het bestand dat moet worden gekopieerd in Egnyte. |
|
Pad naar doelbestand
|
destination_path | True | string |
Het pad naar het doelbestand in Egnyte, inclusief de bestandsnaam van het doel. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bestandspad
|
path | string |
Volledig pad van het gekopieerde bestand. |
|
Bestands-id
|
group_id | string |
De id die als geheel naar het bestand verwijst. |
Bestand kopiëren op pad
Kopieer een bestand met behulp van een pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bronbestand
|
path | True | string |
Het bronbestandspad in Egnyte, inclusief de bestandsnaam van het doel. |
|
Doelbestand
|
destination_path | True | string |
Het pad naar het doelbestand in Egnyte, inclusief de bestandsnaam van het doel. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bestandspad
|
path | string |
Volledig pad van het gekopieerde bestand. |
|
Bestands-id
|
group_id | string |
De id die als geheel naar het bestand verwijst. |
Bestand ontgrendelen op id
Ontgrendel het bestand met id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestands-id
|
id | True | string |
De unieke id van het bestand in Egnyte. |
|
Token vergrendelen
|
lock_token | True | string |
Het huidige vergrendelingstoken voor het bestand. |
Bestand ontgrendelen op pad
Ontgrendel het bestand met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestandspad
|
path | True | string |
Het unieke pad naar het bestand in Egnyte. |
|
Token vergrendelen
|
lock_token | True | string |
Het huidige vergrendelingstoken voor het bestand. |
Bestand per pad verwijderen
Een bestand verwijderen met behulp van een pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestandspad
|
path | True | string |
Het bestandspad in Egnyte, inclusief de bestandsnaam van het doel. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Pad naar bovenliggende map
|
parent_folder_path | string |
Pad naar de bovenliggende map voor het verwijderde bestand |
Bestand vergrendelen op id
Vergrendel het bestand met id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestands-id
|
id | True | string |
De unieke id van het bestand in Egnyte. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Onderbreking
|
timeout | integer |
De tijd in seconden waarop het bestand moet worden vergrendeld. |
|
Token vergrendelen
|
lock_token | string |
Het token dat moet worden gebruikt om het bestand te ontgrendelen. |
Bestand vergrendelen op pad
Vergrendel het bestand met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Pad naar doelbestand
|
path | True | string |
Het pad naar het doelbestand in Egnyte, inclusief de bestandsnaam van het doel. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Onderbreking
|
timeout | integer |
De tijd in seconden waarop het bestand moet worden vergrendeld. |
|
Token vergrendelen
|
lock_token | string |
Het token dat moet worden gebruikt om het bestand te ontgrendelen. |
Bestand verplaatsen op id
Verplaats een bestand in Egnyte met behulp van de bestands-id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestands-id
|
id | True | string |
De unieke id van het bestand in Egnyte. |
|
Pad naar doelbestand
|
destination_path | True | string |
Het pad naar het doelbestand in Egnyte. Inclusief doelbestandsbestand. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bestandspad
|
path | string |
Volledig pad van het verplaatste bestand. |
|
Bestands-id
|
group_id | string |
De id die als geheel naar het bestand verwijst. |
Bestand verplaatsen op pad
Verplaats een bestand in Egnyte met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bronpad
|
path | True | string |
Het pad naar het bronbestand. |
|
Pad naar doelbestand
|
destination_path | True | string |
Het pad naar het doelbestand in Egnyte, inclusief de bestandsnaam van het doel. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bestandspad
|
path | string |
Volledig pad van het verplaatste bestand. |
|
Bestands-id
|
group_id | string |
De id die als geheel naar het bestand verwijst. |
Bestand verwijderen op id
Een bestand verwijderen met een id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestands-id
|
id | True | string |
De unieke id van het bestand dat moet worden verwijderd uit Egnyte. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Pad naar bovenliggende map
|
parent_folder_path | string |
Pad naar de bovenliggende map voor het verwijderde bestand. |
Bestandsgegevens ophalen op id
Bestandsgegevens ophalen met behulp van de bestands-id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestands-id
|
id | True | string |
De unieke id van het bestand in Egnyte. |
Retouren
- Body
- FileInfoResponse
Bestandsgegevens ophalen per pad
Bestandsgegevens ophalen met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestandspad
|
path | True | string |
Het unieke pad naar het bestand in Egnyte. |
Retouren
- Body
- FileInfoResponse
Bestandsinhoud ophalen op id
Haalt de bestandsinhoud van Egnyte op met behulp van id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestands-id
|
fileId | True | string |
De unieke id van het bestand in Egnyte. |
Bestandsinhoud ophalen op pad
Haalt de bestandsinhoud van Egnyte op met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestandspad
|
filePath | True | string |
Het unieke pad naar het bestand in Egnyte. |
Dieptekoppeling per id
Maak een dieptekoppeling voor bestand of map op id. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Identiteitsbewijs
|
id | True | string |
Id van het bestand of de map |
|
Typologie
|
type | True | string |
Type koppeling |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
Dieptekoppeling |
Dieptekoppeling per pad
Maak een dieptekoppeling voor bestand of map per pad. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Path
|
path | True | string |
Pad van het bestand of de map |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
Dieptekoppeling |
Een bestand maken
Uploadt een bestand naar Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestandsnaam
|
Name | True | string |
De naam van het bestand dat u in Egnyte wilt maken. |
|
Maplocatie
|
Path | True | string |
Het mappad om het bestand te uploaden naar Egnyte. |
|
Bestandsinhoud
|
body | True | binary |
De inhoud van het bestand dat moet worden geüpload naar Egnyte. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Versie-id
|
id | string |
De id van de huidige versie van het bestand. |
|
Bestands-id
|
group_id | string |
De id die als geheel naar het bestand verwijst. |
|
Bestandspad
|
path | string |
Volledig pad naar het geüploade bestand. |
Effectieve machtigingen ophalen
Krijg effectieve machtigingen voor een gebruiker. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
path | True | string |
Volledig pad naar de map. |
|
Gebruikersnaam
|
username | True | string |
Gebruikersnaam |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Toestemming
|
permission | string |
Machtigingswaarde |
Gebruiker bijwerken op id
Werk de individuele gebruiker bij. Meer informatie: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
id | True | integer |
Unieke id voor de gebruiker |
|
E-mail van gebruiker
|
string |
Het e-mailadres van de gebruiker. |
||
|
Voornaam
|
givenName | string |
De voornaam van de gebruiker. |
|
|
Achternaam
|
familyName | string |
De achternaam van de gebruiker. |
|
|
Active
|
active | boolean |
Of de gebruiker actief of inactief is. |
|
|
Uitnodiging verzenden
|
sendInvite | boolean |
Als deze optie is ingesteld op waar, wordt er een uitnodigingsmail verzonden. De parameter kan niet de enige zijn die door deze actie is gewijzigd. |
|
|
Language
|
language | string |
De parameter 'language' wordt alleen geaccepteerd wanneer Language Pack is ingeschakeld voor het domein. |
|
|
Verificatietype
|
authType | string |
Het verificatietype voor de gebruiker. |
|
|
Gebruikerstype
|
userType | string |
Het type gebruiker. |
|
|
Rol
|
role | string |
De rol die is toegewezen aan de gebruiker. Alleen van toepassing op Power Users. |
|
|
IDP-gebruikers-id
|
idpUserId | string |
Alleen vereist als de gebruiker is geverifieerd met eenmalige aanmelding en niet gebruikmaakt van standaardgebruikerstoewijzing |
|
|
Hoofdgebruikersnaam
|
userPrincipalName | string |
Geef niet op of de gebruiker niet is geverifieerd met AD. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikers-ID
|
id | integer |
Unieke id voor de gebruiker |
|
E-mail van gebruiker
|
string |
Het e-mailadres van de gebruiker. |
|
|
Achternaam
|
familyName | string |
De achternaam van de gebruiker. |
|
Voornaam
|
givenName | string |
De voornaam van de gebruiker. |
|
Active
|
active | boolean |
Of de gebruiker actief of inactief is. |
|
Uitnodiging verzenden
|
sendInvite | boolean |
Als deze optie is ingesteld op waar, wordt er een uitnodigingsmail verzonden. |
|
Language
|
language | string |
Het wordt alleen geaccepteerd wanneer het taalpakket is ingeschakeld. |
|
Verificatietype
|
authType | string |
Het verificatietype voor de gebruiker. |
|
Gebruikerstype
|
userType | string |
Het type gebruiker. |
|
Rol
|
role | string |
De rol die is toegewezen aan de gebruiker. Alleen van toepassing op Power Users. |
|
IDP-gebruikers-id
|
idpUserId | string |
Alleen vereist als de gebruiker is geverifieerd met eenmalige aanmelding |
|
Hoofdgebruikersnaam
|
userPrincipalName | string |
Geef niet op of de gebruiker niet is geverifieerd met AD. |
Gebruiker maken
Maak een nieuwe gebruiker in Egnyte. Meer informatie: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikersnaam
|
userName | True | string |
De Gebruikersnaam van Egnyte voor de gebruiker. Moet beginnen met een letter of cijfer. |
|
E-mailen
|
True | string |
Het e-mailadres van de gebruiker (bijvoorbeeld admin@acme.com). |
|
|
Voornaam
|
givenName | True | string |
De voornaam van de gebruiker. |
|
Achternaam
|
familyName | True | string |
De achternaam van de gebruiker. |
|
Active
|
active | True | boolean |
Of de gebruiker actief of inactief is. |
|
Gebruikerstype
|
userType | True | string |
Het type gebruiker. |
|
Verificatietype
|
authType | True | string |
Het verificatietype voor de gebruiker. |
|
Externe ID
|
externalId | string |
Onveranderbare unieke id die wordt geleverd door de API-consument. |
|
|
Uitnodiging verzenden
|
sendInvite | boolean |
Als deze optie is ingesteld op waar bij het maken van een gebruiker, wordt er een uitnodigings-e-mail verzonden (als de gebruiker is gemaakt in de actieve status). |
|
|
Is serviceaccount
|
isServiceAccount | boolean |
Als deze optie is ingesteld op true bij het maken van een gebruiker, wordt de gebruiker gemaakt als een serviceaccount. |
|
|
Language
|
language | string |
De parameter 'language' wordt alleen geaccepteerd wanneer Language Pack is ingeschakeld voor het domein. |
|
|
Rol
|
role | string |
De rol die is toegewezen aan de gebruiker. Alleen van toepassing op Power Users. |
|
|
IDP-gebruikers-id
|
idpUserId | string |
Alleen vereist als de gebruiker is geverifieerd met eenmalige aanmelding en niet gebruikmaakt van standaardgebruikerstoewijzing. Geef niet op of de gebruiker niet is geverifieerd met eenmalige aanmelding. |
|
|
Hoofdgebruikersnaam
|
userPrincipalName | string |
Geef niet op of de gebruiker niet is geverifieerd met AD. Wordt gebruikt voor het binden van onderliggend verificatiebeleid aan een gebruiker bij het gebruik van Active Directory-verificatie in een installatie met meerdere domeinen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikers-ID
|
id | integer |
Unieke id voor de zojuist gemaakte gebruiker |
|
Gebruikersnaam
|
userName | string |
De Gebruikersnaam van Egnyte voor de gebruiker. |
|
Externe ID
|
externalId | string |
Onveranderbare unieke id die wordt geleverd door de API-consument. |
|
E-mailen
|
string |
Het e-mailadres van de gebruiker. |
|
|
E-mailwijziging in behandeling
|
emailChangePending | boolean |
Of een e-mailwijziging in behandeling is. |
|
Voornaam
|
name.givenName | string |
De voornaam van de gebruiker. |
|
Achternaam
|
name.familyName | string |
De achternaam van de gebruiker. |
|
Opgemaakte naam
|
name.formatted | string |
De opgemaakte volledige naam van de gebruiker. |
|
Active
|
active | boolean |
Of de gebruiker actief is. |
|
Vergrendeld
|
locked | boolean |
Of het gebruikersaccount is vergrendeld. |
|
Verificatietype
|
authType | string |
Het verificatietype voor de gebruiker. |
|
Gebruikerstype
|
userType | string |
Het type gebruiker. |
|
IDP-gebruikers-id
|
idpUserId | string |
De manier waarop de gebruiker wordt geïdentificeerd in het SAML-antwoord van een id-provider voor eenmalige aanmelding. |
|
Hoofdgebruikersnaam
|
userPrincipalName | string |
Wordt gebruikt voor het binden van onderliggend verificatiebeleid aan een gebruiker bij het gebruik van Active Directory-verificatie. |
|
Rol
|
role | string |
De rol die is toegewezen aan de gebruiker. Alleen van toepassing op Power Users. |
|
Language
|
language | string |
De taalvoorkeur voor de gebruiker. |
|
Aanmaakdatum
|
createdDate | date-time |
De datum en tijd waarop de gebruiker is gemaakt. |
|
Datum van laatste wijziging
|
lastModificationDate | date-time |
De datum en tijd van de laatste wijziging. |
|
Laatste actieve datum
|
lastActiveDate | date-time |
De datum en tijd van de laatste activiteit. |
|
Vervaldatum
|
expiryDate | date-time |
De datum waarop het gebruikersaccount verloopt. |
Gebruiker verwijderen op id
Een gebruiker verwijderen uit Egnyte. Meer informatie: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
id | True | integer |
De id van de gebruiker die moet worden verwijderd |
Gebruikersgegevens ophalen
Haal de informatie over de gebruiker op id op. Meer informatie: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
id | True | integer |
De id van de gebruiker |
Retouren
Gebruikersgegevens
- Body
- UserInfoResponse
Gedeeltelijke groepsupdate
Specifieke kenmerken van een groep bijwerken. https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Groeps-id
|
id | True | string |
De id van de gemaakte groep. |
|
Weergavenaam
|
displayName | string |
De weergavenaam van de groep. |
|
|
Gebruikers-ID
|
value | integer |
De wereldwijd unieke id van een groepslid. |
|
|
operatie
|
operation | string |
De actie die u wilt uitvoeren voor een groep. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Groeps-id
|
id | string |
De id van de gemaakte groep. |
|
displayName
|
displayName | string |
De weergavenaam van een groep. |
|
leden
|
members | array of object |
Groepsleden |
|
Gebruikersnaam
|
members.username | string |
De gebruikersnaam van een lid. |
|
Gebruikers-ID
|
members.value | number |
De gebruikers-id van een lid. |
|
Weergavenaam van de gebruiker
|
members.display | string |
De weergavenaam van een lid. |
Groep maken
Maak een groep in Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Weergavenaam
|
displayName | True | string |
De weergavenaam van de groep. |
|
Gebruikers-ID
|
value | string |
De wereldwijd unieke id van een groepslid. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Groeps-id
|
id | string |
De id van de gemaakte groep. |
|
displayName
|
displayName | string |
De weergavenaam van een groep. |
|
leden
|
members | array of object |
Groepsleden |
|
Gebruikersnaam
|
members.username | string |
De gebruikersnaam van een lid. |
|
Gebruikers-ID
|
members.value | number |
De gebruikers-id van een lid. |
|
Weergavenaam van de gebruiker
|
members.display | string |
De weergavenaam van een lid. |
Groep verwijderen
Een groep op id verwijderen. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Groeps-id
|
id | True | string |
De groeps-id. |
Groepsdetails ophalen
Groepsgegevens ophalen met id. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Groeps-id
|
id | True | string |
De id van de groep. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Groeps-id
|
id | string |
De wereldwijd unieke groeps-id. |
|
Groepsnaam
|
displayName | string |
De naam van de groep. |
|
leden
|
members | array of object |
Groepsleden |
|
Groeps-id
|
members.username | string |
De gebruikersnaam van een groepslid |
|
Gebruikers-ID
|
members.value | number |
De wereldwijd unieke id van een groepslid. |
|
Weergavenaam van de gebruiker
|
members.display | string |
De weergavenaam van een groepslid. |
Koppeling maken
Maak een koppeling. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Path
|
path | True | string |
Het absolute pad van het doelbestand of de doelmap. |
|
Typologie
|
type | True | string |
Hiermee bepaalt u welk type koppeling wordt gemaakt. |
|
Toegankelijkheid
|
accessibility | string |
Bepaalt door wie een koppeling toegankelijk is. Vereist behalve uploadkoppelingen of wanneer useDefaultSettings waar is. |
|
|
Standaardinstellingen gebruiken
|
useDefaultSettings | True | boolean |
Bepaalt of de standaardparameters in het domein moeten worden gebruikt voor het maken van een koppeling |
|
E-mail verzenden
|
send_email | boolean |
Als waar is ingesteld, wordt de koppeling verzonden via e-mail door Egnyte. |
|
|
Ontvangers
|
recipients | array of string |
E-mailadressen van geadresseerden van de koppeling weergeven. Alleen vereist als 'E-mail verzenden' waar is. |
|
|
Bericht (alleen van toepassing als 'E-mail verzenden' waar is.)
|
message | string |
Persoonlijk bericht dat moet worden verzonden in een koppelings-e-mail. |
|
|
Kopiëren (geldt alleen als 'E-mail verzenden' waar is)
|
copy_me | boolean |
Als waar is ingesteld, wordt er een kopie van het koppelingsbericht verzonden naar de maker van de koppeling. |
|
|
Aankondigen
|
notify | boolean |
Als waar is ingesteld, krijgt de maker van de koppeling een melding via e-mail wanneer de koppeling wordt geopend. |
|
|
Koppeling naar huidige (alleen van toepassing op bestandskoppelingen.)
|
link_to_current | boolean |
Als waar is ingesteld, verwijst de koppeling altijd naar de huidige versie van het bestand. |
|
|
Vervaldatum (bijvoorbeeld 2023-12-31)
|
expiry_date | string |
Vervaldatum voor de koppeling. Indien opgegeven, kan 'Verloopklikken' niet worden ingesteld. |
|
|
Verloopklikken
|
expiry_clicks | number |
Het aantal klikken op de koppeling is geldig. Als dit is opgegeven, kan de vervaldatum niet worden ingesteld |
|
|
Een bestandsnaam toevoegen (alleen van toepassing op bestandskoppelingen, niet op mapkoppelingen)
|
add_file_name | boolean |
Indien waar, wordt de bestandsnaam toegevoegd aan het einde van de koppeling. |
|
|
Wachtwoord (wanneer de parameter 'toegankelijkheid' is ingesteld op 'wachtwoord')
|
password | string |
Wanneer dit niet is opgegeven, genereert het systeem automatisch een wachtwoord. |
|
|
Beveiliging
|
protection | string |
Als deze optie is ingesteld op 'PREVIEW', wordt er een koppeling voor alleen-preview gemaakt. |
|
|
Map per geadresseerde (alleen van toepassing op uploadkoppelingen.)
|
folder_per_recipient | boolean |
Indien waar, worden de geüploade gegevens van elke geadresseerde in een afzonderlijke map geplaatst. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Links
|
links | array of object |
Een matrix met de volledige JSON-informatie voor alle koppelingen voor uw domein die deze gebruiker kan zien binnen opgegeven bereiken |
|
Identiteitsbewijs
|
links.id | string |
De id van de koppeling |
|
URL
|
links.url | string |
De volledige URL van de koppeling |
|
Ontvangers
|
links.recipients | array of string |
Een matrix met geldige e-mailadressen waarnaar de koppeling is verzonden. |
|
Path
|
path | string |
Het absolute pad van de doelresource, bestand of map. |
|
Typologie
|
type | string |
Het type koppeling, bestand, map of uploaden |
|
Toegankelijkheid
|
accessibility | string |
Wie een koppeling toegankelijk is voor iedereen, een wachtwoord, domein of geadresseerden. |
|
Aankondigen
|
notify | boolean |
Booleaanse waarde die aangeeft of de maker van de koppeling via e-mail wordt gewaarschuwd wanneer de koppeling wordt geopend. |
|
Koppeling naar huidige
|
link_to_current | boolean |
Booleaanse waarde die aangeeft of de koppeling altijd verwijst naar de huidige versie van het bestand. Alleen van toepassing op bestandskoppelingen. |
|
Vervaldatum
|
expiry_date | string |
Datum en tijd van de vervaldatum van de koppeling. Dit veld wordt alleen weergegeven als de koppeling verloopt op datum |
|
Aanmaakdatum
|
creation_date | string |
Datum en tijd van het maken van de koppeling |
|
Gemaakt door
|
created_by | string |
Gebruikersnaam van de gebruiker die de koppeling heeft gemaakt |
Koppeling verwijderen
Een koppeling verwijderen. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Koppelings-id
|
linkId | True | string |
LinkId |
Koppelingsgegevens weergeven
Bekijk de details van een koppeling. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Koppelings-id
|
linkId | True | string |
LinkId |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Links
|
links | array of object |
Een matrix met de volledige JSON-informatie voor alle koppelingen voor uw domein die deze gebruiker kan zien binnen opgegeven bereiken |
|
Identiteitsbewijs
|
links.id | string |
De id van de koppeling |
|
URL
|
links.url | string |
De volledige URL van de koppeling |
|
Ontvangers
|
links.recipients | array of string |
Een matrix met geldige e-mailadressen waarnaar de koppeling is verzonden. |
|
Path
|
path | string |
Het absolute pad van de doelresource, bestand of map. |
|
Typologie
|
type | string |
Het type koppeling, bestand, map of uploaden |
|
Toegankelijkheid
|
accessibility | string |
Wie een koppeling toegankelijk is voor iedereen, een wachtwoord, domein of geadresseerden. |
|
Aankondigen
|
notify | boolean |
Booleaanse waarde die aangeeft of de maker van de koppeling via e-mail wordt gewaarschuwd wanneer de koppeling wordt geopend. |
|
Koppeling naar huidige
|
link_to_current | boolean |
Booleaanse waarde die aangeeft of de koppeling altijd verwijst naar de huidige versie van het bestand. Alleen van toepassing op bestandskoppelingen. |
|
Vervaldatum
|
expiry_date | string |
Datum en tijd van de vervaldatum van de koppeling. Dit veld wordt alleen weergegeven als de koppeling verloopt op datum |
|
Aanmaakdatum
|
creation_date | string |
Datum en tijd van het maken van de koppeling |
|
Gemaakt door
|
created_by | string |
Gebruikersnaam van de gebruiker die de koppeling heeft gemaakt |
|
Laatst geopend
|
last_accessed | string |
Datum en tijd van de laatste toegang tot de koppeling. Dit veld wordt alleen weergegeven als de koppeling ten minste eenmaal is geopend |
Lijst met alle gebruikers ophalen
Haal de informatie over de gebruikers op. Meer informatie: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Startindex
|
startIndex | integer |
De op 1 gebaseerde index van het eerste zoekresultaat. |
|
|
Aantal
|
count | integer |
Hiermee geeft u het gewenste maximum aantal zoekresultaten per pagina. |
|
|
Filter
|
filter | string |
Hiermee kunt u een subset van gebruikers aanvragen. Raadpleeg de documentatie in de sectie Over. |
Retouren
Antwoord gebruikerslijst ophalen
- Body
- UserListResponse
Lijst met alle groepen ophalen
Haal de lijst met de groepen op. https://developers.egnyte.com/api-docs/read/group-management#List-Groups
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Startindex
|
startIndex | integer |
De index op basis van 1 van de initiële record die wordt aangevraagd (integer ≥ 1). |
|
|
Aantal
|
count | integer |
Het aantal vermeldingen per pagina (min. 1, max. 100) |
|
|
Filter
|
filter | string |
Hiermee kunt u een subset van groepen aanvragen. Deze voorwaarden zijn niet hoofdlettergevoelig |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Totaal aantal resultaten
|
totalResults | integer |
Het totale aantal resultaten dat overeenkomt met de query. |
|
Items per pagina
|
itemsPerPage | integer |
Het aantal geretourneerde resultaten. |
|
Index starten
|
startIndex | integer |
De op 1 gebaseerde index van het eerste resultaat in de huidige set resultaten. |
|
resources
|
resources | array of object | |
|
Groeps-id
|
resources.id | string |
De wereldwijd unieke groeps-id. |
|
Groepsnaam
|
resources.displayName | string |
De naam van de groep. |
Map delen
Deel een map in Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
path | True | string |
Het pad naar de map in Egnyte om te delen. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
koppelingen
|
links | array of object |
Links |
|
Koppelings-id
|
links.id | string |
De id van de koppeling. |
|
Url van koppeling
|
links.url | string |
De volledige URL van de koppeling. |
|
Ontvangers
|
links.recipients | array of string |
Een matrix met geldige e-mailadressen waarnaar de koppeling is verzonden. |
|
Mappad
|
path | string |
Volledig pad van de gedeelde map. |
|
Typologie
|
type | string |
Het type koppeling, bestand, map of upload. |
|
Toegankelijkheid
|
accessibility | string |
Wie een koppeling toegankelijk is voor iedereen, een wachtwoord, domein of geadresseerden. |
|
Maker waarschuwen wanneer deze wordt geopend
|
notify | boolean |
Of de maker van de koppeling via e-mail op de hoogte wordt gesteld wanneer de koppeling wordt geopend. |
|
Verwijst naar versie
|
link_to_current | boolean |
Is deze huidige versie? T of F |
|
Vervaldatum
|
expiry_date | string |
Datum en tijd van de vervaldatum van de koppeling. |
|
Aanmaakdatum
|
creation_date | string |
De datum en tijd waarop de koppeling is gemaakt. |
|
Gemaakt door
|
created_by | string |
Gebruikersnaam van de gebruiker die de koppeling heeft gemaakt. |
Map kopiëren op id
Kopieer een map met een id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Map-id
|
id | True | string |
De unieke id van de map die moet worden gekopieerd in Egnyte. |
|
Pad naar doelmap
|
destination_path | True | string |
Het pad naar de doelmap in Egnyte. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Mappad
|
path | string |
Volledig pad van de gekopieerde map. |
|
Map-id
|
folder_id | string |
De unieke id van de gekopieerde map. |
Map kopiëren per pad
Kopieer een map met behulp van een pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Pad naar bronmap
|
path | True | string |
Het pad naar de bronmap in Egnyte. |
|
Pad naar doelmap
|
destination_path | True | string |
Het pad naar de doelmap in Egnyte. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Mappad
|
path | string |
Volledig pad van de gekopieerde map. |
|
Map-id
|
folder_id | string |
De unieke id van de gekopieerde map. |
Map maken
Maak een map in Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
path | True | string |
Het volledige pad van de nieuwe map. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Mappad
|
path | string |
Volledig pad van de gemaakte map |
|
Map-id
|
folder_id | string |
De unieke id van de gemaakte map |
Map markeren als project
Een bestaande map markeren als een project. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Hoofdmap-id
|
rootFolderId | True | string |
FolderId van de hoofdprojectmap |
|
Naam
|
name | True | string |
De naam van het project |
|
Description
|
description | string |
Beschrijving van map |
|
|
Toestand
|
status | True | string |
Status van het project |
|
Begindatum (bijvoorbeeld 2023-12-31T23:59:59)
|
startDate | date-time |
De begindatum van het project. |
|
|
Voltooiingsdatum (bijvoorbeeld 2023-12-31T23:59:59)
|
completionDate | date-time |
De voltooiingsdatum voor het project. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Identiteitsbewijs
|
id | string |
Item-id |
Map per pad verplaatsen
Verplaats een map in Egnyte met behulp van het pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bronpad
|
path | True | string |
Het pad naar de bronmap. |
|
Pad naar doelmap
|
destination_path | True | string |
Het pad naar de doelmap in Egnyte. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Mappad
|
path | string |
Volledig pad van de verplaatste map. |
|
Map-id
|
folder_id | string |
De unieke id van de verplaatste map. |
Map per pad verwijderen
Een map verwijderen met behulp van een pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
path | True | string |
Het pad naar de map in Egnyte, inclusief de naam van de doelmap die moet worden verwijderd. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Pad naar bovenliggende map
|
parent_folder_path | string |
Pad naar de bovenliggende map voor de verwijderde map. |
Map verplaatsen op id
Een map verplaatsen met id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Map-id
|
id | True | string |
De unieke id van de map in Egnyte. |
|
Pad naar doelmap
|
destination_path | True | string |
Het pad naar de doelmap in Egnyte. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Mappad
|
path | string |
Volledig pad van de verplaatste map. |
|
Map-id
|
folder_id | string |
De unieke id van de verplaatste map. |
Map verwijderen op id
Een map verwijderen met behulp van een id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Map-id
|
id | True | string |
De unieke id van de map die moet worden verwijderd uit Egnyte. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Pad naar bovenliggende map
|
parent_folder_path | string |
Pad naar de bovenliggende map voor de verwijderde map. |
Mapgegevens ophalen op id
Mapgegevens ophalen met id. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Map-id
|
id | True | string |
De unieke id van de map in Egnyte. |
Retouren
- Body
- FolderInfoResponse
Mapgegevens ophalen per pad
Mapgegevens ophalen met behulp van pad. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
path | True | string |
Het unieke pad naar de map in Egnyte. |
Retouren
- Body
- FolderInfoResponse
Mapmachtigingen instellen
Machtigingen instellen voor een map. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
path | True | string |
Volledig pad naar de map. |
|
Gebruikersmachtigingen
|
userPerms | object |
Toewijzing van gebruiker aan machtigingswaarde. |
|
|
Groepsmachtigingen
|
groupPerms | object |
Toewijzing van groepsnaam aan machtigingswaarde |
|
|
Neemt machtigingen over
|
inheritsPermissions | boolean |
Of machtigingen moeten worden overgenomen van de bovenliggende map. |
|
|
Bovenliggende machtigingen behouden (alleen als overgenomenPermissions onwaar is)
|
keepParentPermissions | boolean |
Of machtigingen van bovenliggende mappen van toepassing moeten zijn op deze map. |
Mapmachtigingen ophalen
Machtigingen voor een map ophalen. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
path | True | string |
Volledig pad naar de map. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikersmachtigingen
|
userPerms | object |
Toewijzing van gebruiker aan machtigingswaarde. |
|
Groepsmachtigingen
|
groupPerms | object |
Toewijzing van groepsnaam aan machtigingswaarde |
|
Neemt machtigingen over
|
inheritsPermissions | boolean |
Of machtigingen moeten worden overgenomen van de bovenliggende map. |
|
Bovenliggende machtigingen behouden
|
keepParentPermissions | boolean |
Bij het uitschakelen van overname van machtigingen met overnamesPermissions, bepaalt deze opties of eerder overgenomen machtigingen van bovenliggende mappen moeten worden gekopieerd naar deze map. |
Mapopties wijzigen
Mapopties wijzigen, zoals beschrijving, instellingen voor delen van koppelingen, machtigingen voor openbare koppelingen, beperkingen voor verplaatsen/verwijderen en voorkeuren voor e-mailmeldingen. https://developers.egnyte.com/api-docs/read/folder-options-api
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
path | True | string |
Het unieke pad naar de map in Egnyte. |
|
Beschrijving van map
|
folder_description | string |
Beschrijving van de map. |
|
|
Koppelingen toestaan
|
allow_links | boolean |
Kies of koppelingen kunnen worden gedeeld met bestanden of submappen in deze map. |
|
|
Openbare koppelingen
|
public_links | string |
Geef op welk type openbare koppelingen is toegestaan. Mogelijke waarden: files_folders, bestanden, uitgeschakeld. |
|
|
Verplaatsen/verwijderen beperken
|
restrict_move_delete | boolean |
Beperk verplaatsings- en verwijderbewerkingen tot alleen mapeigenaren en beheerders. |
|
|
Meldingen over inhoudsupdates
|
content_updates | boolean |
Schakel e-mailmeldingen in voor inhoudsupdates. |
|
|
Meldingen voor toegang tot inhoud
|
content_accessed | boolean |
E-mailmeldingen inschakelen voor inhoud die wordt geopend. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naam
|
name | string |
Naam van de map. |
|
Laatst gewijzigd
|
lastModified | integer |
De laatste keer dat een bestand in de map (maar niet binnen submappen) is gewijzigd. |
|
Mappad
|
path | string |
Volledig pad naar de map. |
|
Map-id
|
folder_id | string |
De unieke id van de map. |
|
Beschrijving van map
|
folder_description | string |
De beschrijving van de map. |
|
Is de map
|
is_folder | boolean |
Of de resource een map is. Waar of onwaar |
|
Mogelijke openbare koppelingen
|
public_links | string |
De instelling van de mapoptie voor het instellen van 'Openbare koppelingen uit deze map toestaan' is ingesteld. |
|
Kan worden verwijderd of verplaatst
|
restrict_move_delete | boolean |
Kan worden verwijderd of verplaatst? T of F |
Metagegevens instellen op bestands-id
Schrijf metagegevens naar een bestand met behulp van de bestands-id. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestands-id
|
fileId | True | string |
De unieke id van het bestand in Egnyte. |
|
Naamruimtenaam
|
namespaceName | True | string |
De naam van de naamruimte. |
|
Naam van metagegevenssleutel
|
metadataName | True | string |
De naam van de sleutel waaraan u waarde wilt toewijzen. |
|
Metagegevenswaarde
|
metadataValue | string |
De waarde van de metagegevens die moet worden ingesteld. |
Metagegevens instellen op map-id
Schrijf metagegevens naar een map met behulp van map-id. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Map-id
|
folderId | True | string |
De unieke id van de map in Egnyte. |
|
Naamruimtenaam
|
namespaceName | True | string |
De naam van de naamruimte. |
|
Naam van metagegevenssleutel
|
metadataName | True | string |
De naam van de sleutel waaraan u waarde wilt toewijzen. |
|
Metagegevenswaarde
|
metadataValue | True | string |
De waarde van de metagegevens die moet worden ingesteld. |
Metagegevens ophalen op basis van bestands-id
Haal metagegevens op uit een bestand met behulp van de bestands-id. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestands-id
|
fileId | True | string |
De unieke id van het bestand in Egnyte. |
|
Naamruimtenaam
|
namespace | True | string |
De naam van de naamruimte. |
Metagegevens ophalen op map-id
Haal metagegevens op uit een map met behulp van de map-id. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Map-id
|
folderId | True | string |
De unieke id van de map in Egnyte. |
|
Naamruimtenaam
|
namespace | True | string |
De naam van de naamruimte. |
Metagegevens zoeken
Items zoeken met een specifiek metagegevensveld of een specifieke waarde. https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Zoektype
|
type | string |
In welke itemtypen moet worden gezocht. |
|
|
Naamruimtenaam
|
namespace | True | string |
De naam van de naamruimte. |
|
Metagegevenssleutel
|
keyName | True | string |
De naam van de metagegevenssleutel. |
|
Naamruimtenaam
|
namespace | True | string |
De naam van de naamruimte. |
|
Metagegevenssleutel
|
keyName | True | string |
De naam van de metagegevenssleutel. |
|
Metagegevenswaarde
|
value | True | string |
De waarde van de metagegevenssleutel. |
Metagegevenssleutel maken
Voeg een metagegevenssleutel toe aan een bestaande naamruimte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naamruimtenaam
|
namespace | True | string |
De unieke id van de naamruimte in Egnyte. |
|
Sleutelnaam
|
key | True | string |
De naam van de sleutel die u maakt. |
|
Type (voor 'enum': gegevensparameter is vereist)
|
type | True | string |
Hiermee geeft u het gegevenstype voor een sleutel. |
|
Weergavenaam
|
displayName | string |
De naam om het veld in de gebruikersinterface te identificeren. |
|
|
Priority
|
priority | number |
Hiermee geeft u de prioriteit voor de sleutel op (sleutels met de hogere prioriteit worden eerst weergegeven). |
|
|
Help-tekst
|
helpText | string |
Een beschrijving van knopinfo voor het metagegevensveld. |
|
|
Gegevens
|
data | array of string |
Voor een sleutel van het enumtype geeft u de geïnventareerde waarden op. |
Metagegevenssleutel verwijderen
Verwijder een metagegevenssleutel uit een bestaande naamruimte. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naamruimtenaam
|
namespace | True | string |
De unieke id van de naamruimte in Egnyte. |
|
Naam
|
key | True | string |
De naam van de sleutel die u verwijdert. |
|
Forceren om te verwijderen
|
force | boolean |
Verwijder zelfs als de metagegevenssleutel wordt gebruikt. |
Naamruimte maken
Maak een naamruimte in Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naamruimtenaam
|
name | True | string |
De naam van de naamruimte |
|
Weergavenaam
|
displayName | string |
De naam om de naamruimte in de gebruikersinterface te identificeren |
|
|
Scope
|
scope | True | string |
Wie kan de naamruimte zien en wijzigen |
|
Sleutelnaam
|
name | True | string |
De naam van de sleutel |
|
Typologie
|
type | True | string |
Hiermee geeft u het gegevenstype voor een sleutel |
|
Weergavenaam
|
displayName | string |
De naam voor het identificeren van het veld in de gebruikersinterface |
|
|
Help-tekst
|
helpText | string |
Een beschrijving van knopinfo voor het metagegevensveld |
|
|
Priority
|
priority | number |
Hiermee geeft u prioriteit voor de sleutel op (sleutels met de hogere prioriteit worden eerst weergegeven |
|
|
Gegevens (voor opsommingstype)
|
data | array of string |
Voor een sleutel van het enum-type geeft u de geïnventareerde waarden op |
Naamruimte ophalen
Geef alle aangepaste metagegevenssleutels weer die zijn gemaakt in een bepaalde naamruimte. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naamruimtenaam
|
namespace | True | string |
De unieke id van de naamruimte in Egnyte. |
Retouren
- Body
- NamespaceItem
Naamruimte verwijderen
Een opgegeven naamruimte verwijderen. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naamruimtenaam
|
namespace | True | string |
De unieke id van de naamruimte in Egnyte. |
|
Forceren om te verwijderen
|
force | boolean |
Verwijderen, zelfs als de naamruimte wordt gebruikt |
Naamruimtekenmerken bijwerken
Werkt naamruimtekenmerken bij. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naamruimtenaam
|
namespace | True | string |
De unieke id van de naamruimte in Egnyte. |
|
displayName
|
displayName | string |
De naam om de naamruimte in de gebruikersinterface te identificeren |
|
|
Prioriteiten
|
priorities | object |
Hiermee geeft u de prioriteit (volgorde) voor de sleutels. De sleutels worden weergegeven in aflopende volgorde (sleutels met een hogere prioriteit worden eerst weergegeven) |
Retouren
- Body
- NamespaceItem
Naamruimtesleutels bijwerken
Werk de sleutel van een aangepaste metagegevens voor een domein bij. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naamruimtenaam
|
namespace | True | string |
De unieke id van de naamruimte in Egnyte. |
|
Key
|
key | True | string |
De unieke sleutel in de naamruimte |
|
displayName
|
displayName | string |
Hiermee geeft u de naam die voor de sleutel wordt weergegeven |
|
|
type
|
type | string |
Hiermee geeft u het gegevenstype voor een sleutel |
|
|
priority
|
priority | number |
Hiermee geeft u de prioriteit (volgorde) voor de sleutels. De sleutels worden weergegeven in aflopende volgorde (sleutels met een hogere prioriteit worden eerst weergegeven) |
|
|
gegevens
|
data | string |
Voor een sleutel van het enum-type geeft u de geïnventareerde waarden op |
|
|
helpText
|
helpText | string |
Instructietekst die wordt weergegeven wanneer een gebruiker een eigenschap toevoegt/bewerkt om context te geven over het doel van de eigenschap |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string |
Naamruimtenaam |
|
key
|
key | string |
Sleutelnaam |
|
displayName
|
displayName | string |
De naam voor het identificeren van het veld in de gebruikersinterface |
|
helpText
|
helpText | string |
Een beschrijving van knopinfo voor het metagegevensveld |
|
priority
|
priority | number |
Hiermee geeft u prioriteit voor de sleutel op (sleutels met de hogere prioriteit worden eerst weergegeven |
Project bijwerken op id
Hiermee worden de opgegeven eigenschappen van een project bijgewerkt dat is geïdentificeerd door de id. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
naam
|
name | True | string |
De nieuwe naam van de map. |
|
beschrijving
|
description | string |
Een nieuwe beschrijving voor de map. |
|
|
project-id
|
projectId | True | string |
ID van het project. |
|
customProjectId
|
customProjectId | string |
Aangepaste id van het project. |
|
|
klantnaam
|
customerName | string |
De klant die aan het project is gekoppeld. |
|
|
straatadres1
|
streetAddress1 | string |
Eerste regel van het adres. |
|
|
straatadres2
|
streetAddress2 | string |
Tweede regel van het adres. |
|
|
city
|
city | string |
Plaats. |
|
|
state
|
state | string |
Staat of provincie. |
|
|
postalCode
|
postalCode | string |
Postcode. |
|
|
country
|
country | string |
met behulp van een landcode van 3 tekens uit het ISO 3166 GENC-profiel, bijvoorbeeld: USA, GBR, POL. |
|
|
status
|
status | True | string |
Huidige status van het project. |
|
startDate
|
startDate | string |
De begindatum van het project in ISO 8601-indeling. |
|
|
opleveringDatum
|
completionDate | string |
De verwachte voltooiingsdatum van het project in ISO 8601-indeling. |
Project maken op sjabloon
Maak een nieuw project op basis van een projectmapsjabloon. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bovenliggende map-id
|
parentFolderId | True | string |
Map-id van de bovenliggende map waar de projectmap wordt gemaakt |
|
Sjabloonmap-id
|
templateFolderId | True | string |
Map-id van de projectmapsjabloon |
|
Mapnaam
|
folderName | True | string |
Naam van de nieuwe map die wordt gemaakt |
|
Naam
|
name | True | string |
De naam van het project |
|
Description
|
description | string |
Beschrijving van map |
|
|
Project-id
|
projectId | string |
Aangepaste id van het project |
|
|
Klantnaam
|
customerName | string |
De klant die is gekoppeld aan het project |
|
|
Toestand
|
status | True | string |
Status van het project |
|
Begindatum (bijvoorbeeld 2023-12-31T23:59:59)
|
startDate | date-time |
De begindatum van het project. |
|
|
Voltooiingsdatum (bijvoorbeeld 2023-12-31T23:59:59)
|
completionDate | date-time |
De voltooiingsdatum voor het project. |
|
|
Adres 1
|
streetAddress1 | string |
Eerste regel van het adres |
|
|
Adres 2
|
streetAddress2 | string |
Tweede regel van het adres |
|
|
City
|
city | string |
City |
|
|
Staat of provincie
|
state | string |
Staat of provincie |
|
|
Country
|
country | string |
Country |
|
|
Postcode of postcode
|
postalCode | string |
Postcode of postcode |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
groupsCreated
|
groupsCreated | array of object | |
|
Project-id
|
groupsCreated.id | string |
Project-id |
|
Projectnaam
|
groupsCreated.name | string |
Projectnaam |
Project op id opschonen
Dit eindpunt initieert een opschoning in een project en verwijdert of schakelt eventueel opgegeven gebruikers uit. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Project-id
|
projectId | True | string |
Project-id |
|
deleteLinks
|
deleteLinks | True | boolean |
Als deze optie is ingesteld op true, worden alle bestaande actieve koppelingen in het project verwijderd. |
|
usersToDelete
|
usersToDelete | array of integer |
Lijst met gebruikers-id's die moeten worden verwijderd. |
|
|
usersToDisable
|
usersToDisable | array of integer |
Lijst met gebruikers-id's die moeten worden uitgeschakeld. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
message
|
message | string |
Project ophalen op basis van hoofdmap-id
Een project ophalen op basis van de bijbehorende hoofdmap-id. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De id van de hoofdmap
|
rootFolderId | True | string |
De id van de hoofdmap |
Retouren
- Body
- ProjectItem
Project ophalen op id
Haal een project op met id. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Project-id
|
projectId | True | string |
Project-id |
Retouren
- Body
- ProjectItem
Project verwijderen op id
Een project verwijderen op basis van de id. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Project-id
|
projectId | True | string |
Id van het project dat wordt verwijderd |
Volledige groepsupdate
Overschrijf alle kenmerken van een groep. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Groeps-id
|
id | True | string |
De id van de gemaakte groep. |
|
Weergavenaam
|
displayName | True | string |
De weergavenaam van de groep. |
|
Gebruikers-ID
|
value | integer |
De wereldwijd unieke id van een groepslid. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Groeps-id
|
id | string |
De id van de gemaakte groep. |
|
displayName
|
displayName | string |
De weergavenaam van een groep. |
|
leden
|
members | array of object |
Groepsleden |
|
Gebruikersnaam
|
members.username | string |
De gebruikersnaam van een lid. |
|
Gebruikers-ID
|
members.value | number |
De gebruikers-id van een lid. |
|
Weergavenaam van de gebruiker
|
members.display | string |
De weergavenaam van een lid. |
Zoeken in V1
Inhoud zoeken die is opgeslagen in Egnyte op basis van bestandsnamen, metagegevens en tekstinhoud. https://developers.egnyte.com/api-docs/read/search-api#Search-v1
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Zoekquery
|
query | True | string |
De zoekreeks die u zoekt. |
|
Offset
|
offset | integer |
De index op basis van 0 van de eerste record die wordt aangevraagd. |
|
|
Aantal
|
count | integer |
Het aantal vermeldingen per pagina. |
|
|
Map
|
folder | string |
Beperk resultaten tot items in de opgegeven map en afstammelingen. |
|
|
Gewijzigd vóór
|
modifiedBefore | string |
Beperk de resultaten tot items die vóór deze ISO-8601-tijdstempel zijn gewijzigd. |
|
|
Gewijzigd na
|
modifiedAfter | string |
Beperk de resultaten tot items die na deze ISO-8601-tijdstempel zijn gewijzigd. |
|
|
Vóór geüpload
|
uploadedBefore | string |
Beperk de resultaten tot items die vóór deze ISO-8601-tijdstempel zijn geüpload. |
|
|
Geüpload na
|
uploadedAfter | string |
Beperk resultaten tot items die na deze ISO-8601-tijdstempel zijn geüpload. |
|
|
Typologie
|
type | string |
In welke itemtypen moet worden gezocht. |
|
|
Fragment aangevraagd
|
snippetRequested | boolean |
Of zoekresultaten fragmenten moeten bevatten. |
|
|
Sorteren op
|
sortBy | string |
Het veld dat moet worden gebruikt voor sorteren. |
|
|
Sorteerrichting
|
sortDirection | string |
De richting van de sortering. |
|
|
Bestandsqueryvelden
|
fileQueryFields | string |
Bestanden zoeken met behulp van specifieke velden. |
|
|
Mapqueryvelden
|
folderQueryFields | string |
Zoeken naar mappen met behulp van specifieke velden. |
|
|
Queryoperator
|
queryOperator | string |
Zoek naar alle woorden of een van de woorden. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
results
|
results | array of object | |
|
Bestandsnaam
|
results.name | string | |
|
Bestandspad
|
results.path | string | |
|
MIME-type
|
results.type | string | |
|
Bestandsgrootte
|
results.size | integer | |
|
Fragment
|
results.snippet | string | |
|
HTML-fragment
|
results.snippet_html | string | |
|
Vermeldings-id
|
results.entry_id | string | |
|
Groeps-id
|
results.group_id | string | |
|
Laatst gewijzigd
|
results.last_modified | string | |
|
Geüpload door
|
results.uploaded_by | string | |
|
Geüpload op gebruikersnaam
|
results.uploaded_by_username | string | |
|
Aantal versies
|
results.num_versions | integer | |
|
Is map
|
results.is_folder | boolean | |
|
Totaal aantal
|
total_count | integer | |
|
Offset
|
offset | integer | |
|
Aantal
|
count | integer |
Zoeken in V2
Inhoud zoeken met geavanceerde zoekmogelijkheden. https://developers.egnyte.com/api-docs/read/search-api#Search-v2
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Zoekquery
|
query | True | string |
De zoekreeks die u zoekt. |
|
Offset
|
offset | integer |
De index op basis van 0 van de eerste record die wordt aangevraagd. |
|
|
Aantal
|
count | integer |
Het aantal vermeldingen per pagina. |
|
|
Map
|
folder | string |
Beperk resultaten tot items in de opgegeven map en afstammelingen. |
|
|
Gewijzigd vóór
|
modifiedBefore | integer |
Beperk de resultaten tot items die vóór deze Unix-tijdstempel in milliseconden zijn gewijzigd. |
|
|
Gewijzigd na
|
modifiedAfter | integer |
Beperk de resultaten tot items die na deze Unix-tijdstempel in milliseconden zijn gewijzigd. |
|
|
Vóór geüpload
|
uploadedBefore | integer |
Beperk de resultaten tot items die vóór deze Unix-tijdstempel in milliseconden zijn geüpload. |
|
|
Geüpload na
|
uploadedAfter | integer |
Beperk de resultaten tot items die na deze Unix-tijdstempel in milliseconden zijn geüpload. |
|
|
Typologie
|
type | string |
In welke itemtypen moet worden gezocht. |
|
|
Fragment aangevraagd
|
snippetRequested | boolean |
Of zoekresultaten fragmenten moeten bevatten. |
|
|
Sorteren op
|
sortBy | string |
Het veld dat moet worden gebruikt voor sorteren. |
|
|
Sorteerrichting
|
sortDirection | string |
De richting van de sortering. |
|
|
Bestandsqueryvelden
|
fileQueryFields | array of string |
Bestanden zoeken met behulp van specifieke velden. |
|
|
Mapqueryvelden
|
folderQueryFields | array of string |
Zoeken naar mappen met behulp van specifieke velden. |
|
|
Queryoperator
|
queryOperator | string |
Zoek naar alle woorden of een van de woorden. |
|
|
Meer zoals deze (document-id's)
|
mlt | array of string |
Matrix van document-id's die moeten worden gebruikt als verwijzing voor vergelijkbare zoekopdrachten in documenten. |
|
|
Meer zoals deze (tekst)
|
mltt | array of string |
Matrix van tekstinhoud die moet worden gebruikt als verwijzing voor vergelijkbare documenten zoeken. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
results
|
results | array of object | |
|
Bestandsnaam
|
results.name | string | |
|
Bestandspad
|
results.path | string | |
|
MIME-type
|
results.type | string | |
|
Bestandsgrootte
|
results.size | integer | |
|
Fragment
|
results.snippet | string | |
|
HTML-fragment
|
results.snippet_html | string | |
|
Vermeldings-id
|
results.entry_id | string | |
|
Groeps-id
|
results.group_id | string | |
|
Laatst gewijzigd
|
results.last_modified | string | |
|
Geüpload door
|
results.uploaded_by | string | |
|
Geüpload op gebruikersnaam
|
results.uploaded_by_username | string | |
|
Aantal versies
|
results.num_versions | integer | |
|
Is map
|
results.is_folder | boolean | |
|
Aangepaste eigenschappen
|
results.custom_properties | array of object | |
|
Scope
|
results.custom_properties.scope | string | |
|
Namespace
|
results.custom_properties.namespace | string | |
|
Key
|
results.custom_properties.key | string | |
|
Waarde
|
results.custom_properties.value | string | |
|
Relevantiescore
|
results.score | number | |
|
Totaal aantal
|
total_count | integer | |
|
Aantal
|
count | integer | |
|
Heeft meer resultaten
|
hasMore | boolean |
Triggers
| Wanneer de machtiging voor het bestand of de map wordt gewijzigd |
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand of mapmachtigingen worden gewijzigd |
| Wanneer de metagegevens van het bestand of de map worden gewijzigd |
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand of mapmetagegevens worden gewijzigd |
| Wanneer de naam van een bestand wordt gewijzigd |
Met deze bewerking wordt een stroom geactiveerd wanneer de naam van een bestand in een map wordt gewijzigd. |
| Wanneer de naam van een map wordt gewijzigd |
Met deze bewerking wordt een stroom geactiveerd wanneer de naam van een submap in een map wordt gewijzigd. |
| Wanneer een bestand is ontgrendeld |
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand wordt ontgrendeld |
| Wanneer een bestand is vergrendeld |
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand is vergrendeld |
| Wanneer een bestand wordt bijgewerkt |
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand wordt bijgewerkt in een specifieke map |
| Wanneer een bestand wordt gekopieerd |
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een map wordt gekopieerd. |
| Wanneer een bestand wordt gemaakt (polling) |
Met deze bewerking wordt een stroom geactiveerd wanneer een nieuw bestand wordt gemaakt in een map. |
| Wanneer een bestand wordt gemaakt (webhook) |
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een specifieke map wordt gemaakt |
| Wanneer een bestand wordt verplaatst |
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een map wordt verplaatst. |
| Wanneer een bestand wordt verwijderd |
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een map wordt verwijderd. |
| Wanneer een groep wordt bijgewerkt |
Met deze bewerking wordt een stroom geactiveerd wanneer een groep wordt bijgewerkt |
| Wanneer een groep wordt gemaakt |
Met deze bewerking wordt een stroom geactiveerd wanneer een groep wordt gemaakt |
| Wanneer een groep wordt verwijderd |
Met deze bewerking wordt een stroom geactiveerd wanneer een groep wordt verwijderd |
| Wanneer een map niet is gemarkeerd als een project |
Met deze bewerking wordt een stroom geactiveerd wanneer een map niet is gemarkeerd als een project |
| Wanneer een map wordt gekopieerd |
Met deze bewerking wordt een stroom geactiveerd wanneer een submap wordt gekopieerd in een map. |
| Wanneer een map wordt gemaakt |
Met deze bewerking wordt een stroom geactiveerd wanneer een submap wordt gemaakt in een map. |
| Wanneer een map wordt verplaatst |
Met deze bewerking wordt een stroom geactiveerd wanneer een submap in een map wordt verplaatst. |
| Wanneer een map wordt verwijderd |
Met deze bewerking wordt een stroom geactiveerd wanneer een submap in een map wordt verwijderd. |
| Wanneer een project wordt bijgewerkt |
Met deze bewerking wordt een stroom geactiveerd wanneer een project wordt bijgewerkt |
| Wanneer een projectmap wordt gemaakt |
Met deze bewerking wordt een stroom geactiveerd wanneer een projectmap wordt gemaakt of wanneer een bestaande map is gemarkeerd als een projectmap |
| Wanneer een sharekoppeling wordt verwijderd |
Met deze bewerking wordt een stroom geactiveerd wanneer een sharekoppeling wordt verwijderd |
| Wanneer een werkstroom is voltooid |
Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom is voltooid |
| Wanneer een werkstroom voor het goedkeuringstype wordt geweigerd |
Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom voor het goedkeuringstype wordt geweigerd |
| Wanneer een werkstroom voor het goedkeuringstype wordt goedgekeurd |
Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom van het goedkeuringstype wordt goedgekeurd |
| Wanneer een werkstroom wordt gemaakt |
Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom wordt gemaakt |
| Wanneer er een sharekoppeling wordt gemaakt |
Met deze bewerking wordt een stroom geactiveerd wanneer een sharekoppeling wordt gemaakt |
Wanneer de machtiging voor het bestand of de map wordt gewijzigd
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand of mapmachtigingen worden gewijzigd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Cessionaris
|
assignee | string | |
|
Id van toegewezen gebruiker
|
assigneeId | number | |
|
Assigner
|
assigner | string | |
|
Toewijzings-id
|
assignerId | number | |
|
Mappad
|
folderPath | string | |
|
Nieuwe bevoegdheid
|
newPrivilege | string | |
|
Oude bevoegdheid
|
oldPrivilege | string | |
|
Groepsnaam
|
groupName | string |
Wanneer de metagegevens van het bestand of de map worden gewijzigd
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand of mapmetagegevens worden gewijzigd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Doelpad
|
targetPath | string | |
|
Id van doelgroep
|
targetGroupId | string | |
|
Namespace
|
namespace | string | |
|
Key
|
key | string | |
|
Handeling
|
action | string |
Wanneer de naam van een bestand wordt gewijzigd
Met deze bewerking wordt een stroom geactiveerd wanneer de naam van een bestand in een map wordt gewijzigd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id
|
id | integer |
De id van een afzonderlijke gebeurtenis. |
|
Tijdstempel
|
timestamp | string |
Het iso-8601 opgemaakte tijdstempel voor wanneer deze gebeurtenis is vastgelegd. |
|
Gebruikers-ID
|
actor | integer |
De numerieke id van de gebruiker die de actie heeft uitgevoerd. |
|
Handeling
|
action | string |
De actie die aan deze gebeurtenis is gekoppeld. |
|
Bestandspad
|
data.target_path | string |
Volledig pad naar het hernoemde bestand |
|
Versie-id
|
data.target_id | string |
De id van de specifieke versie van het bestand. |
|
Bestands-id
|
data.target_group_id | string |
De id die als geheel naar het bestand verwijst. |
|
Pad naar bronbestand
|
data.source_path | string |
Volledig oorspronkelijk pad naar het bestand. |
|
Is map
|
data.is_folder | boolean |
Of de resource een map is. (Waar of Onwaar) |
|
Actiebron
|
action_source | string |
De bron van de gebeurtenis. Bijvoorbeeld WebUI, Mobiel, enzovoort. |
|
Objectdetails
|
object_detail | string |
Objectdetails |
Wanneer de naam van een map wordt gewijzigd
Met deze bewerking wordt een stroom geactiveerd wanneer de naam van een submap in een map wordt gewijzigd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id
|
id | integer |
De id van een afzonderlijke gebeurtenis. |
|
Tijdstempel
|
timestamp | string |
Het iso-8601 opgemaakte tijdstempel voor wanneer deze gebeurtenis is vastgelegd. |
|
Gebruikers-ID
|
actor | integer |
De numerieke id van de gebruiker die de actie heeft uitgevoerd. |
|
Handeling
|
action | string |
De actie die aan deze gebeurtenis is gekoppeld. |
|
Mappad
|
data.target_path | string |
Volledig doelpad naar de map. |
|
Pad naar bronmap
|
data.source_path | string |
Volledig oorspronkelijk pad naar de map. |
|
Is map
|
data.is_folder | boolean |
Of de resource een map is. (Waar of Onwaar) |
|
Actiebron
|
action_source | string |
De bron van de gebeurtenis. Bijvoorbeeld WebUI, Mobiel, enzovoort. |
|
Objectdetails
|
object_detail | string |
Objectdetails |
Wanneer een bestand is ontgrendeld
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand wordt ontgrendeld
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar het doelbestand of de doelmap. |
Retouren
Wanneer een bestand is vergrendeld
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand is vergrendeld
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar het doelbestand of de doelmap. |
Retouren
Wanneer een bestand wordt bijgewerkt
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand wordt bijgewerkt in een specifieke map
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar het doelbestand of de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Id van bestandsvermelding
|
targetEntryId | string | |
|
Bestands-id
|
targetGroupId | string | |
|
Bestandspad
|
targetPath | string |
Wanneer een bestand wordt gekopieerd
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een map wordt gekopieerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id
|
id | integer |
De id van een afzonderlijke gebeurtenis. |
|
Tijdstempel
|
timestamp | string |
Het iso-8601 opgemaakte tijdstempel voor wanneer deze gebeurtenis is vastgelegd. |
|
Gebruikers-ID
|
actor | integer |
De numerieke id van de gebruiker die de actie heeft uitgevoerd. |
|
Handeling
|
action | string |
De actie die aan deze gebeurtenis is gekoppeld. |
|
Bestandspad
|
data.target_path | string |
Volledig pad naar het bestand. |
|
Versie-id
|
data.target_id | string |
De id van de specifieke versie van het bestand. |
|
Bestands-id
|
data.target_group_id | string |
De id die als geheel naar het bestand verwijst. |
|
Pad naar bronbestand
|
data.source_path | string |
Volledig oorspronkelijk pad naar het bestand. |
|
Versie-id van bronbestand
|
data.source_id | string |
Specifieke versie-id van bronbestand. |
|
Bronbestands-id
|
data.source_group_id | string |
De id van het bronbestand om als geheel naar het bestand te verwijzen. |
|
Is map
|
data.is_folder | boolean |
Of de resource een map is. (Waar of Onwaar) |
|
Actiebron
|
action_source | string |
De bron van de gebeurtenis. Bijvoorbeeld WebUI, Mobiel, enzovoort. |
|
Objectdetails
|
object_detail | string |
Objectdetails. |
Wanneer een bestand wordt gemaakt (polling)
Met deze bewerking wordt een stroom geactiveerd wanneer een nieuw bestand wordt gemaakt in een map.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id
|
id | integer |
De id van een gebeurtenis. |
|
Tijdstempel
|
timestamp | string |
Het iso-8601 opgemaakte tijdstempel voor wanneer deze gebeurtenis is vastgelegd. |
|
Gebruikers-ID
|
actor | integer |
De numerieke id van de gebruiker die de actie heeft uitgevoerd. |
|
Handeling
|
action | string |
De actie die aan deze gebeurtenis is gekoppeld. |
|
Bestandspad
|
data.target_path | string |
Volledig pad naar het bestand. |
|
Versie-id
|
data.target_id | string |
De id van de specifieke versie van het bestand. |
|
Bestands-id
|
data.target_group_id | string |
De id die als geheel naar het bestand verwijst. |
|
Is map
|
data.is_folder | boolean |
Of de resource een map is (Waar of Onwaar). |
|
Actiebron
|
action_source | string |
De bron van de gebeurtenis. Bijvoorbeeld WebUI, Mobiel, enzovoort. |
|
Objectdetails
|
object_detail | string |
Objectdetails. |
Wanneer een bestand wordt gemaakt (webhook)
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een specifieke map wordt gemaakt
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar het doelbestand of de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Id van bestandsvermelding
|
targetEntryId | string | |
|
Bestands-id
|
targetGroupId | string | |
|
Bestandspad
|
targetPath | string | |
|
Koppelings-URL uploaden
|
uploadLinkUrl | string |
Alleen beschikbaar als het bestand is geüpload via uploadkoppeling |
Wanneer een bestand wordt verplaatst
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een map wordt verplaatst.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id
|
id | integer |
De id van een afzonderlijke gebeurtenis. |
|
Tijdstempel
|
timestamp | string |
Het iso-8601 opgemaakte tijdstempel voor wanneer deze gebeurtenis is vastgelegd. |
|
Gebruikers-ID
|
actor | integer |
De numerieke id van de gebruiker die de actie heeft uitgevoerd. |
|
Handeling
|
action | string |
De actie die aan deze gebeurtenis is gekoppeld. |
|
Bestandspad
|
data.target_path | string |
Volledig pad naar het bestand. |
|
Versie-id
|
data.target_id | string |
De id van de specifieke versie van het bestand. |
|
Bestands-id
|
data.target_group_id | string |
De id die als geheel naar het bestand verwijst. |
|
Pad naar bronbestand
|
data.source_path | string |
Volledig oorspronkelijk pad naar het bestand. |
|
Is map
|
data.is_folder | boolean |
Of de resource een map is. (Waar of Onwaar) |
|
Actiebron
|
action_source | string |
De bron van de gebeurtenis. Bijvoorbeeld WebUI, Mobiel, enzovoort. |
|
Objectdetails
|
object_detail | string |
Objectdetails. |
Wanneer een bestand wordt verwijderd
Met deze bewerking wordt een stroom geactiveerd wanneer een bestand in een map wordt verwijderd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id
|
id | integer |
De id van een gebeurtenis. |
|
Tijdstempel
|
timestamp | string |
Het iso-8601 opgemaakte tijdstempel voor wanneer deze gebeurtenis is vastgelegd. |
|
Gebruikers-ID
|
actor | integer |
De numerieke id van de gebruiker die de actie heeft uitgevoerd. |
|
Handeling
|
action | string |
De actie die aan deze gebeurtenis is gekoppeld. |
|
Versiepad
|
data.target_path | string |
Volledig pad naar de specifieke bestandsversie. |
|
Bestands-id
|
data.target_group_id | string |
De id die als geheel naar het bestand verwijst. |
|
Is map
|
data.is_folder | boolean |
Of de resource een map is. (Waar of Onwaar) |
|
Actiebron
|
action_source | string |
De bron van de gebeurtenis. Bijvoorbeeld WebUI, Mobiel, enzovoort. |
Wanneer een groep wordt bijgewerkt
Met deze bewerking wordt een stroom geactiveerd wanneer een groep wordt bijgewerkt
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikers-ID
|
user.id | integer |
De unieke id van de gebruiker. |
|
Volledige naam
|
user.fullName | string |
Weergavenaam is de volledige naam van de gebruiker. |
|
Gebruikersnaam
|
user.userName | string |
De gebruikersnaam van de gebruiker. |
|
E-mail van gebruiker
|
user.email | string |
Het e-mailadres van de gebruiker. |
|
Gebruikers-ID
|
owner.id | integer |
De unieke id van de gebruiker. |
|
Volledige naam
|
owner.fullName | string |
Weergavenaam is de volledige naam van de gebruiker. |
|
Gebruikersnaam
|
owner.userName | string |
De gebruikersnaam van de gebruiker. |
|
E-mail van gebruiker
|
owner.email | string |
Het e-mailadres van de gebruiker. |
|
Groepsnaam
|
groupName | string |
De naam van de groep. |
|
Groeps-id
|
groupId | string |
De unieke id van de groep. |
|
Handeling
|
action | string |
De specifieke actie die de groepsupdate heeft geactiveerd. |
|
Members
|
members | array of GroupUser |
De leden van de groep. |
Wanneer een groep wordt gemaakt
Met deze bewerking wordt een stroom geactiveerd wanneer een groep wordt gemaakt
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikers-ID
|
user.id | integer |
De unieke id van de gebruiker. |
|
Volledige naam
|
user.fullName | string |
Weergavenaam is de volledige naam van de gebruiker. |
|
Gebruikersnaam
|
user.userName | string |
De gebruikersnaam van de gebruiker. |
|
E-mail van gebruiker
|
user.email | string |
Het e-mailadres van de gebruiker. |
|
Gebruikers-ID
|
owner.id | integer |
De unieke id van de gebruiker. |
|
Volledige naam
|
owner.fullName | string |
Weergavenaam is de volledige naam van de gebruiker. |
|
Gebruikersnaam
|
owner.userName | string |
De gebruikersnaam van de gebruiker. |
|
E-mail van gebruiker
|
owner.email | string |
Het e-mailadres van de gebruiker. |
|
Groepsnaam
|
groupName | string |
De naam van de groep. |
|
Groeps-id
|
groupId | string |
De unieke id van de groep. |
|
Members
|
members | array of GroupUser |
De leden van de groep. |
Wanneer een groep wordt verwijderd
Met deze bewerking wordt een stroom geactiveerd wanneer een groep wordt verwijderd
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikers-ID
|
user.id | integer |
De unieke id van de gebruiker. |
|
Volledige naam
|
user.fullName | string |
Weergavenaam is de volledige naam van de gebruiker. |
|
Gebruikersnaam
|
user.userName | string |
De gebruikersnaam van de gebruiker. |
|
E-mail van gebruiker
|
user.email | string |
Het e-mailadres van de gebruiker. |
|
Groepsnaam
|
groupName | string |
De naam van de groep. |
|
Groeps-id
|
groupId | string |
De unieke id van de groep. |
Wanneer een map niet is gemarkeerd als een project
Met deze bewerking wordt een stroom geactiveerd wanneer een map niet is gemarkeerd als een project
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
- Body
- FolderProjectCommon
Wanneer een map wordt gekopieerd
Met deze bewerking wordt een stroom geactiveerd wanneer een submap wordt gekopieerd in een map.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id
|
id | integer |
De id van een afzonderlijke gebeurtenis. |
|
Tijdstempel
|
timestamp | string |
Het iso-8601 opgemaakte tijdstempel voor wanneer deze gebeurtenis is vastgelegd. |
|
Gebruikers-ID
|
actor | integer |
De numerieke id van de gebruiker die de actie heeft uitgevoerd. |
|
Handeling
|
action | string |
De actie die aan deze gebeurtenis is gekoppeld. |
|
Mappad
|
data.target_path | string |
Volledig doelpad naar de map |
|
Pad naar bronmap
|
data.source_path | string |
Volledig oorspronkelijk pad naar de map |
|
Is map
|
data.is_folder | boolean |
Of de resource een map is (waar of onwaar) |
|
Actiebron
|
action_source | string |
De bron van de gebeurtenis. Bijvoorbeeld WebUI, Mobiel, enzovoort. |
|
Objectdetails
|
object_detail | string |
Objectdetails |
Wanneer een map wordt gemaakt
Met deze bewerking wordt een stroom geactiveerd wanneer een submap wordt gemaakt in een map.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id
|
id | integer |
De id van een gebeurtenis. |
|
Tijdstempel
|
timestamp | string |
Het iso-8601 opgemaakte tijdstempel voor wanneer deze gebeurtenis is vastgelegd. |
|
Gebruikers-ID
|
actor | integer |
De numerieke id van de gebruiker die de actie heeft uitgevoerd. |
|
Handeling
|
action | string |
De actie die aan deze gebeurtenis is gekoppeld. |
|
Mappad
|
data.target_path | string |
Het volledige pad naar de map. |
|
Is map
|
data.is_folder | boolean |
Of de resource een map is. (Waar of Onwaar) |
|
Actiebron
|
action_source | string |
De bron van de gebeurtenis. Bijvoorbeeld WebUI, Mobiel, enzovoort. |
|
Objectdetails
|
object_detail | string |
Objectdetails. |
Wanneer een map wordt verplaatst
Met deze bewerking wordt een stroom geactiveerd wanneer een submap in een map wordt verplaatst.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id
|
id | integer |
De id van een afzonderlijke gebeurtenis. |
|
Tijdstempel
|
timestamp | string |
Het iso-8601 opgemaakte tijdstempel voor wanneer deze gebeurtenis is vastgelegd. |
|
Gebruikers-ID
|
actor | integer |
De numerieke id van de gebruiker die de actie heeft uitgevoerd. |
|
Handeling
|
action | string |
De actie die aan deze gebeurtenis is gekoppeld. |
|
Mappad
|
data.target_path | string |
Volledig doelpad naar de map. |
|
Pad naar bronmap
|
data.source_path | string |
Volledig oorspronkelijk pad naar de map. |
|
Is map
|
data.is_folder | boolean |
Of de resource een map is. (Waar of Onwaar) |
|
Actiebron
|
action_source | string |
De bron van de gebeurtenis. Bijvoorbeeld WebUI, Mobiel, enzovoort. |
|
Objectdetails
|
object_detail | string |
Objectdetails |
Wanneer een map wordt verwijderd
Met deze bewerking wordt een stroom geactiveerd wanneer een submap in een map wordt verwijderd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenis-id
|
id | integer |
De id van een gebeurtenis. |
|
Tijdstempel
|
timestamp | string |
Het iso-8601 opgemaakte tijdstempel voor wanneer deze gebeurtenis is vastgelegd. |
|
Gebruikers-ID
|
actor | integer |
De numerieke id van de gebruiker die de actie heeft uitgevoerd. |
|
Handeling
|
action | string |
De actie die aan deze gebeurtenis is gekoppeld. |
|
Mappad
|
data.target_path | string |
Volledig pad naar de verwijderde map. |
|
Is map
|
data.is_folder | boolean |
Of de resource een map is. (Waar of Onwaar) |
|
Actiebron
|
action_source | string |
De bron van de gebeurtenis. Bijvoorbeeld WebUI, Mobiel, enzovoort. |
Wanneer een project wordt bijgewerkt
Met deze bewerking wordt een stroom geactiveerd wanneer een project wordt bijgewerkt
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
project-id
|
projectId | string | |
|
projectRootFolderId
|
projectRootFolderId | string | |
|
Projectnaam
|
name | string | |
|
Projectlocatie
|
location | string | |
|
Projectstatus
|
status | string |
Projectstatus (IN BEHANDELING, WORDT UITGEVOERD, IN BEWARING, VOLTOOID, GEANNULEERD) |
Wanneer een projectmap wordt gemaakt
Met deze bewerking wordt een stroom geactiveerd wanneer een projectmap wordt gemaakt of wanneer een bestaande map is gemarkeerd als een projectmap
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
- Body
- FolderProjectCommon
Wanneer een sharekoppeling wordt verwijderd
Met deze bewerking wordt een stroom geactiveerd wanneer een sharekoppeling wordt verwijderd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
- Body
- LinkWebhookResponse
Wanneer een werkstroom is voltooid
Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom is voltooid
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Werkstroom-id
|
workflow.id | string | |
|
Werkstroomnaam
|
workflow.name | string | |
|
Weergave-id van werkstroom
|
workflow.displayId | number | |
|
Werkstroomtype
|
workflow.type | string | |
|
Werkstroomsjabloon-id
|
workflow.templateId | string | |
|
Status van werkstroomactie
|
workflow.actionStatus | string | |
|
Eerste entiteitstype
|
firstEntity.type | string | |
|
Eerste entiteitspad
|
firstEntity.filePath | string | |
|
Eerste entiteitsvermeldings-id
|
firstEntity.entryID | string | |
|
Eerste entiteitsgroep-id
|
firstEntity.groupID | string | |
|
Voltooiingsstatuscode
|
completionStatusCode | string | |
|
Totaal aantal stappen
|
totalNumberOfSteps | number | |
|
Voltooiingsdatum
|
completionDate | number |
Wanneer een werkstroom voor het goedkeuringstype wordt geweigerd
Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom voor het goedkeuringstype wordt geweigerd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
- Body
- WorkflowStepResponse
Wanneer een werkstroom voor het goedkeuringstype wordt goedgekeurd
Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom van het goedkeuringstype wordt goedgekeurd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
- Body
- WorkflowStepResponse
Wanneer een werkstroom wordt gemaakt
Met deze bewerking wordt een stroom geactiveerd wanneer een werkstroom wordt gemaakt
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Werkstroom-id
|
workflow.id | string | |
|
Werkstroomnaam
|
workflow.name | string | |
|
Weergave-id van werkstroom
|
workflow.displayId | number | |
|
Werkstroomtype
|
workflow.type | string | |
|
Werkstroomsjabloon-id
|
workflow.templateId | string | |
|
Status van werkstroomactie
|
workflow.actionStatus | string | |
|
Eerste entiteitstype
|
firstEntity.type | string | |
|
Eerste entiteitspad
|
firstEntity.filePath | string | |
|
Eerste entiteitsvermeldings-id
|
firstEntity.entryID | string | |
|
Eerste entiteitsgroep-id
|
firstEntity.groupID | string | |
|
JSON-definitie
|
definitionJson | string |
Wanneer er een sharekoppeling wordt gemaakt
Met deze bewerking wordt een stroom geactiveerd wanneer een sharekoppeling wordt gemaakt
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Mappad
|
FolderPath | True | string |
Het pad naar de doelmap. |
Retouren
- Body
- LinkWebhookResponse
Definities
GroupUser
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikers-ID
|
id | integer |
De unieke id van de gebruiker. |
|
Volledige naam
|
fullName | string |
Weergavenaam is de volledige naam van de gebruiker. |
|
Gebruikersnaam
|
userName | string |
De gebruikersnaam van de gebruiker. |
|
E-mail van gebruiker
|
string |
Het e-mailadres van de gebruiker. |
LinkWebhookResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bronpad
|
sourcePath | string | |
|
Koppelings-id
|
linkId | string | |
|
Koppelingstype
|
linkType | string |
Map of bestand |
|
URL van koppeling
|
linkURL | string |
FileInfoResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Checksum
|
checksum | string |
Controlesomwaarde van de huidige versie van het bestand dat wordt gebruikt om bestandswijzigingen te bepalen. |
|
Grootte
|
size | integer |
Grootte van het bestand in bytes. |
|
Bestandspad
|
path | string |
Volledig pad van het bestand. |
|
Naam
|
name | string |
Naam van het bestand. |
|
Is vergrendeld
|
locked | boolean |
Status van de vergrendeling van het bestand. |
|
Is de map
|
is_folder | boolean |
Of de resource een map is. Waar of onwaar |
|
Versie-id
|
entry_id | string |
De id van de huidige versie van het bestand. |
|
Bestands-id
|
group_id | string |
De id die als geheel naar het bestand verwijst. |
|
Id van bovenliggende map
|
parent_id | string |
De id van de bovenliggende map die is aangevraagd. |
|
Laatst gewijzigd
|
last_modified | string |
Laatst gewijzigd tijdstip van de huidige versie van een bestand. |
|
Geüpload door
|
uploaded_by | string |
Gebruikersnaam van de gebruiker die de huidige versie heeft geüpload. |
|
Geüploade tijdstempel
|
uploaded | integer |
Geüploade tijd van de huidige versie van het bestand. |
|
Aantal versies
|
num_versions | integer |
Het totale aantal versies dat is gekoppeld aan het specifieke bestandspad. |
|
versions
|
versions | array of object |
Versions |
|
Is map (versie)
|
versions.is_folder | boolean |
Of de resource een map is. Waar of onwaar |
|
Versie-id
|
versions.entry_id | string |
De id van de specifieke versie van het bestand. |
|
Controlesom (versie)
|
versions.checksum | string |
Controlesomwaarde van de versie van het bestand dat wordt gebruikt om bestandswijzigingen te bepalen. |
|
Laatst gewijzigd (versie)
|
versions.last_modified | string |
Laatst gewijzigd tijdstip van de specifieke versie van een bestand. |
|
Geüpload door (versie)
|
versions.uploaded_by | string |
Gebruikersnaam van de gebruiker die de versie heeft geüpload. |
|
Geüploade tijdstempel (versie)
|
versions.uploaded | integer |
Geüploade tijd van de specifieke versie van het bestand. |
|
Grootte (versie)
|
versions.size | integer |
De grootte van het bestand in bytes voor de specifieke versie. |
UserInfoResponse
Gebruikersgegevens
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikers-ID
|
id | integer |
De gebruikers-id |
|
Gebruikersnaam
|
userName | string |
De gebruikersnaam van de gebruiker |
|
Externe ID
|
externalId | string |
Externe ID |
|
E-mailen
|
string |
E-mail van gebruiker |
|
|
Achternaam
|
name.familyName | string |
Gebruikersnaam (achternaam) |
|
Voornaam
|
name.givenName | string |
Door de gebruiker opgegeven naam (voornaam) |
|
Active
|
active | boolean |
Is het gebruikersaccount actief |
|
Aanmaakdatum
|
createdDate | string |
De datum waarop de gebruiker is gemaakt |
|
Datum van laatste wijziging
|
lastModificationDate | string |
De laatste datum waarop de gebruiker is gewijzigd |
|
Laatste actieve datum
|
lastActiveDate | string |
De laatste datum waarop de gebruiker actief was |
|
Vergrendeld
|
locked | boolean |
Gebruiker is vergrendeld |
|
Language
|
language | string |
De parameter 'language' wordt alleen geaccepteerd wanneer Language Pack is ingeschakeld voor het domein. |
|
Verificatietype
|
authType | string |
Het verificatietype voor de gebruiker. |
|
Gebruikerstype
|
userType | string |
Het type gebruiker. |
|
Rol
|
role | string |
De rol die is toegewezen aan de gebruiker. Alleen van toepassing op Power Users. |
|
IDP-gebruikers-id
|
idpUserId | string |
Gebruikers-id van id-provider |
|
Is serviceaccount
|
isServiceAccount | boolean |
Wordt het account gebruikt als serviceaccount |
|
Verwijderen na verloop van tijd
|
deleteOnExpiry | string |
Wordt het account verwijderd nadat het is verlopen |
|
E-mailwijziging in behandeling
|
emailChangePending | boolean |
Is de wijziging van de e-mail van de gebruiker in behandeling |
|
Vervaldatum
|
expiryDate | string |
De vervaldatum van het account |
|
Hoofdgebruikersnaam
|
userPrincipalName | string | |
|
groups
|
groups | array of object | |
|
Weergavenaam
|
groups.displayName | string |
De naam van de groep |
|
Groeps-id
|
groups.value | string |
De id van de groep |
UserListResponse
Antwoord gebruikerslijst ophalen
| Name | Pad | Type | Description |
|---|---|---|---|
|
Totaal aantal resultaten
|
totalResults | integer |
Het totale aantal resultaten dat overeenkomt met de query. |
|
Items per pagina
|
itemsPerPage | integer |
Het aantal geretourneerde resultaten. |
|
Index starten
|
startIndex | integer |
De op 1 gebaseerde index van het eerste resultaat in de huidige set resultaten. |
|
resources
|
resources | array of object | |
|
Gebruikers-ID
|
resources.id | integer |
De id van de gebruiker |
|
Gebruikersnaam
|
resources.userName | string |
De gebruikersnaam van de gebruiker |
|
Externe ID
|
resources.externalId | string |
Externe ID |
|
E-mailen
|
resources.email | string |
E-mail van gebruiker |
|
Opgemaakte naam
|
resources.name.formatted | string |
Door de gebruiker opgemaakte naam |
|
Achternaam
|
resources.name.familyName | string |
Gebruikersnaam (achternaam) |
|
Voornaam
|
resources.name.givenName | string |
Door de gebruiker opgegeven naam (voornaam) |
|
Active
|
resources.active | boolean |
Is het gebruikersaccount actief |
|
Vergrendeld
|
resources.locked | boolean |
Is het gebruikersaccount vergrendeld |
|
Aanmaakdatum
|
resources.createdDate | string |
De datum waarop de gebruiker is gemaakt |
|
Datum van laatste wijziging
|
resources.lastModificationDate | string |
De laatste datum waarop de gebruiker is gewijzigd |
|
Laatste actieve datum
|
resources.lastActiveDate | string |
De laatste datum waarop de gebruiker actief was |
|
Language
|
resources.language | string |
De parameter 'language' wordt alleen geaccepteerd wanneer Language Pack is ingeschakeld voor het domein. |
|
Verificatietype
|
resources.authType | string |
Het verificatietype voor de gebruiker. |
|
Gebruikerstype
|
resources.userType | string |
Het type gebruiker. |
|
Rol
|
resources.role | string |
De rol die is toegewezen aan de gebruiker. Alleen van toepassing op Power Users. |
|
IDP-gebruikers-id
|
resources.idpUserId | string |
Gebruikers-id van id-provider |
|
Is serviceaccount
|
resources.isServiceAccount | boolean |
Wordt het account gebruikt als serviceaccount |
|
Verwijderen na verloop van tijd
|
resources.deleteOnExpiry | string |
Wordt het account verwijderd nadat het is verlopen |
|
E-mailwijziging in behandeling
|
resources.emailChangePending | boolean |
Is de wijziging van de e-mail van de gebruiker in behandeling |
|
Vervaldatum
|
resources.expiryDate | string |
De vervaldatum van het account |
|
Hoofdgebruikersnaam
|
resources.userPrincipalName | string |
FolderInfoResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naam
|
name | string |
Naam van de map. |
|
Laatst gewijzigd
|
lastModified | integer |
De laatste keer dat een bestand in de map (maar niet binnen submappen) is gewijzigd. |
|
Geüploade tijdstempel
|
uploaded | integer |
Tijdstip waarop de map is geüpload of gemaakt. |
|
Mappad
|
path | string |
Volledig pad naar de map. |
|
Map-id
|
folder_id | string |
De unieke id van de map. |
|
Id van bovenliggende map
|
parent_id | string |
De id van de bovenliggende map. |
|
Aantal subitems
|
total_count | integer |
Het totale aantal items dat daadwerkelijk beschikbaar is om te retourneren. |
|
Is de map
|
is_folder | boolean |
Of de resource een map is. Waar of onwaar |
|
Mogelijke openbare koppelingen
|
public_links | string |
De instelling van de mapoptie voor het instellen van 'Openbare koppelingen uit deze map toestaan' is ingesteld. |
|
Kan worden gedeeld
|
allow_links | boolean |
Is deelbaar? T of F |
|
Kan worden verwijderd of verplaatst
|
restrict_move_delete | boolean |
Kan worden verwijderd of verplaatst? T of F |
|
Mappen
|
folders | array of object |
Mappen |
|
Naam (submap)
|
folders.name | string |
Naam van de map. |
|
Laatst gewijzigd (submap)
|
folders.lastModified | integer |
De laatste keer dat een bestand in de map (maar niet binnen submappen) is gewijzigd. |
|
Geüploade tijdstempel (submap)
|
folders.uploaded | integer |
Tijdstip waarop de map is geüpload of gemaakt. |
|
Pad (submap)
|
folders.path | string |
Het volledige pad van de map zoals aangevraagd. |
|
Id (submap)
|
folders.folder_id | string |
De id van de aangevraagde map. |
|
Is map (submap)
|
folders.is_folder | boolean |
Of de resource een map is. Waar of onwaar |
|
Bovenliggende map-id (submap)
|
folders.parent_id | string |
De id van de bovenliggende map. |
|
files
|
files | array of object |
Files |
|
Controlesom (bestand)
|
files.checksum | string |
Controlesomwaarde van de huidige versie van het bestand dat wordt gebruikt om bestandswijzigingen te bepalen. |
|
Grootte (bestand)
|
files.size | integer |
Grootte van het bestand in bytes. |
|
Pad (bestand)
|
files.path | string |
Volledig pad van het bestand. |
|
Naam (bestand)
|
files.name | string |
Naam van het bestand. |
|
Is vergrendeld (bestand)
|
files.locked | boolean |
Status van de vergrendeling van het bestand. |
|
Is map (bestand)
|
files.is_folder | boolean |
Of de resource een map is. Waar of onwaar |
|
Versie-id (bestand)
|
files.entry_id | string |
De id van de specifieke versie van het bestand. |
|
Id (bestand)
|
files.group_id | string |
De id die als geheel naar het bestand verwijst. |
|
Bovenliggende map-id (bestand)
|
files.parent_id | string |
De id van de bovenliggende map. |
|
Laatst gewijzigd (bestand)
|
files.last_modified | string |
Laatst gewijzigd tijdstip van de huidige versie van een bestand. |
|
Geüpload door (bestand)
|
files.uploaded_by | string |
Gebruikersnaam van de gebruiker die de versie heeft geüpload. |
|
Geüploade tijdstempel (bestand)
|
files.uploaded | integer |
Geüploade tijd van de huidige versie van het bestand. |
|
Aantal versies (bestand)
|
files.num_versions | integer |
Het totale aantal versies dat is gekoppeld aan het specifieke bestandspad. |
NaamruimteItem
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naamruimtenaam
|
name | string | |
|
Bereik van naamruimte
|
scope | string | |
|
toetsen/sleutels
|
keys | object | |
|
displayName
|
displayName | string |
De naam om de naamruimte in de gebruikersinterface te identificeren |
|
priority
|
priority | number |
Hiermee geeft u de prioriteit (volgorde) voor de sleutels. De sleutels worden weergegeven in aflopende volgorde (sleutels met een hogere prioriteit worden eerst weergegeven) |
|
Overneembare
|
inheritable | boolean | |
|
schemaSystemGenerated
|
schemaSystemGenerated | boolean | |
|
metadataScopeType
|
metadataScopeType | string | |
|
bewerkbaar
|
editable | boolean |
ProjectItem
| Name | Pad | Type | Description |
|---|---|---|---|
|
Identiteitsbewijs
|
id | string |
Item-id |
|
Hoofdmap-id
|
rootFolderId | string |
Hoofdmap-id |
|
Naam
|
name | string |
De naam van het project |
|
Project-id
|
projectId | string |
Id van het project |
|
Klantnaam
|
customerName | string |
De klant die is gekoppeld aan het project |
|
Description
|
description | string |
Beschrijving van map |
|
location
|
location | ProjectLocationItem | |
|
Toestand
|
status | string |
Status van het project |
|
Gemaakt door
|
createdBy | number |
Gemaakt door |
|
Laatst bijgewerkt door
|
lastUpdatedBy | number |
Laatst bijgewerkt door |
|
Aanmaaktijd
|
creationTime | string |
Aanmaaktijd |
|
Tijdstip laatst gewijzigd
|
lastModifiedTime | string |
Tijdstip laatst gewijzigd |
|
Begindatum
|
startDate | string |
De begindatum van het project. |
|
Voltooiingsdatum
|
completionDate | string |
De voltooiingsdatum voor het project. |
ProjectLocationItem
| Name | Pad | Type | Description |
|---|---|---|---|
|
Adres 1
|
streetAddress1 | string |
Eerste regel van het adres |
|
Adres 2
|
streetAddress2 | string |
Tweede regel van het adres |
|
City
|
city | string |
City |
|
Staat of provincie
|
state | string |
Staat of provincie |
|
Country
|
country | string |
Country |
|
Postcode of postcode
|
postalCode | string |
Postcode of postcode |
FileLockWebhookResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bestands-id
|
targetGroupId | string | |
|
Bestandscontrolesom
|
targetFileChecksum | string | |
|
Bestandspad
|
targetPath | string |
FolderProjectCommon
| Name | Pad | Type | Description |
|---|---|---|---|
|
project-id
|
projectId | string | |
|
projectRootFolderId
|
projectRootFolderId | string |
WorkflowStepResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Werkstroom-id
|
workflow.id | string | |
|
Werkstroomnaam
|
workflow.name | string | |
|
Weergave-id van werkstroom
|
workflow.displayId | number | |
|
Werkstroomtype
|
workflow.type | string | |
|
Werkstroomsjabloon-id
|
workflow.templateId | string | |
|
Status van werkstroomactie
|
workflow.actionStatus | string | |
|
Eerste entiteitstype
|
firstEntity.type | string | |
|
Eerste entiteitspad
|
firstEntity.filePath | string | |
|
Eerste entiteitsvermeldings-id
|
firstEntity.entryID | string | |
|
Eerste entiteitsgroep-id
|
firstEntity.groupID | string | |
|
Stap-id
|
step.id | string | |
|
Stapnaam
|
step.name | string | |
|
Staptype
|
step.type | string | |
|
Id van toegewezen gebruiker
|
assignee.id | number | |
|
Weergavenaam van toegewezen gebruiker
|
assignee.displayName | string | |
|
Gebruikersnaam van toegewezen gebruiker
|
assignee.username | string | |
|
E-mailadres van toegewezen gebruiker
|
assignee.email | string | |
|
Totaal aantal stappen
|
totalNumberOfSteps | number | |
|
Voltooiingsdatum
|
completionDate | number | |
|
Aanmaakdatum
|
creationDate | number |
AIQuestionResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
response
|
response | AIResponse | |
|
Citaten
|
citations | array of AICitation |
Bronvermeldingen en verwijzingen die worden gebruikt bij het genereren van het antwoord |
AISummaryResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
response
|
response | AIResponse |
AICopilotResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
response
|
response | AIResponse | |
|
Citaten
|
citations | array of AICitation |
Bronvermeldingen en verwijzingen die worden gebruikt bij het genereren van het antwoord |
|
Gespreks-id
|
conversationId | string |
Unieke id voor het gesprek |
AICitation
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bestandsnaam
|
filename | string |
Naam van het bronbestand |
|
Vermeldings-id
|
entryId | string |
Vermeldings-id van het bronbestand |
|
Tekstsegmenten
|
chunks | array of object |
Matrix van tekstsegmenten uit de bron |
|
Segment-id
|
chunks.chunkId | string |
Id van het tekstsegment |
|
Brontekst
|
chunks.sourceText | string |
Tekstinhoud van het segment |
AIResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Antwoordtekst
|
text | string |
De door AI gegenereerde antwoordtekst |