Introduction
Cette documentation reprend les grandes lignes du document Epifiles - Évolution de l’API pour l’ONG.
Le besoin exprimé est de mettre à disposition des utilisateurs terrain d’Homère et Saga des mises à jour de ces applications sur Epifiles. Les mises à jour seront automatiquement téléchargées par le terrain et installées. Le système reposerait sur des scripts PHP pilotés par l’application Delphi, supportant les coupures réseau et fonctionnant avec des connexions lentes.
Rappel
Si la structure de groupes est la suivante :
Et qu’un entrepôt est configuer sur le groupe ACF
:
Alors nous avons :
Upload
Paramètres
Nom | Unique | Optionnel | Description |
---|---|---|---|
id | Y | N | Identifiant unique utilisé pour créer un dossier du même nom où sera stocker le fichier de résultat info.xml généré par le script |
username | Y | N | Identifiant de connexion |
password | Y | N | Mot de passe |
repository | Y | Y | Nom de l’entrepôt |
group | Y | Y | Nom de la zone dans l’entrepôt. Le paramètre est optionnel si l’utilisateur est dans une seule zone, sinon il faut déclencher une erreur. |
file | N | N | Chemin du fichier à envoyer |
delete_uploaded | Y | Y | Indique s’il faut supprimer le(s) fichier(s) une fois envoyé(s). |
timeout | Y | Y | Durée du timeout en minutes (par défaut à 24h) |
chunk_size | Y | Y | Taille des chunks en octets |
OU
Nom | Unique | Optionnel | Description |
---|---|---|---|
id | Y | N | Identifiant unique utilisé pour créer un dossier du même nom où sera stocker le fichier de résultat info.xml généré par le script |
delete | Y | N | Indique qu’il faut supprimer le répertoire temporaire et tout son contenu (donc le fichier de résultat info.xml). |
Exemples
Si le nom du fichier, ou le nom de l’entrepôt contiennent des espaces, il faut les encadrer par des guillemets.
Download
Paramètres
Nom | Unique | Optionnel | Description |
---|---|---|---|
id | Y | N | Identifiant unique utilisé pour créer un dossier du même nom où sera stocker le fichier de résultat info.xml généré par le script |
username | Y | N | Identifiant de connexion |
password | Y | N | Mot de passe |
repository | Y | Y | Nom de l’entrepôt |
group | Y | Y | Nom de la zone dans l’entrepôt |
file | N | Y | Nom du fichier à télécharger.Si absent, tous les fichiers sont téléchargés. |
timeout | Y | Y | Durée du timeout en minutes (par défaut à 24h) |
chunk_size | Y | Y | Taille des chunks en octets |
OU
Nom | Unique | Optionnel | Description |
---|---|---|---|
id | Y | N | Identifiant unique utilisé pour créer un dossier du même nom où sera stocker le fichier de résultat info.xml généré par le script |
delete | Y | N | Indique qu’il faut supprimer le répertoire temporaire et tout son contenu (donc le fichier de résultat info.xml et les fichiers téléchargés). |
Exemples
Si le nom du fichier, ou le nom de l’entrepôt contiennent des espaces, il faut les encadrer par des guillemets.
Delete
Paramètres
Nom | Unique | Optionnel | Description |
---|---|---|---|
id | Y | N | Identifiant unique utilisé pour créer un dossier du même nom où sera stocker le fichier de résultat info.xml généré par le script |
username | Y | N | Identifiant de connexion |
password | Y | N | Mot de passe |
repository | Y | Y | Nom de l’entrepôt |
group | Y | Y | Nom de la zone dans l’entrepôt |
file | N | Y | Nom du fichier à supprimer.Si absent, tous les fichiers sont supprimer. |
timeout | Y | Y | Durée du timeout en minutes (par défaut à 24h) |
OU
Nom | Unique | Optionnel | Description |
---|---|---|---|
id | Y | N | Identifiant unique utilisé pour créer un dossier du même nom où sera stocker le fichier de résultat info.xml généré par le script |
delete | Y | N | Indique qu’il faut supprimer le répertoire temporaire et tout son contenu (donc le fichier de résultat info.xml). |
Exemples
Si le nom du fichier, ou le nom de l’entrepôt contiennent des espaces, il faut les encadrer par des guillemets.
TestUserLogin
Paramètres
Nom | Unique | Optionnel | Description |
---|---|---|---|
id | Y | N | Identifiant unique, sert à retrouver le fichier xml généré par le script et qui donne le statut de la suppression |
username | Y | N | Identifiant de connexion |
password | Y | N | Mot de passe |
OU
Nom | Unique | Optionnel | Description |
---|---|---|---|
id | Y | N | Identifiant unique utilisé pour créer un dossier du même nom où sera stocker le fichier de résultat info.xml généré par le script |
delete | Y | N | Indique qu’il faut supprimer le répertoire temporaire et tout son contenu (donc le fichier de résultat info.xml). |
Exemples
ListFiles
Cette méthode permet de lister les fichiers qui ont été déposés dans des zones ou entrepôts.
A noter : les entrepôts et les zones correspondent à des groupes au sein de l’application Epifiles et il n’y a aucune contrainte quant à l’unicité des nom des groupes. Ainsi, demander la liste des fichiers contenus dans la zone “VERSION” revient à demander la liste des fichiers contenus dans toutes les zones nommées “VERSION” que l’utilisateur peut “voir” (sur lesquelles il a des droits). De même demander les fichiers contenus dans la zone “VERSION” de l’entrepôt “ACF” peut mener à des résultats différents selon si l’utilisateur a des droits sur SAGA > ACF > VERSION uniquement ou également sur HOMERE > ACF > VERSION.
Paramètres
Nom | Unique | Optionnel | Description |
---|---|---|---|
id | Y | N | Identifiant unique utilisé pour créer un dossier du même nom où sera stocker le fichier de résultat info.xml généré par le script |
username | Y | N | Identifiant de connexion |
password | Y | N | Mot de passe |
repository | Y | Y | Nom de l’entrepôt ciblé. Un nom d’entrepôt ou de zone est obligatoire. |
group | Y | Y | Nom de la zone ciblée. Un nom d’entrepôt ou de zone est obligatoire. |
timeout | Y | Y | Durée du timeout en minutes (par défaut à 1h) |
OU
Nom | Unique | Optionnel | Description |
---|---|---|---|
id | Y | N | Identifiant unique utilisé pour créer un dossier du même nom où sera stocker le fichier de résultat info.xml généré par le script |
delete | Y | N | Indique qu’il faut supprimer le répertoire temporaire et tout son contenu (donc le fichier de résultat info.xml). |