Ce document présente les fonctionnalités exposées par l'API NetExplorer.
Celle-ci est basée sur l'architecture REST, reposant sur le protocole HTTP, permettant ainsi aux développeurs de tirer pleinement parti de leur plateforme de stockage NetExplorer, et mettre au point une solution logicielle répondant aux besoins de leur entreprise.
L'API est accessible en ajoutant /api à l'adresse de votre plateforme.
L'accès aux différents modules se fera donc via des URLs sous la forme https://exemple.fr/api/module.
Enfin, si vous souhaitez rester informé des modifications de la documentation API, vous pouvez vous inscrire à notre liste de diffusion dédiée en cliquant ici : Rester informé
Info Consultez la section Authentification pour savoir comment obtenir un token.
Info Les codes HTTP standards sont à prendre en compte lorsque le serveur répond aux requêtes.
Quelques en-têtes communs:
Note Les structures présentées ci-dessous sont affichées sous la forme d'un objet JSON. Il s'agit du seul format proposé par l'API.
Pour l'exploiter correctement, certains points sont à savoir:
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique du dossier. |
name | string | Nom du dossier. |
parent_id | int | Identifiant numérique unique du dossier parent. |
can_read Lecture seule | bool | Indique si l'utilisateur courant peut avoir un aperçu des documents présents dans ce dossier. |
can_download Lecture seule | bool | Indique si l'utilisateur courant peut télécharger des documents présents dans ce dossier. |
can_write Lecture seule | bool | Indique si l'utilisateur courant peut créer de nouveaux fichiers dans ce dossier. |
can_edit Lecture seule | bool | Indique si l'utilisateur courant peut modifier des documents présents dans ce dossier. |
can_delete Lecture seule | bool | Indique si l'utilisateur courant peut supprimer des documents présents dans ce dossier. |
can_share Lecture seule | bool | Indique si l'utilisateur courant peut partager des documents présents dans ce dossier avec des personnes extérieures. |
creation Lecture seule Indisponible en mode light | date | Date de création du dossier. |
modification Lecture seule Indisponible en mode light | date | Date de dernière modification du contenu du dossier. |
owner Lecture seule Indisponible en mode light | string | Nom complet de l'utilisateur propriétaire du dossier. |
owner_id Lecture seule Indisponible en mode light | string | Identifiant unique de l'utilisateur propriétaire du dossier. |
can_dlink Lecture seule Mode complet uniquement | bool | Indique si l'utilisateur peut générer un lien de téléchargement sur ce dossier, en prenant en compte les droits d'accès et les informations de configuration de la plateforme. |
can_ulink Lecture seule Mode complet uniquement | bool | Indique si l'utilisateur peut générer un lien de dépôt sur ce dossier, en prenant en compte les droits d'accès et les informations de configuration de la plateforme. |
can_admin_rights Lecture seule Mode complet uniquement | bool | Indique si l'utilisateur courant peut gérer les droits sur le dossier. |
can_admin_alerts Lecture seule Mode complet uniquement | bool | Indique si l'utilisateur courant peut gérer les alertes emails sur le dossier. |
self_alert Mode complet uniquement Optionnel | bool ou non défini | Indique si l'utilisateur courant est alerté des modifications sur le dossier. Si l'option self_alert de la configuration n'est pas activée, ce champ sera totalement absent des réponses. |
shared Lecture seule Mode complet uniquement | bool | Indique si le dossier est un dossier d'un espace privé qui a été partagé. |
nb_participants Lecture seule Mode complet uniquement Optionnel | int ou non défini | Nombre de participants invités sur le dossier. Valeur présente uniquement si > 0. |
nb_annotations Lecture seule Mode complet uniquement Optionnel | int ou non défini | Nombre d'annotations sur le dossier. Valeur présente uniquement si > 0. |
nb_unread_annotations Lecture seule Mode complet uniquement Optionnel | int ou non défini | Nombre d'annotations non-lues sur le dossier. Valeur présente uniquement si > 0. |
size Lecture seule Mode complet uniquement | int | Taille en octets du dossier. |
nb_d_folders Lecture seule Mode complet uniquement | int | Nombre de sous-dossiers présents, sans prendre en compte toute l'arborescence inférieure. |
nb_d_files Lecture seule Mode complet uniquement | int | Nombre de fichiers présents, sans prendre en compte toute l'arborescence inférieure. |
nb_folders Lecture seule Mode complet uniquement | int | Nombre total de sous-dossiers (totalité de l'arborescence). |
nb_files Lecture seule Mode complet uniquement | int | Nombre total de fichiers (totalité de l'arborescence). |
quota Mode complet uniquement | int | Quota d'espace disque appliqué au dossier. 0 = illimité, -1 = Hériter du dossier parent, sinon un nombre d'octets. |
purge_frequency Mode complet uniquement | int | Délai après lequel les fichiers sont automatiquement supprimés du dossier. 0 = désactivé, sinon un nombre de jours |
path Lecture seule Mode complet uniquement | string | Chemin d'accès au dossier, composé des identifiants uniques des dossiers parents. |
path_name Lecture seule Mode complet uniquement | string | Chemin d'accès au dossier, composé des noms des dossiers parents, limité par les droits d'accès de l'utilisateur. |
content Lecture seule Mode complet uniquement | Object | Contient 2 entrées, "files" et "folders", contenant les listes de fichiers et dossiers contenu dans le dossier courant. Ne sera retourné que si le listing récursif est demandé et que le niveau de profondeur indiqué n'a pas été atteint. { "files": [ // Objets Fichier { "id": 1, "name": [ ... ] }, ... ], "folders": [ // Objets Dossier { "id": 1, "name": [ ... ] }, ... ] } |
{ "id": 1, "name": "Documents", "parent_id": 0, "can_read": true, "can_download": true, "can_write": false, "can_edit": false, "can_delete": false, "can_share": true, "content": { "files": [ { "id": 1, "name": [ ... ] }, ... ], "folders": [ { "id": 2, "name": [ ... ] }, ... ], // Les paramètres suivants ne sont pas disponibles en mode light }, "creation": "2015-08-01T02:00:00+02:00", "modification": "2015-08-01T02:00:00+02:00", "owner": "Jean DUPOND", "owner_id": [ // Les paramètres suivants ne sont disponibles qu'en mode complet ], "can_dlink": true, "can_ulink": true, "can_admin_rights": false, "can_admin_alerts": false, "self_alert": true, "nb_participants": 0, "nb_annotations": 4, "nb_unread_annotations": 1, "size": 1128963, "nb_d_folders": 1, "nb_d_files": 5, "nb_folders": 1, "nb_files": 14, "quota": -1, "purge_frequency": 0, "path": "/" }
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique du fichier (version). |
guid Lecture seule | string | Identifiant global unique du fichier (GUID) du fichier. |
name | string | Nom du fichier. |
parent_id | int | Identifiant numérique unique du dossier parent. |
creation Lecture seule Indisponible en mode light | date | Date de création de la version courante du fichier. |
modification Lecture seule | date | Date de dernière modification de la version la plus récente du fichier. |
can_download Lecture seule | bool | Indique si l'utilisateur courant peut télécharger le fichier. |
can_write Lecture seule | bool | Indique si l'utilisateur courant peut créer de nouvelles versions du fichier. |
can_edit Lecture seule | bool | Indique si l'utilisateur courant peut modifier une version existante du fichier. |
can_delete Lecture seule | bool | Indique si l'utilisateur courant peut supprimer le fichier. |
can_share Lecture seule | bool | Indique si l'utilisateur courant peut partager le fichier vers l'exterieur. |
owner Lecture seule Indisponible en mode light | string | Nom complet de l'utilisateur propriétaire du fichier. |
owner_id Lecture seule Indisponible en mode light | string | Identifiant unique de l'utilisateur propriétaire du fichier. |
hash Lecture seule | string[32] | Hash MD5 du fichier. |
lock Lecture seule | Verrou ou null | Contient les informations sur le verrou actuellement en place, s'il y en a un. Sinon, vaut null. |
nb_versions Lecture seule Mode complet uniquement Optionnel | int ou non défini | Nombre de versions existantes pour ce fichier. Valeur présente uniquement si > 1. |
nb_annotations Lecture seule Mode complet uniquement Optionnel | int ou non défini | Nombre d'annotations sur le fichier. Valeur présente uniquement si > 0. |
nb_unread_annotations Lecture seule Mode complet uniquement Optionnel | int ou non défini | Nombre d'annotations non-lues sur le fichier. Valeur présente uniquement si > 0 |
meta Lecture seule Mode complet uniquement Optionnel | Object ou non défini | Contient les méta-données du document. { "author": "Luc MARCHAND", // Auteur du document "creator": "LibreOffice", // Logiciel de traitement de texte utilisé "date": "Sun Sep 1 00:00:00 2013", // Date de dernière édition du document "keywords": "mots clés document", // Mots clés "pages": 10, // Nombre de pages "producer": "GhostScript", // Logiciel ayant produit le fichier "subject": "Détail des ventes pour l'année 2013", // Sujet détaillé du document "title": "Rapport ventes 2013" // Titre du document } |
thumb_token Lecture seule Mode complet uniquement Optionnel | string ou non défini | Token d'accès aux miniatures de ce fichier si le format est supporté. |
file_type Lecture seule Mode complet uniquement Optionnel | string ou non défini | Type d'aperçu du fichier. Peut valoir image , document ou video si l'aperçu est disponible pour ce fichier. |
Attention Cette propriété est obsolète. Utilisez plutôt POST /token/file/(fileId)/(type) Lecture seule Mode complet uniquement | string | Token d'accès pour le téléchargement du fichier. |
path Lecture seule Mode complet uniquement | string | Chemin d'accès au fichier, composé des identifiants uniques des dossiers parents. |
{ "id": 458, "name": "MonImage.jpg", "parent_id": 1, "creation": "2015-08-01T02:00:00+02:00", "modification": "2015-08-01T02:00:00+02:00", "can_download": true, "can_write": false, "can_edit": false, "can_delete": false, "can_share": true, "owner": "Jean DUPOND", "owner_id": "4", "hash": "d41d8cd98f00b204e9800998ecf8427e", "lock": [ // Les paramètres suivants ne sont disponibles qu'en mode complet ], "nb_versions": 7, "nb_annotations": 4, "nb_unread_annotations": 1, "meta": { "author": "Luc MARCHAND", "creator": "LibreOffice", "date": "Sun Sep 1 00:00:00 2013", "keywords": "mots clés document", "pages": 10, "producer": "GhostScript", "subject": "Détail des ventes pour l'année 2013", "title": "Rapport ventes 2013" }, "thumbs_token": "2uYPfBWitiof...", "file_type": "image", "path": "/1/" }
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique de l'élément de la corbeille. |
name Lecture seule | string | Nom de l'élément de la corbeille. |
is_file Lecture seule | bool | Indique s'il s'agit d'un fichier ou d'un dossier. |
deletion Lecture seule | date | Date de suppression du fichier. |
modification Lecture seule | date | Date de dernière modification du fichier avant suppression. |
owner Lecture seule | string | Nom complet de l'utilisateur propriétaire du fichier supprimé. |
owner_id Lecture seule | string | Identifiant unique de l'utilisateur propriétaire du fichier supprimé. |
size Lecture seule | int | Taille de l'élément de la corbeille. |
nb_folders Lecture seule Optionnel | int ou non défini | Nombre de sous-dossiers présents dans le dossier. Ne s'applique pas aux fichiers |
nb_files Lecture seule Optionnel | int ou non défini | Nombre de fichiers présents dans le dossier. Ne s'applique pas aux fichiers |
{ "id": 11567, "name": "MonFichier.txt", "is_file": true, "deletion": "2015-07-18T20:59:00+0200", "modification": "2015-06-24T15:45:28+0200", "owner": "Bob Jensen", "owner_id": "22", "size": 15632 }
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique de l'annotation. |
target_id | int | Identifiant numérique unique du fichier ou du dossier. |
target_type | string | Type d'objet rattaché. Vaut "file" ou "folder". |
owner Lecture seule | string | Nom complet de l'auteur de l'annotation. |
owner_id Lecture seule | string | Identifiant unique de l'auteur de l'annotation. |
date Lecture seule | date | Date à laquelle l'annotation a été créé. |
text | string | Contenu textuel de l'annotation |
conversation | int ou null | Identifiant unique de l'annotation dont ce message est la réponse. |
{ "id": 24, "target_id": 11567, "target_type": "file", "owner": "Jack JAUFFRE", "owner_id": "4558", "date": "2015-07-28T12:58:26+02:00", "text": "Voici le contenu de mon annotation", "conversation": null }
Nom | Type | Description |
---|---|---|
file Lecture seule | string | Identifiant global unique du fichier (GUID) auquel ce verrou est rattaché. |
owner Lecture seule | string | Nom complet du propriétaire du verrou. |
owner_id Lecture seule | string | Identifiant unique du propriétaire du verrou. |
locked Lecture seule | bool | Indique si le fichier est actuellement verrouillé, quelque soit l'utilisateur l'ayant verrouillé. |
writeable Lecture seule | bool | Indique si le fichier est accessible en écriture. Peut être à true même si locked = true , notamment si le fichier est verrouillé par l'utilisateur courant. |
readable Lecture seule | bool | Indique si le fichier est accessible en lecture, notamment si le fichier n'est verrouillé qu'en écriture. |
date Lecture seule | date | Date à laquelle le verrouillage a été créé. |
{ "file": "00000000-0000-0000-0000-000000000000", "owner": "Edouard DESPEREAUX", "owner_id": "125696", "locked": true, "writeable": false, "readable": true }
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique du droit. |
folder_id Lecture seule | int | Identifiant numérique unique du dossier. |
target_id | int | Identifiant unique de l'utilisateur auquel est accordé le droit. |
target Lecture seule | string | Nom complet de l'utilisateur cible. |
browse | bool | Indique si l'utilisateur a le droit de naviguer dans le dossier. Si ce champ vaut false, l'utilisateur n'aura plus accès au dossier courant. |
read | bool | Indique si l'utilisateur peut voir la liste des fichiers du dossier courant, et en avoir un aperçu. |
download | bool | Indique si l'utilisateur peut télécharger les fichiers présents dans le dossier. |
write | bool | Indique si l'utilisateur peut ajouter de nouveaux fichiers. |
edit | bool | Indique si l'utilisateur peur modifier un fichier existant. |
delete | bool | Indique si l'utilisateur peut supprimer un fichier de ce dossier. |
share | bool | Indique si l'utilisateur peut inviter des participants à collaborer sur le dossier, et créer des liens de téléchargement/dépôt. |
{ "id": 56629, "folder_id": 36948, "target_id": "4673", "target": [ ], "browse": true, "read": true, "download": true, "write": false, "edit": false, "delete": false, "share": false }
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique de l'alerte. |
folder_id Lecture seule | int | Identifiant numérique unique du dossier. |
target_id | int | Identifiant unique de l'utilisateur ou du groupe alerté. |
target Lecture seule | string | Nom complet de l'utilisateur cible, ou nom du groupe. |
target_isgroup Lecture seule | bool | Indique si la cible est un utilisateur (true) ou un groupe (false). |
int | Identifiant numérique unique de l'objet Email utilisé pour l'envoi de l'alerte. | |
expiration_date | date ou null | Date d'expiration de l'alerte. Après cette date, l'alerte existera toujours, mais sera considérée comme inactive. Le champs vaut null si aucune date d'expiration n'a été définie. |
owner Lecture seule | string | Nom complet de l'utilisateur ayant créé l'alerte. |
owner_id Lecture seule | string | Identifiant unique de l'utilisateur ayant créé l'alerte. |
{ "id": 104, "folder_id": 1, "target_id": 3, "target": "José SANCHEZ", "target_isgroup": false, "active": true, "email": -1, "expiration_date": null, "owner": "Hervé FIGIS", "owner_id": 14 }
Nom | Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id Lecture seule | string | Identifiant unique de l'utilisateur. | ||||||||||||||||
lastname | string | Prénom de l'utilisateur. | ||||||||||||||||
firstname | string | Nom de l'utilisateur. | ||||||||||||||||
login | string | Identifiant de l'utilisateur. | ||||||||||||||||
string | Adresses emails de l'utilisateur, séparées par des virgules. | |||||||||||||||||
roots Lecture seule | int[] | Liste des identifiants numériques uniques des dossiers racines de l'utilisateur. Utilisé pour constituer son arborescence de base. | ||||||||||||||||
organization | string | Nom de la société dont fait partie l'utilisateur. Attention En fonction de la configuration de la plateforme, un groupe sera créé et portera ce nom. L'utilisateur y sera ensuite automatiquement ajouté. | ||||||||||||||||
phone | string | Liste des numéros de téléphones de l'utilisateur, séparés par des virgules. Ce champs n'a aucune utilité au sein de NetExplorer, mais peut être utilisé par des applicatifs tiers via l'API. | ||||||||||||||||
active | bool | Indique si le compte de l'utilisateur est actif ou non. | ||||||||||||||||
language | string | Langue utilisée par la plateforme web pour traduire les labels de langue. Par défaut, la valeur auto permet de choisir la langue en fonction de celle du navigateur.Sinon, 6 langues sont disponibles :
| ||||||||||||||||
current_language Lecture seule | string | Langue actuellement utilisée pour l'utilisateur courant. Permet de connaitre la langue utilisée lorsque language vaut auto .Attention Ce champ n'est visible que dans les informations personnelles retournées par la méthode GET /account. | ||||||||||||||||
quota | int ou null | Quota en octets appliqué au contenu créé par l'utilisateur. | ||||||||||||||||
expire | date ou null | Date d'expiration du compte. Arrivé à échéance, le compte apparait comme désactivé mais n'est pas supprimé. | ||||||||||||||||
creation_date | date ou null | Date de création du compte. Peut être null pour les comptes créés avant l'ajout de cette propriété. | ||||||||||||||||
last_login | date ou null | Date de dernière connexion du compte. Peut être null pour les comptes qui ne se sont jamais connectés. | ||||||||||||||||
plugin_outlook Optionnel | int ou non défini | Si le connecteur Outlook est autorisé sur la plateforme, ce champs indique quel est l'identifiant numérique unique du dossier où sont stockées les pièces jointes de l'utilisateur. | ||||||||||||||||
ldap Lecture seule | bool | Indique si le compte provient d'un annuaire externe. Attention Si ce champs vaut true, le seul champ modifiable est le champ "groups". | ||||||||||||||||
can_edit_options | bool | Indique si l'utilisateur peut modifier lui même les informations de son compte via la méthode PUT /account | ||||||||||||||||
can_admin Lecture seule | bool | Indique si l'utilisateur est administrateur de la plateforme. | ||||||||||||||||
can_admin_users Lecture seule | bool | Indique si l'utilisateur peut gérer les comptes utilisateurs. Vaudra true si l'utilisateur est administrateur de la plateforme ou délégué d'un groupe avec l'option users active. | ||||||||||||||||
groups | Groupe[] | Liste des groupes dont l'utilisateur est membre. Il est possible de rajouter des entrées ne contenant que l'id du groupe pour qu'il y soit ajouté automatiquement. | ||||||||||||||||
delegate_of | Groupe[] | Liste des groupes dont l'utilisateur est délégué. | ||||||||||||||||
has_mfa_yubikey | bool | Indique si l'utilisateur a configuré une double authentification Yubikey. | ||||||||||||||||
has_mfa_otp | bool | Indique si l'utilisateur a configuré une double authentification OTP. | ||||||||||||||||
has_mfa_sms | bool | Indique si l'utilisateur a configuré une double authentification SMS. | ||||||||||||||||
can_mfa_yubikey | bool | Indique si l'utilisateur peut configurer une double authentification Yubikey. | ||||||||||||||||
can_mfa_otp | bool | Indique si l'utilisateur peut configurer une double authentification OTP. | ||||||||||||||||
can_mfa_sms | bool | Indique si l'utilisateur peut configurer une double authentification SMS. | ||||||||||||||||
mfa_required | bool | Indique si l'utilisateur est obligé de configurer une double authentification. | ||||||||||||||||
role | int | Rôle de l'utilisateur. Le rôle défini aussi le groupe système dans lequel appartient l'utilisateur.
|
{ "id": "15", "firstname": "Noël", "lastname": "FLANTIER", "login": "n.flantier", "email": [ ], "roots": [ 14, 18, 24, ], "organization": "OSS", "phone": "", "active": true, "language": "fr", "quota": null, "expire": null, "creation_date": null, "last_login": "2020-06-16T13:14:08+00:00", "plugin_outlook": 128, "ldap": false, "can_edit_options": true, "can_admin": false, "can_admin_users": false, "groups": [ { "id": 4, "login": "Agents opérationnels", "ldap": false }, { "id": 14, "login": "Top Secret", "ldap": false } ], "has_mfa_yubikey": false, "has_mfa_otp": false, "has_mfa_sms": true, "can_mfa_yubikey": false, "can_mfa_otp": false, "can_mfa_sms": true, "mfa_required": false, "role": 3 }
Nom | Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id Lecture seule | string | Identifiant unique de l'invitation. | ||||||||||||||
key | string | Clé de l'invitation qui va permettre à l'utilisateur de procéder à la modification de son compte. | ||||||||||||||
source Lecture seule | string | Identifiant de l'utilisateur ayant procédé à l'invitation. | ||||||||||||||
source_name Lecture seule | string | Nom de l'utilisateur ayant procédé à l'invitation. | ||||||||||||||
target | int | Identifiant de l'utilisateur crée suite à l'invitation. | ||||||||||||||
expiration | date ou null | Date d'expiration de l'invitation. Arrivé à échéance, l'utilisateur invité ne pourra pas créer de compte avec cette invitation. | ||||||||||||||
folder | int | Identifiant du dossier auquel l'utilisateur aura accès une fois son compte crée. | ||||||||||||||
rights Lecture seule | int | Correspondance des droits à appliquer à la création du compte.
|
{ "id": 9, "key": "3Rjy060qP5rrJx4qRz5KdcTS", "source": 5, "source_name": "Bob Herry", "target": "bob.herry@oss.gouv.fr", "expiration": null, "folder": 64, "rights": 3 }
Nom | Type | Description |
---|---|---|
id Lecture seule | string | Identifiant unique du groupe. |
login | string | Nom du groupe. |
ldap Lecture seule | bool | Indique si le groupe provient d'un annuaire externe. Attention Si ce champs vaut true, l'objet sera alors en lecture seule. |
members | Utilisateur[] | Liste des membres du groupe. |
{ "id": "78", "login": "Marketing", "ldap": false, "members": [ { "id": "14", "firstname": "Jacques", "lastname": "JOBERT", "login": [ ... ] }, { "id": "145", "firstname": "Elodie", "lastname": "CARNERA", "login": [ ... ] }, ... ] }
Nom | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
target_id | string | Identifiant unique de l'utilisateur ou du groupe auquel s'applique les options. | ||||||||||||||||||
target Lecture seule | string | Nom complet de l'utilisateur ou du groupe auquel s'applique les options. | ||||||||||||||||||
target_isgroup Lecture seule | bool | Indique si la cible est un utilisateur ou un groupe. | ||||||||||||||||||
ips | string[] ou null | Liste blanche des IPs autorisées à se connecter à la plateforme. Attention Si un tableau vide est fourni au lieu de null, cet utilisateur ou ce groupe ne pourra pas se connecter. Cela peut être utilisé par exemple pour bloquer l'accès à un groupe complet. | ||||||||||||||||||
days | int | Masque numérique des jours de connexion autorisés. Il suffit d'additionner les valeurs, le résultat correspond au masque. Ex: Mardi + Jeudi = 4 + 16 = 20.
| ||||||||||||||||||
hour_start | time ou null | Heure GMT à partir de laquelle les utilisateurs peuvent se connecter. | ||||||||||||||||||
hour_end | time ou null | Heure GMT à partir de laquelle les utilisateurs ne peuvent plus se connecter. | ||||||||||||||||||
can_netsync | bool | Indique si l'utilisateur a le droit d'utiliser la synchronisation ou non. | ||||||||||||||||||
oauth_blocked | int | Masque numérique des applications dont la connexion sera bloquée. Il suffit d'additionner les valeurs, le résultat correspond au masque.
| ||||||||||||||||||
inherited Lecture seule | bool | Utilisateurs Indique si les options de connexions sont hérités d'un groupe ou définies explicitement sur l'utilisateur. Groupes Pour les groupe, ce champ vaut toujours false. |
{ "target_id": "1", "target": "Administrateurs NetExplorer", "target_isgroup": true, "ips": null, "days": 62, // Lundi => Vendredi "hour_start": "07:00:00", // 7h GMT "hour_end": "16:00:00", // 16h GMT "can_netsync": true, "inherited": false }
Manager
.Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique de l'entrée de délégation. |
user Lecture seule | string | Nom complet de l'utilisateur délégué. |
user_id | string | Identifiant unique de l'utilisateur délégué. |
group_id | string | Identifiant unique du groupe dont l'utilisateur sera le délégué. |
users | bool | Indique si le délégué pourra gérer les utilisateurs au sein du groupe. |
security | bool | Indique si le délégué pourra gérer les droits d'accès pour le groupe et ses utilisateurs. Le délégué ne pourra jamais accorder plus de droit qu'il n'en possède. |
alerts | bool | Indique si le délégué pourra mettre en place des alertes emails pour les utilisateurs de son groupe. |
{ "id": 60, "user": "Jennifer BRANT", "user_id": 186, "group_id": 17, "users": true, "security": false, "alerts": true }
Nom | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
id Lecture seule | int | Identifiant numérique unique de l'email. | ||||||||||
object | string | Objet de l'email. | ||||||||||
content | string | Contenu de l'email. Texte ou HTML accepté. | ||||||||||
type | string | Enumération pouvant prendre les valeurs suivantes:
| ||||||||||
owner Lecture seule | string | Nom complet du propriétaire de l'email. | ||||||||||
owner_id | string | Identifiant unique de l'utilisateur propriétaire de l'email. | ||||||||||
from | string | Adresse email de l'expéditeur de l'email. Attention Seuls les emails de type EM_TE_SENDED et EM_TE_TOSEND sont concernés.Pour les emails de type EM_TE_SENDED , ce champ est en lecture seule. | ||||||||||
to | string | Adresses emails des destinataires de l'email, séparées par des virgules. Attention Seuls les emails de type EM_TE_SENDED et EM_TE_TOSEND sont concernés.Pour les emails de type EM_TE_SENDED , ce champ est en lecture seule. | ||||||||||
Attention Cette propriété est obsolète. | string | Adresses emails des destinataires des copies cachées de l'email, séparées par des virgules. Attention Seuls les emails de type EM_TE_SENDED et EM_TE_TOSEND sont concernés.Pour les emails de type EM_TE_SENDED , ce champ est en lecture seule. | ||||||||||
last_send Lecture seule | date ou null | Date du dernier envoi de cet email. Vaudra null si le mail n'a jamais été expédié. |
Nom | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id Lecture seule | int | Identifiant numérique unique du partage par lien. | ||||||||||||||||||
key | string | Clé de téléchargement du partage par lien. | ||||||||||||||||||
roots | array | Liste d'objets Contenu de partage. | ||||||||||||||||||
flags | int | Masque numérique des droits appliqués au lien.
| ||||||||||||||||||
expiration_date | date ou null | Date d'expiration du partage. Lorsque le partage expire, le lien n'est pas supprimé mais le fichier n'est plus téléchargeable par celui-ci. | ||||||||||||||||||
creation_date Lecture seule | date | Date de création du partage par lien | ||||||||||||||||||
name Optionnel | string ou non défini | Nom du partage | ||||||||||||||||||
owner Lecture seule | string | Nom complet de l'utilisateur ayant généré le partage par lien. | ||||||||||||||||||
owner_id | int | Identifiant unique de l'utilisateur. | ||||||||||||||||||
access_token Lecture seule | string | Si le lien est protégé par mot de passe ce token permettra la récupération du contenu du lien (expire au bout de 2h). |
{ "id": 4559, "key": "258fqwu987y57D", "roots": [ { "id": 1, "entity_type": 0, "share_id": 4559, "name": "Fichier de test.pdf", "can_download": true, "can_preview": true, "can_edit": false, "size": 311111, "is_file": false, "parent_id": 23, "file_type": "document", "guid": "00000-0000-00000-00000", "extension": "pdf" }, { "id": 2, "entity_type": 1, "share_id": 4559, "name": "Dossier partagé", "can_download": true, "can_preview": true, "can_edit": false, "size": 311111, "is_file": false, "parent_id": 23 } ], "flags": 4, // Aperçu et téléchargement "expiration_date": null, "creation_date": "14/02/2024", "owner": "Amir BEN OUALI", "owner_id": 55 }
Nom | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
guid | string | Le guid du fichier (Si l'entité est un fichier) | ||||||
id | int | L'identifiant unique de l'entité | ||||||
entity_type | int | Type d'entité
| ||||||
share_id Lecture seule | int | Identifiant numérique unique du partage par lien. | ||||||
name Lecture seule | string | Nom de l'élément | ||||||
extension Lecture seule | string | Nom de l'extension (Si l'entité est un fichier) | ||||||
lock Lecture seule | object | Objet Verrou (Si l'entité est un fichier) | ||||||
can_download Lecture seule | bool | L'élément peut être télécharger | ||||||
can_preview Lecture seule | bool | L'élément peut être ouvert en aperçu | ||||||
can_edit Lecture seule | bool | L'élément peut être modifié | ||||||
file_type Lecture seule | string | Le type de fichier (Si l'entité est un fichier) | ||||||
size Lecture seule | int | La taille de l'entité |
[ { "id": 1, "entity_type": 0, "share_id": 4559, "name": "Fichier de test.pdf", "can_download": true, "can_preview": true, "can_edit": false, "size": 311111, "parent_id": 23, "file_type": "document", "guid": "00000-0000-00000-00000", "extension": "pdf" }, { "id": 2, "entity_type": 1, "share_id": 4559, "name": "Dossier partagé", "can_download": true, "can_preview": true, "can_edit": false, "size": 311111, "parent_id": 23 } ]
Nom | Type | Description | ||||
---|---|---|---|---|---|---|
id Lecture seule | int | Identifiant numérique unique du partage par lien. | ||||
key | string | Clé de téléchargement du partage par lien. Il est possible de réutiliser la même clé pour plusieurs fichiers. Les différents fichiers seront alors listés ensemble lorsque le destinataire ouvrira le lien. | ||||
files Lecture seule | array | Liste d'objets Fichier contenu dans le partage par lien. | ||||
is_valid Lecture seule | bool | Indique si le fichier est téléchargeable via ce lien ou non. | ||||
expiration_date | date ou null | Date d'expiration du partage. Lorsque le partage expire, le lien n'est pas supprimé mais le fichier n'est plus téléchargeable par celui-ci. | ||||
password_protected Lecture seule | string ou null | Clé unique indiquant si le fichier est protégé par mot de passe ou non. Si la même clé est utilisée pour 2 liens différents, le mot de passe est alors le même. Vaut null si le lien est n'est pas protégé par mot de passe. | ||||
remaining_downloads | int ou null | Nombre de téléchargements restants. | ||||
thumb_token Lecture seule Optionnel | string ou non défini | Clé de téléchargement de la miniature du fichier. A utiliser avec le générateur de miniatures rattaché à la plateforme. Attention Ce champ n'est renseigné que si le générateur de miniatures gère ce format de fichiers. | ||||
file_type Lecture seule Optionnel | string ou non défini | Type de fichier. Peut valoir image ou document .Attention Ce champ n'est renseigné que si le générateur de miniatures gère ce format de fichiers. | ||||
owner Lecture seule | string | Nom complet de l'utilisateur ayant généré le partage par lien. | ||||
owner_id | string | Identifiant unique de l'utilisateur. | ||||
nb_downloads Lecture seule Propriétaire de l'objet uniquement | int | Nombre de téléchargements effectués sur ce partage. | ||||
max_downloads Propriétaire de l'objet uniquement | int | Nombre de téléchargements maximum avant désactivation du partage. | ||||
notify Propriétaire de l'objet uniquement | bool | Notifier l'utilisateur ayant généré le partage par lien lors du téléchargement du fichier par le destinataire. | ||||
autoupdate | bool | Indique si le partage pointe toujours vers la dernière version du fichier cible ou non. | ||||
only_preview | bool | Indique si le partage donne le droit uniquement à l'aperçu des fichiers. | ||||
type | int ou vide | Indique si le lien est d'un certain type.
| ||||
force_dl | bool | Indique si le partage déclenchera un téléchargement forcé. | ||||
access_token Lecture seule | string | Si le lien est protégé par mot de passe ce token permettra la récupération du contenu du lien (expire au bout de 2h). | ||||
Attention Cette propriété est obsolète. Utilisez plutôt POST /token/sharelink/(key)/download Lecture seule | string | Si le lien est protégé par mot de passe et qu'il n'est pas en "Aperçu uniquement" ce token permettra le téléchargement des fichiers (expire au bout de 2h). | ||||
stats Propriétaire de l'objet uniquement | Object | Retourne un ensemble d'informations sur les téléchargements du partage. downloadsInformations détaillées sur les téléchargements qui ont eu lieu. usersNombre d'utilisateurs différents ayant téléchargé un ou plusieurs fichiers attachés au partage. "downloads": [ { "id": 124589, "date": "2016-01-25T19:58:56Z", "user": null, "user_id": null, "geo": { "city": "Lyon", "country": "France", "loc": "Lyon, France" }, "env": { "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36", "os": "Mac OS X", "os_type": 2 } } ], "users": 2 |
{ "id": 4559, "key": "258fqwu987y57D", "file_id": 1, "file": "Guide de prise en main.pdf", "file_size": 455663, "is_valid": true, "expiration_date": null, "password_protected": "5e3db300c59409695d5e3943e5f2532486e7b8dd", "remaining_downloads": null, "thumb_token": "JB%252F3j3r7Q%25[...]z2MXMloxO3kcAw%253D%253D", "file_type": "document", "owner": "Amir BEN OUALI", "owner_id": 55, "nb_downloads": 45, "max_downloads": null, "notify": true, "autoupdate": false, "stats": { "downloads": [ { "id": 124589, "date": "2016-01-25T19:58:56Z", "user": null, "user_id": null, "geo": { "city": "Lyon", "country": "France", "loc": "Lyon, France" }, "env": { "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36", "os": "Mac OS X", "os_type": 2 } } ], "users": 2 } }
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique du partage par email. |
object | string | Objet envoyé lors de la création du partage par email. |
content | string | Contenu de l'email envoyé lors de la création du partage par email. |
owner_id Lecture seule | int | Identifiant numérique du créateur du partage par email. |
share_id Lecture seule | int | Identifiant du partage par lien rattaché. |
creation_date Lecture seule | date | Date à laquelle le partage par email a été crée. |
recipients Lecture seule | array | Tableau contenant les différents destinataires. Chaque entrées contient l'email du destinataire |
{ "id": 12, "object": "Objet de l'email", "content": "Bonjour, ci joint un partage par email.", "owner_id": 1, "share_id": 13, "creation_date": "2021-04-21T10:04:20+00:00", "recipients": [ { "email": "email@netexplorer.fr" } ] }
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique du partage par email. |
object | string | Objet envoyé lors de la création du partage par email. |
content | string | Contenu de l'email envoyé lors de la création du partage par email. |
owner Lecture seule | int | Identifiant numérique du créateur du partage par email. |
stats Lecture seule | json | Statistiques des téléchargements et des aperçus du partage par email. |
sending_date Lecture seule | date | Date à laquelle l'email a été envoyé. |
recipients Lecture seule | array | Tableau contenant les différents destinataires. Chaque entrées contient email name du destinataireSi le destinataire est une persone interne la propriété id sera rajouté.La propriété dlink correspondra au partage par lien (unique) du destinataire. |
{ "id": "12", "object": "Objet de l'email", "content": "Bonjour, ci joint un partage par email.", "owner": 1, "stats": { "nb_download": 1, "nb_preview": 1 }, "sendind_date": "2021-04-21T10:04:20+00:00", "recipients": [ { "email": "email@netexplorer.fr", "name": "Bob Bob", "id": "123", "dlink": [ // Objet partage par lien { "id": 14, ... } ] } ] }
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique du lien de dépôt. |
key | string | Clé d'accès au lien de dépôt. |
folder Propriétaire de l'objet uniquement | string | Nom du dossier de destination. |
folder_id | int ou null | Identifiant numérique unique du dossier dans lequel déposer les documents. Peut être défini à null si le dossier de destination n'existe plus. |
is_valid Lecture seule | bool | Indique si le lien de dépôt est toujours accessible. Pour cela, il ne doit pas être expiré et le dossier de destination doit être toujours présent. |
owner Lecture seule | string | Nom complet de l'utilisateur propriétaire du lien de dépôt. |
owner_id | string | Identifiant unique de propriétaire. |
{ "id": 4456, "key": "258fqwu987y57D", "folder": "Dépôt externe", "folder_id": 4, "is_valid": true, "expiration_date": "2018-01-01T12:00:00+00:00", "owner": "Erica JONES", "owner_id": "3" }
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant du template. |
name | string | Nom du template. |
description | string | Description du template. |
date Lecture seule | string | Date de modification du template. |
guid Lecture seule | string | guid du template. |
parent_id Lecture seule | int | Id du dossier parent du template. |
file_type Lecture seule | string | Type d'aperçu du fichier. Peut valoir image , document ou video si l'aperçu est disponible pour ce fichier. |
thumb_token Lecture seule | string | Token d'accès aux miniatures de ce fichier si le format est supporté. |
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant de l'instance du flux. |
object_type | string ou null | Type d'objet sur lequel l'instance du flux est rattaché. |
object_id | int ou null | Identifiant de l'objet sur lequel l'instance du flux est rattaché. |
flux | string | Clé de traduction du nom du flux. |
flux | object | Objet contenu l'identifiant, le nom, la description du type de flux. |
state Lecture seule | object | Objet contenu l'identifiant et le nom de l'état du flux. |
owner_id Lecture seule | int | Identifiant du créateur de l'instance du flux. |
properties | string | Tableau json des propriétés du flux. |
creation Lecture seule | string | Date de création du flux |
is_closed Lecture seule | bool | Informe si l'instance du flux est dans un état ne pouvant évoluer vers un autre état. |
transitions_available Lecture seule | array | Tableau listant les transitions disponible pour l'état actuel de l'instance du flux. |
data_objects Lecture seule | array | Tableau d'objets rattachés au flux |
{ "id": 12, "object_type": null, "object_id": null, "properties": [ { "signatures": [ { "email": "email@netexplorer.fr" }, ... ] }, { "signature_fields": [ { "x": 123, "y": 321, "page": 1, "signerIndex": 0, "document": 0 }, ... ] }, { "objects": [ { "type": "file", "id": 1 }, ... ] }, ... ], "owner_id": 2, "creation": "2024-01-01 00:00:00", "edit": "2024-01-01 00:00:00", "is_closed": false, "state": { "id": 3, "name": "FLOW_STATES_NAME_WAITINGSIGNATURE" }, "flux": { "id": 2, "name": "FLOW_NAME_DOCSIGNATURE", "description": "FLOW_DESC_DOCSIGNATURE" }, "data_objects": [ { "type": "file", "id": 1 }, ... ], "transitions_available": { "DocumentHandwrittenSignedTransition": [ { "name": "FLOW_STATES_NAME_SIGNED", "id": 4 }, ... ] } }
Nom | Type | Description |
---|---|---|
id Lecture seule | int | Identifiant numérique unique de l'entrée des journaux. |
user_id Lecture seule | string | Identifiant unique de l'utilisateur à l'origine de l'action. Toute action de la part d'un utilisateur non connecté sera affichée comme provenant du compte Invité. |
user Lecture seule | string | Nom complet de l'utilisateur. |
date Lecture seule | date | Date à laquelle l'évènement s'est produit. |
message Lecture seule | string | Informations complétaires spécifiques à l'évènement. |
ip Lecture seule | string | Adresse IP de connexion de l'utilisateur. |
user_agent Lecture seule | string | Chaine d'identification du navigateur internet ou de l'outil utilisé pour la connexion. |
type Lecture seule | string | Type d'évènement enregistré. |
statut Lecture seule | string | Indique si l'évènement est un succès (ADMLLOG_OK ) ou un échec (ADMLLOG_ERROR ). |
object_id Lecture seule | string | Identifiant unique de l'élément affecté par la requête. |
object_type Lecture seule | string | Type de l'objet affecté par la requête. |
object Lecture seule | string | Nom représentatif de l'objet affecté. |
{ "id": 33837, "user_id": 2, "user": "Bob Jensen", "date": "2013-09-17T11:31:28+00:00", "message": "", "ip": "8.5.2.1", "user_agent": "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:31.0) Gecko/20100101 Firefox/31.0", "type": "ADMLLOG_INSERT", "statut": "ADMLLOG_OK", "object_id": 11007, "object_type": "Dossier", "object": "Documents/Comptabilité/2015" }
Nom | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
browser | string | Nom du navigateur/logiciel utilisé (avec sa version, si détecté) | ||||||||||||
os | string | Nom et version du système d'exploitation. | ||||||||||||
os_type | string | Identifiant numérique de l'OS utilisé.
|
{ "browser": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)", "os": "Windows 10", "os_type": 1 }
Nom | Type | Description |
---|---|---|
city | string | Ville la plus proche de la position de l'IP géolocalisée. |
country | string | Pays de l'IP géolocalisée. |
loc | string | Chaîne de localisation complète (ville + pays) de l'IP géolocalisée. |
{ "city": "Colomiers", "country": "France", "loc": "Colomiers, France" }
Permet d'authentifier un utilisation et récupérer un token d'authentification a utiliser avec l'API pour utiliser les méthodes sécurisée.
{ "user": "smithj", "password": "monsupermotdepasse" }
{ "token": "0123456789ABCDEFFEDCBA9876543210" // Token de connexion }
A savoir La durée de vie du token est limitée par les paramètres session_limit et session_idle de la configuration de la plateforme. Même s'il n'y a aucune indication concernant la durée de vie du token, il ne faut pas considérer sa validité comme étant infinie.
Cette méthode ne gère aucun paramètre ou contenu en entrée.
Cette méthode ne génère aucun paramètre ou contenu en sortie.
Cette méthode ne gère aucun paramètre ou contenu en entrée.
Cette méthode ne gère aucun paramètre ou contenu en entrée.
{ "login_or_email": "smithj" // Identifiant ou adresse email du compte }
multipart/form-data
.OK
est retourné.Sinon, ce sont les messages d'erreurs correspondants qui sont retournés.Afin d'alléger le traitement et réduire les risques d'erreurs, vous pouvez ne préciser que les propriétés qui vous interesse.
Les propriétés non renseignées ne seront pas modifiées.
{ // Pour changer le mot de passe, l'utilisateur doit fournir l'ancien mot de passe "old_password": "0123456789ABCDEFFEDCBA98765432100123456789", "new_password": [ ], "lastname": "Smith", "firstname": "John", "email": "smithj@domain.com", "phone": "+33 5.01.02.03.04", "organization": "NetExplorer", "language": "en" }
Retourne un objet Utilisateur représentant l'utilisateur courant.
Cette méthode ne gère aucun paramètre ou contenu en entrée.
Le champs folderId
de l'url est à remplacer par l'identifiant numérique unique du dossier à récupérer.
can_dlink
, can_ulink
, can_admin_rights
, can_admin_alerts
, nb_participants
, self_alert
, nb_annotations
, nb_unread_annotations
, size
, nb_d_folders
, nb_d_files
, nb_folders
, nb_files
, quota
, purge_frequency
, path
, path_name
.creation
, modification
, owner
et owner_id
.Permet de filtrer les informations reçues lors des listings récursifs pour accélérer le traitement et alléger le contenu reçu.
Les types disponibles sont les suivants :
Valeur | Description | |
---|---|---|
1 | Lors du parcours de l'arborescence, ne liste exclusivement que les dossiers. Les fichiers sont ignorés. | |
2 | Lors du parcours de l'arborescence, ne liste exclusivement que les fichiers. Les dossiers sont ignorés, ce qui empêche le parcours de dossiers au delà du premier niveau (depth >= 1). | |
3 | Lors du parcours de l'arborescence, liste tous les éléments (fichiers et dossiers). Ceci est le comportement par défaut. |
depth
est alors ignoré.recursive
doit être activé.recursive
doit être activé.1
pour activer la recherche dans le nom des fichiers/dossiers ou 0
(par défaut) pour la désactiver.recursive
doit être activé.1
pour activer la recherche dans le contenu des annotations ou 0
(par défaut) pour la désactiver.recursive
doit être activé.1
pour activer la recherche dans le contenu indexé des fichiers ou 0
(par défaut) pour la désactiver.recursive
doit être activé.1
pour activer la recherche dans la totalité de la plateforme ou 0
(par défaut) pour la désactiver.recursive
doit être activé.recursive
doit être activé.recursive
doit être activé.recursive
doit être activé.recursive
doit être activé.recursive
doit être activé.Retourne un objet Dossier représentant le dossier recherché.
Dans le cas d'une recherche, les éléments sont retournés sous cette forme :
{ "folders": [ { "id": 128, "nom": "Dossier 1", ... }, { "id": 1885, "nom": "Dossier 2", ... } ], "files": [ { "id": 4788, "nom": "MonFichier.docx", ... }, { "id": 96332, "nom": "photo_128_78.png", ... } ] }
Le champs folderId
de l'url est à remplacer par l'identifiant numérique unique du dossier à récupérer.
Retourne un objet Dossier représentant le dossier cible, avec en plus les informations de la timeline comme présenté ci-dessous :
{ "id": 128, "nom": "Dossier 1", ... "events": [ { "id": 1, "type": 4, "date": "2024-11-21T05:00:23+00:00", "geo": { "city": "Paris", "country": "France", "loc": "Paris, France" }, "env": { "browser": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537 (KHTML, like Gecko) Chrome/50.0 Safari/537.0", "os": "Windows", "os_type": 1 }, "owner": "Simon BERGES", "owner_id": 54, "data": null } ] }
can_dlink
, can_ulink
, can_admin_rights
, can_admin_alerts
, nb_participants
, self_alert
, nb_annotations
, nb_unread_annotations
, size
, nb_d_folders
, nb_d_files
, nb_folders
, nb_files
, quota
, purge_frequency
, path
, path_name
.creation
, modification
, owner
et owner_id
.Permet de filtrer les informations reçues lors des listings récursifs pour accélérer le traitement et alléger le contenu reçu.
Les types disponibles sont les suivants :
Valeur | Description | |
---|---|---|
1 | Lors du parcours de l'arborescence, ne liste exclusivement que les dossiers. Les fichiers sont ignorés. | |
2 | Lors du parcours de l'arborescence, ne liste exclusivement que les fichiers. Les dossiers sont ignorés, ce qui empêche le parcours de dossiers au delà du premier niveau (depth >= 1). | |
3 | Lors du parcours de l'arborescence, liste tous les éléments (fichiers et dossiers). Ceci est le comportement par défaut. |
depth
est alors ignoré.recursive
doit être activé.recursive
doit être activé.1
pour activer la recherche dans le nom des fichiers/dossiers ou 0
(par défaut) pour la désactiver.recursive
doit être activé.1
pour activer la recherche dans le contenu des annotations ou 0
(par défaut) pour la désactiver.recursive
doit être activé.1
pour activer la recherche dans le contenu indexé des fichiers ou 0
(par défaut) pour la désactiver.recursive
doit être activé.recursive
doit être activé.recursive
doit être activé.recursive
doit être activé.recursive
doit être activé.recursive
doit être activé.Retourne un tableau de Dossier représentant les différents dossiers racines de l'utilisateur.
can_dlink
, can_ulink
, can_admin_rights
, can_admin_alerts
, nb_participants
, self_alert
, nb_annotations
, nb_unread_annotations
, size
, nb_d_folders
, nb_d_files
, nb_folders
, nb_files
, quota
, purge_frequency
, path
, path_name
.creation
, modification
, owner
et owner_id
.Les informations concernant le dossier doivent être passées dans le corps de la requête et au format JSON.
parent_id: 0
n'est possible que si l'utilisateur est administrateur.
Exemple :
{ "name": "Mon nouveau dossier", "parent_id": 1, "quota": -1, "purge_frequency": 0 }
Retourne un objet Dossier représentant le dossier créé.
can_dlink
, can_ulink
, can_admin_rights
, can_admin_alerts
, nb_participants
, self_alert
, nb_annotations
, nb_unread_annotations
, size
, nb_d_folders
, nb_d_files
, nb_folders
, nb_files
, quota
, purge_frequency
, path
, path_name
.creation
, modification
, owner
et owner_id
.Les informations concernant le dossier doivent être passées dans le corps de la requête et au format JSON.
parent_id: 0
).
Exemple :
{ "name": "Finances 2017", "parent_id": 1, "quota": -1, "purge_frequency": 0 }
Retourne un objet Dossier représentant le dossier créé.
Le champs folderId
de l'url est à remplacer par l'identifiant numérique unique du dossier à récupérer.
1
, par défaut) ou être supprimé définitivement (valeur à 0
).nb_versions
, nb_annotations
, nb_unread_annotations
, path
, thumb_token
, file_type
, meta
, workflow
.creation
, owner
et owner_id
.Retourne un objet Fichier représentant la version recherchée du fichier.
Retourne une liste d'objets Fichier.
{ "offset_start": 0, "nb_objets": 30, "nb_total_objects": 50, "objects": [ { "id": 20, "parent_id": 1, "name": "test.docx", ... }, ... ] }
download_token
du fichier à télécharger. S'obtient via la méthode POST /token/file/(fileId)/(type)attachment; filename=<Nom du fichier>
Le contenu binaire du fichier retourné, en totalité ou partiellement (HTTP Range).
attachment; filename=<Nom du fichier>
Le contenu binaire du fichier retourné, en totalité ou partiellement (HTTP Range).
Cette méthode ne gère aucun paramètre ou contenu en entrée.
Un objet est retourné contenant les différents champs retournés par le service d'indexation.
Pour le moment, seul le champ length
est géré.
Exemple:
{ "length": "2" // Nombre de pages dans le document }
Cette méthode ne gère aucun paramètre ou contenu en entrée.
Le contenu est composé de la liste des versions du fichiers avec des champs supplémentaires.
On retrouve notamment le champ events
contenant la liste des évènements, ainsi que les champs total_annotations
, total_downloads
, total_dlinks
et total_previews
représentant respectivement les nombres d'annotations, de téléchargements, de liens de partages et de prévisualisations.
Chaque évènement embarque un champs type
correspondant au type d'évènement généré dont la liste des correspondances figure ci-dessous :
ID | Evènement | |
---|---|---|
1 | Ajout d'une annotation Dans ce cas, le champs data de l'évènement contiendra un objet Annotation.Celui-ci pourra lui aussi contenir d'autres évènements (contenant là aussi à leur tour un objet Annotation) correspondants aux réponses apportées à l'annotation dans la propriété responses . | |
2 | Création d'un partage par lien Le champ data embarque les informations du partage par lien sous la forme d'un objet Partage par lien avec en plus 2 champs : downloads représentant le nombre de téléchargements du lien, et users pour le nombre d'utilisateurs identifiés comme étant différents et ayant téléchargé le lien. | |
3 | Téléchargement Le champ data est toujours vide pour ce type d'évènement.Un champ extended peut cependant être ajouté et contient des évènements de téléchargements récents originaires du même utilisateur. | |
4 | Aperçu / Prévisualisation Le champ data est toujours vide pour ce type d'évènement. | |
6 | Verrou actif Le champ data contient un objet de type Verrou. | |
9 | Agregation d'évènements L'agrégation d'évènements se produit sur les téléchargements afin de réduire la quantité d'informations redondantes au sein de la timeline. Lors plusieurs téléchargements sont agrégés, ceux-ci sont rassemblés dans un faux évènement parent, dans la propriété extended .Exemple: { "id": 1255447, "type": 9, "subtype": 3, "date": "2024-11-21T05:00:23+00:00", "geo": null, "env": null, "owner": "Fabrice GERARD", "owner_id": 77855, "data": { "users": [ "Boris" ], "users_count": 1 }, "extended": [ { "id": 44558, "type": 3, "date": "2024-11-21T05:00:23+00:00", "geo": null, "env": null, "owner": "Melanie BOLIVET", "owner_id": 774, "data": null } ] } |
Exemple succinct d'une timeline de fichier:
[ { // Champs liés à l'objet Dossier "id": 74885, "name": "bilan_final.docx", "size": 896652, ... // Champs complémentaires liés à la timeline "total_annotations": 0, "total_download": 4, "total_dlinks": 1, "total_previews": 7, "events": [ { "id": 4588, "type": 0, "date": "2024-11-21T05:00:23+00:00", "geo": { // Objet de type Géolocalisation "city": "Toulouse", ... }, "env": { // Objet de type Environnement utilisateur "os": "Windows", ... }, "owner": "Paul GILIER", "owner_id": 4788, "data": null } ] }, { // Version précédente "id": 74810, ... }, ... ]
Retourne la liste des versions d'un fichier sous la forme d'un tableau de Fichier, incluant la version cible, de la plus récente à la plus ancienne.
Exemple:
[ { "id": 5, "name": "rapport2016.docx", ... }, { "id": 4, "name": "rapport2016.docx", ... } ]
nb_versions
, nb_annotations
, nb_unread_annotations
, path
, thumb_token
, file_type
, meta
, workflow
.creation
, owner
et owner_id
.Le corps de la requête doit contenir plusieurs informations:
parent_id: 0
).Voici un exemple de corps valide :
{ "name": "rapport_2016.docx", "parent_id": 445 }
multipart/form-data
.parent_id: 0
).Il est possible de procéder à un dépôt de fichier découpé en ajoutant les propriétés suivantes:
Dans ce cas, le targetFile
ne contiendra que la portion du fichier.
En cas de succès, retourne un objet Fichier.
Dans le cas d'un envoi découpé:
Les requêtes intermédiaires ne renvoient que le texte "OK" pour valider la réception du bloc.
Dans ce mode, les erreurs > 500 ne sont pas récupérables, alors que les erreurs > 400 peuvent être récupérées et sont probablement dûe à un bug côté client.
Un rapport indiquant la prochaine partie manquante à envoyer peut être récupéré en ajoutant la propriété report
. Le json transmit aura la forme suivante:
[ { "missing": 14 } ]
Ce rapport sera automatiquement transmit si la requête courante concerne le dernier bloc mais que le fichier s'avère incomplet.
La modification des méta-données ne concerne que 2 champs :
parent_id: 0
).
Par exemple, ce JSON déplace le fichier dans le dossier #85 en le renommant :
{ "name": "presentation_2016.docx", "parent_id": 85 }
L'utilisateur n'a pas le droit de modifier (edit) dans le dossier parent.
Si le fichier est déplacé, l'utilisateur doit alors avoir :
application/octet-stream
.1
pour l'activer ou 0
pour supprimer définitivement le fichier.Permet d'indiquer si les versions précédentes du fichiers sont impactées par la suppression.
Par défaut, le champ vaut all
pour indiquer que le fichier et toutes ses versions sont affectés par la suppression.
Il est aussi possible d'utiliser les valeurs suivantes :
none
pour supprimer uniquement la version en coursprevious
pour ne supprimer que la version courante et les plus ancienne, concervant ainsi les plus récentes s'il y en a.OK
si tout s'est bien passé.Cette méthode ne gère aucun paramètre ou contenu en entrée.
{ "folder": 123 // Identifiant du dossier }
Le paramètre folderId
est obligatoire et représente l'ID du dossier dans lequel récupérer les templates.
Le paramètre templateId
est obligatoire et représente l'ID template à modifier.
Le paramètre templateId
est obligatoire et représente l'ID template à supprimer.
Le paramètre trashId
est obligatoire et représente l'identifiant de l'élément à récupérer.
Retourne la liste d'objets Corbeille représentant les éléments présents dans la corbeille, séparés en fichiers/dossiers.
{ "folders": [ { "id": 11568, ... }, ... ], "files": [ { "id": 958, ... }, ... ] }
Le paramètre trashId
est obligatoire et représente l'identifiant de l'élément à restaurer.
Exemple :
{ "folder_id": 15 }
Retourne un objet Fichier ou Dossier en fonction du type d'objet restauré.
{ "id": 29753, "parent_id": "29628,", "name": "Nouveau dossier", "creation": "2017-08-08T14:55:00+00:00", "modification": "2017-09-04T18:30:00+00:00", "can_read": true, "can_download": true, "can_write": true, "can_edit": true, "owner": "Jean Edouard", "owner_id": 2 }
Le paramètre trashId
est obligatoire et représente l'identifiant de l'élément à restaurer.
all
pour purger l'ensemble des corbeilles de tous les utilisateurs.Le paramètre annotationId
est obligatoire et représente l'identifiant de l'annotation à récupérer.
L'URL d'accès est composée de 2 éléments obligatoire :
{ "offset_start": 0, "nb_objets": 30, "nb_total_objects": 50, "objects": [ { "id": 30, "target_id": 28, ... }, ... ] }
{ "offset_start": 0, "nb_objets": 30, "nb_total_objects": 50, "objects": [ { "id": 30, "target_id": 28, ... }, ... ] }
Exemple :
{ "target_id": 20, "target_type": "file", "text": "Ceci est le contenu de mon annotation !" }
Le paramètre annotationId
est obligatoire et correspond à l'identifiant de l'annotation.
{ "text": "Ceci est le texte modifié de mon annotation !" }
Cette méthode ne gère aucun paramètre ou contenu en entrée.
Cette méthode ne génère aucun paramètre ou contenu en sortie.
Le paramètre annotationId
est obligatoire et correspond à l'identifiant de l'annotation.
Le paramètre fileId
est obligatoire et représente l'identifiant du fichier associé.
Le paramètre folderId
est facultatif et représente l'identifiant du dossier à partir duquel rechercher la liste.
{ "offset_start": 0, "nb_objets": 30, "nb_total_objects": 50, "objects": [ { "file": 147, "owner": "Edouard DESPEREAUX", "owner_id": 19, "locked": true, ... }, ... ] }
Le paramètre fileId
est obligatoire et représente l'identifiant du fichier associé.
Le paramètre fileId
est obligatoire et représente l'identifiant du fichier associé.
Le paramètre rightId
représente l'identifiant du droit à récupérer.
Le paramètre folderId
représente le dossier dont les droits doivent être lus.
[ { "id": 78, "folder_id": 21, "target_id": 6, ... }, ... ]
Il est possible de n'envoyer que les propriétés à accorder. Les propriétés non précisées auront la valeur false
par defaut.
Exemple :
{ "folder_id": 4, "target_id": "14", "browse": true, "read": true, "download": true, "write": false, "edit": false, "delete": false, "share": false }
Le paramètre rightId
représente l'identifiant du droit à modifier.
{ "browse": true, "read": true, "download": true, "write": false, "edit": false }
Le paramètre rightId
représente l'identifiant du droit à supprimer.
Le paramètre alertId
est obligatoire et représente l'identifiant de l'alerte.
Retourne un objet Alerte représentant l'alerte demandée.
Le paramètre folderId
est obligatoire et représente l'identifiant du dossier dont il faut lister les alertes.
[ { "id": 104, "folder_id": 21, "target_id": 6, ... }, ... ]
{ "folder_id": 3, "target_id": 14, "email": 10 }
Le paramètre alertId
est obligatoire et représente l'identifiant de l'alerte.
{ "email": 5 }
Le paramètre alertId
est obligatoire et représente l'identifiant de l'alerte.
Le paramètre userId
est obligatoire et représente l'identifiant de l'utilisateur.
Le paramètre userId
est obligatoire et représente l'identifiant de l'utilisateur.
{ "quota": 100000000, "user": 3892501810 }
{ "offset_start": 0, "nb_objets": 30, "nb_total_objects": 500, "objects": [ { "id": 7, "lastname": "Smith", ... }, ... ] }
Le paramètre userId
est obligatoire et représente l'identifiant de l'utilisateur.
Info Seuls les champs login
et password
sont obligatoires pour la création d'un utilisateur.
Cependant nous vous recommandons de toujours définir un email afin de faciliter la récupération du mot de passe si celui ci venait à être oubliée.
Le paramètre userId
est obligatoire et représente l'identifiant de l'utilisateur.
multipart/form-data
.OK
est retourné.Sinon, ce sont les messages d'erreurs correspondants qui sont retournés.Le paramètre userId
est obligatoire et représente l'identifiant de l'utilisateur.
Afin d'alléger le traitement et réduire les risques d'erreurs, vous pouvez ne préciser que les propriétés qui vous interesse.
Les propriétés non précisées ne seront pas modifiées.
groups
contient un tableau vide, l'utilisateur ne sera plus membre d'aucun groupe.Le paramètre userId
est obligatoire et représente l'identifiant de l'utilisateur.
Le paramètre userId
est obligatoire et représente l'identifiant de l'utilisateur.
Le paramètre folderId
est facultatif et représente l'identifiant du dossier dans lequel rechercher les invitations.
Le paramètre folderId
est obligatoire et représente l'identifiant du dossier sur lequel appliquer l'invitation.
{ "offset_start": 0, "nb_objects": 16, "nb_total_objects": 16, "objects": [ { "id": 321, "name": "Marjorie Balcera", "emails": "marjorie@avocats.com" }, ... ] }
{ "target": "franck@solution.fr", "folder": 14, "rights": 3 // Lecture et Téléchargement }
Le paramètre invitationId
est obligatoire et représente l'identifiant de l'invitation à modifier.
Le paramètre inviteId
est obligatoire et représente l'identifiant de l'invitation à supprimer.
Le paramètre groupId
est obligatoire et représente l'identifiant du groupe.
Retourne un objet Groupe représentant le groupe cible.
{ "offset_start": 0, "nb_objets": 30, "nb_total_objects": 500, "objects": [ { "id": 18, "login": "Comptabilité" }, ... ] }
Le paramètre groupId
est obligatoire et représente l'identifiant du groupe.
Le paramètre groupId
est obligatoire et représente l'identifiant du groupe.
Le paramètre userId
est obligatoire et représente l'id d'un utilisateur ou d'un groupe.
Le paramètre userId
est obligatoire et représente l'id d'un utilisateur ou d'un groupe.
null
si aucun filtrage n'a lieu sur les IPs.Valeur | Application |
---|---|
1 | Application Web |
2 | Application Mobile |
4 | Connecteur Outlook |
Le paramètre userId
est obligatoire et représente l'id d'un utilisateur ou d'un groupe.
Remplacé par le rôle utilisateur Manager
.
Le paramètre delegateId
est obligatoire et représente l'id d'un utilisateur délégué.
Le paramètre groupId
est obligatoire et représente l'id du groupe où récupérer les délégués.
{ "offset_start": 0, "nb_objects": 30, "nb_total_objects": 5, "objects": [ { "id": 7, "user_id": "2", ... }, ... ] }
Le paramètre delegateId
est obligatoire et représente l'id d'un utilisateur délégué.
Afin d'alléger le traitement et réduire les risques d'erreurs, vous pouvez ne préciser que les propriétés qui vous interesse.
Les propriétés non précisées ne seront pas modifiées.
Le paramètre delegateId
est obligatoire et représente l'id d'un utilisateur délégué.
Le paramètre emailId
est obligatoire et représente l'id de l'email à récupérer.
{ "offset_start": 0, "nb_objects": 30, "nb_total_objects": 500, "objects": [ { "id": 7, "object": "Mail subject", ... }, ... ] }
EM_TE_ALERT
est disponible à la création.Le paramètre emailId
est obligatoire et représente l'ID de l'email à mettre à jour.
Le paramètre emailId
est obligatoire et représente l'ID de l'email à mettre à jour.
Le paramètre ulinkId
est obligatoire et représente l'ID du lien de dépôt à récupérer.
{ "offset_start": 0, "nb_objects": 30, "nb_total_objects": 10, "objects": [ { "id": 47, "key": "emMC3e7v0IkI", ... }, ... ] }
Le paramètre ulinkId
est obligatoire et représente l'ID du lien de dépôt à modifier.
Afin d'alléger le traitement et réduire les risques d'erreurs, vous pouvez ne préciser que les propriétés qui vous interesse.
Les propriétés non précisées ne seront pas modifiées.
Retourne un objet Lien de dépôt représentant le lien de dépôt à jour.
Le paramètre ulinkId
est obligatoire et représente l'ID du lien de dépôt à supprimer.
features.lock_read : false
{ "features": { "lock_read": true, "lock": true, "edit": true, "trash": true, "versioning": true, ... }, ... }
Cette méthode ne gère aucun paramètre ou contenu en entrée.
{ "config": { "defaut_language": "fr", "allow_guest": false, ... }, ... }
{ "smtp_host": "", "smtp_port": "", "smtp_auth": "", "smtp_secure": "", "smtp_username": "", "smtp_password": "", // Affiche des informations supplémentaires en cas d'erreur "smtp_debug": "" }
{ "config": { "default_language": "fr", ... }, ... }
Retourne l'ensemble des paramètres de configuration.
{ "0": "config", "default_language": "fr", ... ... }
Le paramètre token
est obligatoire et correspond à la clé d'accès à la miniature.
Ce endpoint doit appelé comme source d'une iframe ou dans un nouvel onglet/fenêtre pour afficher la prévisualisation du fichier.
Pour un document ouvert avec OnlyOffice / Office pour le web, la page redirige vers la plateforme d'édition choisie.
Pour un fichier audio/vidéo, le lecteur sera chargé et affiché.
Pour les fichiers PDF, l'aperçu PDF standard sera affiché.
Le paramètre token
est obligatoire et correspond à la clé d'accès à la miniature.
Le contenu retourné est un objet JSON contenant les informations sur l'état de génération de la miniature.
Si la miniature est en cours de génération, le serveur attend 30 secondes que le processus se termine.
S'il ne se termine pas dans ce laps de temps, un code 423 Locked
est retourné.
pending
, preparing
, streamable
, available
ou failed
. streamable
n'est disponible que pour les fichiers audio/vidéo, l'aperçu peut alors être lu pendant que la génération est toujours en cours.Le paramètre token
est obligatoire et représente le token qui a été généré à la création de l'instance puis envoyé par email.
Valeur | Application |
---|---|
1 | Validation de document |
2 | Signature manuscrite numérisée |
3 | Signature électronique via tiers de confiance (eIDAS simple) |
4 | Validation de plusieurs documents |
5 | Signature électronique via tiers de confiance (eIDAS avancée) |
{ "flux": { "id": 2 // Flux de signature manuscrite numérisée } }
obligatoire
. Peut être remplacé par la propriété objects
dans le champ properties
Tableau de concordance : Flux ID | Requis |
---|---|
1 | Oui |
2 | Oui |
3 | Oui |
4 | Non |
5 | Oui |
obligatoire
. Actuellement seul le type 'file' est utilisé. Peut être remplacé par la propriété objects
dans le champ properties
Flux ID | Type possible | Requis |
---|---|---|
1 | file | Oui |
2 | file | Oui |
3 | file | Oui |
4 | Aucun | Non |
5 | file | Oui |
objects
est requise si vous souhaitez envoyer plusieurs documents en validation ou en signature.{ "objects": [ { "id": 12, "type": "file" }, { "id": 34, "type": "file" } ] }
validation de document
{ "validation": { "externe": [ // Tableau d'emails externes { "email": "person@externe.fr" } ], "interne": [ // Tableau d'utilisateurs internes { "name": "Mark Dupont", // Ce champ est facultatif et permet d'afficher un nom "email": "mark.dupont@netexplorer.fr", "id": 12 } ] }, "comment": "Merci de valider ce document." // Ce champ est facultatif et permet d'afficher un commentaire sur l'email et la page de validation }
signature manuscrite numérisée
signature électronique via tiers de confiance (eIDAS simple)
et signature électronique via tiers de confiance (eIDAS avancée)
{ "signatures": [ // Tableau d'utilisateurs { "firstname": "Mark", // Obligatoire sur la signature électronique via tiers de confiance (eIDAS avancée) "lastname": "Dupont", // Obligatoire sur la signature électronique via tiers de confiance (eIDAS avancée) "email": "mark.dupont@netexplorer.fr", "id": 13 // Identifiant de l'utilisateur. Permet de différencier si l'utilisateur est interne ou externe à la plateforme }, { "firstname": "Edouard", "lastname": "Vicheli", "email": "edouard.vicheli@netexplorer.fr" } ], "signature_fields": [ // Tableau de positions des cachets de signatures { "x": 604, // Le repère des coordonnées x,y démarre en bas à gauche de la page "y": 49, "page": 1, "signerIndex": 0, // Index correspondant à un utilisateur dans le tableau signatures "document": 0 // Index du document concerné }, { "x": 304, // La taille du cartouche est de 200px(l) sur 70px(h) "y": 49, "page": 1, "signerIndex": 1, "document": 0 } ], "objects": [ { "type": "file", "id": 32 // Id du fichier concerné }, { "type": "file", "id": 67 } ], "comment": "Merci de signer ce document." // Ce champ est facultatif et permet d'afficher un commentaire sur l'email et la page de signature }
validation de plusieurs documents
{ "objects": [ { "type": "file", "id": 32 // Id du fichier concerné }, { "type": "file", "id": 67 } ], "validation": { "externe": [ // Tableau d'emails externes { "email": "person@externe.fr" } ], "interne": [ // Tableau d'utilisateurs internes { "name": "Mark Dupont", // Ce champ est facultatif et permet d'afficher un nom "email": "mark.dupont@netexplorer.fr", "id": 12 } ] }, "comment": "Merci de valider ce document." // Ce champ est facultatif et permet d'afficher un commentaire sur l'email et la page de validation }
{ "flux": { "id": 2 }, "properties": { "signatures": [ { "firstname": "Mark", "lastname": "Dupont", "email": "mark.dupont@netexplorer.fr" }, { "firstname": "Edouard", "lastname": "Vicheli", "email": "edouard@vicheli@netexplorer.fr" } ], "signature_fields": [ { "x": 373, "y": 40, "page": 1, "signerIndex": 0, // L'index du signataire "document": 0 // L'index du document }, { "x": 160, "y": 41, "page": 1, "signerIndex": 1, "document": 0 }, { "x": 384, "y": 46, "page": 1, "signerIndex": 0, "document": 1 }, { "x": 164, "y": 44, "page": 1, "signerIndex": 1, "document": 1 } ], "send_copy": true, // Active l'envoi d'une copie des documents signées aux destinataires "objects": [ { "type": "file", "id": 4918 }, { "type": "file", "id": 4917 } ] } }
Le paramètre instanceId
est obligatoire et représente l'ID de l'instance de flux de travail à supprimer.
Le paramètre logId
est obligatoire et correspond à l'ID de l'entrée du journal que vous souhaitez récupérer.
Retourne un objet Entrée de journal représentant l'évènement cible.
{ "offset_start": 0, "nb_objects": 30, "nb_total_objects": 10, "objects": [ { "id": 987, "user_id": 5, "user_agent": "Mozilla/5.0...", ... }, ... ] }
Le paramètre folderId
est obligatoire et correspond à l'ID du dossier archivé que vous souhaitez récupérer.
Le paramètre fileId
est obligatoire et correspond à l'ID du fichier archivé que vous souhaitez récupérer.
Le paramètre folderId
est obligatoire et correspond à l'ID du dossier à archiver.
Le paramètre folderId
est obligatoire et correspond à l'ID du dossier archivé que vous souhaitez désarchiver.
Le paramètre fileId
est obligatoire et correspond à l'ID du fichier à archiver.
Le paramètre fileId
est obligatoire et correspond à l'ID du fichier archivé que vous souhaitez désarchiver.
Le paramètre folderId
est obligatoire et correspond à l'ID du dossier archivé que vous souhaitez éditer.
Le paramètre fileId
est obligatoire et correspond à l'ID du fichier archivé que vous souhaitez éditer.
Le paramètre folderId
est obligatoire et représente l'ID du dossier archivé à supprimer.
Le paramètre fileId
est obligatoire et représente l'ID du fichier archivé à supprimer.
Valeur | Droits |
---|---|
1 | Donne des informations basics sur storage |
2 | Rajoute des informations sur trashes.users |
4 | Rajoute les informations de slots |
8 | Rajoute les informations de visits |
16 | Compte le nombre de versions |
32 | Rajoute les informations de stats |
64 | Rajoute les informations de private.users |
{ "expire": 1515166838, // Date d'expiration de la plateforme (Timestamp Unix) "storage": { "main": { "used": 10000000000, // 10Go, espace disque utilisé, en incluant les archives "free": 90000000000, // 90Go "quota": 100000000000, // 100Go "percent": 10 // 10% }, "archive": { // Cette section est obsolète et ne dois plus être utilisée "used": 10000000000, // Obsolète "free": 90000000000, // Obsolète "quota": 100000000000, // Obsolète "percent": 10 // Obsolète }, "trashes": { "total": 452632, "users": [ { "id": 3, "user": "Louis BRETEL", "login": "louis.bretel", "size": 452632 } ] }, "private": { "total": 246895, "users": [ { "id": 5, "user": "Jérôme Acantil", "login": "jereom.acantil", "size": 14000 } ] }, "outlook": 0, // Espace disque utilisé par les pièces jointes déposés par le connecteur Outlook "versions": 452664 // Espace disque utilisé par les versions }, "visits": [ { "id": 3, "user": "Louis BRETEL", "login": "louis.bretel", "last_seen": "1732165223", "actions": 184, "external": false } ], "slots": { "allowed": 5, "used": 2, "billable": 2, // Nombre de connexions facturées "recents": [ { "id": 3, "user": "Louis BRETEL", "login": "louis.bretel", "ip": "1.1.1.1", "user_agent": "NetSync/1.2.69 (macOS High Sierra 10.13)", "computer": "PC01", "date": null, "state": "online", "type": "client", "env": { "os": "Mac OS", "os_type": 2, "browser": "NetSync 1.2.69" }, "geo": { "city": "Nice", "country": "France", "loc": "Nice, France" } }, { "id": 4, "user": "Marc KELSEN", "login": "marc.kelsen", "ip": "1.1.2.2", "user_agent": "NetSync/1.2.72 (Windows 10)", "computer": "PC11", "date": null, "state": "online", "type": "client", "env": { "os": "Windows", "os_type": 1, "browser": "NetSync 1.2.72" }, "geo": { "city": "Colomiers", "country": "France", "loc": "Colomiers, France" } }, { "id": 5, "user": "Elise ORGANA", "login": "elise.organa", "ip": "1.1.1.1", "user_agent": "NetSync/1.2.72 (Windows 10)", "computer": "PC02", "date": 1514761200, // Date de dernière connexion "state": "offline", "type": "client", "env": { "os": "Windows", "os_type": 1, "browser": "NetSync 1.2.72" }, "geo": { "city": "Colomiers", "country": "France", "loc": "Colomiers, France" } } ] }, // Signature de documents "docsigning": { "sign": 0, // Nombre de signatures restantes "sign_personal": 0, "timestamp": 0 } }
fileId
selon le type d'action voulu.Le champs fileId
de l'url est à remplacer par l'identifiant numérique unique du fichier à récupérer.
Le champs type
de l'url est à remplacer par le type de token voulu (preview
, edit
ou download
)
{ "token": "eyJhbGciOiJBMjU2S1ciLCJlbm..." }
Le champs key
de l'url est à remplacer par la clé du partage par lien.
Les informations concernant le token doivent être passées dans le corps de la requête et au format JSON.
{ "token": "eyJhbGciOiJBMjU2S1ciLCJlbm..." }
guid
selon le type d'action voulu.Le champs key
de l'url est à remplacer par la clé du partage par lien.
Le champs guid
de l'url est à remplacer par le guid du fichier contenu dans le partage par lien à utiliser.
Le champs type
de l'url est à remplacer par le type de token voulu (preview
, edit
ou download
)
Les informations concernant le token doivent être passées dans le corps de la requête et au format JSON.
{ "token": "eyJhbGciOiJBMjU2S1ciLCJlbm..." }
dataId
selon le type d'action voulu.Le champs key
de l'url est à remplacer par la clé du partage par lien.
Le champs dataId
de l'url est à remplacer par l'identifiant numérique unique du fichier contenu dans le partage par lien à récupérer.
Le champs type
de l'url est à remplacer par le type de token voulu (preview
ou video
)
Les informations concernant le token doivent être passées dans le corps de la requête et au format JSON.
{ "token": "eyJhbGciOiJBMjU2S1ciLCJlbm..." }
Le champs key
de l'url est à remplacer par la clé du partage par lien.
Les informations concernant le token doivent être passées dans le corps de la requête et au format JSON.
{ "token": "eyJhbGciOiJBMjU2S1ciLCJlbm..." }
id
selon le type d'action voulu.Le champs id
de l'url est à remplacer par l'id du template de fichier à utiliser.
Le champs type
de l'url est à remplacer par le type de token voulu (preview
, edit
ou download
)
{ "token": "eyJhbGciOiJBMjU2S1ciLCJlbm..." }
Fichier
ou Dossier
).{ "object": "Documents/Partagé/informations_diverses.docx" }
Si le chemin d'accès se termine par un /
, alors celui-ci pointe vers un dossier.
Dans le cas contraire, il s'agit d'un fichier.
L'objet retourné peut représenter soit un Fichier, soit un Dossier.
{ "object": { // Fichier ou Dossier "id": 1458, "name": "MonObjet", ... } }
OK
est retourné.Sont retournés les quotas globaux de la plateforme, le quota en place pour l'utilisateur courant, et si demandé, le quota appliqué sur le dossier recherché.
Si l'un des quotas vaut null, c'est qu'aucun quota n'est appliqué.
Les champs used
seront cependant renseignés dans tous les cas.
Le champ folder.folder
indique l'ID du dossier sur lequel est appliqué le quota dans le cas ou cette limitation est héritée.
Si la limitation n'est pas héritée ou si le dossier n'est pas acessible par l'utilisateur, cette valeur vaudra null.
{ "platform": { "quota": 10000000000, "used": 2048000000 }, "user": { "quota": null, "used": 589412556 }, "folder": { "quota": null, "used": 5682555, "folder": 142 } }
Cette méthode ne gère aucun paramètre ou contenu en entrée.
Le paramètre clientId
est obligatoire et représente l'identifiant public de l'application fourni par NetExplorer.
Le paramètre clientId
est obligatoire et représente l'identifiant public de l'application fourni par NetExplorer.
Cette méthode ne gère aucun paramètre ou contenu en entrée.
Le paramètre clientId
est obligatoire et représente l'identifiant public de l'application fourni par NetExplorer.
Type d'application OAuth2
Type | Description | |
---|---|---|
0 | Application Client <-> Serveur | |
1 | Application Serveur <-> Serveur |
all
active tout. Il est possible d'avoir plus de granularité par fonctionnalités. Les scopes finissant par .read
donne l'accès en lecture et ceux finissant en .readwrite
donne l'accès complet. Si le scope offline
est défini. Le token généré par la suite n'aura pas de date d'expiration. Type | Valeur disponible |
---|---|
Administration | admin.read admin.readwrite |
Account Security (Double Authentification) | accountsec.read accountsec.readwrite |
Account | account.read account.readwrite |
Annotations | annotations.read annotations.readwrite |
Archives | archives.read archives.readwrite |
Configuration | config.read config.readwrite |
Fichiers | files.read files.readwrite |
Groupes | groups.read groups.readwrite |
Partages | sharelinks.read sharelinks.readwrite |
Lien de dépôt | uploadlinks.read uploadlinks.readwrite |
Corbeille | trashes.read trashes.readwrite |
Utilisateurs | users.read users.readwrite |
Dossiers | folders.read folders.readwrite |
client_secret
Le paramètre clientId
est obligatoire et représente l'identifiant public de l'application fourni par NetExplorer.
Cette action entrainera l'invalidation des tous les tokens actifs pour cette application.
Le paramètre clientId
est obligatoire et représente l'identifiant public de l'application fourni par NetExplorer.
Le paramètre clientId
est obligatoire et représente l'identifiant public de l'application fourni par NetExplorer.
La suppression entraine une invalidation des tous les tokens associés à l'application.
Le paramètre token
est obligatoire et représente le token à supprimer.
Le paramètre token
est obligatoire et représente le token à supprimer.
Pour toute question relative à l'API REST, vous pouvez nous contacter :
Si vous souhaitez rester informé des modifications de la documentation API, vous pouvez vous inscrire à notre liste de diffusion dédiée en cliquant ici : Rester informé