Sessions
| Méthode | Description |
|---|---|
| CloseSession | Ferme une session |
| GetSessionInfo | Récupère les informations d’une session |
| IsSessionExists | Vérifie si une session existe |
| OpenSession | Ouvre une session et spécifie les types de rôles et la station |
| OpenSessionEx | Ouvre une session (version étendue d’OpenSession) |
Projets
| Méthode | Description |
|---|---|
| CloseProject | Ferme un projet |
| GetProjects | Renvoie la liste des projets chargés sur le serveur d’applications |
| GetProjectsForUser | Renvoie l’ensemble des enregistrements répertoriant les projets disponibles pour l’utilisateur |
| OpenProject | Ouvre un projet |
Types de lots
| Méthode | Description |
|---|---|
| GetAllowedBatchTypes | Renvoie une liste des types de lots disponibles |
| GetBatchType | Renvoie des informations sur un type de lot |
| GetBatchTypes | Renvoie une liste de types de lots |
| GetProcessingStages | Renvoie une liste d’étapes de traitement |
| GetProcessingStagesExt | Renvoie des informations détaillées sur les étapes de traitement |
| HasRightsForBatchType | Vérifie si le rôle de l’utilisateur dispose des droits d’accès pour un type de lot donné |
Batches
| Méthode | Description |
|---|---|
| AddNewBatch | Ajoute un nouveau lot et en spécifie le propriétaire |
| AddNewBatchExt | Ajoute un nouveau lot et en spécifie le propriétaire (version étendue de AddNewBatch) |
| AddNewImage | Ajoute une image à un lot |
| CloseBatch | Ferme (déverrouille) un lot |
| DeleteBatch | Supprime un lot |
| GetBatch | Récupère des informations sur un lot |
| GetBatches | Récupère des informations sur les lots d’un projet |
| GetBatchesExt | Récupère des informations sur les lots d’un projet (version étendue de GetBatches) |
| GetDetailedBatch | Récupère des informations détaillées sur un lot |
| GetDetailedBatches | Récupère des informations détaillées sur les lots d’un projet |
| GetDetailedBatches2 | Récupère des informations détaillées sur les lots accessibles à un utilisateur |
| GetBatchIdsRange | Réserve un ensemble d’ID dans un lot |
| GetBatchPercentCompleted | Récupère des informations sur le traitement d’un lot |
| GetFilteredBatches | Récupère la liste filtrée des lots d’un serveur, par groupes |
| OpenBatch | Ouvre (verrouille) un lot |
| ProcessBatch | Lance le traitement d’un lot |
| UpdateBatch | Met à jour l’en-tête du lot |
Tâches
| Méthode | Description |
|---|---|
| CancelTask | Annule une tâche |
| CloseTask | Ferme une tâche |
| CloseTaskEx | Renvoie une tâche pour traitement ultérieur (version étendue de CloseTask) |
| CreateTask | Crée une tâche |
| GetAvailableTasks | Renvoie la liste des tâches disponibles pour le type d’étape sélectionné. Permet de restreindre l’ensemble des lots disponibles. |
| GetAvailableTasksExt | Renvoie la liste des tâches disponibles pour un type d’étape (version étendue) |
| GetAvailableTasksByStageId | Renvoie la liste des tâches disponibles pour les étapes de traitement spécifiées. Permet de restreindre l’ensemble des lots disponibles |
| GetAvailableTasksByStageIdExt | Renvoie la liste des tâches disponibles pour les étapes de traitement spécifiées (version étendue) |
| GetAvailableQueues | Renvoie l’ensemble des enregistrements répertoriant les étapes de traitement disponibles pour l’utilisateur |
| GetCurrentTask | Renvoie l’ID de la tâche obtenue avec la méthode GetTask et qui n’a pas encore été traitée |
| GetPostponedTasks | Renvoie la liste des tâches reportées |
| GetTask | Sélectionne la tâche de priorité la plus élevée aux étapes de traitement du type sélectionné et l’ouvre pour traitement. Permet de restreindre l’ensemble des lots disponibles. |
| GetTaskExt | Sélectionne et ouvre la tâche de priorité la plus élevée (version étendue de GetTask) |
| GetTaskByStageId | Sélectionne la tâche de priorité la plus élevée aux étapes de traitement spécifiées et l’ouvre pour traitement |
| GetTaskByStageIdExt | Sélectionne et ouvre la tâche de priorité la plus élevée aux étapes spécifiées (version étendue) |
| GetTaskDocuments | Renvoie la liste des documents d’une tâche |
| GetTaskInfo | Renvoie des informations sur une tâche |
| GetTaskInfoExt | Renvoie des informations détaillées sur une tâche |
| OpenTask | Ouvre une tâche |
| PostponeTask | Reporte une tâche |
| SendTask | Envoie la tâche à l’étape de traitement spécifiée |
| SendTaskToException | Envoie une tâche vers Exceptions |
| SetTaskPriority | Modifie la priorité de la tâche |
Documents
| Méthode | Description |
|---|---|
| AddNewDocument | Ajoute un nouveau document et spécifie des informations supplémentaires |
| AddNewDocumentEx | Ajoute un document à partir d’un fichier image (version étendue d’AddNewDocument) |
| AddNewEmptyDocument | Ajoute un document vide à un lot |
| AddNewImage | Ajoute une image à un lot |
| DeleteDocument | Supprime un document |
| GetDocument | Récupère des informations sur un document |
| GetDocument2 | Récupère des informations sur un document (version étendue de GetDocument) |
| GetDocumentResultsList | Récupère la liste des fichiers dans lesquels les résultats du traitement des documents ont été exportés |
| GetDocuments | Récupère la liste des documents d’un lot |
| GetDocuments2 | Récupère la liste des documents d’un lot (version étendue de GetDocuments) |
| LoadDocumentResult | Récupère le fichier dans lequel les résultats du traitement des documents ont été exportés |
| SetDocumentProperties | Spécifie les paramètres d’enregistrement d’un document |
| SetDocumentPriority | Modifie la priorité du document |
Pages
| Méthode | Description |
|---|---|
| AddNewPage | Ajoute l’image d’une page à un document et inclut une description |
| AddNewPageEx | Ajoute l’image d’une page à un document (version étendue d’AddNewPage) |
| DeletePage | Supprime une page d’un document |
| ReplacePageImage | Remplace l’image d’une page |
Tickets de licence
| Méthode | Description |
|---|---|
| GetNewTicket | Obtient un nouveau ticket de licence |
| ReleaseTicket | Libère un ticket de licence |
| UpdateTicket | Met à jour l’état d’un ticket de licence |
Users
| Méthode | Description |
|---|---|
| AddUserIfNotExist | Obtient l’ID de l’utilisateur actuel et crée un enregistrement dans la base de données si nécessaire |
| FindUser | Obtient l’ID et le nom de l’utilisateur |
| GetAvailableQueues | Obtient l’ensemble des enregistrements répertoriant les étapes de traitement disponibles pour l’utilisateur |
| GetAvailableUsers | Obtient une liste des utilisateurs ou groupes autorisés à traiter une étape donnée |
| GetProjectsForStationType | Recherche les projets dans lesquels un utilisateur a au moins un rôle associé à un type de station particulier |
| GetProjectsForUser | Obtient l’ensemble des enregistrements répertoriant les projets disponibles pour l’utilisateur |
| GetRoles | Obtient la liste de tous les rôles du projet |
| GetUser | Obtient des informations sur l’utilisateur à partir de son ID |
| GetUserRoles | Obtient la liste des ID des rôles utilisateur disponibles pour l’utilisateur actuel dans le projet spécifié |
| GetUsers | Obtient la liste des utilisateurs |
| GetUserStatistics | Obtient un ensemble d’enregistrements répertoriant le nombre de lots, de documents et de pages dont l’état est passé à « traité » sur une période donnée |
| HasRightsForBatchType | Vérifie si le rôle utilisateur dispose des droits d’accès à un certain type de lot |
Fichiers
| Méthode | Description |
|---|---|
| GetCustomFileNames | Renvoie la liste des fichiers utilisateur stockés sur le serveur d’applications |
| LoadCustomFile | Charge un fichier utilisateur à partir du serveur d’applications |
| RemoveCustomFile | Supprime un fichier utilisateur du serveur d’applications |
| SaveCustomFile | Enregistre un fichier utilisateur sur le serveur d’applications |
Pièces jointes
| Méthode | Description |
|---|---|
| GetAttachmentNames | Récupère la liste des pièces jointes du serveur d’applications |
| LoadAttachment | Charge une pièce jointe depuis le serveur d’applications |
| RemoveAttachment | Supprime une pièce jointe du serveur d’applications |
| SaveAttachment | Enregistre une pièce jointe sur le serveur d’applications |
Définitions de documents
| Méthode | Description |
|---|---|
| GetTemplates | Obtient l’ensemble des définitions de documents du projet |
| GetBatchTypeTemplates | Renvoie l’ensemble des identifiants des définitions de documents associées au type de lot |
Log
| Méthode | Description |
|---|---|
| WriteToLog | Consigne des informations sur les événements dans le journal du serveur d’applications |
Requêtes du serveur
| Méthode | Description |
|---|---|
| CreateRequest | Crée une requête adressée au serveur d’applications |
| DeleteRequest | Supprime une requête adressée au serveur d’applications. |
| GetRequests | Récupère la liste des requêtes adressées au serveur d’applications dans la session en cours |
| GetRequestStatus | Récupère le statut d’une requête adressée au serveur d’applications |
| SetRequestStatus | Modifie le statut d’une requête adressée au serveur d’applications |
Autres
| Méthode | Description |
|---|---|
| GetSettingValue | Récupère un paramètre nommé dans la base de données |
| SetSettingValue | Enregistre un paramètre nommé dans la base de données |