Différences entre versions de « WebAPI Maintenance.SQL »

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'><br/><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/core/api/Maintenance.SQL</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Maintenance+SQLResult|SQLResult]][]</span> <span class='method-name'>Maintenance.SQL</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'>queries</span> = null]</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'>reason</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[[WebAPI Type RepCommon.Constantes.RepPriorities|RepPriorities]]</span> <span class='parameter-name'>priority</span> = Medium]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</span> <span class='parameter-name'>nb_ops</span> = 50]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Execute une requête SQL</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'>queries</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'>Requêtes SQL à exécuter</span></td></tr><tr><th class='parameter-name'>reason</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'>En cas de modification de la base, raison</span></td></tr><tr><th class='parameter-name'>priority</th><td class='parameter-type'>[[WebAPI Type RepCommon.Constantes.RepPriorities|RepPriorities]]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: Medium)<br/></span><span class='param-doc'>En cas de modification de la base, priorité des opérations générées</span></td></tr><tr><th class='parameter-name'>nb_ops</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 50)<br/></span><span class='param-doc'>En cas de modification de la base, nombre d'instructions maximum par opération</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.Maintenance+SQLResult|SQLResult]][]</td><td class='return-doc'>Résultat de la requête</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;'>Posséder le droit «<span class='security-elt'>autorisation d'effectuer une sauvegarde de la base de données</span>»</p></div></div>
+
<div id='api-body'><br/><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/core/api/Maintenance.SQL</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Maintenance+SQLResult|SQLResult]][]</span> <span class='method-name'>Maintenance.SQL</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'>queries</span> = null]</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'>reason</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</span> <span class='parameter-name'>replicate</span> = True]</span>, <span class='opt'>[<span class='parameter-type'>[[WebAPI Type RepCommon.Constantes.RepPriorities|RepPriorities]]</span> <span class='parameter-name'>priority</span> = Medium]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</span> <span class='parameter-name'>nb_ops</span> = 50]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Execute une requête SQL</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'>queries</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'>Requêtes SQL à exécuter</span></td></tr><tr><th class='parameter-name'>reason</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'>En cas de modification de la base, raison</span></td></tr><tr><th class='parameter-name'>replicate</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'>En cas de modification de la base, spécifier vrai pour la répliquer, faux pour opérer que sur la base du service</span></td></tr><tr><th class='parameter-name'>priority</th><td class='parameter-type'>[[WebAPI Type RepCommon.Constantes.RepPriorities|RepPriorities]]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: Medium)<br/></span><span class='param-doc'>En cas de modification de la base, priorité des opérations générées</span></td></tr><tr><th class='parameter-name'>nb_ops</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 50)<br/></span><span class='param-doc'>En cas de modification de la base, nombre d'instructions maximum par opération</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.Maintenance+SQLResult|SQLResult]][]</td><td class='return-doc'>Résultat de la requête</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;'>Posséder le droit «<span class='security-elt'>autorisation d'effectuer une sauvegarde de la base de données</span>»</p></div></div>
 
{{FinInfoCartographe}}[[Catégorie:Webservice Maintenance|SQL]]
 
{{FinInfoCartographe}}[[Catégorie:Webservice Maintenance|SQL]]

Version du 25 février 2019 à 11:04

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).


Appel Web : http://localhost/core/api/Maintenance.SQL

SQLResult[] Maintenance.SQL ([String queries = null], [String reason = null], [Boolean replicate = True], [RepPriorities priority = Medium], [Int32 nb_ops = 50], [xml|json output = xml ])

Execute une requête SQL

Arguments :

NomTypeDescription
queriesString (optionnel, par défaut: null)
Requêtes SQL à exécuter
reasonString (optionnel, par défaut: null)
En cas de modification de la base, raison
replicateBoolean (optionnel, par défaut: True)
En cas de modification de la base, spécifier vrai pour la répliquer, faux pour opérer que sur la base du service
priorityRepPriorities (optionnel, par défaut: Medium)
En cas de modification de la base, priorité des opérations générées
nb_opsInt32 (optionnel, par défaut: 50)
En cas de modification de la base, nombre d'instructions maximum par opération
outputxml|json (optionnel, par défaut: xml)
Format de la réponse
RetourSQLResult[]Résultat de la requête

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

Posséder le droit «autorisation d'effectuer une sauvegarde de la base de données»