AWS Der Mainframe Modernization Service (Managed Runtime Environment Experience) steht Neukunden nicht mehr zur Verfügung. Funktionen, die dem AWS Mainframe Modernization Service (Managed Runtime Environment-Erfahrung) ähneln, finden Sie unter AWS Mainframe Modernization Service (Self-Managed Experience). Bestandskunden können den Service weiterhin wie gewohnt nutzen. Weitere Informationen finden Sie unter Änderung der Verfügbarkeit von [AWS Mainframe Modernization](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich. # BlusamREST-Endpunkte der Anwendungskonsole In diesem Abschnitt erfahren Sie mehr über die Blusam Anwendungskonsole, eine API, die die Verwaltung modernisierter VSAM-Datensätze vereinfachen soll. Endpunkte für die Blusam Webanwendung verwenden den Root-Pfad. `/bac` **Topics** + [Datensätze, verwandte Endpunkte](#ba-endpoints-bac-datasets) + [Massendatensätze, verwandte Endpunkte](#ba-endpoints-bac-bulk) + [Datensätze](#ba-endpoints-bac-records) + [Masks](#ba-endpoints-bac-masks) + [Sonstige](#ba-endpoints-bac-other) + [BAC-Endpunkte für die Benutzerverwaltung](#ba-endpoints-bac-users) ## Datensätze, verwandte Endpunkte Verwenden Sie die folgenden Endpunkte, um einen bestimmten Datensatz zu erstellen oder zu verwalten. **Topics** + [Erstellen Sie einen Datensatz](#ba-create-data-set) + [Hochladen einer Datei](#ba-upload-file) + [Lädt einen Datensatz (POST)](#ba-load-data-set-post) + [Lädt einen Datensatz (GET)](#ba-load-data-set-get) + [Einen Datensatz aus einem Amazon S3 S3-Bucket laden](#ba-load-data-set-s3) + [Exportieren Sie einen Datensatz in einen Amazon S3 S3-Bucket](#ba-export-data-set-s3) + [Einen Datensatz löschen](#ba-clear-data-set) + [Löscht einen Datensatz](#ba-delete-data-set) + [Zählen Sie Datensätze](#ba-count-data-set-records) ### Erstellen Sie einen Datensatz Sie können diesen Endpunkt verwenden, um eine Datensatzdefinition zu erstellen. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/createDataSet` + Argumente: Name (erforderlich, Zeichenfolge): der Name des Datensatzes. type (erforderlich, Zeichenfolge): der Datensatztyp. Mögliche Werte sind:`ESDS`,`KSDS`,`RRDS`. Datensatzgröße (optional, Zeichenfolge): Maximale Größe jedes Datensatzes des Datensatzes. Feste Länge (optional, boolean): Gibt an, ob die Länge des Datensatzes fest ist. Kompression (optional, boolean): Gibt an, ob der Datensatz komprimiert ist. CacheEnable (optional, boolean): Gibt an, ob das Caching für den Datensatz aktiviert ist. Alternative Schlüssel (optional, Liste der Schlüssel): + Offset (erforderlich, Zahl) + Länge (erforderlich, Zahl) + Name (erforderlich, Nummer) + Gibt eine JSON-Datei zurück, die den neu erstellten Datensatz darstellt. Beispielanforderung: ``` 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 } ``` Beispielantwort: ``` { "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 } ``` ### Hochladen einer Datei Sie können diesen Endpunkt verwenden, um Dateien auf den Server hochzuladen. Die Datei wird in einem temporären Ordner gespeichert, der jedem bestimmten Benutzer entspricht. Verwenden Sie diesen Endpunkt jedes Mal, wenn Sie eine Datei hochladen müssen. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/upload` + Argumente: file (erforderlich, multipart/form-data): Die hochzuladende Datei. + Gibt einen booleschen Wert zurück, der den Status des Uploads widerspiegelt ### Lädt einen Datensatz (POST) Nachdem Sie `createDataSet` die Datensatzdefinition erstellt haben, können Sie Datensätze, die mit der hochgeladenen Datei verknüpft sind, in einen bestimmten Datensatz laden. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/loadDataSet` + Argumente: Name (erforderlich, Zeichenfolge): der Name des Datensatzes. + Gibt den Status der Anfrage und des geladenen Datensatzes zurück. ### Lädt einen Datensatz (GET) + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/loadDataSet` + Argumente: listcatFileOrDatasetName (erforderlich, Zeichenfolge): der Name des Datensatzes. Dataset-Datei (erforderlich, Zeichenfolge): Der Name der Datensatzdatei. + Gibt den Status der Anfrage und des geladenen Datensatzes zurück. ### Einen Datensatz aus einem Amazon S3 S3-Bucket laden Lädt einen Datensatz mithilfe einer Listcat-Datei aus einem Amazon S3 S3-Bucket. + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/loadDataSetFromS3` + Argumente: Speicherort von CatFiles3 auflisten (erforderlich, Zeichenfolge): Der Amazon S3 S3-Speicherort der Listcat-Datei. DatasetFiles3-Speicherort (erforderlich, Zeichenfolge): Der Amazon S3 S3-Speicherort der Datensatzdatei. Region (erforderlich, Zeichenfolge): Amazon S3, AWS-Region in dem die Dateien gespeichert sind. + Gibt den neu erstellten Datensatz zurück Beispielanforderung: ``` /BAC/api/services/rest/bluesamservice/loadDataSetFromS3?region=us-east-1&listcatFileS3Location=s3://bucket-name/listcat.json&datasetFileS3Location=s3://bucket-name/dataset.DAT ``` ### Exportieren Sie einen Datensatz in einen Amazon S3 S3-Bucket Exportiert einen Datensatz in den angegebenen Amazon S3 S3-Bucket. + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/exportDataSetToS3` + Argumente: s3Location (erforderlich, Zeichenfolge): Der Amazon S3 S3-Speicherort, an den der Datensatz exportiert werden soll. datasetName (erforderlich, Zeichenfolge): Der Name des Datensatzes, der exportiert werden soll. Region (erforderlich, Zeichenfolge): der AWS-Region des Amazon S3 S3-Buckets. kmsKeyId (optional, Zeichenfolge): Die AWS KMS ID, die für die Verschlüsselung des exportierten Datensatzes in den Amazon S3 S3-Bucket verwendet werden soll. + Gibt den exportierten Datensatz zurück Beispielanforderung: ``` /BAC/api/services/rest/bluesamservice/exportDataSetToS3?region=eu-west-1&s3Location=s3://bucket-name/dump&datasetName=dataset ``` ### Einen Datensatz löschen Löscht alle Datensätze aus einem Datensatz. + Unterstützte Methoden: POST, GET + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/clearDataSet` + Argumente: Name (erforderlich, Zeichenfolge): Der Name des zu löschenden Datensatzes. Bei Verwendung der GET-Methode lautet der Parametername`datasetName`. + Gibt den Status der Anfrage zurück. ### Löscht einen Datensatz Löscht die Datensatzdefinition und die Datensätze. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/deleteDataSet` + Argumente: Name (erforderlich, Zeichenfolge): Der Name des zu löschenden Datensatzes. + Gibt den Status der Anfrage und den gelöschten Datensatz zurück. ### Zählen Sie Datensätze Dieser Endpunkt gibt die Anzahl der Datensätze zurück, die einem Datensatz zugeordnet sind. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/bluesamservice/countRecords` + Argumente: Name (erforderlich, Zeichenfolge): der Name des Datensatzes. + Gibt zurück: die Anzahl der Datensätze ## Massendatensätze, verwandte Endpunkte Verwenden Sie die folgenden Endpunkte, um mehrere Datensätze gleichzeitig zu erstellen oder zu verwalten. **Topics** + [Datensätze exportieren (GET)](#ba-export-data-sets-get) + [Datensätze exportieren (POST)](#ba-export-data-sets-post) + [Erstellen Sie mehrere Datensätze](#ba-create-multiple-data-sets) + [Listet alle Datensätze auf](#ba-list-all-data-sets) + [Direkte Liste aller Datensätze](#ba-direct-list-all-data-sets) + [Direkte Auflistung aller Datensätze pro Seite](#ba-direct-list-all-data-sets-by-page) + [Datensatz streamen](#ba-stream-data-sets) + [Löscht alle Datensätze](#ba-delete-all-data-sets) + [Ruft Datensatzdefinitionen aus der Listcat-Datei ab](#ba-get-definitions-listcat) + [Ruft Datensatzdefinitionen aus der hochgeladenen List-Cat-Datei ab](#ba-get-definitions-uploaded-listcat) + [Holen Sie sich einen Datensatz](#ba-get-data-set) + [Listcat aus der JSON-Datei laden](#ba-load-listcat) ### Datensätze exportieren (GET) + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/exportDataSet` + Argumente: datasetName (erforderlich, Zeichenfolge): Der Name des zu exportierenden Datensatzes. datasetOutputFile (erforderlich, Zeichenfolge): Der Pfad des Ordners, in dem Sie den exportierten Datensatz auf dem Server speichern möchten. rdw (erforderlich, boolean): ob das Datensatzdeskriptorwort (RDW) Teil der exportierten Datensätze sein soll. Wenn der Datensatz Datensätze mit fester Länge enthält, wird der Wert dieses Parameters ignoriert. + Gibt den Status der Anfrage und den Pfad zu der Datei zurück, die den exportierten Datensatz enthält (falls vorhanden). Wenn der Datensatz in der Antwort Null ist, bedeutet das, dass das System keinen Datensatz mit dem angegebenen Namen finden konnte. ### Datensätze exportieren (POST) + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/bluesamservice/exportDataSet` + Argumente: Parameter auswerfen (erforderlich, BACRead Parameter): Bluesam-Leseparameter. + Gibt den Status des exportierten Datensatzes zurück. ### Erstellen Sie mehrere Datensätze + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/createAllDataSets` + Argumente: + Liste der Datensätze Name (erforderlich, Zeichenfolge): der Name des Datensatzes. type (erforderlich, Zeichenfolge): der Datensatztyp. Mögliche Werte sind:`ESDS`,`KSDS`,`RRDS`. Datensatzgröße (optional, Zeichenfolge): Maximale Größe jedes Datensatzes des Datensatzes. Feste Länge (optional, boolean): Gibt an, ob die Länge des Datensatzes fest ist. Kompression (optional, boolean): Gibt an, ob der Datensatz komprimiert ist. CacheEnable (optional, boolean): Gibt an, ob das Caching für den Datensatz aktiviert ist. + Gibt Folgendes zurück: den Status der Anfrage und den neu erstellten Datensatz. ### Listet alle Datensätze auf + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/bluesamservice/listDataSet` + Argumente: Keine + Gibt den Status der Anfrage und die Liste der Datensätze zurück. ### Direkte Liste aller Datensätze + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/bluesamservice/directListDataSet` + Argumente: Keine + Gibt den Status der Anfrage und die Liste der Datensätze zurück. ### Direkte Auflistung aller Datensätze pro Seite + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/bluesamservice/directListDataSetByPage` + Argumente: Name (erforderlich, Zeichenfolge): der Name des Datensatzes. Standardmäßig `%` (alle Datensätze), falls nicht angegeben. angezeigten (erforderlich, int): Die Seitennummer (mindestens 0). pageSize (erforderlich, int): Die Seitengröße (mindestens 1, maximal 500). + Gibt den Status der Anfrage und die Liste der Datensätze zurück. ### Datensatz streamen + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/streamDataset` + Argumente: datasetName (erforderlich, Zeichenfolge): der Name des Datensatzes. + Gibt zurück: Ein Stream der angeforderten Datensätze. ### Löscht alle Datensätze + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/removeAll` + Argumente: Keine + Gibt zurück: einen booleschen Wert, der den Status der Anfrage darstellt. ### Ruft Datensatzdefinitionen aus der Listcat-Datei ab + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromListcat` + Argumente: paramFilePath (erforderlich, Zeichenfolge): Der Pfad zur Listcat-Datei. + Gibt zurück: eine Liste von Datensätzen ### Ruft Datensatzdefinitionen aus der hochgeladenen List-Cat-Datei ab + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat` + Argumente: Keine + Gibt zurück: eine Liste von Datensätzen ### Holen Sie sich einen Datensatz + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/bluesamservice/getDataSet` + Argumente: Name (erforderlich, Zeichenfolge): der Name des Datensatzes. + Gibt den angeforderten Datensatz zurück. ### Listcat aus der JSON-Datei laden + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/loadListcatFromJsonFile` + Argumente: filePath (erforderlich, Zeichenfolge): Der Pfad zur Listcat-Datei. + Gibt zurück: eine Liste von Datensätzen ## Datensätze Verwenden Sie die folgenden Endpunkte, um Datensätze innerhalb eines Datensatzes zu erstellen oder zu verwalten. **Topics** + [Erstellen eines Datensatzes](#ba-create-record) + [Liest einen Datensatz](#ba-read-data-set) + [Einen Datensatz löschen](#ba-delete-record) + [Aktualisieren von Datensätzen](#ba-update-record) + [Speichert einen Datensatz](#ba-save-record) + [Validiert einen Datensatz](#ba-validate-record) + [Holen Sie sich einen Datensatzbaum](#ba-get-record-tree) ### Erstellen eines Datensatzes Sie können diesen Endpunkt verwenden, um einen neuen Datensatz zu erstellen. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/crud/createRecord` + Argumente: dataset (erforderlich, DataSet): das Datensatz-Objekt maskieren (erforderlich, Maske): das Maskenobjekt. + Gibt den Status der Anfrage und des erstellten Datensatzes zurück. ### Liest einen Datensatz Sie können diesen Endpunkt verwenden, um einen Datensatz zu lesen. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/crud/readDataSet` + Argumente: dataset (erforderlich, DataSet): das Datensatz-Objekt. + Gibt den Status der Anfrage und den Datensatz mit den Datensätzen zurück. ### Einen Datensatz löschen Sie können diesen Endpunkt verwenden, um einen Datensatz aus einem Datensatz zu löschen. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/crud/deleteRecord` + Argumente: dataset (erforderlich, DataSet): das Datensatz-Objekt record (erforderlich, Datensatz): der zu löschende Datensatz + Gibt anschließend den Status der Löschung zurück. ### Aktualisieren von Datensätzen Sie können diesen Endpunkt verwenden, um einen Datensatz zu aktualisieren, der einem Datensatz zugeordnet ist. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/crud/updateRecord` + Argumente: dataset (erforderlich, DataSet): das Datensatz-Objekt record (erforderlich, Datensatz): der zu aktualisierende Datensatz maskieren (optional, Maske): Das Maskenobjekt, das während der Aktualisierung angewendet werden soll. + Gibt den Status der Anfrage und den Datensatz mit den Datensätzen zurück. ### Speichert einen Datensatz Sie können diesen Endpunkt verwenden, um einen Datensatz in einem Datensatz zu speichern und dabei eine Maske zu verwenden. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/crud/saveRecord` + Argumente: dataset (erforderlich, DataSet): das Datensatz-Objekt record (erforderlich, Datensatz): der zu speichernde Datensatz maskieren (optional, Maske): Das Maskenobjekt, das beim Speichern angewendet werden soll. + Gibt den Status der Anfrage und den Datensatz mit den Datensätzen zurück. ### Validiert einen Datensatz Verwenden Sie diesen Endpunkt, um einen Datensatz zu validieren. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/crud/validateRecord` + Argumente: dataset (erforderlich, DataSet): das Datensatz-Objekt record (optional, Datensatz): der zu validierende Datensatz. maskieren (optional, Maske): Das Maskenobjekt, das bei der Validierung angewendet werden soll. + Gibt den Status der Anfrage und den Datensatz mit den Datensätzen zurück. ### Holen Sie sich einen Datensatzbaum Verwenden Sie diesen Endpunkt, um den hierarchischen Baum eines Datensatzes abzurufen. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/crud/getRecordTree` + Argumente: dataset (erforderlich, DataSet): das Datensatz-Objekt record (erforderlich, Datensatz): der Datensatz, der abgerufen werden soll maskieren (optional, Maske): das Maskenobjekt. + Gibt den Status der Anfrage und den hierarchischen Baum des angeforderten Datensatzes zurück. ## Masks Verwenden Sie die folgenden Endpunkte, um Masken zu laden oder auf einen Datensatz anzuwenden. **Topics** + [Masken laden](#ba-load-mask) + [Maske auftragen](#ba-apply-mask) + [Maskenfilter anwenden](#ba-apply-mask-filter) ### Masken laden Sie können diesen Endpunkt verwenden, um alle Masken abzurufen, die einem bestimmten Datensatz zugeordnet sind. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/crud/loadMasks` + Pfadvariablen: Datensatzgröße:... /loadMasks/ {RecordSize} (optional, numerisch): Die Datensatzgröße, filtern Sie geladene Masken, die dieser Datensatzgröße entsprechen + Argumente: dataset (erforderlich, DataSet): das Datensatz-Objekt + Gibt den Status der Anfrage und die Liste der Masken zurück. ### Maske auftragen Sie können diesen Endpunkt verwenden, um eine Maske auf einen bestimmten Datensatz anzuwenden. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/crud/applyMask` + Argumente: dataset (erforderlich, DataSet): das Datensatz-Objekt maskieren (erforderlich, Maske): das Datensatz-Objekt + Gibt den Status der Anfrage und den Datensatz mit der angewendeten Maske zurück. ### Maskenfilter anwenden Sie können diesen Endpunkt verwenden, um eine Maske und einen Filter auf einen bestimmten Datensatz anzuwenden. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/crud/applyMaskFilter` + Argumente: dataset (erforderlich, DataSet): das Datensatz-Objekt maskieren (erforderlich, Maske): das Maskenobjekt Filter (erforderlich, Filter): das anzuwendende Filterobjekt. + Gibt den Status der Anfrage und den Datensatz mit der angewendeten Maske und dem Filter zurück. ## Sonstige Verwenden Sie die folgenden Endpunkte, um den Cache für einen Datensatz zu verwalten oder die Eigenschaften eines Datensatzes zu überprüfen **Topics** + [Überprüfen Sie den Aufwärm-Cache](#ba-check-warm-up-cache) + [Prüfen Sie, ob der Cache aktiviert](#ba-check-cache-enabled) + [Cache aktivieren](#ba-enable-cache) + [Überprüfen Sie den zugewiesenen RAM-Cache](#ba-check-allocated-ram-cache) + [Überprüfen Sie die Persistenz](#ba-check-persistence) + [Überprüfen Sie die unterstützten Datensatztypen](#ba-check-supported-data-set-types) + [Überprüfen Sie den Serverstatus](#ba-check-server-health) + [Überprüfen Sie die PostgreSQL-Multischema-Konfiguration](#ba-check-postgres-multi-schema) ### Überprüfen Sie den Aufwärm-Cache Prüft, ob der Aufwärm-Cache für einen bestimmten Datensatz aktiviert ist. + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/warmupCache` + Argumente: Name (erforderlich, Zeichenfolge): der Name des Datensatzes. + Gibt Folgendes zurück: true, wenn der Warmup-Cache aktiviert ist, andernfalls false. ### Prüfen Sie, ob der Cache aktiviert Prüft, ob der Cache für einen bestimmten Datensatz aktiviert ist. + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/bluesamservice/isEnableCache` + Argumente: Keine + Gibt true zurück, wenn das Caching aktiviert ist. ### Cache aktivieren + Unterstützte Methoden: POST + Erfordert Authentifizierung und die Rollen ROLE\_ADMIN und ROLE\_SUPER\_ADMIN. + Pfad: `/api/services/rest/bluesamservice/enableDisableCache/{enable}` + Argumente: enable (erforderlich, boolean): Wenn auf true gesetzt, wird das Caching aktiviert. dataset (erforderlich, DataSet): das Datensatz-Objekt. + Gibt None zurück ### Überprüfen Sie den zugewiesenen RAM-Cache Sie können diesen Endpunkt verwenden, um den zugewiesenen RAM-Cache-Speicher abzurufen. + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/bluesamservice/allocatedRamCache` + Argumente: Keine + Gibt zurück: die Größe des Speichers als Zeichenfolge ### Überprüfen Sie die Persistenz + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/bluesamservice/persistence` + Argumente: Keine + Gibt zurück: die Persistenz, die als Zeichenfolge verwendet wird ### Überprüfen Sie die unterstützten Datensatztypen + Unterstützte Methoden: GET + Pfad: `/api/services/rest/bluesamservice/getDataSetTypes` + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Argumente: Keine + Gibt Folgendes zurück: die Liste der unterstützten Datensatztypen als Liste von Zeichenketten. ### Überprüfen Sie den Serverstatus + Unterstützte Methoden: GET + Pfad: `/api/services/rest/bluesamserver/serverIsUp` + Argumente: Keine + Gibt zurück: Keine. Der HTTP-Antwortstatuscode 200 gibt an, dass der Server betriebsbereit ist. ### Überprüfen Sie die PostgreSQL-Multischema-Konfiguration Überprüft, ob die PostgreSQL-Multischema-Konfiguration aktiviert ist. + Unterstützte Methoden: GET + Erfordert Authentifizierung und die Rolle ROLE\_USER. + Pfad: `/api/services/rest/bluesamservice/isPostgresMultiSchema` + Argumente: Keine + Gibt Folgendes zurück: true, wenn die PostgreSQL-Multischema-Konfiguration aktiviert ist, andernfalls false. ## BAC-Endpunkte für die Benutzerverwaltung Verwenden Sie die folgenden Endpunkte, um Benutzerinteraktionen zu verwalten. **Topics** + [Melden Sie einen Benutzer an](#ba-log-user-in) + [Überprüfen Sie, ob mindestens ein Benutzer im System existiert](#ba-verify-at-least-one-user-exists) + [Einen neuen Benutzer aufnehmen](#ba-record-new-user) + [Benutzerinformationen abrufen](#ba-user-info) + [Auflisten von Benutzern](#ba-list-users) + [Löschen eines Benutzers](#ba-delete-user) + [Meldet den aktuellen Benutzer ab](#ba-log-user-out) ### Melden Sie einen Benutzer an + Unterstützte Methode: POST + Pfad: `/api/services/security/servicelogin/login` + Argumente: Keine + Gibt die JSON-Serialisierung eines `com.netfective.bluage.bac.entities.SignOn` Objekts zurück, die den Benutzer darstellt, dessen Anmeldeinformationen in der aktuellen Anfrage angegeben wurden. Das Passwort ist im zurückgegebenen Objekt nicht sichtbar. Die Rollen, die dem Benutzer zugewiesen wurden, werden aufgelistet. Beispielantwort: ``` { "login": "some-admin", "password": null, "roles": [ { "id": 0, "roleName": "ROLE_ADMIN" } ] } ``` ### Überprüfen Sie, ob mindestens ein Benutzer im System existiert + Unterstützte Methode: GET + Pfad: `/api/services/security/servicelogin/hasAccount` + Argumente: Keine + Gibt den booleschen Wert zurück, `true` wenn mindestens ein anderer Benutzer als der Standard-Super-Admin-Benutzer erstellt wurde. Gibt andernfalls zurück`false`. ### Einen neuen Benutzer aufnehmen + Unterstützte Methode: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/security/servicelogin/recorduser` + Argumente: Die JSON-Serialisierung eines `com.netfective.bluage.bac.entities.SignOn` Objekts, das den Benutzer darstellt, der dem Speicher hinzugefügt werden soll. Die Rollen für den Benutzer müssen definiert werden, andernfalls kann der Benutzer die BAC-Einrichtung und die Endpunkte möglicherweise nicht verwenden. + Gibt den booleschen Wert zurück, `true` wenn der Benutzer erfolgreich erstellt wurde. Gibt andernfalls zurück`false`. + JSON-Beispiel für eine Anfrage: ``` { "login": "simpleuser", "password": "simplepassword", "roles": [ { "id": 2, "roleName": "ROLE_USER" } ] } ``` Im Folgenden sind die beiden gültigen Werte für aufgeführt`roleName`: + `ROLE_ADMIN`: kann Blusam Ressourcen und Benutzer verwalten. + `ROLE_USER`: kann Blusam Ressourcen verwalten, aber keine Benutzer. ### Benutzerinformationen abrufen + Unterstützte Methode: GET + Pfad: `/api/services/security/servicelogin/userInfo` + Argumente: Keine + Gibt den Benutzernamen und die Rolle des aktuell verbundenen Benutzers zurück ### Auflisten von Benutzern + Unterstützte Methode: GET + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/security/servicelogin/listusers` + Argumente: Keine + Gibt eine Liste von zurück`com.netfective.bluage.bac.entities.SignOn`, serialisiert als JSON. ### Löschen eines Benutzers **Wichtig** Diese Aktion kann nicht rückgängig gemacht werden. Der gelöschte Benutzer kann sich nicht wieder mit der BAC-Anwendung verbinden. + Unterstützte Methode: POST + Erfordert Authentifizierung und die Rolle ROLE\_ADMIN. + Pfad: `/api/services/security/servicelogin/deleteuser` + Argumente: Die JSON-Serialisierung eines `com.netfective.bluage.bac.entities.SignOn` Objekts, das den Benutzer darstellt, der aus dem Speicher entfernt werden soll. + Gibt den booleschen Wert zurück, `true` wenn der Benutzer erfolgreich entfernt wurde. ### Meldet den aktuellen Benutzer ab + Unterstützte Methode: GET + Pfad: `/api/services/security/servicelogout/logout` + Argumente: Keine + Gibt die JSON-Nachricht zurück, `{"success":true}` wenn der aktuelle Benutzer erfolgreich abgemeldet wurde. Die zugehörige HTTP-Sitzung wird ungültig gemacht.