Différences entre versions de « WebAPI Process.GetProgress »
De Documentation Polaris
(Modification automatique par le cartographe) |
(Modification automatique par le cartographe) |
||
| Ligne 4 : | Ligne 4 : | ||
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)]]. | 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><br/><p class='appel'><span class='lbl'>Appel Web :</span> <span class='vlr'> | + | <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><br/><p class='appel'><span class='lbl'>Appel Web :</span> <span class='vlr'>https://nur298.ws-dev.polarisgestionmag.net/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'> (<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</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 :</span></p><table class='t-args'><tr><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>process_name</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</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 :</span></p><p style='padding-left:1em;'>au moins une des conditions suivantes doit être vérifiée : <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 Process|GetProgress]] | {{FinInfoCartographe}}[[Catégorie:Webservice Process|GetProgress]] | ||
Version du 18 juillet 2022 à 10:25
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
Appel Web : https://nur298.ws-dev.polarisgestionmag.net/core/api/Process.GetProgress
Progress Process.GetProgress (String process_name, [xml|json output = xml ])
Renvoi la progression d'un traitement particulier en fonction de son nom
Arguments :
| Nom | Type | Description |
|---|---|---|
| process_name | String | Nom du processus |
| output | xml|json | (optionnel, par défaut: xml) Format de la réponse |
| Retour | Progress |
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é