Egnyte
Egnyte est un service qui assure la sécurité, la synchronisation et le partage de vos fichiers. Connectez-vous à Egnyte pour gérer vos fichiers. Vous pouvez effectuer différentes actions telles que le chargement, la mise à jour, l’obtention et la suppression de fichiers dans Egnyte.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Prise en charge d’Egnyte |
| URL | https://helpdesk.egnyte.com |
| Messagerie électronique | support@egnyte.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Egnyte |
| Site internet | https://egnyte.com/ |
| Politique de confidentialité | https://www.egnyte.com/privacy-policy |
| Catégories | Collaboration; Productivité |
Egnyte
Egnyte est une plateforme de collaboration de contenu qui assure la sécurité, la synchronisation et le partage de vos fichiers. Connectez-vous à Egnyte pour gérer vos fichiers. Vous pouvez effectuer différentes actions telles que le chargement, le déplacement, le téléchargement et la suppression de fichiers dans Egnyte.
Conditions préalables
Pour utiliser le connecteur, vous devez être un utilisateur Egnyte.
Actions prises en charge
Le connecteur prend en charge les actions suivantes :
Create group: Créer un groupe dans Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-GroupGet group details: Récupérer les informations de groupe à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-GroupGet list of all groups: Récupérez la liste des groupes. https://developers.egnyte.com/api-docs/read/group-management#List-GroupsGet user details: récupérez les informations relatives à l’utilisateur par ID. Pour en savoir plus: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-UserGet list of all users: Récupérez les informations sur les utilisateurs. Pour en savoir plus: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-ListUpdate user by ID: Mettez à jour l’utilisateur unique. Pour en savoir plus: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-UserCreate user: Créez un utilisateur dans Egnyte. Pour en savoir plus: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-UserDelete user by ID: supprimer un utilisateur d’Egnyte. Pour en savoir plus: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-UserCreate folder: Créez un dossier dans Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-FolderDelete file by path: supprimez un fichier à l’aide d’un chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-FolderDelete folder by path: supprimez un dossier à l’aide d’un chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-FolderDelete folder by ID: supprimez un dossier à l’aide d’un ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-FolderDelete file by ID: supprimez un fichier à l’aide d’un ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-FolderCopy file by path: copiez un fichier à l’aide d’un chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-FolderCopy folder by path: copiez un dossier à l’aide d’un chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-FolderFull group update: remplacez tous les attributs d’un groupe. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-GroupPartial group update: Mettez à jour des attributs spécifiques d’un groupe. https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-GroupDelete group: Supprimez un groupe par ID. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-GroupCopy file by ID: copiez un fichier à l’aide d’un ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-FolderCopy folder by ID: copiez un dossier à l’aide d’un ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-FolderMove file by path: Déplacez un fichier dans Egnyte à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-FolderMove folder by path: Déplacez un dossier dans Egnyte à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-FolderMove file by ID: Déplacez un fichier dans Egnyte à l’aide de l’ID de fichier. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-FolderMove folder by ID: Déplacer un dossier à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-FolderShare file: Partagez un fichier dans Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-LinkShare folder: Partagez un dossier dans Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-LinkGet file info by path: Récupérer les informations de fichier à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentationGet folder info by path: Récupérer les informations de dossier à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentationModify folder options: Modifiez les options de dossier telles que la description, les paramètres de partage de liens, les autorisations de lien public, les restrictions de déplacement/suppression et les préférences de notification par e-mail. https://developers.egnyte.com/api-docs/read/folder-options-apiGet file info by ID: Récupérer les informations de fichier à l’aide de l’ID de fichier. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentationGet folder info by ID: Récupérer les informations de dossier à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentationLock file by path: Verrouiller le fichier à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-FileUnlock file by path: déverrouiller le fichier à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-FileLock file by ID: Verrouiller le fichier à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-FileUnlock file by ID: Déverrouiller le fichier à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-FileGet file content by path: récupère le contenu du fichier d’Egnyte à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-FileGet file content by ID: récupère le contenu du fichier d’Egnyte à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-FileCreate file: charge un fichier dans Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-FileSet metadata by file ID: écrivez des métadonnées dans un fichier à l’aide de l’ID de fichier. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-NamespaceSet metadata by folder ID: écrivez des métadonnées dans un dossier à l’aide de l’ID de dossier. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-NamespaceGet all namespaces: Obtenez une liste de tous les espaces de noms de métadonnées personnalisés dans le domaine. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-NamespacesCreate namespace: Créez un espace de noms dans Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-NamespaceUpdate namespace attributes: met à jour les attributs d’espace de noms. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-AttributesUpdate namespace keys: Mettez à jour la clé d’une métadonnées personnalisée pour un domaine. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-KeysGet namespace: répertorie toutes les clés de métadonnées personnalisées qui ont été créées dans un espace de noms donné. https://developers.egnyte.com/api-docs/read/metadata-api#Get-NamespaceDelete namespace: Supprimez un espace de noms spécifié. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-NamespaceGet all projects: répertorie tous les dossiers de projet dans le domaine. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-ProjectsMark folder as project: marquez un dossier existant en tant que projet. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-ProjectCreate project from template: Créez un projet à partir d’un modèle de dossier de projet. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-TemplateGet project by ID: Récupérer un projet à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-IDUpdate project by ID: met à jour les propriétés spécifiées d’un projet identifié par son ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-ProjectDelete project by ID: supprimez un projet en fonction de son ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-ProjectGet project by root folder ID: Récupérez un projet en fonction de son ID de dossier racine. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-FolderClean up project by ID: ce point de terminaison lance un nettoyage dans un projet et supprime ou désactive éventuellement les utilisateurs spécifiés. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-ProjectCreate metadata key: Ajoutez une clé de métadonnées à un espace de noms existant. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-KeyDelete metadata key: supprimez une clé de métadonnées d’un espace de noms existant. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-KeyGet metadata by file ID: obtenir des métadonnées à partir d’un fichier à l’aide de l’ID de fichier. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-NamespaceGet metadata by folder ID: obtenir des métadonnées à partir d’un dossier à l’aide de l’ID de dossier. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-NamespaceSearch V1: recherchez le contenu stocké dans Egnyte en fonction des noms de fichiers, des métadonnées et du contenu texte. https://developers.egnyte.com/api-docs/read/search-api#Search-v1Search V2: recherchez du contenu avec des fonctionnalités de recherche avancées. https://developers.egnyte.com/api-docs/read/search-api#Search-v2Search metadata: recherchez des éléments avec un champ ou une valeur de métadonnées spécifique. https://developers.egnyte.com/api-docs/read/metadata-api#Search-MetadataGet effective permissions: Obtenir des autorisations effectives pour un utilisateur. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-UserSet folder permissions: définissez des autorisations pour un dossier. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-PermissionsGet folder permissions: Obtenir des autorisations pour un dossier. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-PermissionsDeep link by ID: Créez un lien profond pour le fichier ou le dossier par ID. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-FoldersDeep link by path: Créez un lien profond pour le fichier ou le dossier par chemin d’accès. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-FoldersList all links: répertorie tous les liens à l’exception des liens supprimés. Notez que si l’utilisateur exécutant cette méthode n’est pas un administrateur, seuls les liens créés par l’utilisateur sont répertoriés. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-LinksList all links V2: répertorie tous les liens. Notez que si l’utilisateur exécutant cette méthode n’est pas un administrateur, seuls les liens créés par l’utilisateur sont répertoriés. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2Show link details: affichez les détails d’un lien. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-DetailsCreate link: Créez un lien. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-LinkDelete link: Supprimer un lien. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link[AI] Ask a question about a document: Posez des questions relatives à un document donné, en fournissant une réponse basée sur l’IA basée sur le contenu du document. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question[AI] Generate a summary for a document: Générez un résumé pour un document donné, fournissant une réponse basée sur l’IA basée sur le contenu du document. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document[AI] Ask a question to Egnyte Copilot: Posez des questions au copilote de la plateforme, en fournissant une réponse basée sur l’IA basée sur le contenu global au sein de votre domaine Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot
Déclencheurs pris en charge
Le connecteur prend en charge les déclencheurs suivants :
-
When a file is locked: cette opération déclenche un flux lorsqu’un fichier est verrouillé -
When a file is unlocked: cette opération déclenche un flux lorsqu’un fichier est déverrouillé -
When a file is updated: cette opération déclenche un flux lorsqu’un fichier est mis à jour dans un dossier spécifique -
When a file is created (webhook): cette opération déclenche un flux lorsqu’un fichier crée dans un dossier spécifique -
When a share link is created: cette opération déclenche un flux lorsqu’un lien de partage est créé -
When a share link is deleted: cette opération déclenche un flux lorsqu’un lien de partage est supprimé -
When the file or folder permission changes: cette opération déclenche un flux lorsqu’un fichier ou un dossier autorisations change -
When the file or folder metadata changes: cette opération déclenche un flux lorsqu’un fichier ou une métadonnées de dossier change -
When a project folder is created: cette opération déclenche un flux lorsqu’un dossier de projet est créé ou lorsqu’un dossier existant est marqué comme dossier de projet -
When a folder is unmarked as a project: cette opération déclenche un flux lorsqu’un dossier n’est pas balisé en tant que projet -
When a project is updated: cette opération déclenche un flux lorsqu’un projet est mis à jour -
When a workflow is created: cette opération déclenche un flux lors de la création d’un flux de travail -
When a workflow is completed: cette opération déclenche un flux lorsqu’un flux de travail est terminé -
When an approval type workflow is approved: cette opération déclenche un flux lorsqu’un flux de travail de type d’approbation est approuvé -
When an approval type workflow is rejected: cette opération déclenche un flux lorsqu’un flux de travail de type d’approbation est rejeté -
When a group is created: cette opération déclenche un flux lors de la création d’un groupe -
When a group is updated: cette opération déclenche un flux lorsqu’un groupe est mis à jour -
When a group is deleted: cette opération déclenche un flux lorsqu’un groupe est supprimé -
When a file is created (polling): cette opération déclenche un flux lorsqu’un nouveau fichier est créé dans un dossier. -
When a folder is created: cette opération déclenche un flux lorsqu’un sous-dossier est créé dans un dossier. -
When a file is deleted: cette opération déclenche un flux lorsqu’un fichier est supprimé dans un dossier. -
When a folder is deleted: cette opération déclenche un flux lorsqu’un sous-dossier est supprimé dans un dossier. -
When a file is renamed: cette opération déclenche un flux lorsqu’un fichier est renommé dans un dossier. -
When a folder is renamed: cette opération déclenche un flux lorsqu’un sous-dossier est renommé dans un dossier. -
When a file is moved: cette opération déclenche un flux lorsqu’un fichier est déplacé dans un dossier. -
When a folder is moved: cette opération déclenche un flux lorsqu’un sous-dossier est déplacé dans un dossier. -
When a file is copied: cette opération déclenche un flux lorsqu’un fichier est copié dans un dossier. -
When a folder is copied: cette opération déclenche un flux lorsqu’un sous-dossier est copié dans un dossier.
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
[IA] Générer un résumé pour un document
Générez un résumé pour un document donné, fournissant une réponse basée sur l’IA basée sur le contenu du document. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’entrée de fichier
|
entryId | True | string |
ID de la version spécifique du fichier |
|
Role
|
role | string | ||
|
Contenu du message
|
content | string |
Retours
- Corps
- AISummaryResponse
[IA] Poser une question sur un document
Posez des questions relatives à un document donné, en fournissant une réponse basée sur l’IA basée sur le contenu du document. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’entrée de fichier
|
entryId | True | string |
ID de la version spécifique du fichier |
|
Question
|
question | True | string |
Question spécifique que vous souhaitez poser |
|
Inclure des citations
|
includeCitations | boolean |
Indique si la réponse doit inclure des citations (valeur par défaut false) |
|
|
Role
|
role | string | ||
|
Contenu du message
|
content | string |
Retours
- Corps
- AIQuestionResponse
[IA] Poser une question à Egnyte Copilot
Posez des questions au copilote de la plateforme, en fournissant une réponse basée sur l’IA basée sur le contenu global au sein de votre domaine Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Question
|
question | True | string |
Question spécifique que vous souhaitez poser |
|
ID du dossier
|
id | string |
ID du dossier sélectionné |
|
|
ID d’entrée de fichier
|
entryId | string |
ID d’entrée du fichier sélectionné |
|
|
Inclure des citations
|
includeCitations | boolean |
Indique si la réponse doit inclure des citations (valeur par défaut false) |
|
|
Role
|
role | string | ||
|
Contenu du message
|
content | string |
Retours
- Corps
- AICopilotResponse
Afficher les détails du lien
Affichez les détails d’un lien. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de lien
|
linkId | True | string |
LinkId |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Links
|
links | array of object |
Tableau contenant les informations json complètes pour tous les liens de votre domaine que cet utilisateur peut voir dans toutes les plages spécifiées |
|
Id
|
links.id | string |
ID du lien |
|
URL
|
links.url | string |
URL complète du lien |
|
Destinataires
|
links.recipients | array of string |
Tableau d’adresses e-mail valides auxquelles le lien a été envoyé. |
|
Chemin
|
path | string |
Chemin absolu de la ressource cible, fichier ou dossier. |
|
Type
|
type | string |
Type de lien, fichier, dossier ou chargement |
|
Accessibilité
|
accessibility | string |
Qui est accessible par l’un des utilisateurs, mot de passe, domaine ou destinataires. |
|
Notification
|
notify | boolean |
Boolean quant à savoir si le créateur de lien sera averti par e-mail lorsque le lien est accessible. |
|
Lien vers la version actuelle
|
link_to_current | boolean |
Boolean quant à savoir si le lien fait toujours référence à la version actuelle du fichier. Applicable uniquement aux liens de fichiers. |
|
Date d’expiration
|
expiry_date | string |
Date et heure de l’expiration du lien. Ce champ s’affiche uniquement si le lien doit expirer par date |
|
Date de création
|
creation_date | string |
Date et heure de création du lien |
|
Créé par
|
created_by | string |
Nom d’utilisateur de l’utilisateur qui a créé le lien |
|
Dernier accès
|
last_accessed | string |
Date et heure du dernier accès du lien. Ce champ s’affiche uniquement si le lien a été accédé au moins une fois |
Copier le dossier par chemin d’accès
Copiez un dossier à l’aide d’un chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier source
|
path | True | string |
Chemin du dossier source dans Egnyte. |
|
Chemin du dossier de destination
|
destination_path | True | string |
Chemin du dossier de destination dans Egnyte. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès au dossier
|
path | string |
Chemin d’accès complet du dossier copié. |
|
ID du dossier
|
folder_id | string |
ID unique du dossier copié. |
Copier le dossier par ID
Copiez un dossier à l’aide d’un ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de dossier
|
id | True | string |
Identificateur unique du dossier à copier dans Egnyte. |
|
Chemin du dossier de destination
|
destination_path | True | string |
Chemin du dossier de destination dans Egnyte. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès au dossier
|
path | string |
Chemin d’accès complet du dossier copié. |
|
ID du dossier
|
folder_id | string |
ID unique du dossier copié. |
Copier le fichier par chemin d’accès
Copiez un fichier à l’aide d’un chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Fichier source
|
path | True | string |
Chemin du fichier source dans Egnyte, y compris le nom de fichier cible. |
|
Fichier de destination
|
destination_path | True | string |
Chemin d’accès du fichier de destination dans Egnyte, y compris le nom de fichier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès au fichier
|
path | string |
Chemin d’accès complet du fichier copié. |
|
ID de fichier
|
group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
Copier un fichier par ID
Copiez un fichier à l’aide d’un ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
id | True | string |
Identificateur unique du fichier à copier dans Egnyte. |
|
Chemin d’accès du fichier de destination
|
destination_path | True | string |
Chemin d’accès du fichier de destination dans Egnyte, y compris le nom de fichier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès au fichier
|
path | string |
Chemin d’accès complet du fichier copié. |
|
ID de fichier
|
group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
Créer un dossier
Créez un dossier dans Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
path | True | string |
Chemin d’accès complet du nouveau dossier. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès au dossier
|
path | string |
Chemin d’accès complet du dossier créé |
|
ID du dossier
|
folder_id | string |
ID unique du dossier créé |
Créer un espace de noms
Créez un espace de noms dans Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’espace de noms
|
name | True | string |
Nom de l’espace de noms |
|
Nom affiché
|
displayName | string |
Nom permettant d’identifier l’espace de noms dans l’interface utilisateur |
|
|
Scope
|
scope | True | string |
Qui peut voir et modifier l’espace de noms |
|
Nom de la clé
|
name | True | string |
Nom de la clé |
|
Type
|
type | True | string |
Spécifie le type de données d’une clé |
|
Nom d’affichage
|
displayName | string |
Nom permettant d’identifier le champ dans l’interface utilisateur |
|
|
Texte d’aide
|
helpText | string |
Description de l’info-bulle pour le champ de métadonnées |
|
|
Priority
|
priority | number |
Spécifie la priorité de la clé (les clés dont la priorité est supérieure s’affichent en premier |
|
|
Données (pour le type d’énumération)
|
data | array of string |
Pour une clé de type énumération, spécifie les valeurs énumérées |
Créer un fichier
Charge un fichier dans Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de fichier
|
Name | True | string |
Nom du fichier à créer dans Egnyte. |
|
Chemin du dossier
|
Path | True | string |
Chemin d’accès au dossier pour charger le fichier dans Egnyte. |
|
Contenu du fichier
|
body | True | binary |
Contenu du fichier à charger sur Egnyte. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de version
|
id | string |
ID de la version actuelle du fichier. |
|
ID de fichier
|
group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
|
Chemin d’accès au fichier
|
path | string |
Chemin d’accès complet du fichier chargé. |
Créer un groupe
Créez un groupe dans Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom affiché
|
displayName | True | string |
Nom complet du groupe. |
|
ID d’utilisateur
|
value | string |
ID global unique d’un membre de groupe. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de groupe
|
id | string |
ID du groupe créé. |
|
nom d’affichage
|
displayName | string |
Nom complet d’un groupe. |
|
membres
|
members | array of object |
Membres du groupe |
|
Nom d’utilisateur
|
members.username | string |
Nom d’utilisateur d’un membre. |
|
ID d’utilisateur
|
members.value | number |
ID d’utilisateur d’un membre. |
|
Nom d’affichage de l’utilisateur
|
members.display | string |
Nom complet d’un membre. |
Créer un lien
Créez un lien. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin
|
path | True | string |
Chemin absolu du fichier ou dossier cible. |
|
Type
|
type | True | string |
Cela détermine le type de lien qui sera créé. |
|
Accessibilité
|
accessibility | string |
Détermine par qui un lien est accessible. Obligatoire à l’exception des liens de chargement ou lorsque « useDefaultSettings » a la valeur true. |
|
|
Utiliser les paramètres par défaut
|
useDefaultSettings | True | boolean |
Détermine s’il faut utiliser les paramètres par défaut sur le domaine pour la création de liens |
|
Envoyer un e-mail
|
send_email | boolean |
Si la valeur true est définie, le lien est envoyé par e-mail par Egnyte. |
|
|
Destinataires
|
recipients | array of string |
Répertoriez les adresses e-mail des destinataires du lien. Obligatoire uniquement si « Envoyer un e-mail » est vrai. |
|
|
Message (s’applique uniquement si « Envoyer un e-mail » a la valeur true.)
|
message | string |
Message personnel à envoyer dans l’e-mail de lien. |
|
|
Copiez-moi (s’applique uniquement si « Envoyer un e-mail » a la valeur true)
|
copy_me | boolean |
Si la valeur true est définie, une copie du message de lien est envoyée au créateur du lien. |
|
|
Notification
|
notify | boolean |
Si la valeur true est définie, le créateur de liens est averti par e-mail lorsque le lien est accessible. |
|
|
Lien vers actuel (applicable uniquement aux liens de fichiers.)
|
link_to_current | boolean |
Si la valeur est true, le lien fait toujours référence à la version actuelle du fichier. |
|
|
Date d’expiration (par exemple, 2023-12-31)
|
expiry_date | string |
Date d’expiration du lien. Si spécifié, les « clics d’expiration » ne peuvent pas être définis. |
|
|
Clics d’expiration
|
expiry_clicks | number |
Nombre de clics pour utilisant le lien. S’il est spécifié, « Date d’expiration » ne peut pas être défini |
|
|
Ajouter un nom de fichier (s’applique uniquement aux liens de fichiers, et non aux liens de dossier)
|
add_file_name | boolean |
Si la valeur est true, le nom de fichier est ajouté à la fin du lien. |
|
|
Mot de passe (lorsque le paramètre « accessibilité » est défini sur « password »)
|
password | string |
Lorsqu’il n’est pas spécifié, le système génère automatiquement un mot de passe. |
|
|
Protection
|
protection | string |
Si la valeur est « PREVIEW », elle crée un lien en préversion uniquement. |
|
|
Dossier par destinataire (s’applique uniquement au chargement de liens.)
|
folder_per_recipient | boolean |
Si la valeur est true, les données chargées de chaque destinataire sont placées dans un dossier distinct. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Links
|
links | array of object |
Tableau contenant les informations json complètes pour tous les liens de votre domaine que cet utilisateur peut voir dans toutes les plages spécifiées |
|
Id
|
links.id | string |
ID du lien |
|
URL
|
links.url | string |
URL complète du lien |
|
Destinataires
|
links.recipients | array of string |
Tableau d’adresses e-mail valides auxquelles le lien a été envoyé. |
|
Chemin
|
path | string |
Chemin absolu de la ressource cible, fichier ou dossier. |
|
Type
|
type | string |
Type de lien, fichier, dossier ou chargement |
|
Accessibilité
|
accessibility | string |
Qui est accessible par l’un des utilisateurs, mot de passe, domaine ou destinataires. |
|
Notification
|
notify | boolean |
Boolean quant à savoir si le créateur de lien sera averti par e-mail lorsque le lien est accessible. |
|
Lien vers la version actuelle
|
link_to_current | boolean |
Boolean quant à savoir si le lien fait toujours référence à la version actuelle du fichier. Applicable uniquement aux liens de fichiers. |
|
Date d’expiration
|
expiry_date | string |
Date et heure de l’expiration du lien. Ce champ s’affiche uniquement si le lien doit expirer par date |
|
Date de création
|
creation_date | string |
Date et heure de création du lien |
|
Créé par
|
created_by | string |
Nom d’utilisateur de l’utilisateur qui a créé le lien |
Créer un projet à partir d’un modèle
Créez un projet à partir d’un modèle de dossier de projet. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de dossier parent
|
parentFolderId | True | string |
ID de dossier du dossier parent où le dossier du projet sera créé |
|
ID de dossier de modèle
|
templateFolderId | True | string |
ID de dossier du modèle de dossier de projet |
|
Nom du dossier
|
folderName | True | string |
Nom du nouveau dossier qui sera créé |
|
Nom
|
name | True | string |
Nom du projet |
|
Descriptif
|
description | string |
Description du dossier |
|
|
ID de projet
|
projectId | string |
ID personnalisé du projet |
|
|
Nom du client
|
customerName | string |
Client associé au projet |
|
|
Statut
|
status | True | string |
État du projet |
|
Date de début (par exemple, 2023-12-31T23:59:59)
|
startDate | date-time |
Date de début du projet. |
|
|
Date d’achèvement (par exemple, 2023-12-31T23:59:59)
|
completionDate | date-time |
Date d’achèvement du projet. |
|
|
Adresse postale 1
|
streetAddress1 | string |
Première ligne de l’adresse postale |
|
|
Adresse postale 2
|
streetAddress2 | string |
Deuxième ligne de l’adresse postale |
|
|
Ville
|
city | string |
Ville |
|
|
Département ou région
|
state | string |
Département ou région |
|
|
Pays
|
country | string |
Pays |
|
|
Code postal ou code postal
|
postalCode | string |
Code postal ou code postal |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
groupsCreated
|
groupsCreated | array of object | |
|
ID de projet
|
groupsCreated.id | string |
ID Projet |
|
Nom du projet
|
groupsCreated.name | string |
Nom du projet |
Créer un utilisateur
Créez un utilisateur dans Egnyte. Pour en savoir plus: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom d’utilisateur
|
userName | True | string |
Nom d’utilisateur Egnyte de l’utilisateur. Doit commencer par une lettre ou un chiffre. |
|
Messagerie électronique
|
True | string |
Adresse e-mail de l’utilisateur (par exemple admin@acme.com). |
|
|
Prénom
|
givenName | True | string |
Prénom de l’utilisateur. |
|
Nom de la famille
|
familyName | True | string |
Nom de l’utilisateur. |
|
Active
|
active | True | boolean |
Indique si l’utilisateur est actif ou inactif. |
|
Type d’utilisateur
|
userType | True | string |
Type de l’utilisateur. |
|
Type d’authentification
|
authType | True | string |
Type d’authentification pour l’utilisateur. |
|
External ID
|
externalId | string |
Identificateur unique immuable fourni par le consommateur d’API. |
|
|
Envoyer une invitation
|
sendInvite | boolean |
Si la valeur est true lors de la création d’un utilisateur, un e-mail d’invitation est envoyé (si l’utilisateur est créé dans un état actif). |
|
|
Compte de service
|
isServiceAccount | boolean |
Si la valeur est true lors de la création d’un utilisateur, l’utilisateur est créé en tant que compte de service. |
|
|
Language
|
language | string |
Le paramètre « language » est accepté uniquement lorsque le module linguistique a été activé pour le domaine. |
|
|
Role
|
role | string |
Rôle attribué à l’utilisateur. Applicable uniquement aux utilisateurs Power. |
|
|
ID d’utilisateur du fournisseur d’identité
|
idpUserId | string |
Obligatoire uniquement si l’utilisateur est authentifié et n’utilise pas le mappage utilisateur par défaut. Ne spécifiez pas si l’utilisateur n’est pas authentifié par l’authentification unique. |
|
|
Nom d’utilisateur principal
|
userPrincipalName | string |
Ne spécifiez pas si l’utilisateur n’est pas authentifié AD. Utilisé pour lier des stratégies d’authentification enfant à un utilisateur lors de l’utilisation de l’authentification Active Directory dans une configuration multi-domaine. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’utilisateur
|
id | integer |
Identificateur unique pour l’utilisateur nouvellement créé |
|
Nom d’utilisateur
|
userName | string |
Nom d’utilisateur Egnyte de l’utilisateur. |
|
External ID
|
externalId | string |
Identificateur unique immuable fourni par le consommateur d’API. |
|
Messagerie électronique
|
string |
Adresse e-mail de l’utilisateur. |
|
|
Modification de l’e-mail en attente
|
emailChangePending | boolean |
Indique si une modification d’e-mail est en attente. |
|
Prénom
|
name.givenName | string |
Prénom de l’utilisateur. |
|
Nom de la famille
|
name.familyName | string |
Nom de l’utilisateur. |
|
Nom mis en forme
|
name.formatted | string |
Nom complet mis en forme de l’utilisateur. |
|
Active
|
active | boolean |
Indique si l’utilisateur est actif. |
|
Verrouillé
|
locked | boolean |
Indique si le compte d’utilisateur est verrouillé. |
|
Type d’authentification
|
authType | string |
Type d’authentification pour l’utilisateur. |
|
Type d’utilisateur
|
userType | string |
Type de l’utilisateur. |
|
ID d’utilisateur du fournisseur d’identité
|
idpUserId | string |
La façon dont l’utilisateur est identifié dans la réponse SAML à partir d’un fournisseur d’identité SSO. |
|
Nom d’utilisateur principal
|
userPrincipalName | string |
Utilisé pour lier des stratégies d’authentification enfant à un utilisateur lors de l’utilisation de l’authentification Active Directory. |
|
Role
|
role | string |
Rôle attribué à l’utilisateur. Applicable uniquement aux utilisateurs Power. |
|
Language
|
language | string |
Préférence de langue pour l’utilisateur. |
|
Date de création
|
createdDate | date-time |
Date et heure de création de l’utilisateur. |
|
Date de la dernière modification
|
lastModificationDate | date-time |
Date et heure de la dernière modification. |
|
Dernière date active
|
lastActiveDate | date-time |
Date et heure de la dernière activité. |
|
Date d’expiration
|
expiryDate | date-time |
Date à laquelle le compte d’utilisateur expire. |
Créer une clé de métadonnées
Ajoutez une clé de métadonnées à un espace de noms existant. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’espace de noms
|
namespace | True | string |
Identificateur unique de l’espace de noms dans Egnyte. |
|
Nom de clé
|
key | True | string |
Nom de la clé que vous créez. |
|
Type (Pour « enum » : le paramètre de données est requis)
|
type | True | string |
Spécifie le type de données d’une clé. |
|
Nom affiché
|
displayName | string |
Nom permettant d’identifier le champ dans l’interface utilisateur. |
|
|
Priority
|
priority | number |
Spécifie la priorité de la clé (les clés dont la priorité est supérieure s’affichent en premier). |
|
|
Texte d’aide
|
helpText | string |
Description de l’info-bulle pour le champ de métadonnées. |
|
|
Data
|
data | array of string |
Pour une clé de type énumération, spécifie les valeurs énumérées. |
Définir des autorisations de dossier
Définissez des autorisations pour un dossier. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
path | True | string |
Chemin complet du dossier. |
|
Autorisations utilisateur
|
userPerms | object |
Mapper l’utilisateur à la valeur d’autorisation. |
|
|
Autorisations de groupe
|
groupPerms | object |
Mappage du nom du groupe à la valeur d’autorisation |
|
|
Hérite des autorisations
|
inheritsPermissions | boolean |
Indique si les autorisations doivent être héritées du dossier parent. |
|
|
Conserver les autorisations parentes (uniquement si hériterPermissions est false)
|
keepParentPermissions | boolean |
Indique si les autorisations des dossiers parents doivent s’appliquer à ce dossier. |
Définir les métadonnées par ID de dossier
Écrivez des métadonnées dans un dossier à l’aide de l’ID de dossier. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de dossier
|
folderId | True | string |
Identificateur unique du dossier dans Egnyte. |
|
Nom de l’espace de noms
|
namespaceName | True | string |
Nom de l’espace de noms. |
|
Nom de clé de métadonnées
|
metadataName | True | string |
Nom de la clé à laquelle vous souhaitez affecter la valeur. |
|
Valeur des métadonnées
|
metadataValue | True | string |
Valeur de métadonnées à définir. |
Définir les métadonnées par ID de fichier
Écrivez des métadonnées dans un fichier à l’aide de l’ID de fichier. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
fileId | True | string |
Identificateur unique du fichier dans Egnyte. |
|
Nom de l’espace de noms
|
namespaceName | True | string |
Nom de l’espace de noms. |
|
Nom de clé de métadonnées
|
metadataName | True | string |
Nom de la clé à laquelle vous souhaitez affecter la valeur. |
|
Valeur des métadonnées
|
metadataValue | string |
Valeur de métadonnées à définir. |
Déplacer le dossier par chemin
Déplacez un dossier dans Egnyte à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès source
|
path | True | string |
Chemin d’accès au dossier source. |
|
Chemin du dossier de destination
|
destination_path | True | string |
Chemin du dossier de destination dans Egnyte. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès au dossier
|
path | string |
Chemin complet du dossier déplacé. |
|
ID du dossier
|
folder_id | string |
ID unique du dossier déplacé. |
Déplacer le dossier par ID
Déplacez un dossier à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de dossier
|
id | True | string |
Identificateur unique du dossier dans Egnyte. |
|
Chemin du dossier de destination
|
destination_path | True | string |
Chemin du dossier de destination dans Egnyte. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès au dossier
|
path | string |
Chemin complet du dossier déplacé. |
|
ID du dossier
|
folder_id | string |
ID unique du dossier déplacé. |
Déplacer le fichier par chemin d’accès
Déplacez un fichier dans Egnyte à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès source
|
path | True | string |
Chemin d’accès au fichier source. |
|
Chemin d’accès du fichier de destination
|
destination_path | True | string |
Chemin d’accès du fichier de destination dans Egnyte, y compris le nom de fichier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès au fichier
|
path | string |
Chemin d’accès complet du fichier déplacé. |
|
ID de fichier
|
group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
Déplacer un fichier par ID
Déplacez un fichier dans Egnyte à l’aide de l’ID de fichier. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
id | True | string |
Identificateur unique du fichier dans Egnyte. |
|
Chemin d’accès du fichier de destination
|
destination_path | True | string |
Chemin du fichier de destination dans Egnyte. Nom de fichier cible inclus. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès au fichier
|
path | string |
Chemin d’accès complet du fichier déplacé. |
|
ID de fichier
|
group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
Déverrouiller le fichier par chemin d’accès
Déverrouiller le fichier à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au fichier
|
path | True | string |
Chemin unique du fichier dans Egnyte. |
|
Jeton de verrouillage
|
lock_token | True | string |
Jeton de verrou actuel pour le fichier. |
Déverrouiller le fichier par ID
Déverrouiller le fichier à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
id | True | string |
Identificateur unique du fichier dans Egnyte. |
|
Jeton de verrouillage
|
lock_token | True | string |
Jeton de verrou actuel pour le fichier. |
Lien profond par chemin
Créez un lien profond pour le fichier ou le dossier par chemin d’accès. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin
|
path | True | string |
Chemin d’accès du fichier ou du dossier |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
Lien profond |
Lien profond par ID
Créez un lien profond pour le fichier ou le dossier par ID. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
ID du fichier ou du dossier |
|
Type
|
type | True | string |
Type du lien |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
Lien profond |
Marquer le dossier en tant que projet
Marquez un dossier existant en tant que projet. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de dossier racine
|
rootFolderId | True | string |
FolderId du dossier du projet racine |
|
Nom
|
name | True | string |
Nom du projet |
|
Descriptif
|
description | string |
Description du dossier |
|
|
Statut
|
status | True | string |
État du projet |
|
Date de début (par exemple, 2023-12-31T23:59:59)
|
startDate | date-time |
Date de début du projet. |
|
|
Date d’achèvement (par exemple, 2023-12-31T23:59:59)
|
completionDate | date-time |
Date d’achèvement du projet. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
ID de l’élément |
Mettre à jour le projet par ID
Met à jour les propriétés spécifiées d’un projet identifié par son ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
nom
|
name | True | string |
Nouveau nom du dossier. |
|
descriptif
|
description | string |
Nouvelle description du dossier. |
|
|
projectId
|
projectId | True | string |
ID du projet. |
|
customProjectId
|
customProjectId | string |
ID personnalisé du projet. |
|
|
customerName
|
customerName | string |
Client associé au projet. |
|
|
rueAdresse1
|
streetAddress1 | string |
Première ligne de l’adresse postale. |
|
|
rueAdresse2
|
streetAddress2 | string |
Deuxième ligne de l’adresse postale. |
|
|
city
|
city | string |
City. |
|
|
état
|
state | string |
État ou province. |
|
|
postalCode
|
postalCode | string |
Code postal ou code postal. |
|
|
country
|
country | string |
à l’aide d’un code de pays de 3 caractères à partir du profil GENC ISO 3166, par exemple : Usa, GBR, POL. |
|
|
status
|
status | True | string |
État actuel du projet. |
|
date de début
|
startDate | string |
Date de début du projet au format ISO 8601. |
|
|
date d’achèvement
|
completionDate | string |
Date d’achèvement prévue du projet au format ISO 8601. |
Mettre à jour les attributs d’espace de noms
Met à jour les attributs d’espace de noms. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’espace de noms
|
namespace | True | string |
Identificateur unique de l’espace de noms dans Egnyte. |
|
nom d’affichage
|
displayName | string |
Nom permettant d’identifier l’espace de noms dans l’interface utilisateur |
|
|
Priorités
|
priorities | object |
Spécifie la priorité (ordre) des clés. Les clés seront affichées conformément à leurs priorités dans l’ordre décroissant (les clés avec une priorité plus élevée seront affichées en premier) |
Retours
- Corps
- NamespaceItem
Mettre à jour les clés d’espace de noms
Mettez à jour la clé d’une métadonnées personnalisée pour un domaine. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’espace de noms
|
namespace | True | string |
Identificateur unique de l’espace de noms dans Egnyte. |
|
Key
|
key | True | string |
Clé unique dans l’espace de noms |
|
nom d’affichage
|
displayName | string |
Spécifie le nom affiché pour la clé |
|
|
type
|
type | string |
Spécifie le type de données d’une clé |
|
|
priority
|
priority | number |
Spécifie la priorité (ordre) des clés. Les clés seront affichées conformément à leurs priorités dans l’ordre décroissant (les clés avec une priorité plus élevée seront affichées en premier) |
|
|
données
|
data | string |
Pour une clé de type énumération, spécifie les valeurs énumérées |
|
|
helpText
|
helpText | string |
Texte d’instruction affiché lorsqu’un utilisateur ajoute/modifie une propriété pour donner un contexte à l’objectif de la propriété |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nom
|
name | string |
Nom de l’espace de noms |
|
key
|
key | string |
Nom de clé |
|
nom d’affichage
|
displayName | string |
Nom permettant d’identifier le champ dans l’interface utilisateur |
|
helpText
|
helpText | string |
Description de l’info-bulle pour le champ de métadonnées |
|
priority
|
priority | number |
Spécifie la priorité de la clé (les clés dont la priorité est supérieure s’affichent en premier |
Mettre à jour l’utilisateur par ID
Mettez à jour l’utilisateur unique. Pour en savoir plus: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
id | True | integer |
Identificateur unique pour l’utilisateur |
|
Adresse e-mail de l’utilisateur
|
string |
Adresse e-mail de l’utilisateur. |
||
|
Prénom
|
givenName | string |
Prénom de l’utilisateur. |
|
|
Nom de la famille
|
familyName | string |
Nom de l’utilisateur. |
|
|
Active
|
active | boolean |
Indique si l’utilisateur est actif ou inactif. |
|
|
Envoyer une invitation
|
sendInvite | boolean |
Si la valeur est true, un e-mail d’invitation est envoyé. Le paramètre ne peut pas être le seul modifié par cette action. |
|
|
Language
|
language | string |
Le paramètre « language » est accepté uniquement lorsque le module linguistique a été activé pour le domaine. |
|
|
Type d’authentification
|
authType | string |
Type d’authentification pour l’utilisateur. |
|
|
Type d’utilisateur
|
userType | string |
Type de l’utilisateur. |
|
|
Role
|
role | string |
Rôle attribué à l’utilisateur. Applicable uniquement aux utilisateurs Power. |
|
|
ID d’utilisateur du fournisseur d’identité
|
idpUserId | string |
Obligatoire uniquement si l’utilisateur est authentifié et n’utilise pas le mappage utilisateur par défaut |
|
|
Nom d’utilisateur principal
|
userPrincipalName | string |
Ne spécifiez pas si l’utilisateur n’est pas authentifié AD. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’utilisateur
|
id | integer |
Identificateur unique pour l’utilisateur |
|
Adresse e-mail de l’utilisateur
|
string |
Adresse e-mail de l’utilisateur. |
|
|
Nom de la famille
|
familyName | string |
Nom de l’utilisateur. |
|
Prénom
|
givenName | string |
Prénom de l’utilisateur. |
|
Active
|
active | boolean |
Indique si l’utilisateur est actif ou inactif. |
|
Envoyer une invitation
|
sendInvite | boolean |
Si la valeur est true, un e-mail d’invitation est envoyé. |
|
Language
|
language | string |
Il est accepté uniquement lorsque le module linguistique a été activé. |
|
Type d’authentification
|
authType | string |
Type d’authentification pour l’utilisateur. |
|
Type d’utilisateur
|
userType | string |
Type de l’utilisateur. |
|
Role
|
role | string |
Rôle attribué à l’utilisateur. Applicable uniquement aux utilisateurs Power. |
|
ID d’utilisateur du fournisseur d’identité
|
idpUserId | string |
Obligatoire uniquement si l’utilisateur est authentifié par l’authentification unique |
|
Nom d’utilisateur principal
|
userPrincipalName | string |
Ne spécifiez pas si l’utilisateur n’est pas authentifié AD. |
Mise à jour complète du groupe
Remplacez tous les attributs d’un groupe. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de groupe
|
id | True | string |
ID du groupe créé. |
|
Nom affiché
|
displayName | True | string |
Nom complet du groupe. |
|
ID d’utilisateur
|
value | integer |
ID global unique d’un membre de groupe. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de groupe
|
id | string |
ID du groupe créé. |
|
nom d’affichage
|
displayName | string |
Nom complet d’un groupe. |
|
membres
|
members | array of object |
Membres du groupe |
|
Nom d’utilisateur
|
members.username | string |
Nom d’utilisateur d’un membre. |
|
ID d’utilisateur
|
members.value | number |
ID d’utilisateur d’un membre. |
|
Nom d’affichage de l’utilisateur
|
members.display | string |
Nom complet d’un membre. |
Mise à jour partielle du groupe
Mettez à jour des attributs spécifiques d’un groupe. https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de groupe
|
id | True | string |
ID du groupe créé. |
|
Nom affiché
|
displayName | string |
Nom complet du groupe. |
|
|
ID d’utilisateur
|
value | integer |
ID global unique d’un membre de groupe. |
|
|
opération
|
operation | string |
Action que vous souhaitez effectuer sur un groupe. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de groupe
|
id | string |
ID du groupe créé. |
|
nom d’affichage
|
displayName | string |
Nom complet d’un groupe. |
|
membres
|
members | array of object |
Membres du groupe |
|
Nom d’utilisateur
|
members.username | string |
Nom d’utilisateur d’un membre. |
|
ID d’utilisateur
|
members.value | number |
ID d’utilisateur d’un membre. |
|
Nom d’affichage de l’utilisateur
|
members.display | string |
Nom complet d’un membre. |
Modifier les options de dossier
Modifiez les options de dossier telles que la description, les paramètres de partage de liens, les autorisations de lien public, les restrictions de déplacement/suppression et les préférences de notification par e-mail. https://developers.egnyte.com/api-docs/read/folder-options-api
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
path | True | string |
Chemin unique du dossier dans Egnyte. |
|
Description du dossier
|
folder_description | string |
Description du dossier. |
|
|
Autoriser les liens
|
allow_links | boolean |
Choisissez si des liens peuvent être partagés vers des fichiers ou sous-dossiers dans ce dossier. |
|
|
Liens publics
|
public_links | string |
Spécifiez le type de liens publics autorisés. Valeurs possibles : files_folders, fichiers, désactivés. |
|
|
Restreindre le déplacement/suppression
|
restrict_move_delete | boolean |
Limitez les opérations de déplacement et de suppression aux seuls propriétaires et administrateurs de dossiers. |
|
|
Notifications de mises à jour de contenu
|
content_updates | boolean |
Activez les notifications par e-mail pour les mises à jour de contenu. |
|
|
Notifications d’accès au contenu
|
content_accessed | boolean |
Activez les notifications par e-mail pour le contenu accessible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom du dossier. |
|
Dernière modification
|
lastModified | integer |
La dernière fois que n’importe quel fichier du dossier (mais pas dans les sous-dossiers) a été modifié. |
|
Chemin d’accès au dossier
|
path | string |
Chemin complet du dossier. |
|
ID du dossier
|
folder_id | string |
ID unique du dossier. |
|
Description du dossier
|
folder_description | string |
Description du dossier. |
|
Dossier Is
|
is_folder | boolean |
Indique si la ressource est un dossier. Vrai ou Faux |
|
Liens publics possibles
|
public_links | string |
Paramètre d’option de dossier sur la façon dont « Autoriser les liens publics à partir de ce dossier » a été défini. |
|
Peut être supprimé ou déplacé
|
restrict_move_delete | boolean |
Peut-il être supprimé ou déplacé ? T ou F |
Métadonnées de recherche
Recherchez des éléments avec un champ ou une valeur de métadonnées spécifique. https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type de recherche
|
type | string |
Quels types d’éléments doivent être recherchés. |
|
|
Nom de l’espace de noms
|
namespace | True | string |
Nom de l’espace de noms. |
|
Clé de métadonnées
|
keyName | True | string |
Nom de la clé de métadonnées. |
|
Nom de l’espace de noms
|
namespace | True | string |
Nom de l’espace de noms. |
|
Clé de métadonnées
|
keyName | True | string |
Nom de la clé de métadonnées. |
|
Valeur des métadonnées
|
value | True | string |
Valeur de la clé de métadonnées. |
Nettoyer le projet par ID
Ce point de terminaison lance un nettoyage dans un projet et supprime ou désactive éventuellement les utilisateurs spécifiés. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID Projet
|
projectId | True | string |
ID Projet |
|
deleteLinks
|
deleteLinks | True | boolean |
Si la valeur est true, tous les liens actifs existants dans le projet sont supprimés. |
|
usersToDelete
|
usersToDelete | array of integer |
Liste des ID d’utilisateur à supprimer. |
|
|
usersToDisable
|
usersToDisable | array of integer |
Liste des ID d’utilisateur à désactiver. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Message
|
message | string |
Obtenir des autorisations effectives
Obtenez des autorisations effectives pour un utilisateur. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
path | True | string |
Chemin complet du dossier. |
|
Nom d’utilisateur
|
username | True | string |
Nom d’utilisateur |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Autorisation
|
permission | string |
Valeur d’autorisation |
Obtenir des informations de dossier par ID
Récupérer les informations de dossier à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de dossier
|
id | True | string |
Identificateur unique du dossier dans Egnyte. |
Retours
- Corps
- FolderInfoResponse
Obtenir des informations de fichier par chemin d’accès
Récupérez les informations de fichier à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au fichier
|
path | True | string |
Chemin unique du fichier dans Egnyte. |
Retours
- Corps
- FileInfoResponse
Obtenir des informations de fichier par ID
Récupérez les informations de fichier à l’aide de l’ID de fichier. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
id | True | string |
Identificateur unique du fichier dans Egnyte. |
Retours
- Corps
- FileInfoResponse
Obtenir des informations sur le dossier par chemin d’accès
Récupérez les informations de dossier à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
path | True | string |
Chemin unique du dossier dans Egnyte. |
Retours
- Corps
- FolderInfoResponse
Obtenir des métadonnées par ID de dossier
Obtenez des métadonnées à partir d’un dossier à l’aide de l’ID de dossier. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du dossier
|
folderId | True | string |
Identificateur unique du dossier dans Egnyte. |
|
Nom de l’espace de noms
|
namespace | True | string |
Nom de l’espace de noms. |
Obtenir des métadonnées par ID de fichier
Obtenez des métadonnées à partir d’un fichier à l’aide de l’ID de fichier. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
fileId | True | string |
Identificateur unique du fichier dans Egnyte. |
|
Nom de l’espace de noms
|
namespace | True | string |
Nom de l’espace de noms. |
Obtenir la liste de tous les groupes
Récupérez la liste des groupes. https://developers.egnyte.com/api-docs/read/group-management#List-Groups
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Index de début
|
startIndex | integer |
Index de base 1 de l’enregistrement initial demandé (Entier ≥ 1). |
|
|
Nombre
|
count | integer |
Nombre d’entrées par page (min 1, maximum 100) |
|
|
Filter
|
filter | string |
Vous permet de demander un sous-ensemble de groupes. Ces termes ne respectent pas la casse |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Résultats totaux
|
totalResults | integer |
Nombre total de résultats correspondant à la requête. |
|
Éléments par page
|
itemsPerPage | integer |
Nombre de résultats retournés. |
|
Index de démarrage
|
startIndex | integer |
Index de base 1 du premier résultat dans l’ensemble actuel de résultats. |
|
resources
|
resources | array of object | |
|
ID de groupe
|
resources.id | string |
ID de groupe global unique. |
|
Nom du groupe
|
resources.displayName | string |
Nom du groupe. |
Obtenir la liste de tous les utilisateurs
Récupérez les informations sur les utilisateurs. Pour en savoir plus: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Index de début
|
startIndex | integer |
Index de base 1 du premier résultat de recherche. |
|
|
Nombre
|
count | integer |
Spécifie le nombre maximal souhaité de résultats de recherche par page. |
|
|
Filter
|
filter | string |
Vous permet de demander un sous-ensemble d’utilisateurs. Reportez-vous à la documentation de la section About. |
Retours
Obtenir la réponse de liste des utilisateurs
- Corps
- UserListResponse
Obtenir le contenu du fichier par chemin d’accès
Récupère le contenu du fichier d’Egnyte à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au fichier
|
filePath | True | string |
Chemin unique du fichier dans Egnyte. |
Obtenir le contenu du fichier par ID
Récupère le contenu du fichier d’Egnyte à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
fileId | True | string |
Identificateur unique du fichier dans Egnyte. |
Obtenir les autorisations de dossier
Obtenez des autorisations pour un dossier. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
path | True | string |
Chemin complet du dossier. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Autorisations utilisateur
|
userPerms | object |
Mapper l’utilisateur à la valeur d’autorisation. |
|
Autorisations de groupe
|
groupPerms | object |
Mappage du nom du groupe à la valeur d’autorisation |
|
Hérite des autorisations
|
inheritsPermissions | boolean |
Indique si les autorisations doivent être héritées du dossier parent. |
|
Conserver les autorisations parentes
|
keepParentPermissions | boolean |
Lors de la désactivation de l’héritage des autorisations avec hériterPermissions, ces options déterminent si les autorisations héritées précédemment des dossiers parents doivent être copiées dans ce dossier. |
Obtenir les détails de l’utilisateur
Récupérez les informations relatives à l’utilisateur par ID. Pour en savoir plus: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
id | True | integer |
ID de l’utilisateur |
Retours
Informations utilisateur
- Corps
- UserInfoResponse
Obtenir les détails du groupe
Récupérer les informations de groupe à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de groupe
|
id | True | string |
ID du groupe. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de groupe
|
id | string |
ID de groupe global unique. |
|
Nom du groupe
|
displayName | string |
Nom du groupe. |
|
membres
|
members | array of object |
Membres du groupe |
|
ID de groupe
|
members.username | string |
Nom d’utilisateur d’un membre de groupe |
|
ID d’utilisateur
|
members.value | number |
ID global unique d’un membre de groupe. |
|
Nom d’affichage de l’utilisateur
|
members.display | string |
Nom complet d’un membre de groupe. |
Obtenir tous les espaces de noms
Obtenez une liste de tous les espaces de noms de métadonnées personnalisés dans le domaine. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces
Retours
- response
- array of NamespaceItem
Obtenir tous les projets
Répertorier tous les dossiers de projet dans le domaine. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects
Retours
- response
- array of ProjectItem
Obtenir un espace de noms
Répertoriez toutes les clés de métadonnées personnalisées qui ont été créées dans un espace de noms donné. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’espace de noms
|
namespace | True | string |
Identificateur unique de l’espace de noms dans Egnyte. |
Retours
- Corps
- NamespaceItem
Obtenir un projet par ID
Récupérez un projet à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de projet
|
projectId | True | string |
ID de projet |
Retours
- Corps
- ProjectItem
Obtenir un projet par ID de dossier racine
Récupérez un projet en fonction de son ID de dossier racine. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du dossier racine
|
rootFolderId | True | string |
ID du dossier racine |
Retours
- Corps
- ProjectItem
Partager un dossier
Partagez un dossier dans Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
path | True | string |
Chemin d’accès au dossier dans Egnyte, à partager. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
links
|
links | array of object |
Links |
|
ID de lien
|
links.id | string |
ID du lien. |
|
URL du lien
|
links.url | string |
URL complète du lien. |
|
Destinataires
|
links.recipients | array of string |
Tableau d’adresses e-mail valides auxquelles le lien a été envoyé. |
|
Chemin d’accès au dossier
|
path | string |
Chemin complet du dossier partagé. |
|
Type
|
type | string |
Type de lien, fichier, dossier ou chargement. |
|
Accessibilité
|
accessibility | string |
Qui est accessible par l’un des utilisateurs, mot de passe, domaine ou destinataires. |
|
Notifier le créateur lors de l’accès
|
notify | boolean |
Indique si le créateur de liens sera averti par e-mail lorsque le lien est accessible. |
|
Fait référence à la version
|
link_to_current | boolean |
Cette version actuelle est-elle en cours ? T ou F |
|
Date d’expiration
|
expiry_date | string |
Date et heure de l’expiration du lien. |
|
Date de création
|
creation_date | string |
Date et heure de création du lien. |
|
Créé par
|
created_by | string |
Nom d’utilisateur de l’utilisateur qui a créé le lien. |
Partager un fichier
Partagez un fichier dans Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au fichier
|
path | True | string |
Chemin d’accès au fichier dans Egnyte, y compris le nom de fichier cible à partager. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
links
|
links | array of object |
Links |
|
ID de lien
|
links.id | string |
ID du lien. |
|
URL du lien
|
links.url | string |
URL complète du lien. |
|
Destinataires
|
links.recipients | array of string |
Tableau d’adresses e-mail valides auxquelles le lien a été envoyé. |
|
Chemin d’accès au fichier
|
path | string |
Chemin complet du fichier partagé. |
|
Type
|
type | string |
Type de lien, fichier, dossier ou chargement. |
|
Accessibilité
|
accessibility | string |
Qui est accessible par l’un des utilisateurs, mot de passe, domaine ou destinataires. |
|
Notifier le créateur lors de l’accès
|
notify | boolean |
Indique si le créateur de liens sera averti par e-mail lorsque le lien est accessible. |
|
Fait référence à la version
|
link_to_current | boolean |
Cette version actuelle est-elle en cours ? T ou F |
|
Date d’expiration
|
expiry_date | string |
Date et heure de l’expiration du lien. |
|
Date de création
|
creation_date | string |
Date et heure de création du lien. |
|
Créée par
|
created_by | string |
Nom d’utilisateur de l’utilisateur qui a créé le lien. |
Rechercher V1
Recherchez le contenu stocké dans Egnyte en fonction des noms de fichiers, des métadonnées et du contenu texte. https://developers.egnyte.com/api-docs/read/search-api#Search-v1
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Requête de recherche
|
query | True | string |
Chaîne de recherche que vous souhaitez rechercher. |
|
Décalage
|
offset | integer |
Index de base 0 de l’enregistrement initial demandé. |
|
|
Nombre
|
count | integer |
Nombre d’entrées par page. |
|
|
Dossier
|
folder | string |
Limitez les résultats aux éléments du dossier et des descendants spécifiés. |
|
|
Modifié avant
|
modifiedBefore | string |
Limitez les résultats aux éléments modifiés avant cet horodatage ISO-8601. |
|
|
Modifié après
|
modifiedAfter | string |
Limitez les résultats aux éléments modifiés après cet horodatage ISO-8601. |
|
|
Chargé avant
|
uploadedBefore | string |
Limitez les résultats aux éléments chargés avant cet horodatage ISO-8601. |
|
|
Chargé après
|
uploadedAfter | string |
Limitez les résultats aux éléments chargés après cet horodatage ISO-8601. |
|
|
Type
|
type | string |
Quels types d’éléments doivent être recherchés. |
|
|
Extrait de code demandé
|
snippetRequested | boolean |
Indique si les résultats de la recherche doivent contenir des extraits de code. |
|
|
Trier par
|
sortBy | string |
Champ à utiliser pour le tri. |
|
|
Direction du tri
|
sortDirection | string |
Direction du tri. |
|
|
Champs de requête de fichier
|
fileQueryFields | string |
Recherchez des fichiers à l’aide de champs spécifiques. |
|
|
Champs de requête de dossier
|
folderQueryFields | string |
Recherchez des dossiers à l’aide de champs spécifiques. |
|
|
Opérateur de requête
|
queryOperator | string |
Recherchez tous les mots ou l’un des mots. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
results
|
results | array of object | |
|
Nom du fichier
|
results.name | string | |
|
Chemin d’accès au fichier
|
results.path | string | |
|
Type MIME
|
results.type | string | |
|
Taille du fichier
|
results.size | integer | |
|
Extrait
|
results.snippet | string | |
|
Extrait de code HTML
|
results.snippet_html | string | |
|
ID d’entrée
|
results.entry_id | string | |
|
ID de groupe
|
results.group_id | string | |
|
Dernière modification
|
results.last_modified | string | |
|
Chargé par
|
results.uploaded_by | string | |
|
Chargé par nom d’utilisateur
|
results.uploaded_by_username | string | |
|
Nombre de versions
|
results.num_versions | integer | |
|
Dossier Is
|
results.is_folder | boolean | |
|
Nombre total
|
total_count | integer | |
|
Décalage
|
offset | integer | |
|
Nombre
|
count | integer |
Rechercher V2
Recherchez du contenu avec des fonctionnalités de recherche avancées. https://developers.egnyte.com/api-docs/read/search-api#Search-v2
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Requête de recherche
|
query | True | string |
Chaîne de recherche que vous souhaitez rechercher. |
|
Décalage
|
offset | integer |
Index de base 0 de l’enregistrement initial demandé. |
|
|
Nombre
|
count | integer |
Nombre d’entrées par page. |
|
|
Dossier
|
folder | string |
Limitez les résultats aux éléments du dossier et des descendants spécifiés. |
|
|
Modifié avant
|
modifiedBefore | integer |
Limitez les résultats aux éléments modifiés avant cet horodatage Unix en millisecondes. |
|
|
Modifié après
|
modifiedAfter | integer |
Limitez les résultats aux éléments modifiés après cet horodatage Unix en millisecondes. |
|
|
Chargé avant
|
uploadedBefore | integer |
Limitez les résultats aux éléments chargés avant ce timestamp Unix en millisecondes. |
|
|
Chargé après
|
uploadedAfter | integer |
Limitez les résultats aux éléments chargés après cet horodatage Unix en millisecondes. |
|
|
Type
|
type | string |
Quels types d’éléments doivent être recherchés. |
|
|
Extrait de code demandé
|
snippetRequested | boolean |
Indique si les résultats de la recherche doivent contenir des extraits de code. |
|
|
Trier par
|
sortBy | string |
Champ à utiliser pour le tri. |
|
|
Direction du tri
|
sortDirection | string |
Direction du tri. |
|
|
Champs de requête de fichier
|
fileQueryFields | array of string |
Recherchez des fichiers à l’aide de champs spécifiques. |
|
|
Champs de requête de dossier
|
folderQueryFields | array of string |
Recherchez des dossiers à l’aide de champs spécifiques. |
|
|
Opérateur de requête
|
queryOperator | string |
Recherchez tous les mots ou l’un des mots. |
|
|
Plus comme ceci (ID de document)
|
mlt | array of string |
Tableau d’ID de document à utiliser comme référence pour la recherche de documents similaire. |
|
|
Plus comme ceci (texte)
|
mltt | array of string |
Tableau de contenu texte à utiliser comme référence pour une recherche de document similaire. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
results
|
results | array of object | |
|
Nom du fichier
|
results.name | string | |
|
Chemin d’accès au fichier
|
results.path | string | |
|
Type MIME
|
results.type | string | |
|
Taille du fichier
|
results.size | integer | |
|
Extrait
|
results.snippet | string | |
|
Extrait de code HTML
|
results.snippet_html | string | |
|
ID d’entrée
|
results.entry_id | string | |
|
ID de groupe
|
results.group_id | string | |
|
Dernière modification
|
results.last_modified | string | |
|
Chargé par
|
results.uploaded_by | string | |
|
Chargé par nom d’utilisateur
|
results.uploaded_by_username | string | |
|
Nombre de versions
|
results.num_versions | integer | |
|
Dossier Is
|
results.is_folder | boolean | |
|
Propriétés personnalisées
|
results.custom_properties | array of object | |
|
Scope
|
results.custom_properties.scope | string | |
|
Namespace
|
results.custom_properties.namespace | string | |
|
Key
|
results.custom_properties.key | string | |
|
Valeur
|
results.custom_properties.value | string | |
|
Score de pertinence
|
results.score | number | |
|
Nombre total
|
total_count | integer | |
|
Nombre
|
count | integer | |
|
A plus de résultats
|
hasMore | boolean |
Répertorier tous les liens
Répertorie tous les liens à l’exception des liens supprimés. Notez que si l’utilisateur exécutant cette méthode n’est pas un administrateur, seuls les liens créés par l’utilisateur sont répertoriés. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin
|
path | string |
Répertorier les liens vers un fichier ou un dossier spécifié par son chemin d’accès complet. |
|
|
Nom d’utilisateur
|
username | string |
Répertorier les liens créés par cet utilisateur. |
|
|
Créé avant
|
createdBefore | string |
Répertorier les liens créés avant une date donnée (ISO-8601 ou AAAA-MM-DD). |
|
|
Créé après
|
createdAfter | string |
Répertorier les liens créés après une date donnée (ISO-8601 ou AAAA-MM-DD). |
|
|
Type
|
type | string |
Filtrez uniquement les éléments « fichier » ou « dossier ». |
|
|
Accessibilité
|
accessibility | string |
Sélectionner le type d’accessibilité |
|
|
Décalage
|
offset | string |
Index de base 0 de l’enregistrement initial demandé. |
|
|
Nombre (Par défaut, 500 entrées sont retournées)
|
count | string |
Limitez le nombre d’entrées par page. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
ids | array of string |
Tableau contenant les ID de tous les liens de votre domaine que cet utilisateur peut voir. |
|
Décalage
|
offset | number |
Index de base 0 de l’enregistrement initial demandé. |
|
Nombre
|
count | number |
Nombre d’éléments retournés. Si ce champ n’est pas spécifié, la valeur du nombre est 0. |
|
Nombre total
|
total_count | number |
Nombre de liens visibles par l’utilisateur dans le domaine. |
Répertorier tous les liens V2
Répertorie tous les liens. Notez que si l’utilisateur exécutant cette méthode n’est pas un administrateur, seuls les liens créés par l’utilisateur sont répertoriés. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin
|
path | string |
Répertorier les liens vers un fichier ou un dossier spécifié par son chemin d’accès complet. |
|
|
Nom d’utilisateur
|
username | string |
Répertorier les liens créés par cet utilisateur. |
|
|
Créé avant
|
createdBefore | string |
Répertorier les liens créés avant une date donnée (ISO-8601 ou AAAA-MM-DD). |
|
|
Créé après
|
createdAfter | string |
Répertorier les liens créés après une date donnée (ISO-8601 ou AAAA-MM-DD). |
|
|
Type
|
type | string |
Filtrez uniquement les éléments « fichier » ou « dossier ». |
|
|
Accessibilité
|
accessibility | string |
Sélectionner le type d’accessibilité |
|
|
Décalage
|
offset | string |
Index de base 0 de l’enregistrement initial demandé. |
|
|
Nombre (Par défaut, 500 entrées sont retournées)
|
count | string |
Limitez le nombre d’entrées par page. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Links
|
links | array of object |
Tableau contenant les informations json complètes pour tous les liens de votre domaine que cet utilisateur peut voir dans toutes les plages spécifiées |
|
Chemin
|
links.path | string |
Chemin absolu de la ressource cible, fichier ou dossier. |
|
Type
|
links.type | string |
Type de lien, fichier, dossier ou chargement |
|
Accessibilité
|
links.accessibility | string |
Qui est accessible par l’un des utilisateurs, mot de passe, domaine ou destinataires. |
|
Protection
|
links.protection | string |
Si le lien « PRÉVERSION » d’un fichier (ou d’un dossier), il s’agit d’un lien en préversion uniquement vers le fichier (dossier), sinon il s’agit de « NONE » |
|
Destinataires
|
links.recipients | array of string |
Tableau d’adresses e-mail valides auxquelles le lien a été envoyé. |
|
Notification
|
links.notify | boolean |
Boolean quant à savoir si le créateur de lien sera averti par e-mail lorsque le lien est accessible. |
|
URL
|
links.url | string |
URL complète du lien |
|
Id
|
links.id | string |
ID du lien |
|
Lien vers la version actuelle
|
links.link_to_current | boolean |
Boolean quant à savoir si le lien fait toujours référence à la version actuelle du fichier. Applicable uniquement aux liens de fichiers. |
|
Date de création
|
links.creation_date | string |
Date et heure de création du lien |
|
Créé par
|
links.created_by | string |
Nom d’utilisateur de l’utilisateur qui a créé le lien |
|
ID de ressource
|
links.resource_id | string |
ID de la ressource associée, id de groupe s’il s’agit d’un lien de fichier ou id de dossier s’il s’agit d’un dossier ou d’un lien de chargement |
|
Clics d’expiration
|
links.expiry_clicks | number |
Nombre de clics laissés sur le lien avant l’expiration. Ce champ s’affiche uniquement si le lien doit expirer par le biais de clics |
|
Dernier accès
|
links.last_accessed | string |
Date et heure du dernier accès du lien. Ce champ s’affiche uniquement si le lien a été accédé au moins une fois |
|
Date d’expiration
|
links.expiry_date | string |
Date et heure de l’expiration du lien. Ce champ s’affiche uniquement si le lien doit expirer par date |
|
Nombre
|
count | number |
Nombre de liens visibles par l’utilisateur dans le domaine retournés |
Supprimer la clé de métadonnées
Supprimez une clé de métadonnées d’un espace de noms existant. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’espace de noms
|
namespace | True | string |
Identificateur unique de l’espace de noms dans Egnyte. |
|
Nom
|
key | True | string |
Nom de la clé que vous supprimez. |
|
Forcer la suppression
|
force | boolean |
Supprimez même si la clé de métadonnées est utilisée. |
Supprimer le dossier par chemin d’accès
Supprimez un dossier à l’aide d’un chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
path | True | string |
Chemin d’accès au dossier dans Egnyte, y compris le nom du dossier cible à supprimer. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin du dossier parent
|
parent_folder_path | string |
Chemin d’accès au dossier parent du dossier supprimé. |
Supprimer le dossier par ID
Supprimez un dossier à l’aide d’un ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de dossier
|
id | True | string |
Identificateur unique du dossier à supprimer d’Egnyte. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin du dossier parent
|
parent_folder_path | string |
Chemin d’accès au dossier parent du dossier supprimé. |
Supprimer le lien
Supprimez un lien. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de lien
|
linkId | True | string |
LinkId |
Supprimer l’espace de noms
Supprimez un espace de noms spécifié. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de l’espace de noms
|
namespace | True | string |
Identificateur unique de l’espace de noms dans Egnyte. |
|
Forcer la suppression
|
force | boolean |
Supprimer même si l’espace de noms est utilisé |
Supprimer l’utilisateur par ID
Supprimez un utilisateur d’Egnyte. Pour en savoir plus: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’utilisateur
|
id | True | integer |
ID de l’utilisateur à supprimer |
Supprimer un fichier par chemin d’accès
Supprimez un fichier à l’aide d’un chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au fichier
|
path | True | string |
Chemin d’accès du fichier dans Egnyte, y compris le nom de fichier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin du dossier parent
|
parent_folder_path | string |
Chemin d’accès au dossier parent du fichier supprimé |
Supprimer un fichier par ID
Supprimez un fichier à l’aide d’un ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
id | True | string |
Identificateur unique du fichier à supprimer d’Egnyte. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin du dossier parent
|
parent_folder_path | string |
Chemin d’accès au dossier parent du fichier supprimé. |
Supprimer un groupe
Supprimez un groupe par ID. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de groupe
|
id | True | string |
ID de groupe. |
Supprimer un projet par ID
Supprimez un projet en fonction de son ID. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID Projet
|
projectId | True | string |
ID du projet en cours de suppression |
Verrouiller le fichier par chemin d’accès
Verrouiller le fichier à l’aide du chemin d’accès. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès du fichier cible
|
path | True | string |
Chemin du fichier cible dans Egnyte, y compris le nom de fichier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Délai d'expiration
|
timeout | integer |
Durée en secondes pendant laquelle le fichier doit être verrouillé. |
|
Jeton de verrouillage
|
lock_token | string |
Jeton qui doit être utilisé pour déverrouiller le fichier. |
Verrouiller le fichier par ID
Verrouiller le fichier à l’aide de l’ID. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de fichier
|
id | True | string |
Identificateur unique du fichier dans Egnyte. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Délai d'expiration
|
timeout | integer |
Durée en secondes pendant laquelle le fichier doit être verrouillé. |
|
Jeton de verrouillage
|
lock_token | string |
Jeton qui doit être utilisé pour déverrouiller le fichier. |
Déclencheurs
| Lorsque les métadonnées du fichier ou du dossier changent |
Cette opération déclenche un flux lorsqu’un fichier ou une métadonnées de dossier change |
| Lorsque l’autorisation de fichier ou de dossier change |
Cette opération déclenche un flux lorsqu’un fichier ou un dossier est autorisé à modifier |
| Lorsqu’un dossier de projet est créé |
Cette opération déclenche un flux lorsqu’un dossier de projet est créé ou lorsqu’un dossier existant est marqué comme dossier de projet |
| Lorsqu’un dossier est copié |
Cette opération déclenche un flux lorsqu’un sous-dossier est copié dans un dossier. |
| Lorsqu’un dossier est créé |
Cette opération déclenche un flux lorsqu’un sous-dossier est créé dans un dossier. |
| Lorsqu’un dossier est déplacé |
Cette opération déclenche un flux lorsqu’un sous-dossier est déplacé dans un dossier. |
| Lorsqu’un dossier est renommé |
Cette opération déclenche un flux lorsqu’un sous-dossier est renommé dans un dossier. |
| Lorsqu’un dossier est supprimé |
Cette opération déclenche un flux lorsqu’un sous-dossier est supprimé dans un dossier. |
| Lorsqu’un dossier n’est pas balisé en tant que projet |
Cette opération déclenche un flux lorsqu’un dossier n’est pas balisé en tant que projet |
| Lorsqu’un fichier est copié |
Cette opération déclenche un flux lorsqu’un fichier est copié dans un dossier. |
| Lorsqu’un fichier est créé (interrogation) |
Cette opération déclenche un flux lorsqu’un nouveau fichier est créé dans un dossier. |
| Lorsqu’un fichier est créé (webhook) |
Cette opération déclenche un flux lorsqu’un fichier crée dans un dossier spécifique |
| Lorsqu’un fichier est déplacé |
Cette opération déclenche un flux lorsqu’un fichier est déplacé dans un dossier. |
| Lorsqu’un fichier est déverrouillé |
Cette opération déclenche un flux lorsqu’un fichier est déverrouillé |
| Lorsqu’un fichier est mis à jour |
Cette opération déclenche un flux lorsqu’un fichier est mis à jour dans un dossier spécifique |
| Lorsqu’un fichier est renommé |
Cette opération déclenche un flux lorsqu’un fichier est renommé dans un dossier. |
| Lorsqu’un fichier est supprimé |
Cette opération déclenche un flux lorsqu’un fichier est supprimé dans un dossier. |
| Lorsqu’un fichier est verrouillé |
Cette opération déclenche un flux lorsqu’un fichier est verrouillé |
| Lorsqu’un flux de travail de type d’approbation est approuvé |
Cette opération déclenche un flux lorsqu’un flux de travail de type d’approbation est approuvé |
| Lorsqu’un flux de travail de type d’approbation est rejeté |
Cette opération déclenche un flux lorsqu’un flux de travail de type d’approbation est rejeté |
| Lorsqu’un flux de travail est créé |
Cette opération déclenche un flux lors de la création d’un flux de travail |
| Lorsqu’un flux de travail est terminé |
Cette opération déclenche un flux lorsqu’un flux de travail est terminé |
| Lorsqu’un groupe est créé |
Cette opération déclenche un flux lorsqu’un groupe est créé |
| Lorsqu’un groupe est mis à jour |
Cette opération déclenche un flux lorsqu’un groupe est mis à jour |
| Lorsqu’un groupe est supprimé |
Cette opération déclenche un flux lorsqu’un groupe est supprimé |
| Lorsqu’un lien de partage est créé |
Cette opération déclenche un flux lorsqu’un lien de partage est créé |
| Lorsqu’un lien de partage est supprimé |
Cette opération déclenche un flux lorsqu’un lien de partage est supprimé |
| Lorsqu’un projet est mis à jour |
Cette opération déclenche un flux lorsqu’un projet est mis à jour |
Lorsque les métadonnées du fichier ou du dossier changent
Cette opération déclenche un flux lorsqu’un fichier ou une métadonnées de dossier change
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès cible
|
targetPath | string | |
|
ID de groupe cible
|
targetGroupId | string | |
|
Namespace
|
namespace | string | |
|
Key
|
key | string | |
|
Action
|
action | string |
Lorsque l’autorisation de fichier ou de dossier change
Cette opération déclenche un flux lorsqu’un fichier ou un dossier est autorisé à modifier
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Assignee
|
assignee | string | |
|
ID du bénéficiaire
|
assigneeId | number | |
|
Assigneur
|
assigner | string | |
|
ID de l’assigneur
|
assignerId | number | |
|
Chemin d’accès au dossier
|
folderPath | string | |
|
Nouveau privilège
|
newPrivilege | string | |
|
Ancien privilège
|
oldPrivilege | string | |
|
Nom du groupe
|
groupName | string |
Lorsqu’un dossier de projet est créé
Cette opération déclenche un flux lorsqu’un dossier de projet est créé ou lorsqu’un dossier existant est marqué comme dossier de projet
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
- Corps
- FolderProjectCommon
Lorsqu’un dossier est copié
Cette opération déclenche un flux lorsqu’un sous-dossier est copié dans un dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’événement
|
id | integer |
ID d’un événement individuel. |
|
Timestamp
|
timestamp | string |
Horodatage au format ISO-8601 pour lequel cet événement a été enregistré. |
|
ID d’utilisateur
|
actor | integer |
ID numérique de l’utilisateur qui a effectué l’action. |
|
Action
|
action | string |
Action associée à cet événement. |
|
Chemin d’accès au dossier
|
data.target_path | string |
Chemin d’accès de destination complet au dossier |
|
Chemin d’accès au dossier source
|
data.source_path | string |
Chemin d’accès d’origine complet au dossier |
|
Dossier Is
|
data.is_folder | boolean |
Indique si la ressource est un dossier (True ou False) |
|
Source d’action
|
action_source | string |
Source de l'événement. Par exemple, WebUI, Mobile, etc. |
|
Détail de l’objet
|
object_detail | string |
Détail de l’objet |
Lorsqu’un dossier est créé
Cette opération déclenche un flux lorsqu’un sous-dossier est créé dans un dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’événement
|
id | integer |
ID d’un événement. |
|
Timestamp
|
timestamp | string |
Horodatage au format ISO-8601 pour lequel cet événement a été enregistré. |
|
ID d’utilisateur
|
actor | integer |
ID numérique de l’utilisateur qui a effectué l’action. |
|
Action
|
action | string |
Action associée à cet événement. |
|
Chemin d’accès au dossier
|
data.target_path | string |
Chemin complet du dossier. |
|
Dossier Is
|
data.is_folder | boolean |
Indique si la ressource est un dossier. (True ou False) |
|
Source d’action
|
action_source | string |
Source de l'événement. Par exemple, WebUI, Mobile, etc. |
|
Détail de l’objet
|
object_detail | string |
Détail de l’objet. |
Lorsqu’un dossier est déplacé
Cette opération déclenche un flux lorsqu’un sous-dossier est déplacé dans un dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’événement
|
id | integer |
ID d’un événement individuel. |
|
Timestamp
|
timestamp | string |
Horodatage au format ISO-8601 pour lequel cet événement a été enregistré. |
|
ID d’utilisateur
|
actor | integer |
ID numérique de l’utilisateur qui a effectué l’action. |
|
Action
|
action | string |
Action associée à cet événement. |
|
Chemin d’accès au dossier
|
data.target_path | string |
Chemin d’accès de destination complet au dossier. |
|
Chemin d’accès au dossier source
|
data.source_path | string |
Chemin d’accès d’origine complet au dossier. |
|
Dossier Is
|
data.is_folder | boolean |
Indique si la ressource est un dossier. (True ou False) |
|
Source d’action
|
action_source | string |
Source de l'événement. Par exemple, WebUI, Mobile, etc. |
|
Détail de l’objet
|
object_detail | string |
Détail de l’objet |
Lorsqu’un dossier est renommé
Cette opération déclenche un flux lorsqu’un sous-dossier est renommé dans un dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’événement
|
id | integer |
ID d’un événement individuel. |
|
Timestamp
|
timestamp | string |
Horodatage au format ISO-8601 pour lequel cet événement a été enregistré. |
|
ID d’utilisateur
|
actor | integer |
ID numérique de l’utilisateur qui a effectué l’action. |
|
Action
|
action | string |
Action associée à cet événement. |
|
Chemin d’accès au dossier
|
data.target_path | string |
Chemin d’accès de destination complet au dossier. |
|
Chemin d’accès au dossier source
|
data.source_path | string |
Chemin d’accès d’origine complet au dossier. |
|
Dossier Is
|
data.is_folder | boolean |
Indique si la ressource est un dossier. (True ou False) |
|
Source d’action
|
action_source | string |
Source de l'événement. Par exemple, WebUI, Mobile, etc. |
|
Détail de l’objet
|
object_detail | string |
Détail de l’objet |
Lorsqu’un dossier est supprimé
Cette opération déclenche un flux lorsqu’un sous-dossier est supprimé dans un dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’événement
|
id | integer |
ID d’un événement. |
|
Timestamp
|
timestamp | string |
Horodatage au format ISO-8601 pour lequel cet événement a été enregistré. |
|
ID d’utilisateur
|
actor | integer |
ID numérique de l’utilisateur qui a effectué l’action. |
|
Action
|
action | string |
Action associée à cet événement. |
|
Chemin d’accès au dossier
|
data.target_path | string |
Chemin d’accès complet au dossier supprimé. |
|
Dossier Is
|
data.is_folder | boolean |
Indique si la ressource est un dossier. (True ou False) |
|
Source d’action
|
action_source | string |
Source de l'événement. Par exemple, WebUI, Mobile, etc. |
Lorsqu’un dossier n’est pas balisé en tant que projet
Cette opération déclenche un flux lorsqu’un dossier n’est pas balisé en tant que projet
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
- Corps
- FolderProjectCommon
Lorsqu’un fichier est copié
Cette opération déclenche un flux lorsqu’un fichier est copié dans un dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’événement
|
id | integer |
ID d’un événement individuel. |
|
Timestamp
|
timestamp | string |
Horodatage au format ISO-8601 pour lequel cet événement a été enregistré. |
|
ID d’utilisateur
|
actor | integer |
ID numérique de l’utilisateur qui a effectué l’action. |
|
Action
|
action | string |
Action associée à cet événement. |
|
Chemin d’accès au fichier
|
data.target_path | string |
Chemin complet du fichier. |
|
ID de version
|
data.target_id | string |
ID de la version spécifique du fichier. |
|
ID de fichier
|
data.target_group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
|
Chemin d’accès au fichier source
|
data.source_path | string |
Chemin d’accès d’origine complet au fichier. |
|
ID de version du fichier source
|
data.source_id | string |
ID de version spécifique au fichier source. |
|
ID de fichier source
|
data.source_group_id | string |
ID du fichier source pour référencer le fichier dans son ensemble. |
|
Dossier Is
|
data.is_folder | boolean |
Indique si la ressource est un dossier. (True ou False) |
|
Source d’action
|
action_source | string |
Source de l'événement. Par exemple, WebUI, Mobile, etc. |
|
Détail de l’objet
|
object_detail | string |
Détail de l’objet. |
Lorsqu’un fichier est créé (interrogation)
Cette opération déclenche un flux lorsqu’un nouveau fichier est créé dans un dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’événement
|
id | integer |
ID d’un événement. |
|
Timestamp
|
timestamp | string |
Horodatage au format ISO-8601 pour lequel cet événement a été enregistré. |
|
ID d’utilisateur
|
actor | integer |
ID numérique de l’utilisateur qui a effectué l’action. |
|
Action
|
action | string |
Action associée à cet événement. |
|
Chemin d’accès au fichier
|
data.target_path | string |
Chemin complet du fichier. |
|
ID de version
|
data.target_id | string |
ID de la version spécifique du fichier. |
|
ID de fichier
|
data.target_group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
|
Dossier Is
|
data.is_folder | boolean |
Indique si la ressource est un dossier (True ou False). |
|
Source d’action
|
action_source | string |
Source de l'événement. Par exemple, WebUI, Mobile, etc. |
|
Détail de l’objet
|
object_detail | string |
Détail de l’objet. |
Lorsqu’un fichier est créé (webhook)
Cette opération déclenche un flux lorsqu’un fichier crée dans un dossier spécifique
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au fichier ou dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’entrée de fichier
|
targetEntryId | string | |
|
ID de fichier
|
targetGroupId | string | |
|
Chemin d’accès au fichier
|
targetPath | string | |
|
URL du lien de chargement
|
uploadLinkUrl | string |
Disponible uniquement si le fichier a été chargé via le lien de chargement |
Lorsqu’un fichier est déplacé
Cette opération déclenche un flux lorsqu’un fichier est déplacé dans un dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’événement
|
id | integer |
ID d’un événement individuel. |
|
Timestamp
|
timestamp | string |
Horodatage au format ISO-8601 pour lequel cet événement a été enregistré. |
|
ID d’utilisateur
|
actor | integer |
ID numérique de l’utilisateur qui a effectué l’action. |
|
Action
|
action | string |
Action associée à cet événement. |
|
Chemin d’accès au fichier
|
data.target_path | string |
Chemin complet du fichier. |
|
ID de version
|
data.target_id | string |
ID de la version spécifique du fichier. |
|
ID de fichier
|
data.target_group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
|
Chemin d’accès au fichier source
|
data.source_path | string |
Chemin d’accès d’origine complet au fichier. |
|
Dossier Is
|
data.is_folder | boolean |
Indique si la ressource est un dossier. (True ou False) |
|
Source d’action
|
action_source | string |
Source de l'événement. Par exemple, WebUI, Mobile, etc. |
|
Détail de l’objet
|
object_detail | string |
Détail de l’objet. |
Lorsqu’un fichier est déverrouillé
Cette opération déclenche un flux lorsqu’un fichier est déverrouillé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au fichier ou dossier cible. |
Retours
- Corps
- FileLockWebhookResponse
Lorsqu’un fichier est mis à jour
Cette opération déclenche un flux lorsqu’un fichier est mis à jour dans un dossier spécifique
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au fichier ou dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’entrée de fichier
|
targetEntryId | string | |
|
ID de fichier
|
targetGroupId | string | |
|
Chemin d’accès au fichier
|
targetPath | string |
Lorsqu’un fichier est renommé
Cette opération déclenche un flux lorsqu’un fichier est renommé dans un dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’événement
|
id | integer |
ID d’un événement individuel. |
|
Timestamp
|
timestamp | string |
Horodatage au format ISO-8601 pour lequel cet événement a été enregistré. |
|
ID d’utilisateur
|
actor | integer |
ID numérique de l’utilisateur qui a effectué l’action. |
|
Action
|
action | string |
Action associée à cet événement. |
|
Chemin d’accès au fichier
|
data.target_path | string |
Chemin complet du fichier renommé |
|
ID de version
|
data.target_id | string |
ID de la version spécifique du fichier. |
|
ID de fichier
|
data.target_group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
|
Chemin d’accès au fichier source
|
data.source_path | string |
Chemin d’accès d’origine complet au fichier. |
|
Dossier Is
|
data.is_folder | boolean |
Indique si la ressource est un dossier. (True ou False) |
|
Source d’action
|
action_source | string |
Source de l'événement. Par exemple, WebUI, Mobile, etc. |
|
Détail de l’objet
|
object_detail | string |
Détail de l’objet |
Lorsqu’un fichier est supprimé
Cette opération déclenche un flux lorsqu’un fichier est supprimé dans un dossier.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de l’événement
|
id | integer |
ID d’un événement. |
|
Timestamp
|
timestamp | string |
Horodatage au format ISO-8601 pour lequel cet événement a été enregistré. |
|
ID d’utilisateur
|
actor | integer |
ID numérique de l’utilisateur qui a effectué l’action. |
|
Action
|
action | string |
Action associée à cet événement. |
|
Chemin d’accès à la version
|
data.target_path | string |
Chemin complet de la version de fichier spécifique. |
|
ID de fichier
|
data.target_group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
|
Dossier Is
|
data.is_folder | boolean |
Indique si la ressource est un dossier. (True ou False) |
|
Source d’action
|
action_source | string |
Source de l'événement. Par exemple, WebUI, Mobile, etc. |
Lorsqu’un fichier est verrouillé
Cette opération déclenche un flux lorsqu’un fichier est verrouillé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au fichier ou dossier cible. |
Retours
- Corps
- FileLockWebhookResponse
Lorsqu’un flux de travail de type d’approbation est approuvé
Cette opération déclenche un flux lorsqu’un flux de travail de type d’approbation est approuvé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
- Corps
- WorkflowStepResponse
Lorsqu’un flux de travail de type d’approbation est rejeté
Cette opération déclenche un flux lorsqu’un flux de travail de type d’approbation est rejeté
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
- Corps
- WorkflowStepResponse
Lorsqu’un flux de travail est créé
Cette opération déclenche un flux lors de la création d’un flux de travail
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de flux de travail
|
workflow.id | string | |
|
Nom du flux de travail
|
workflow.name | string | |
|
ID d’affichage du flux de travail
|
workflow.displayId | number | |
|
Type de flux de travail
|
workflow.type | string | |
|
ID du modèle de flux de travail
|
workflow.templateId | string | |
|
Statut de l’action du workflow
|
workflow.actionStatus | string | |
|
Premier type d’entité
|
firstEntity.type | string | |
|
Premier chemin d’entité
|
firstEntity.filePath | string | |
|
PREMIER ID d’entrée d’entité
|
firstEntity.entryID | string | |
|
Premier ID de groupe d’entités
|
firstEntity.groupID | string | |
|
Définition JSON
|
definitionJson | string |
Lorsqu’un flux de travail est terminé
Cette opération déclenche un flux lorsqu’un flux de travail est terminé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de flux de travail
|
workflow.id | string | |
|
Nom du flux de travail
|
workflow.name | string | |
|
ID d’affichage du flux de travail
|
workflow.displayId | number | |
|
Type de flux de travail
|
workflow.type | string | |
|
ID du modèle de flux de travail
|
workflow.templateId | string | |
|
Statut de l’action du workflow
|
workflow.actionStatus | string | |
|
Premier type d’entité
|
firstEntity.type | string | |
|
Premier chemin d’entité
|
firstEntity.filePath | string | |
|
PREMIER ID d’entrée d’entité
|
firstEntity.entryID | string | |
|
Premier ID de groupe d’entités
|
firstEntity.groupID | string | |
|
Code d’état de saisie semi-automatique
|
completionStatusCode | string | |
|
Nombre total d’étapes
|
totalNumberOfSteps | number | |
|
Date d’achèvement
|
completionDate | number |
Lorsqu’un groupe est créé
Cette opération déclenche un flux lorsqu’un groupe est créé
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’utilisateur
|
user.id | integer |
Identificateur unique de l’utilisateur. |
|
Nom complet
|
user.fullName | string |
Nom d'affichage indique le nom complet de l'utilisateur. |
|
Nom d’utilisateur
|
user.userName | string |
Nom d’utilisateur de l’utilisateur. |
|
Adresse e-mail de l’utilisateur
|
user.email | string |
Adresse e-mail de l’utilisateur. |
|
ID d’utilisateur
|
owner.id | integer |
Identificateur unique de l’utilisateur. |
|
Nom complet
|
owner.fullName | string |
Nom d'affichage indique le nom complet de l'utilisateur. |
|
Nom d’utilisateur
|
owner.userName | string |
Nom d’utilisateur de l’utilisateur. |
|
Adresse e-mail de l’utilisateur
|
owner.email | string |
Adresse e-mail de l’utilisateur. |
|
Nom du groupe
|
groupName | string |
Nom du groupe. |
|
ID de groupe
|
groupId | string |
Identificateur unique du groupe. |
|
Members
|
members | array of GroupUser |
Membres du groupe. |
Lorsqu’un groupe est mis à jour
Cette opération déclenche un flux lorsqu’un groupe est mis à jour
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’utilisateur
|
user.id | integer |
Identificateur unique de l’utilisateur. |
|
Nom complet
|
user.fullName | string |
Nom d'affichage indique le nom complet de l'utilisateur. |
|
Nom d’utilisateur
|
user.userName | string |
Nom d’utilisateur de l’utilisateur. |
|
Adresse e-mail de l’utilisateur
|
user.email | string |
Adresse e-mail de l’utilisateur. |
|
ID d’utilisateur
|
owner.id | integer |
Identificateur unique de l’utilisateur. |
|
Nom complet
|
owner.fullName | string |
Nom d'affichage indique le nom complet de l'utilisateur. |
|
Nom d’utilisateur
|
owner.userName | string |
Nom d’utilisateur de l’utilisateur. |
|
Adresse e-mail de l’utilisateur
|
owner.email | string |
Adresse e-mail de l’utilisateur. |
|
Nom du groupe
|
groupName | string |
Nom du groupe. |
|
ID de groupe
|
groupId | string |
Identificateur unique du groupe. |
|
Action
|
action | string |
Action spécifique qui a déclenché la mise à jour du groupe. |
|
Members
|
members | array of GroupUser |
Membres du groupe. |
Lorsqu’un groupe est supprimé
Cette opération déclenche un flux lorsqu’un groupe est supprimé
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’utilisateur
|
user.id | integer |
Identificateur unique de l’utilisateur. |
|
Nom complet
|
user.fullName | string |
Nom d'affichage indique le nom complet de l'utilisateur. |
|
Nom d’utilisateur
|
user.userName | string |
Nom d’utilisateur de l’utilisateur. |
|
Adresse e-mail de l’utilisateur
|
user.email | string |
Adresse e-mail de l’utilisateur. |
|
Nom du groupe
|
groupName | string |
Nom du groupe. |
|
ID de groupe
|
groupId | string |
Identificateur unique du groupe. |
Lorsqu’un lien de partage est créé
Cette opération déclenche un flux lorsqu’un lien de partage est créé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
- Corps
- LinkWebhookResponse
Lorsqu’un lien de partage est supprimé
Cette opération déclenche un flux lorsqu’un lien de partage est supprimé
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
- Corps
- LinkWebhookResponse
Lorsqu’un projet est mis à jour
Cette opération déclenche un flux lorsqu’un projet est mis à jour
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Chemin d’accès au dossier
|
FolderPath | True | string |
Chemin d’accès au dossier cible. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
projectId
|
projectId | string | |
|
projectRootFolderId
|
projectRootFolderId | string | |
|
Nom du projet
|
name | string | |
|
Emplacement du projet
|
location | string | |
|
État du projet
|
status | string |
État du projet (EN COURS, EN COURS, ON-HOLD, COMPLETED, CANCELED) |
Définitions
GroupUser
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’utilisateur
|
id | integer |
Identificateur unique de l’utilisateur. |
|
Nom complet
|
fullName | string |
Nom d'affichage indique le nom complet de l'utilisateur. |
|
Nom d’utilisateur
|
userName | string |
Nom d’utilisateur de l’utilisateur. |
|
Adresse e-mail de l’utilisateur
|
string |
Adresse e-mail de l’utilisateur. |
LinkWebhookResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Chemin d’accès source
|
sourcePath | string | |
|
ID de lien
|
linkId | string | |
|
Type de lien
|
linkType | string |
Fichier ou dossier |
|
URL du lien
|
linkURL | string |
FileInfoResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Somme de contrôle
|
checksum | string |
Valeur de somme de contrôle de la version actuelle du fichier utilisé pour déterminer les modifications apportées au fichier. |
|
Taille
|
size | integer |
Taille du fichier en octets. |
|
Chemin d’accès au fichier
|
path | string |
Chemin d’accès complet du fichier. |
|
Nom
|
name | string |
Nom de fichier. |
|
Est verrouillé
|
locked | boolean |
État du verrou sur le fichier. |
|
Dossier Is
|
is_folder | boolean |
Indique si la ressource est un dossier. Vrai ou Faux |
|
ID de version
|
entry_id | string |
ID de la version actuelle du fichier. |
|
ID de fichier
|
group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
|
ID de répertoire parent
|
parent_id | string |
ID du dossier parent demandé. |
|
Dernière modification
|
last_modified | string |
Heure de dernière modification de la version actuelle d’un fichier. |
|
Chargé par
|
uploaded_by | string |
Nom d’utilisateur de l’utilisateur qui a chargé la version actuelle. |
|
Horodatage chargé
|
uploaded | integer |
Heure de chargement de la version actuelle du fichier. |
|
Nombre de versions
|
num_versions | integer |
Nombre total de versions associées au chemin d’accès de fichier spécifique. |
|
versions
|
versions | array of object |
Versions |
|
Dossier Is (version)
|
versions.is_folder | boolean |
Indique si la ressource est un dossier. Vrai ou Faux |
|
ID de version
|
versions.entry_id | string |
ID de la version spécifique du fichier. |
|
Somme de contrôle (version)
|
versions.checksum | string |
Valeur de somme de contrôle de la version du fichier utilisée pour déterminer les modifications de fichier. |
|
Dernière modification (version)
|
versions.last_modified | string |
Heure de dernière modification de la version spécifique d’un fichier. |
|
Chargé par (version)
|
versions.uploaded_by | string |
Nom d’utilisateur de l’utilisateur qui a chargé la version. |
|
Horodatage chargé (version)
|
versions.uploaded | integer |
Heure de chargement de la version spécifique du fichier. |
|
Taille (version)
|
versions.size | integer |
Taille du fichier en octets pour la version spécifique. |
UserInfoResponse
Informations utilisateur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’utilisateur
|
id | integer |
ID d’utilisateur |
|
Nom d’utilisateur
|
userName | string |
Nom d’utilisateur de l’utilisateur |
|
External ID
|
externalId | string |
External ID |
|
Messagerie électronique
|
string |
Adresse e-mail de l’utilisateur |
|
|
Nom de la famille
|
name.familyName | string |
Nom de famille d’utilisateurs (Nom) |
|
Prénom
|
name.givenName | string |
Nom donné par l’utilisateur (prénom) |
|
Active
|
active | boolean |
Compte d’utilisateur actif |
|
Date de création
|
createdDate | string |
Date de création de l’utilisateur |
|
Date de la dernière modification
|
lastModificationDate | string |
La dernière date de modification de l’utilisateur |
|
Dernière date active
|
lastActiveDate | string |
La dernière date d’activité de l’utilisateur |
|
Verrouillé
|
locked | boolean |
L’utilisateur est verrouillé |
|
Language
|
language | string |
Le paramètre « language » est accepté uniquement lorsque le module linguistique a été activé pour le domaine. |
|
Type d’authentification
|
authType | string |
Type d’authentification pour l’utilisateur. |
|
Type d’utilisateur
|
userType | string |
Type de l’utilisateur. |
|
Role
|
role | string |
Rôle attribué à l’utilisateur. Applicable uniquement aux utilisateurs Power. |
|
ID d’utilisateur du fournisseur d’identité
|
idpUserId | string |
ID d’utilisateur du fournisseur d’identité |
|
Compte de service
|
isServiceAccount | boolean |
Compte utilisé comme compte de service |
|
Supprimer à l’expiration
|
deleteOnExpiry | string |
Le compte sera-t-il supprimé après son expiration |
|
Modification de l’e-mail en attente
|
emailChangePending | boolean |
Modification de l’e-mail de l’utilisateur en attente |
|
Date d’expiration
|
expiryDate | string |
Expiration du compte |
|
Nom d’utilisateur principal
|
userPrincipalName | string | |
|
groups
|
groups | array of object | |
|
Nom affiché
|
groups.displayName | string |
Nom du groupe |
|
ID de groupe
|
groups.value | string |
L’ID du groupe |
UserListResponse
Obtenir la réponse de liste des utilisateurs
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Résultats totaux
|
totalResults | integer |
Nombre total de résultats correspondant à la requête. |
|
Éléments par page
|
itemsPerPage | integer |
Nombre de résultats retournés. |
|
Index de démarrage
|
startIndex | integer |
Index de base 1 du premier résultat dans l’ensemble actuel de résultats. |
|
resources
|
resources | array of object | |
|
ID d’utilisateur
|
resources.id | integer |
ID de l’utilisateur |
|
Nom d’utilisateur
|
resources.userName | string |
Nom d’utilisateur de l’utilisateur |
|
External ID
|
resources.externalId | string |
External ID |
|
Messagerie électronique
|
resources.email | string |
Adresse e-mail de l’utilisateur |
|
Nom mis en forme
|
resources.name.formatted | string |
Nom mis en forme par l’utilisateur |
|
Nom de la famille
|
resources.name.familyName | string |
Nom de famille d’utilisateurs (Nom) |
|
Prénom
|
resources.name.givenName | string |
Nom donné par l’utilisateur (prénom) |
|
Active
|
resources.active | boolean |
Compte d’utilisateur actif |
|
Verrouillé
|
resources.locked | boolean |
Le compte d’utilisateur est-il verrouillé |
|
Date de création
|
resources.createdDate | string |
Date de création de l’utilisateur |
|
Date de la dernière modification
|
resources.lastModificationDate | string |
La dernière date de modification de l’utilisateur |
|
Dernière date active
|
resources.lastActiveDate | string |
La dernière date d’activité de l’utilisateur |
|
Language
|
resources.language | string |
Le paramètre « language » est accepté uniquement lorsque le module linguistique a été activé pour le domaine. |
|
Type d’authentification
|
resources.authType | string |
Type d’authentification pour l’utilisateur. |
|
Type d’utilisateur
|
resources.userType | string |
Type de l’utilisateur. |
|
Role
|
resources.role | string |
Rôle attribué à l’utilisateur. Applicable uniquement aux utilisateurs Power. |
|
ID d’utilisateur du fournisseur d’identité
|
resources.idpUserId | string |
ID d’utilisateur du fournisseur d’identité |
|
Compte de service
|
resources.isServiceAccount | boolean |
Compte utilisé comme compte de service |
|
Supprimer à l’expiration
|
resources.deleteOnExpiry | string |
Le compte sera-t-il supprimé après son expiration |
|
Modification de l’e-mail en attente
|
resources.emailChangePending | boolean |
Modification de l’e-mail de l’utilisateur en attente |
|
Date d’expiration
|
resources.expiryDate | string |
Expiration du compte |
|
Nom d’utilisateur principal
|
resources.userPrincipalName | string |
FolderInfoResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom du dossier. |
|
Dernière modification
|
lastModified | integer |
La dernière fois que n’importe quel fichier du dossier (mais pas dans les sous-dossiers) a été modifié. |
|
Horodatage chargé
|
uploaded | integer |
Heure à laquelle le dossier a été chargé ou créé. |
|
Chemin d’accès au dossier
|
path | string |
Chemin complet du dossier. |
|
ID du dossier
|
folder_id | string |
ID unique du dossier. |
|
ID de répertoire parent
|
parent_id | string |
ID du dossier parent. |
|
Nombre de sous-éléments
|
total_count | integer |
Nombre total d’éléments réellement disponibles pour le retour. |
|
Dossier Is
|
is_folder | boolean |
Indique si la ressource est un dossier. Vrai ou Faux |
|
Liens publics possibles
|
public_links | string |
Paramètre d’option de dossier sur la façon dont « Autoriser les liens publics à partir de ce dossier » a été défini. |
|
Est partageable
|
allow_links | boolean |
Est-il partageable ? T ou F |
|
Peut être supprimé ou déplacé
|
restrict_move_delete | boolean |
Peut-il être supprimé ou déplacé ? T ou F |
|
Dossiers
|
folders | array of object |
Dossiers |
|
Nom (sous-dossier)
|
folders.name | string |
Nom du dossier. |
|
Dernière modification (sous-dossier)
|
folders.lastModified | integer |
La dernière fois que n’importe quel fichier du dossier (mais pas dans les sous-dossiers) a été modifié. |
|
Timestamp chargé (sous-dossier)
|
folders.uploaded | integer |
Heure à laquelle le dossier a été chargé ou créé. |
|
Chemin d’accès (sous-dossier)
|
folders.path | string |
Chemin d’accès complet du dossier tel que demandé. |
|
ID (sous-dossier)
|
folders.folder_id | string |
ID du dossier demandé. |
|
Dossier Is (sous-dossier)
|
folders.is_folder | boolean |
Indique si la ressource est un dossier. Vrai ou Faux |
|
ID de dossier parent (sous-dossier)
|
folders.parent_id | string |
ID du dossier parent. |
|
Fichiers
|
files | array of object |
Fichiers |
|
Somme de contrôle (fichier)
|
files.checksum | string |
Valeur de somme de contrôle de la version actuelle du fichier utilisé pour déterminer les modifications apportées au fichier. |
|
Taille (fichier)
|
files.size | integer |
Taille du fichier en octets. |
|
Chemin d’accès (fichier)
|
files.path | string |
Chemin d’accès complet du fichier. |
|
Nom (fichier)
|
files.name | string |
Nom de fichier. |
|
Est verrouillé (fichier)
|
files.locked | boolean |
État du verrou sur le fichier. |
|
Dossier (fichier)
|
files.is_folder | boolean |
Indique si la ressource est un dossier. Vrai ou Faux |
|
ID de version (fichier)
|
files.entry_id | string |
ID de la version spécifique du fichier. |
|
ID (fichier)
|
files.group_id | string |
ID permettant de référencer le fichier dans son ensemble. |
|
ID de dossier parent (fichier)
|
files.parent_id | string |
ID du dossier parent. |
|
Dernière modification (fichier)
|
files.last_modified | string |
Heure de dernière modification de la version actuelle d’un fichier. |
|
Chargé par (fichier)
|
files.uploaded_by | string |
Nom d’utilisateur de l’utilisateur qui a chargé la version. |
|
Timestamp chargé (fichier)
|
files.uploaded | integer |
Heure de chargement de la version actuelle du fichier. |
|
Nombre de versions (fichier)
|
files.num_versions | integer |
Nombre total de versions associées au chemin d’accès de fichier spécifique. |
NamespaceItem
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom de l’espace de noms
|
name | string | |
|
Étendue de l’espace de noms
|
scope | string | |
|
clés
|
keys | object | |
|
nom d’affichage
|
displayName | string |
Nom permettant d’identifier l’espace de noms dans l’interface utilisateur |
|
priority
|
priority | number |
Spécifie la priorité (ordre) des clés. Les clés seront affichées conformément à leurs priorités dans l’ordre décroissant (les clés avec une priorité plus élevée seront affichées en premier) |
|
hériter
|
inheritable | boolean | |
|
schemaSystemGenerated
|
schemaSystemGenerated | boolean | |
|
metadataScopeType
|
metadataScopeType | string | |
|
modifiable
|
editable | boolean |
ProjectItem
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
ID de l’élément |
|
ID de dossier racine
|
rootFolderId | string |
ID de dossier racine |
|
Nom
|
name | string |
Nom du projet |
|
ID de projet
|
projectId | string |
ID du projet |
|
Nom du client
|
customerName | string |
Client associé au projet |
|
Descriptif
|
description | string |
Description du dossier |
|
location
|
location | ProjectLocationItem | |
|
Statut
|
status | string |
État du projet |
|
Créée par
|
createdBy | number |
Créée par |
|
Dernière mise à jour par
|
lastUpdatedBy | number |
Dernière mise à jour par |
|
Heure de création
|
creationTime | string |
Heure de création |
|
Heure de la dernière modification
|
lastModifiedTime | string |
Heure de la dernière modification |
|
Date de début
|
startDate | string |
Date de début du projet. |
|
Date d’achèvement
|
completionDate | string |
Date d’achèvement du projet. |
ProjectLocationItem
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Adresse postale 1
|
streetAddress1 | string |
Première ligne de l’adresse postale |
|
Adresse postale 2
|
streetAddress2 | string |
Deuxième ligne de l’adresse postale |
|
Ville
|
city | string |
Ville |
|
Département ou région
|
state | string |
Département ou région |
|
Pays
|
country | string |
Pays |
|
Code postal ou code postal
|
postalCode | string |
Code postal ou code postal |
FileLockWebhookResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de fichier
|
targetGroupId | string | |
|
Somme de contrôle de fichier
|
targetFileChecksum | string | |
|
Chemin d’accès au fichier
|
targetPath | string |
FolderProjectCommon
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
projectId
|
projectId | string | |
|
projectRootFolderId
|
projectRootFolderId | string |
WorkflowStepResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de flux de travail
|
workflow.id | string | |
|
Nom du flux de travail
|
workflow.name | string | |
|
ID d’affichage du flux de travail
|
workflow.displayId | number | |
|
Type de flux de travail
|
workflow.type | string | |
|
ID du modèle de flux de travail
|
workflow.templateId | string | |
|
Statut de l’action du workflow
|
workflow.actionStatus | string | |
|
Premier type d’entité
|
firstEntity.type | string | |
|
Premier chemin d’entité
|
firstEntity.filePath | string | |
|
PREMIER ID d’entrée d’entité
|
firstEntity.entryID | string | |
|
Premier ID de groupe d’entités
|
firstEntity.groupID | string | |
|
ID d’étape
|
step.id | string | |
|
Nom de l’étape
|
step.name | string | |
|
Type d’étape
|
step.type | string | |
|
ID du bénéficiaire
|
assignee.id | number | |
|
Nom d’affichage du destinataire
|
assignee.displayName | string | |
|
Nom d’utilisateur du bénéficiaire
|
assignee.username | string | |
|
Adresse e-mail du destinataire
|
assignee.email | string | |
|
Nombre total d’étapes
|
totalNumberOfSteps | number | |
|
Date d’achèvement
|
completionDate | number | |
|
Date de création
|
creationDate | number |
AIQuestionResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
response
|
response | AIResponse | |
|
Références
|
citations | array of AICitation |
Citations et références utilisées pour générer la réponse |
AISummaryResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
response
|
response | AIResponse |
AICopilotResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
response
|
response | AIResponse | |
|
Références
|
citations | array of AICitation |
Citations et références utilisées pour générer la réponse |
|
ID de conversation
|
conversationId | string |
Identificateur unique de la conversation |
AICitation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Filename
|
filename | string |
Nom du fichier source |
|
ID d’entrée
|
entryId | string |
ID d’entrée du fichier source |
|
Blocs de texte
|
chunks | array of object |
Tableau de blocs de texte de la source |
|
ID de bloc
|
chunks.chunkId | string |
ID du bloc de texte |
|
Texte de départ
|
chunks.sourceText | string |
Contenu texte du bloc |
AIResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Texte de réponse
|
text | string |
Texte de réponse généré par l’IA |