Pour les développeurs de scripts plus avancés, vous pouvez ouvrir et enregistrer des scripts par programmation pour faciliter les processus de développement automatisés. Développez les listes déroulantes suivantes pour afficher les détails de base de chaque API.
GET https://{domain}/services/v18.0/scripts
Sommaire: Renvoie le XML d'un script par Name ou masterId.
La description: Cette méthode renvoie le XML d'un script par nom ou masterId.
Paramètres:
- nom : scriptPath
dans : chemin
description: chemin complet du script
requis : vrai
style : simple
exploser : faux
schéma:
type : chaîne
- nom : scriptId
dans : chemin
description: identifiant maître d'un script
requis : vrai
style : simple
exploser : faux
schéma:
type : entier
Réponses :
'200' :
descriptif : SUCCÈS
contenu:
application/json :
schéma:
type : objet
Propriétés:
Nom:
type : chaîne
description : Nom d'un script
chemin du fichier:
type : chaîne
description: chemin du fichier
ID de script :
type : entier
description : MasterId
corps:
type : chaîne
description : XML d'un script
'400' : description : paramètres non valides
'404' : description : introuvable
'500' : description : erreur interne
'501' : description : erreur interne du service Incontrol.Net
METTRE https://{domain}/services/v18.0/scripts
Sommaire: Enregistrez un nouveau script ou un script existant.
La description: Cette méthode enregistrera un script dans la base de données à l'aide d'une chaîne base64.
Paramètres:
- nom : scriptPath
dans : chemin
description : chemin complet et nom du script
requis : vrai
style : simple
exploser : faux
schéma:
type : chaîne
- nom : corps
dans : chemin
description: 'corps du script, ceci est un XML encodé en base64'
requis : vrai
style : simple
exploser : faux
schéma:
type : chaîne
Réponses :
'200' :
descriptif : Succès
contenu:
application/json :
schéma:
Script de sauvegarde :
type : objet
Propriétés:
ID de script :
type : chaîne
description : Le nouveau ScriptId généré après la réussite de l'enregistrement
'400' : description : paramètres non valides
'405' : description : Verrouillé par quelqu'un d'autre
'500' : description : erreur interne
'501' : description : erreur interne du service
POST https: // {domaine} /services/v18.0/scripts
Sommaire: Enregistrez un nouveau script ou un script existant.
La description: Cette méthode enregistrera un script dans la base de données à l'aide d'une chaîne base64.
Paramètres:
- nom : scriptPath
dans : chemin
description : chemin complet et nom du script
requis : vrai
style : simple
exploser : faux
schéma:
type : chaîne
- nom : corps
dans : chemin
description: 'corps du script, ceci est un XML encodé en base64'
requis : vrai
style : simple
exploser : faux
schéma:
type : chaîne
Réponses :
'200' :
descriptif : Succès
contenu:
application/json :
schéma:
type : objet
Propriétés:
ID de script :
type : chaîne
description : Le nouveau ScriptId généré après la réussite de l'enregistrement
'400' : description : paramètres non valides
'405' : description : Verrouillé par quelqu'un d'autre
'500' : description : erreur interne
'501' : description : erreur interne du service
POST https://{domain}/services/v18.0/scripts/kick
Sommaire: Kick un script verrouillé.
La description: Cette méthode forcera le déverrouillage d'un script.
Paramètres:
- nom : scriptPath
dans : chemin
description: chemin complet du script
requis : vrai
style : simple
exploser : faux
schéma:
type : chaîne
Réponses :
'200' : description : Succès
type : objet
Propriétés:
type : chaîne
description : Date de la demande
Message d'erreur:
type : chaîne
description : Message d'erreur du service
État d'erreur :
tapez : booléen
description : État d'erreur
KickResult :
type : chaîne
description : Résultat du service
Identifiant maître:
type : entier
description : ID maître du script
CurrLockedBy :
type : entier
description : ID de l'utilisateur expulsé
'400' : description : paramètres non valides, script déjà déverrouillé, vous ne pouvez pas vous expulser du script
'404' : description : ScriptNotFound
'500' : description : erreur interne
'501' : description : erreur interne du service
GET https://{domain}/services/v18.0/scripts/historyByName/{scriptPath}
Sommaire: Renvoie l'historique d'un script.
La description: Cette méthode renverra un historique d'un script par nom.
Paramètres:
- nom : scriptPath
dans : chemin
description: chemin complet du script
requis : vrai
style : simple
exploser : faux
schéma:
type : chaîne
Réponses :
'200' :
descriptif : SUCCÈS
contenu:
application/json :
schéma:
Scripts d'historique :
type : objet
Propriétés:
Nom:
type : chaîne
description: chemin complet d'un script joint au nom
versions :
tapez : tableau
Articles:
HistoryScripts_versions :
type : objet
Propriétés:
ID de script :
type : entier
description : ID maître du script
modifierDate :
type : chaîne
description : Modifier la date
modifierUtilisateur :
type : chaîne
description : Modifier l'utilisateur
Statut:
type : chaîne
description : Statut d'un script
'400' : description : paramètres non valides
'404' : description : introuvable
'500' : description : erreur interne
'501' : description : erreur interne du service Incontrol.Net
GET https://{domain}/services/v19.0/scripts/search
obtenir:
Mots clés:
Sommaire: Script de recherche
La description: Cette méthode recherchera un script dans l'unité commerciale en fonction de mots-clés.
Paramètres:
nom : type de média
dans : requête
description : Type de média du script.
obligatoire : faux
exploser : faux
schéma:
type : entier
nom : scriptName
dans : chemin
description: mot-clé pour la recherche
requis : vrai
style : simple
exploser : faux
schéma:
type : chaîne
nom : includeInactive
dans : requête
description : Cette variable permet d'inclure la recherche parmi les scripts inactifs.
obligatoire : faux
exploser : faux
schéma:
tapez : booléen
nom : includeTrusted
dans : requête
description : cette variable est utilisée pour inclure la recherche parmi les unités commerciales de confiance
obligatoire : faux
exploser : faux
schéma:
type : chaîne
nom : modEndDate
dans : requête
description : Cette variable permet d'inclure la recherche dans une plage de dates établie
obligatoire : faux
exploser : faux
schéma:
type : chaîne
Réponses :
'200' :
descriptif : SUCCÈS
contenu:
application/json :
schéma:
$ref : '#/components/schemasSearchScript'
«400»:
description : Paramètres invalides
«401»:
description : Non autorisé. Vous ne disposez pas des autorisations suffisantes
«404»:
description : chemin du script introuvable
«500»:
description : Erreur interne
«501»:
description : Erreur interne du service Incontrol.Net
Composants:
schémas :
GetScript :
type : objet
Propriétés:
Nom:
type : chaîne
description: 'Nom du script'
chemin du fichier:
type : chaîne
description: 'Chemin complet du script'
ID de script :
type : entier
description: 'Ceci est l'identifiant du script, il est unique'
corps:
type : chaîne
description: 'Contenu du script encodé au format Base63'
SupprimerScript :
type : objet
Propriétés:
scriptPath :
type : chaîne
description: 'Informations sur le nom du script de chemin complet qui a été supprimé'
supprimé :
tapez : booléen
description: 'Statut du script'
Erreur:
type : chaîne
description: 'Si une erreur se produit dans le processus de suppression'
Script de recherche :
type : objet
Propriétés:
type : entier
description: 'Informations de l'unité commerciale'
nom_script :
type : chaîne
description: 'Chemin complet du script'
scriptSearchDetails :
tapez : tableau
description: 'Détail du résultat de la recherche'
éléments:
$ref : '#/components/schemas/SearchScript_Details'
SearchScript_Details :
type : objet
Propriétés:
n°bus :
type : entier
description : 'Numéro d'unité commerciale'
Identifiant maître:
type : chaîne
description : 'Identifiant de script'
nom_script :
type : chaîne
description: 'Nom du script'
statut:
type : chaîne
description: 'Statut du script actif/inactif'
type de support:
type : entier
description: 'Numéro de type de média'
modifierDate :
type : chaîne
description: 'La date de la dernière modification
mUtilisateur :
type : entier
description: 'Le dernier utilisateur qui a modifié le script'
ID action :
type : entier
description : 'Identifiant de l'action'