Manuel d'intégration des applications > Service Web Internal > Opérations du service Web

Opérations du service Web

Les opérations sont aussi décrites dans le fichier fourni uc4.wsdl.

Connexion et déconnexion

Description Opération Paramètres Code retour
Connexion

logon

 

Client, nom d'utilisateur, département, mot de passe, langue

Valeurs autorisées pour la langue : "68" (Allemand), "69" (Anglais) et "70" (Français)

ID de session
Déconnexion logoff ID de session -

Informations relatives au système AE

Description Opération Paramètres Code retour
Déterminer la version Automation Engine accompagnée du numéro de correctif getVersion -

Automation Engine version

Exemple : 8.00A909-001

Déterminer les informations relatives à la base de données (voir Supervision Système - Base de données) getDatabaseInfo -

Type intitulé DatabaseInformation

Vous utilisez ce type pour demander des informations détaillées, par exemple le nom de la base de données

Informations relatives aux Clients

Le client système 0000 propose une liste de tous les utilisateurs, agents, etc. du système AE. Lorsque vous vous connectez à un client défini par l'utilisateur, vous obtenez uniquement les objets du client. La liste correspond à ce dernier dans la Supervision système.

Description Opération Paramètres Code retour
Liste des processus serveur getServerList -

Liste du type ServerListItem

Vous utilisez ce type pour demander des informations détaillées, par exemple le nom du processus serveur

Liste par charge des processus serveur getSystemWorkload -

Liste du type WorkLoadItem

Vous utilisez ce type pour demander des informations détaillées, par exemple la moyenne

Liste des Clients getClientList -

Liste du type ClientListItem

Vous utilisez ce type pour demander des informations détaillées, par exemple le Fuseau horaire

Liste des utilisateurs getUserList -

Liste du type UserListItem

Vous utilisez ce type pour demander des informations détaillées, par exemple le nom

Liste des Agents getAgentList -

Liste du type AgentListItem

Vous utilisez ce type pour demander des informations détaillées, par exemple les rôles

Liste des groupes d'agents getAgentGroupList -

Liste du type AgentGroupListItem

Vous utilisez ce type pour demander des informations détaillées, par exemple le mode

Contenu de la fenêtre des activités getActivityList

Filtres

Le paramètre est du type TaskFilter

Liste du type Task

Utilisez ce type pour demander des tâches individuelles

Priorité la plus élevée des notifications actives getHighestNotificationPriority -

Priorité la plus élevée de toutes les notifications en cours.

Valeurs possibles :

"LOW" - Faible
"MEDIUM" - Normal
"HIGH" - Elevé

Démarrage et arrêt des Clients

Description Opération Paramètres Code retour
Démarrer un Client resumeClient - -
Arrêter un Client suspendClient - -

Démarrer, Arrêter, etc. des tâches

Description Opération Paramètres Code retour
Exécuter un objet executeObject

Nom de l'objet, Fuseau horaire, Paramètre d'entrée pour les masques READ, Heure de début, Attend la libération manuelle

Voir aussi Remplissage de masques :Read

Le paramètre "Attend la libération manuelle" est de type booléen.

RunID de la tâche démarrée
Démarrer une tâche périodique executeRecurring

Nom de l'objet, Fuseau horaire, Fréquence, Fenêtre horaire, Jours, Zone

Le paramètre "Fréquence" est de type ExecuteFrequency.

Le paramètre "Fenêtre horaire" est de type ExecuteTimeFrame.

Le paramètre "Jours" est de type ExecuteDays.

Le paramètre "Intervalle" est de type ExecuteRange.

RunID du conteneur de Périodes lancé
Répéter une tâche restartTask

RunID de référence, Point de reprise, Conserver le type de démarrage, Attend la libération manuelle, Relancer uniquement les processus enfants en erreur

Les paramètres 3, 4 et 5 sont de type booléen.

-
Arrêter une tâche suspendTask

RunID, Récursif

Le paramètre "Récursif" est de type booléen.

-
Activer une tâche arrêtée resumeTask

RunID, Récursif

Le paramètre "Récursif" est de type booléen.

-
Terminer une tâche quitTask RunID -
Interrompre une tâche cancelTask

RunID, Récursif

Le paramètre "Récursif" est de type booléen.

-
Désactiver une tâche deactivateTask RunID -
Reprendre une tâche adoptTask RunID -

Tâches pendant leur exécution

Description Opération Paramètres Code retour
Recharger un Schedule à la prochaine heure de réinitialisation setReloadNextTurnaround Nom du Schedule -
Ignorer les conditions Sync ignoreTaskSyncCondition RunID -
Supprimer une entrée unregisterTask RunID -
Définir l'heure de début d'une tâche setTaskStartTime

RunID, Heure de début, Fuseau horaire

-
Définir le statut d'une tâche setTaskState

RunID, Ancien statut,Nouveau statut

Indiquez le code retour système pour les deux paramètres de statut.

-
Démarrer une tâche immédiatement startTaskImmediately RunID -
Lire les informations de la fenêtre de détails de la tâche getTaskDetails RunID

Vous utilisez le type DetailGroupItem

Vous utilisez ce type pour demander des informations détaillées, par exemple le statut

Workflow et tâches du Workflow

Description Opération Paramètres Code retour
Positionner un point d'arrêt dans un Workflow setProcessFlowBreakPoint RunID -
Supprimer un point d'arrêt dans un Workflow removeProcessFlowBreakPoint RunID -
Débloquer une tâche dans un Workflow unblockProcessFlowTask RunID -
Activer une tâche dans un Workflow setProcessFlowTaskActive RunID -
Désactiver une tâche dans un Workflow setProcessFlowTaskInactive RunID -

 

Rubriques connexes :

Utilisation du service Web