AWS Le service de modernisation du mainframe (expérience de l'environnement d'exécution géré) n'est plus ouvert aux nouveaux clients. Pour des fonctionnalités similaires au service de modernisation AWS du mainframe (expérience de l'environnement d'exécution géré), explorez le service de modernisation AWS du mainframe (expérience autogérée). Les clients existants peuvent continuer à utiliser le service normalement. Pour plus d'informations, consultez la section [Modification de la disponibilité de la modernisation du AWS mainframe](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra. # Blusampoints de terminaison REST de la console d'applications Dans cette section, vous découvrirez la console d'Blusamapplication, qui est une API conçue pour simplifier la gestion des ensembles de données VSAM modernisés. Les points de terminaison de l'application Blusam Web utilisent le chemin `/bac` racine. **Topics** + [Points de terminaison liés aux ensembles de données](#ba-endpoints-bac-datasets) + [Points de terminaison associés aux ensembles de données en masse](#ba-endpoints-bac-bulk) + [Enregistrements](#ba-endpoints-bac-records) + [Masques](#ba-endpoints-bac-masks) + [Autre](#ba-endpoints-bac-other) + [Points de terminaison de gestion des utilisateurs BAC](#ba-endpoints-bac-users) ## Points de terminaison liés aux ensembles de données Utilisez les points de terminaison suivants pour créer ou gérer un ensemble de données spécifique. **Topics** + [Création d'un ensemble de données](#ba-create-data-set) + [Charger un fichier](#ba-upload-file) + [Charger un ensemble de données (POST)](#ba-load-data-set-post) + [Charger un ensemble de données (GET)](#ba-load-data-set-get) + [Charger un ensemble de données depuis un compartiment Amazon S3](#ba-load-data-set-s3) + [Exporter un ensemble de données vers un compartiment Amazon S3](#ba-export-data-set-s3) + [Effacer un ensemble de données](#ba-clear-data-set) + [Supprimer un ensemble de données](#ba-delete-data-set) + [Compter les enregistrements d'ensembles de données](#ba-count-data-set-records) ### Création d'un ensemble de données Vous pouvez utiliser ce point de terminaison pour créer une définition d'ensemble de données. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/createDataSet` + Arguments : name (obligatoire, chaîne) : le nom de l'ensemble de données. type (obligatoire, chaîne) : le type de jeu de données. Les valeurs possibles sont les suivantes :`ESDS`,`KSDS`,`RRDS`. Taille de l'enregistrement (facultatif, chaîne) : taille maximale de chaque enregistrement de l'ensemble de données. Longueur fixe (facultatif, booléen) : indique si la longueur des enregistrements est fixe. compression (facultatif, booléen) : indique si le jeu de données est compressé. Activer le cache (facultatif, booléen) : indique si la mise en cache est activée pour l'ensemble de données. Clés alternatives (facultatif, liste des clés) : + offset (obligatoire, nombre) + longueur (obligatoire, nombre) + nom (obligatoire, numéro) + Renvoie un fichier JSON représentant le nouvel ensemble de données créé. Demande d'échantillon : ``` POST /api/services/rest/bluesamservice/createDataSet { "name": "DATASET", "checked": false, "records": [], "primaryKey": { "name": "PK" }, "alternativeKeys": [ { "offset": 10, "length": 10, "name": "ALTK_0" } ], "type": "ESDS", "recordSize": 10, "compression": true, "cacheEnable": true } ``` Exemple de réponse : ``` { "dataSet": { "name": "DATASET", "checked": false, "nbRecords": 0, "keyLength": -1, "recordSize": 10, "compression": false, "fixLength": true, "type": "ESDS", "cacheEnable": false, "cacheWarmup": false, "cacheEviction": "100ms", "creationDate": 1686744961234, "modificationDate": 1686744961234, "records": [], "primaryKey": { "name": "PK", "offset": null, "length": null, "columns": null, "unique": true }, "alternativeKeys": [ { "offset": 10, "length": 10, "name": "ALTK_0" } ], "readLimit": 0, "readEncoding": null, "initCharacter": null, "defaultCharacter": null, "blankCharacter": null, "strictZoned": null, "decimalSeparator": null, "currencySign": null, "pictureCurrencySign": null }, "message": null, "result": true } ``` ### Charger un fichier Vous pouvez utiliser ce point de terminaison pour télécharger des fichiers sur le serveur. Le fichier est stocké dans un dossier temporaire qui correspond à chaque utilisateur spécifique. Utilisez ce point de terminaison chaque fois que vous devez télécharger un fichier. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/upload` + Arguments : dans le fichier (obligatoire, multipart/form-data) : Le fichier à télécharger. + Renvoie une valeur booléenne reflétant le statut du téléchargement ### Charger un ensemble de données (POST) Après `createDataSet` avoir créé la définition de l'ensemble de données, vous pouvez charger les enregistrements associés au fichier téléchargé dans un ensemble de données spécifique. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/loadDataSet` + Arguments : name (obligatoire, chaîne) : le nom de l'ensemble de données. + Renvoie l'état de la demande et le jeu de données chargé. ### Charger un ensemble de données (GET) + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/loadDataSet` + Arguments : listcatFileOrDatasetName (obligatoire, chaîne) : le nom de l'ensemble de données. Fichier de jeu de données (obligatoire, chaîne) : nom du fichier de l'ensemble de données. + Renvoie l'état de la demande et le jeu de données chargé. ### Charger un ensemble de données depuis un compartiment Amazon S3 Charge un ensemble de données à l'aide d'un fichier listcat depuis un compartiment Amazon S3. + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/loadDataSetFromS3` + Arguments : Emplacement des fichiers ListCat 3 (obligatoire, chaîne) : l'emplacement du fichier listcat sur Amazon S3. Emplacement des fichiers du jeu de données 3 (obligatoire, chaîne) : l'emplacement du fichier d'ensemble de données sur Amazon S3. region (obligatoire, chaîne) : l'Amazon S3 Région AWS où les fichiers sont stockés. + Renvoie le jeu de données nouvellement créé Demande d'échantillon : ``` /BAC/api/services/rest/bluesamservice/loadDataSetFromS3?region=us-east-1&listcatFileS3Location=s3://bucket-name/listcat.json&datasetFileS3Location=s3://bucket-name/dataset.DAT ``` ### Exporter un ensemble de données vers un compartiment Amazon S3 Exporte un ensemble de données vers le compartiment Amazon S3 spécifié. + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/exportDataSetToS3` + Arguments : s3Location (obligatoire, chaîne) : l'emplacement Amazon S3 vers lequel exporter l'ensemble de données. datasetName (obligatoire, chaîne) : le nom du jeu de données à exporter. region (obligatoire, chaîne) : Région AWS celui du compartiment Amazon S3. kmsKeyId (facultatif, chaîne) : l' AWS KMS ID à utiliser pour le chiffrement de l'ensemble de données exporté vers le compartiment Amazon S3. + Renvoie l'ensemble de données exporté Demande d'échantillon : ``` /BAC/api/services/rest/bluesamservice/exportDataSetToS3?region=eu-west-1&s3Location=s3://bucket-name/dump&datasetName=dataset ``` ### Effacer un ensemble de données Efface tous les enregistrements d'un ensemble de données. + Méthodes prises en charge : POST, GET + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/clearDataSet` + Arguments : name (obligatoire, chaîne) : le nom du jeu de données à effacer. Lorsque vous utilisez la méthode GET, le nom du paramètre est`datasetName`. + Renvoie le statut de la demande. ### Supprimer un ensemble de données Supprime la définition et les enregistrements de l'ensemble de données. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/deleteDataSet` + Arguments : name (obligatoire, chaîne) : nom du jeu de données à supprimer. + Renvoie le statut de la demande et le jeu de données supprimé. ### Compter les enregistrements d'ensembles de données Ce point de terminaison renvoie le nombre d'enregistrements associés à un ensemble de données. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/bluesamservice/countRecords` + Arguments : name (obligatoire, chaîne) : le nom de l'ensemble de données. + Retours : le nombre d'enregistrements ## Points de terminaison associés aux ensembles de données en masse Utilisez les points de terminaison suivants pour créer ou gérer plusieurs ensembles de données à la fois. **Topics** + [Exporter des ensembles de données (GET)](#ba-export-data-sets-get) + [Exporter des ensembles de données (POST)](#ba-export-data-sets-post) + [Création de plusieurs ensembles de données](#ba-create-multiple-data-sets) + [Répertorier tous les ensembles de données](#ba-list-all-data-sets) + [Lister directement tous les ensembles de données](#ba-direct-list-all-data-sets) + [Liste directe de tous les ensembles de données par page](#ba-direct-list-all-data-sets-by-page) + [Ensemble de données de streaming](#ba-stream-data-sets) + [Supprimer tous les ensembles de données](#ba-delete-all-data-sets) + [Obtenir des définitions d'ensembles de données à partir du fichier listcat](#ba-get-definitions-listcat) + [Obtenir les définitions des ensembles de données à partir du fichier list cat téléchargé](#ba-get-definitions-uploaded-listcat) + [Obtenir un ensemble de données](#ba-get-data-set) + [Charger listcat depuis un fichier JSON](#ba-load-listcat) ### Exporter des ensembles de données (GET) + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/exportDataSet` + Arguments : datasetName (obligatoire, chaîne) : le nom du jeu de données à exporter. datasetOutputFile (obligatoire, chaîne) : le chemin du dossier dans lequel vous souhaitez stocker le jeu de données exporté sur le serveur. rdw (obligatoire, booléen) : si vous souhaitez que le mot descripteur d'enregistrement (RDW) fasse partie des enregistrements exportés. Si l'ensemble de données comporte des enregistrements de longueur fixe, la valeur de ce paramètre est ignorée. + Renvoie l'état de la demande et le chemin d'accès au fichier contenant l'ensemble de données exporté (le cas échéant). Si l'ensemble de données est nul dans la réponse, cela signifie que le système n'a pas pu localiser un ensemble de données portant le nom donné. ### Exporter des ensembles de données (POST) + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/bluesamservice/exportDataSet` + Arguments : Paramètres de vidange (obligatoire, BACRead Paramètres) : paramètres de lecture Bluesam. + Renvoie l'état de l'ensemble de données exporté. ### Création de plusieurs ensembles de données + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/createAllDataSets` + Arguments : + Liste des ensembles de données name (obligatoire, chaîne) : le nom de l'ensemble de données. type (obligatoire, chaîne) : le type de jeu de données. Les valeurs possibles sont les suivantes :`ESDS`,`KSDS`,`RRDS`. Taille de l'enregistrement (facultatif, chaîne) : taille maximale de chaque enregistrement de l'ensemble de données. Longueur fixe (facultatif, booléen) : indique si la longueur des enregistrements est fixe. compression (facultatif, booléen) : indique si le jeu de données est compressé. Activer le cache (facultatif, booléen) : indique si la mise en cache est activée pour l'ensemble de données. + Retours : le statut de la demande et le nouvel ensemble de données créé. ### Répertorier tous les ensembles de données + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/bluesamservice/listDataSet` + Arguments : Aucun + Retours : le statut de la demande et la liste des ensembles de données. ### Lister directement tous les ensembles de données + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/bluesamservice/directListDataSet` + Arguments : Aucun + Retours : le statut de la demande et la liste des ensembles de données. ### Liste directe de tous les ensembles de données par page + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/bluesamservice/directListDataSetByPage` + Arguments : name (obligatoire, chaîne) : le nom de l'ensemble de données. La valeur par défaut est `%` (tous les ensembles de données) si elle n'est pas spécifiée. page (obligatoire, int) : le numéro de page (minimum 0). pageSize (obligatoire, int) : taille de page (minimum 1, maximum 500). + Retours : le statut de la demande et la liste des ensembles de données. ### Ensemble de données de streaming + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/streamDataset` + Arguments : datasetName (obligatoire, chaîne) : le nom de l'ensemble de données. + Retours : un flux des ensembles de données demandés. ### Supprimer tous les ensembles de données + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/removeAll` + Arguments : Aucun + Renvoie : une valeur booléenne qui représente le statut de la demande. ### Obtenir des définitions d'ensembles de données à partir du fichier listcat + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/getDataSetsDefinitionFromListcat` + Arguments : paramFilePath (obligatoire, chaîne) : chemin d'accès au fichier listcat. + Retours : liste d'ensembles de données ### Obtenir les définitions des ensembles de données à partir du fichier list cat téléchargé + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat` + Arguments : Aucun + Retours : liste d'ensembles de données ### Obtenir un ensemble de données + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/bluesamservice/getDataSet` + Arguments : name (obligatoire, chaîne) : le nom de l'ensemble de données. + Renvoie l'ensemble de données demandé. ### Charger listcat depuis un fichier JSON + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/loadListcatFromJsonFile` + Arguments : filePath (obligatoire, chaîne) : chemin d'accès au fichier listcat. + Retours : liste d'ensembles de données ## Enregistrements Utilisez les points de terminaison suivants pour créer ou gérer des enregistrements au sein d'un ensemble de données. **Topics** + [Créer un enregistrement](#ba-create-record) + [Lire un ensemble de données](#ba-read-data-set) + [Supprimer un enregistrement](#ba-delete-record) + [Mettre à jour un enregistrement](#ba-update-record) + [Enregistrer un enregistrement](#ba-save-record) + [Valider un enregistrement](#ba-validate-record) + [Obtenez un arbre d'enregistrements](#ba-get-record-tree) ### Créer un enregistrement Vous pouvez utiliser ce point de terminaison pour créer un nouvel enregistrement. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/crud/createRecord` + Arguments : dataset (obligatoire, DataSet) : l'objet du jeu de données masque (obligatoire, masque) : l'objet du masque. + Renvoie le statut de la demande et l'enregistrement créé. ### Lire un ensemble de données Vous pouvez utiliser ce point de terminaison pour lire un ensemble de données. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/crud/readDataSet` + Arguments : dataset (obligatoire, DataSet) : l'objet du jeu de données. + Renvoie le statut de la demande et le jeu de données contenant les enregistrements. ### Supprimer un enregistrement Vous pouvez utiliser ce point de terminaison pour supprimer un enregistrement d'un ensemble de données. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/crud/deleteRecord` + Arguments : dataset (obligatoire, DataSet) : l'objet du jeu de données record (obligatoire, Enregistrement) : l'enregistrement à supprimer + Renvoie le statut de la suppression. ### Mettre à jour un enregistrement Vous pouvez utiliser ce point de terminaison pour mettre à jour un enregistrement associé à un ensemble de données. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/crud/updateRecord` + Arguments : dataset (obligatoire, DataSet) : l'objet du jeu de données record (obligatoire, enregistrement) : l'enregistrement à mettre à jour masque (facultatif, Masque) : l'objet du masque à appliquer lors de la mise à jour. + Renvoie le statut de la demande et le jeu de données contenant les enregistrements. ### Enregistrer un enregistrement Vous pouvez utiliser ce point de terminaison pour enregistrer un enregistrement dans un ensemble de données à l'aide d'un masque. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/crud/saveRecord` + Arguments : dataset (obligatoire, DataSet) : l'objet du jeu de données record (obligatoire, enregistrement) : l'enregistrement à enregistrer masque (optionnel, Masque) : l'objet du masque à appliquer lors de la sauvegarde. + Renvoie le statut de la demande et le jeu de données contenant les enregistrements. ### Valider un enregistrement Utilisez ce point de terminaison pour valider un enregistrement. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/crud/validateRecord` + Arguments : dataset (obligatoire, DataSet) : l'objet du jeu de données record (facultatif, Enregistrement) : l'enregistrement à valider. masque (optionnel, Masque) : l'objet du masque à appliquer lors de la validation. + Renvoie le statut de la demande et le jeu de données contenant les enregistrements. ### Obtenez un arbre d'enregistrements Utilisez ce point de terminaison pour obtenir l'arborescence hiérarchique d'un enregistrement. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/crud/getRecordTree` + Arguments : dataset (obligatoire, DataSet) : l'objet du jeu de données record (obligatoire, Record) : l'enregistrement à récupérer masque (facultatif, Masque) : l'objet du masque. + Renvoie le statut de la demande et l'arborescence hiérarchique de l'enregistrement demandé. ## Masques Utilisez les points de terminaison suivants pour charger ou appliquer des masques à un ensemble de données. **Topics** + [Masques de chargement](#ba-load-mask) + [Appliquer un masque](#ba-apply-mask) + [Appliquer un filtre de masque](#ba-apply-mask-filter) ### Masques de chargement Vous pouvez utiliser ce point de terminaison pour récupérer tous les masques associés à un ensemble de données spécifique. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/crud/loadMasks` + Variables de chemin : Taille de l'enregistrement :... /LoadMasks/ {recordSize} (facultatif, numérique) : la taille de l'enregistrement, filtres chargés, masques qui correspondent à cette taille d'enregistrement + Arguments : dataset (obligatoire, DataSet) : l'objet du jeu de données + Renvoie le statut de la demande et la liste des masques. ### Appliquer un masque Vous pouvez utiliser ce point de terminaison pour appliquer un masque à un ensemble de données spécifique. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/crud/applyMask` + Arguments : dataset (obligatoire, DataSet) : l'objet du jeu de données masque (obligatoire, masque) : l'objet du jeu de données + Renvoie l'état de la demande et le jeu de données avec le masque appliqué. ### Appliquer un filtre de masque Vous pouvez utiliser ce point de terminaison pour appliquer un masque et un filtre à un ensemble de données spécifique. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/crud/applyMaskFilter` + Arguments : dataset (obligatoire, DataSet) : l'objet du jeu de données masque (obligatoire, masque) : l'objet du masque filtre (obligatoire, Filtre) : l'objet du filtre à appliquer. + Renvoie le statut de la demande et le jeu de données avec le masque et le filtre appliqués. ## Autre Utilisez les points de terminaison suivants pour gérer le cache d'un ensemble de données ou vérifier les caractéristiques d'un ensemble de données **Topics** + [Vérifiez le cache de préchauffage](#ba-check-warm-up-cache) + [Vérifier le cache activé](#ba-check-cache-enabled) + [Activer le cache](#ba-enable-cache) + [Vérifiez le cache RAM alloué](#ba-check-allocated-ram-cache) + [Vérifier la persistance](#ba-check-persistence) + [Vérifiez les types d'ensembles de données pris en charge](#ba-check-supported-data-set-types) + [Vérifier l'état du serveur](#ba-check-server-health) + [Vérifiez la configuration multi-schémas de PostgreSQL](#ba-check-postgres-multi-schema) ### Vérifiez le cache de préchauffage Vérifie si le cache de préchauffage est activé pour un ensemble de données spécifique. + Méthodes prises en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/warmupCache` + Arguments : name (obligatoire, chaîne) : le nom de l'ensemble de données. + Renvoie : vrai si le cache de préchauffage est activé et faux dans le cas contraire. ### Vérifier le cache activé Vérifie si le cache est activé pour un ensemble de données spécifique. + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/bluesamservice/isEnableCache` + Arguments : Aucun + Renvoie vrai si la mise en cache est activée. ### Activer le cache + Méthodes prises en charge : POST + Nécessite une authentification et les rôles ROLE\_ADMIN et ROLE\_SUPER\_ADMIN. + Trajectoire : `/api/services/rest/bluesamservice/enableDisableCache/{enable}` + Arguments : activer (obligatoire, booléen) : s'il est défini sur true, il activera la mise en cache. dataset (obligatoire, DataSet) : l'objet du jeu de données. + Ne renvoie aucun ### Vérifiez le cache RAM alloué Vous pouvez utiliser ce point de terminaison pour récupérer la mémoire cache RAM allouée. + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/bluesamservice/allocatedRamCache` + Arguments : Aucun + Renvoie : la taille de la mémoire sous forme de chaîne ### Vérifier la persistance + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/bluesamservice/persistence` + Arguments : Aucun + Retours : la persistance utilisée sous forme de chaîne ### Vérifiez les types d'ensembles de données pris en charge + Méthodes prises en charge : GET + Trajectoire : `/api/services/rest/bluesamservice/getDataSetTypes` + Nécessite une authentification et le rôle ROLE\_USER. + Arguments : Aucun + Renvoie : la liste des types d'ensembles de données pris en charge sous forme de liste de chaînes. ### Vérifier l'état du serveur + Méthodes prises en charge : GET + Trajectoire : `/api/services/rest/bluesamserver/serverIsUp` + Arguments : Aucun + Retours : Aucun. Le code d'état de réponse HTTP 200 indique que le serveur est opérationnel. ### Vérifiez la configuration multi-schémas de PostgreSQL Vérifie si la configuration multi-schémas de PostgreSQL est activée. + Méthodes prises en charge : GET + Nécessite une authentification et le rôle ROLE\_USER. + Trajectoire : `/api/services/rest/bluesamservice/isPostgresMultiSchema` + Arguments : Aucun + Renvoie : vrai si la configuration multi-schémas de PostgreSQL est activée et faux dans le cas contraire. ## Points de terminaison de gestion des utilisateurs BAC Utilisez les points de terminaison suivants pour gérer les interactions des utilisateurs. **Topics** + [Connectez un utilisateur](#ba-log-user-in) + [Vérifiez s'il existe au moins un utilisateur dans le système](#ba-verify-at-least-one-user-exists) + [Enregistrer un nouvel utilisateur](#ba-record-new-user) + [Obtenir des informations sur l'utilisateur](#ba-user-info) + [Répertorier des utilisateurs](#ba-list-users) + [Suppression d’un utilisateur](#ba-delete-user) + [Déconnectez l'utilisateur actuel](#ba-log-user-out) ### Connectez un utilisateur + Méthode prise en charge : POST + Trajectoire : `/api/services/security/servicelogin/login` + Arguments : Aucun + Renvoie la sérialisation JSON d'un `com.netfective.bluage.bac.entities.SignOn` objet, représentant l'utilisateur dont les informations d'identification sont fournies dans la demande en cours. Le mot de passe est masqué dans la vue dans l'objet renvoyé. Les rôles attribués à l'utilisateur sont listés. Exemple de réponse : ``` { "login": "some-admin", "password": null, "roles": [ { "id": 0, "roleName": "ROLE_ADMIN" } ] } ``` ### Vérifiez s'il existe au moins un utilisateur dans le système + Méthode prise en charge : GET + Trajectoire : `/api/services/security/servicelogin/hasAccount` + Arguments : Aucun + Renvoie la valeur booléenne `true` si au moins un utilisateur autre que le super administrateur par défaut a été créé. Retourne dans `false` le cas contraire. ### Enregistrer un nouvel utilisateur + Méthode prise en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/security/servicelogin/recorduser` + Arguments : la sérialisation JSON d'un `com.netfective.bluage.bac.entities.SignOn` objet qui représente l'utilisateur à ajouter au stockage. Les rôles de l'utilisateur doivent être définis, sinon l'utilisateur risque de ne pas être en mesure d'utiliser la fonction BAC et les points de terminaison. + Renvoie la valeur booléenne `true` si l'utilisateur a été créé avec succès. Retourne dans `false` le cas contraire. + Exemple de demande JSON : ``` { "login": "simpleuser", "password": "simplepassword", "roles": [ { "id": 2, "roleName": "ROLE_USER" } ] } ``` Voici les deux valeurs valides pour `roleName` : + `ROLE_ADMIN`: permet de gérer les Blusam ressources et les utilisateurs. + `ROLE_USER`: peut gérer les Blusam ressources mais pas les utilisateurs. ### Obtenir des informations sur l'utilisateur + Méthode prise en charge : GET + Trajectoire : `/api/services/security/servicelogin/userInfo` + Arguments : Aucun + Renvoie le nom d'utilisateur et le rôle de l'utilisateur actuellement connecté ### Répertorier des utilisateurs + Méthode prise en charge : GET + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/security/servicelogin/listusers` + Arguments : Aucun + Renvoie une liste de`com.netfective.bluage.bac.entities.SignOn`, sérialisée au format JSON. ### Suppression d’un utilisateur **Important** Cette action ne peut pas être annulée. L'utilisateur supprimé ne pourra pas se reconnecter à l'application BAC. + Méthode prise en charge : POST + Nécessite une authentification et le rôle ROLE\_ADMIN. + Trajectoire : `/api/services/security/servicelogin/deleteuser` + Arguments : la sérialisation JSON d'un `com.netfective.bluage.bac.entities.SignOn` objet qui représente l'utilisateur à supprimer du stockage. + Renvoie la valeur booléenne `true` si l'utilisateur a été correctement supprimé. ### Déconnectez l'utilisateur actuel + Méthode prise en charge : GET + Trajectoire : `/api/services/security/servicelogout/logout` + Arguments : Aucun + Renvoie le message JSON `{"success":true}` si l'utilisateur actuel s'est déconnecté avec succès. La session HTTP associée sera invalidée.