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

De Documentation Polaris
Aller à : navigation, rechercher
(Modification automatique par le cartographe)
(Modification automatique par le cartographe)
Ligne 1 : Ligne 1 :
{{DebutInfoCartographe}}{{Jusqua|6.02}}
+
{{DebutInfoCartographe}}{{Depuis|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é.
 
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)]].
 
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><h2>Methode Health.EnvironmentInfo</h2><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://xx.xx.xx.xx/core/api/Health.EnvironmentInfo</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Health+EnvInfo|EnvInfo]][]</span> <span class='method-name'>Health.EnvironmentInfo</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>key</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Obtient des informations diverses sur l'environnement du programme</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'>key</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='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Précisez une clé d'information pour en obtenir sa valeur, sinon, renvoi une liste d'information complète</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.Health+EnvInfo|EnvInfo]][]</td><td class='return-doc'>Informations diverses sur le système, sous forme de clé/valeur</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>
+
<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>
 +
== Methode Health.EnvironmentInfo ==
 +
<p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/core/api/Health.EnvironmentInfo</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Health+EnvInfo|EnvInfo]][]</span> <span class='method-name'>Health.EnvironmentInfo</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'>key</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Obtient des informations diverses sur l'environnement du programme</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'>key</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'>Précisez une clé d'information pour en obtenir sa valeur, sinon, renvoi une liste d'information complète</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.Health+EnvInfo|EnvInfo]][]</td><td class='return-doc'>Informations diverses sur le système, sous forme de clé/valeur</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|Health.EnvironmentInfo]]
 
{{FinInfoCartographe}}[[Catégorie:Webservice API|Health.EnvironmentInfo]]

Version du 2 octobre 2017 à 11:05

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.

Methode Health.EnvironmentInfo

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

EnvInfo[] Health.EnvironmentInfo ([String key = null], [xml|json output = xml ])

Obtient des informations diverses sur l'environnement du programme

Arguments :

NomTypeDescription
keyString (optionnel, par défaut: null)
Précisez une clé d'information pour en obtenir sa valeur, sinon, renvoi une liste d'information complète
outputxml|json (optionnel, par défaut: xml)
Format de la réponse
RetourEnvInfo[]Informations diverses sur le système, sous forme de clé/valeur

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

aucune, cette API est disponible pour tous