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

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 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.DbTableStats</h2><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://xx.xx.xx.xx/core/api/Health.DbTableStats</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Health+DbInfo|DbInfo]]</span> <span class='method-name'>Health.DbTableStats</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></span> <span class='parameter-name'>statsTables</span> = True]</span>, <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'>table</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'>Renvoi la liste des tables et des informations les concernants.</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'>statsTables</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: True)<br/></span><span class='param-doc'>Précise que nous souhaitons avoir le détail par tables.</span></td></tr><tr><th class='parameter-name'>table</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'>Nom de la table recherchée. Si non précisé, alors renvoi les informations de toutes les tables.</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+DbInfo|DbInfo]]</td><td class='return-doc'>Liste de description de statistiques de table</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|Health.DbTableStats]]

Version du 2 octobre 2017 à 12: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 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.DbTableStats

Appel Web : http://xx.xx.xx.xx/core/api/Health.DbTableStats

DbInfo Health.DbTableStats ([<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a> statsTables = True], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> table = null], [xml|json output = xml ])

Renvoi la liste des tables et des informations les concernants.

Arguments :

<thead></thead>
NomTypeDescription
statsTables<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a> (optionnel, par défaut: True)
Précise que nous souhaitons avoir le détail par tables.
table<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> (optionnel, par défaut: null)
Nom de la table recherchée. Si non précisé, alors renvoi les informations de toutes les tables.
outputxml|json (optionnel, par défaut: xml)
Format de la réponse
RetourDbInfoListe de description de statistiques de table

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é