Différences entre versions de « WebAPI Process.GetProgress »

De Documentation Polaris
Aller à : navigation, rechercher
(création automatique de la page par le cartographe)
 
(Modification automatique par le cartographe)
Ligne 1 : Ligne 1 :
{{DebutInfoCartographe}}{{FinInfoCartographe}}
+
{{DebutInfoCartographe}}{{Jusqua|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 : [[NF13075|Interface de programmation applicative par Webservice (API)]].
 +
 
 +
<div id='api-body'><p class='prp'>L'API Process permet de contrôler tout ce qui est relatif aux traitements du système</p><h2>Methode Process.GetProgress</h2><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://xx.xx.xx.xx/core/api/Process.GetProgress</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Process+Progress|Progress]]</span> <span class='method-name'>Process.GetProgress</span><span class='parameters'>&nbsp;(<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>process_name</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Renvoi la progression d'un traitement particulier en fonction de son nom</p><div class='args'><p><span class='lbl'>Arguments&nbsp;:</span></p><table class='t-args'><tr><thead><th>Nom</th><th>Type</th><th>Description</th></thead></tr><tr><th class='parameter-name'>process_name</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'><span class='param-doc'>Nom du processus</span></td></tr><tr><th class='parameter-name'>output</th><td class='parameter-type'>xml|json</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: xml)<br/></span><span class='param-doc'>Format de la réponse</span></td></tr><tr class='t-return'><th>Retour</th><td class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Process+Progress|Progress]]</td><td class='return-doc'></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;'>au moins une des conditions suivantes doit être vérifiée&nbsp;: <ul><li>passer par un lien de type <span class='security-elt'>boucle locale</span></li><li>passer par un lien de type <span class='security-elt'>machine</span></li><li>être identifié</li></ul></p></div></div>
 +
{{FinInfoCartographe}}[[Catégorie:Webservice API|Process.GetProgress]]

Version du 2 octobre 2017 à 11:03

Cette fonctionnalité n'est plus 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 Process permet de contrôler tout ce qui est relatif aux traitements du système

Methode Process.GetProgress

Appel Web : http://xx.xx.xx.xx/core/api/Process.GetProgress

Progress Process.GetProgress (<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> process_name, [xml|json output = xml ])

Renvoi la progression d'un traitement particulier en fonction de son nom

Arguments :

<thead></thead>
NomTypeDescription
process_name<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a>Nom du processus
outputxml|json (optionnel, par défaut: xml)
Format de la réponse
RetourProgress

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

au moins une des conditions suivantes doit être vérifiée :

  • passer par un lien de type boucle locale
  • passer par un lien de type machine
  • être identifié