Différences entre versions de « WebAPI Files.Upload »

De Documentation Polaris
Aller à : navigation, rechercher
(Modification automatique par le cartographe)
(Modification automatique par le cartographe)
Ligne 7 : Ligne 7 :
 
== Methode Files.Upload ==
 
== Methode Files.Upload ==
 
<p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/core/api/Files.Upload</span></p><p class='signature'><span class='return-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='method-name'>Files.Upload</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>file</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</span> <span class='parameter-name'>startAt</span> = 0]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</span> <span class='parameter-name'>expectedSize</span> = 0]</span>)</span></p><p class='mrp'>Procède au téléversement du fichier de votre poste vers le service de réplication.</p><p class='remarks'><span class='lbl'>Remarques</span>&nbsp;: Il est nécessaire d'être connecté pour procéder à l'envoi d'un fichier. Pour créer un fichier, appeler cette méthode en ne spécifiant aucun nom de fichier. Spécifiez les données dans le corps de la requête.</p><div class='args'><p><span class='lbl'>Arguments&nbsp;:</span></p><table class='t-args'><tr><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>file</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Nom du fichier</span></td></tr><tr><th class='parameter-name'>startAt</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 0)<br/></span><span class='param-doc'>Complète le fichier à partir de cette position</span></td></tr><tr><th class='parameter-name'>expectedSize</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 0)<br/></span><span class='param-doc'>Précise la taille du fichier, en octets, qui va être envoyé au serveur</span></td></tr><tr class='t-return'><th>Retour</th><td class='return-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='return-doc'>Nom du fichier sur le serveur</td></tr></table><p><span class='lbl'>Politique de sécurité et règles d'accès à l'API&nbsp;:</span></p><p style='padding-left:1em;'>aucune, cette API est disponible pour tous</p></div></div>
 
<p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/core/api/Files.Upload</span></p><p class='signature'><span class='return-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='method-name'>Files.Upload</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>file</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</span> <span class='parameter-name'>startAt</span> = 0]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</span> <span class='parameter-name'>expectedSize</span> = 0]</span>)</span></p><p class='mrp'>Procède au téléversement du fichier de votre poste vers le service de réplication.</p><p class='remarks'><span class='lbl'>Remarques</span>&nbsp;: Il est nécessaire d'être connecté pour procéder à l'envoi d'un fichier. Pour créer un fichier, appeler cette méthode en ne spécifiant aucun nom de fichier. Spécifiez les données dans le corps de la requête.</p><div class='args'><p><span class='lbl'>Arguments&nbsp;:</span></p><table class='t-args'><tr><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>file</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Nom du fichier</span></td></tr><tr><th class='parameter-name'>startAt</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 0)<br/></span><span class='param-doc'>Complète le fichier à partir de cette position</span></td></tr><tr><th class='parameter-name'>expectedSize</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 0)<br/></span><span class='param-doc'>Précise la taille du fichier, en octets, qui va être envoyé au serveur</span></td></tr><tr class='t-return'><th>Retour</th><td class='return-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='return-doc'>Nom du fichier sur le serveur</td></tr></table><p><span class='lbl'>Politique de sécurité et règles d'accès à l'API&nbsp;:</span></p><p style='padding-left:1em;'>aucune, cette API est disponible pour tous</p></div></div>
{{FinInfoCartographe}}[[Catégorie:Webservice API|Files.Upload]][[Catégorie:Webservice WebAPI Files|Upload]]
+
{{FinInfoCartographe}}[[Catégorie:Webservice Files|Upload]]

Version du 30 juillet 2018 à 16:52

Disponible depuis la version 6.02

L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe via un langage normalisé. Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : Interface de programmation applicative par Webservice (API).

L'API Files permet de gérer le système de fichiers du service de réplication.

Methode Files.Upload

Appel Web : http://localhost/core/api/Files.Upload

String Files.Upload ([String file = null], [Int64 startAt = 0], [Int64 expectedSize = 0])

Procède au téléversement du fichier de votre poste vers le service de réplication.

Remarques : Il est nécessaire d'être connecté pour procéder à l'envoi d'un fichier. Pour créer un fichier, appeler cette méthode en ne spécifiant aucun nom de fichier. Spécifiez les données dans le corps de la requête.

Arguments :

NomTypeDescription
fileString (optionnel, par défaut: null)
Nom du fichier
startAtInt64 (optionnel, par défaut: 0)
Complète le fichier à partir de cette position
expectedSizeInt64 (optionnel, par défaut: 0)
Précise la taille du fichier, en octets, qui va être envoyé au serveur
RetourStringNom du fichier sur le serveur

Politique de sécurité et règles d'accès à l'API :

aucune, cette API est disponible pour tous