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

De Documentation Polaris
Aller à : navigation, rechercher
(Modification automatique par le cartographe)
(Modification automatique par le cartographe)
Ligne 7 : Ligne 7 :
 
== Methode Health.DbTableStats ==
 
== Methode Health.DbTableStats ==
 
<p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/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'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</span> <span class='parameter-name'>statsTables</span> = True]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</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><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>statsTables</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</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'>[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'>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>
 
<p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/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'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</span> <span class='parameter-name'>statsTables</span> = True]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</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><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>statsTables</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</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'>[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'>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]][[Catégorie:Webservice WebAPI Health|DbTableStats]]
+
{{FinInfoCartographe}}[[Catégorie:Webservice Health|DbTableStats]]

Version du 30 juillet 2018 à 16:53

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://localhost/core/api/Health.DbTableStats

DbInfo Health.DbTableStats ([Boolean statsTables = True], [String table = null], [xml|json output = xml ])

Renvoi la liste des tables et des informations les concernants.

Arguments :

NomTypeDescription
statsTablesBoolean (optionnel, par défaut: True)
Précise que nous souhaitons avoir le détail par tables.
tableString (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é