Différences entre versions de « WebAPI Health.ProcessList »

De Documentation Polaris
Aller à : navigation, rechercher
(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 Health vous permet d'obtenir des informations sur le système et son état de fonctionnement, ses procédures en cours et sa journalisation.</p>
+
<div id='api-body'><p class='prp'>L'API Health vous permet d'obtenir des informations sur le système et son état de fonctionnement, ses procédures en cours et sa journalisation.</p><br/><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/core/api/Health.ProcessList</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Health+ProcessInfo|ProcessInfo]][]</span> <span class='method-name'>Health.ProcessList</span><span class='parameters'>&nbsp;(<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 liste des processus et fils d'exécution en cours sur le système, ainsi que leur état et leur tâche respective.</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'>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.Health+ProcessInfo|ProcessInfo]][]</td><td class='return-doc'>Liste de description de processus</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>
== Methode Health.ProcessList ==
 
<p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/core/api/Health.ProcessList</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Health+ProcessInfo|ProcessInfo]][]</span> <span class='method-name'>Health.ProcessList</span><span class='parameters'>&nbsp;(<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 liste des processus et fils d'exécution en cours sur le système, ainsi que leur état et leur tâche respective.</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'>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.Health+ProcessInfo|ProcessInfo]][]</td><td class='return-doc'>Liste de description de processus</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 Health|ProcessList]]
 
{{FinInfoCartographe}}[[Catégorie:Webservice Health|ProcessList]]

Version du 30 juillet 2018 à 17:50

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 Health vous permet d'obtenir des informations sur le système et son état de fonctionnement, ses procédures en cours et sa journalisation.


Appel Web : http://localhost/core/api/Health.ProcessList

ProcessInfo[] Health.ProcessList ([xml|json output = xml ])

Renvoi la liste des processus et fils d'exécution en cours sur le système, ainsi que leur état et leur tâche respective.

Arguments :

NomTypeDescription
outputxml|json (optionnel, par défaut: xml)
Format de la réponse
RetourProcessInfo[]Liste de description de processus

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é