AWS El servicio de modernización de mainframes (experiencia en entornos de ejecución gestionados) ya no está abierto a nuevos clientes. Para obtener prestaciones similares a las del Servicio de Modernización de AWS Mainframe (experiencia en entornos de ejecución gestionados), explore el Servicio de Modernización de AWS Mainframe (experiencia autogestionada). Los clientes existentes pueden seguir utilizando el servicio con normalidad. Para obtener más información, consulte Cambio en la disponibilidad de la modernización del [AWS mainframe.](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés. # Blusampuntos finales REST de la consola de aplicaciones En esta sección, puede obtener información sobre la consola de Blusam aplicaciones, que es una API diseñada para simplificar la administración de conjuntos de datos de VSAM modernizados. Los puntos finales de la aplicación Blusam web utilizan la ruta raíz. `/bac` **Topics** + [Puntos de conexión relacionados con conjuntos de datos](#ba-endpoints-bac-datasets) + [Puntos de conexión relacionados con conjuntos de datos en bloque](#ba-endpoints-bac-bulk) + [Registros](#ba-endpoints-bac-records) + [Máscaras](#ba-endpoints-bac-masks) + [Otro](#ba-endpoints-bac-other) + [Puntos de conexión de administración de usuarios de BAC](#ba-endpoints-bac-users) ## Puntos de conexión relacionados con conjuntos de datos Utilice los siguientes puntos de conexión para crear o administrar un conjunto de datos específico. **Topics** + [Creación de un conjunto de datos](#ba-create-data-set) + [Carga de un archivo](#ba-upload-file) + [Carga de un conjunto de datos (POST)](#ba-load-data-set-post) + [Carga de un conjunto de datos (GET)](#ba-load-data-set-get) + [Puede cargar un conjunto de datos desde un bucket de Amazon S3.](#ba-load-data-set-s3) + [Exportar el conjunto de datos a un bucket de Amazon S3.](#ba-export-data-set-s3) + [Borrar un conjunto de datos](#ba-clear-data-set) + [Eliminar un conjunto de datos](#ba-delete-data-set) + [Contar los registros del conjunto de datos](#ba-count-data-set-records) ### Creación de un conjunto de datos Puede utilizar este punto de conexión para crear una definición de conjunto de datos. + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/createDataSet` + Argumentos: name (obligatorio, cadena): el nombre del conjunto de datos. type (obligatorio, cadena): el tipo de conjunto de datos. Los valores posibles son `ESDS`, `KSDS`, `RRDS`. recordSize (opcional, cadena): tamaño máximo de cada registro del conjunto de datos. fixedLength (opcional, booleano): indica si la longitud de los registros es fija. compression (opcional, booleano): indica si el conjunto de datos está comprimido. cacheEnable (opcional, booleano): indica si el almacenamiento en caché está habilitado para el conjunto de datos. alternativeKeys (opcional, lista de claves): + offset (obligatorio, número) + length (obligatorio, número) + name (obligatorio, número) + Devuelve un archivo JSON que representa el conjunto de datos recién creado. Solicitud de ejemplo: ``` 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 } ``` Respuesta de ejemplo: ``` { "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 } ``` ### Carga de un archivo Este punto de conexión permite cargar archivos al servidor. El archivo se almacena en una carpeta temporal que corresponde a cada usuario específico. Utilice este punto de conexión cada vez que necesite cargar un archivo. + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/upload` + Argumentos: archivo (obligatorio, datos de varias partes/formulario): el archivo que se va a cargar. + Devuelve un valor booleano que refleja el estado de la carga ### Carga de un conjunto de datos (POST) Después de utilizar `createDataSet` para crear la definición del conjunto de datos, puede cargar los registros asociados al archivo cargado en un conjunto de datos específico. + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/loadDataSet` + Argumentos: name (obligatorio, cadena): el nombre del conjunto de datos. + Devuelve el estado de la solicitud y del conjunto de datos cargado. ### Carga de un conjunto de datos (GET) + Método compatible: GET + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/loadDataSet` + Argumentos: listcatFileOrDatasetName (obligatorio, cadena): el nombre del conjunto de datos. Archivo de conjunto de datos (obligatorio, cadena): el nombre del archivo de conjunto de datos. + Devuelve el estado de la solicitud y del conjunto de datos cargado. ### Puede cargar un conjunto de datos desde un bucket de Amazon S3. Carga un conjunto de datos mediante un archivo listcat de un bucket de Amazon S3. + Método compatible: GET + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/loadDataSetFromS3` + Argumentos: listcatFileS3Location (obligatorio, cadena): la ubicación de Amazon S3 del archivo listcat. datasetFileS3Location (obligatorio, cadena): la ubicación de Amazon S3 del archivo de conjunto de datos. region (obligatorio, cadena): Amazon S3 Región de AWS donde se almacenan los archivos. + Devuelve el conjunto de datos recién creado Solicitud de ejemplo: ``` /BAC/api/services/rest/bluesamservice/loadDataSetFromS3?region=us-east-1&listcatFileS3Location=s3://bucket-name/listcat.json&datasetFileS3Location=s3://bucket-name/dataset.DAT ``` ### Exportar el conjunto de datos a un bucket de Amazon S3. Exporta un conjunto de datos al bucket de Amazon S3 especificado. + Método compatible: GET + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/exportDataSetToS3` + Argumentos: s3Location (obligatorio, cadena): la ubicación de Amazon S3 a la que exportar el conjunto de datos. datasetName (obligatorio, cadena): el nombre del conjunto de datos que se va a exportar. region (obligatorio, cadena): el Región de AWS del bucket de Amazon S3. kmsKeyId (opcional, cadena): el AWS KMS ID que se utilizará para cifrar el conjunto de datos exportado al bucket de Amazon S3. + Devuelve el conjunto de datos exportado Solicitud de ejemplo: ``` /BAC/api/services/rest/bluesamservice/exportDataSetToS3?region=eu-west-1&s3Location=s3://bucket-name/dump&datasetName=dataset ``` ### Borrar un conjunto de datos Borra todos los registros de un conjunto de datos. + Métodos compatibles: POST, GET + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/clearDataSet` + Argumentos: name (obligatorio, cadena): el nombre del conjunto de datos que se va a borrar. Cuando se utiliza el método GET, el nombre del parámetro es`datasetName`. + Devuelve: el estado de la solicitud. ### Eliminar un conjunto de datos Elimina la definición y los registros del conjunto de datos. + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/deleteDataSet` + Argumentos: name (obligatorio, cadena): el nombre del conjunto de datos que se va a eliminar. + Devuelve el estado de la solicitud y del conjunto de datos eliminado. ### Contar los registros del conjunto de datos Este punto de conexión devuelve el número de registros asociados a un conjunto de datos. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/bluesamservice/countRecords` + Argumentos: name (obligatorio, cadena): el nombre del conjunto de datos. + Devuelve: el número de registros ## Puntos de conexión relacionados con conjuntos de datos en bloque Utilice los siguientes puntos de conexión para crear o administrar varios conjuntos de datos a la vez. **Topics** + [Exportación de conjuntos de datos (GET)](#ba-export-data-sets-get) + [Exportación de conjuntos de datos (POST)](#ba-export-data-sets-post) + [Creación de varios conjuntos de datos](#ba-create-multiple-data-sets) + [Lista de todos los conjuntos de datos](#ba-list-all-data-sets) + [Lista directa de todos los conjuntos de datos](#ba-direct-list-all-data-sets) + [Lista directa de todos los conjuntos de datos por página](#ba-direct-list-all-data-sets-by-page) + [Flujo de conjunto de datos](#ba-stream-data-sets) + [Eliminación de todos los conjuntos de datos](#ba-delete-all-data-sets) + [Obtención de las definiciones de conjuntos de datos del archivo listcat](#ba-get-definitions-listcat) + [Obtener las definiciones de conjuntos de datos del archivo listcat cargado](#ba-get-definitions-uploaded-listcat) + [Obtención de un conjunto de datos](#ba-get-data-set) + [Carga de listcat desde el archivo JSON](#ba-load-listcat) ### Exportación de conjuntos de datos (GET) + Método compatible: GET + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/exportDataSet` + Argumentos: datasetName (obligatorio, cadena): el nombre del conjunto de datos que se va a exportar. datasetOutputFile (obligatorio, cadena): la ruta de la carpeta donde desea almacenar el conjunto de datos exportado en el servidor. rdw (obligatorio, booleano): si desea que la palabra descriptora del registro (RDW) forme parte de los registros exportados. Si el conjunto de datos tiene registros de longitud fija, se omite el valor de este parámetro. + Devuelve el estado de la solicitud y la ruta al archivo que contiene el conjunto de datos exportado (de haberlo). Si el conjunto de datos es nulo en la respuesta, significa que el sistema no ha podido localizar un conjunto de datos con el nombre especificado. ### Exportación de conjuntos de datos (POST) + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/bluesamservice/exportDataSet` + Argumentos: dumpParameters (obligatorio, BACRead parámetros): parámetros de lectura de Bluesam. + Devuelve el estado del conjunto de datos exportado. ### Creación de varios conjuntos de datos + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/createAllDataSets` + Argumentos: + Lista de conjuntos de datos name (obligatorio, cadena): el nombre del conjunto de datos. type (obligatorio, cadena): el tipo de conjunto de datos. Los valores posibles son `ESDS`, `KSDS`, `RRDS`. recordSize (opcional, cadena): tamaño máximo de cada registro del conjunto de datos. fixedLength (opcional, booleano): indica si la longitud de los registros es fija. compression (opcional, booleano): indica si el conjunto de datos está comprimido. cacheEnable (opcional, booleano): indica si el almacenamiento en caché está habilitado para el conjunto de datos. + Devuelve: el estado de la solicitud y el conjunto de datos recién creado. ### Lista de todos los conjuntos de datos + Método compatible: GET + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/bluesamservice/listDataSet` + Argumentos: ninguno + Devuelve el estado de la solicitud y de la lista de conjuntos de datos. ### Lista directa de todos los conjuntos de datos + Método compatible: GET + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/bluesamservice/directListDataSet` + Argumentos: ninguno + Devuelve el estado de la solicitud y de la lista de conjuntos de datos. ### Lista directa de todos los conjuntos de datos por página + Método compatible: GET + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/bluesamservice/directListDataSetByPage` + Argumentos: name (obligatorio, cadena): el nombre del conjunto de datos. El valor predeterminado es `%` (todos los conjuntos de datos) si no se especifica. page (obligatorio, int): el número de página (mínimo 0). pageSize (obligatorio, int): el tamaño de la página (mínimo 1, máximo 500). + Devuelve el estado de la solicitud y de la lista de conjuntos de datos. ### Flujo de conjunto de datos + Método compatible: GET + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/streamDataset` + Argumentos: datasetName (obligatorio, cadena): el nombre del conjunto de datos. + Devuelve: un flujo de los conjuntos de datos solicitados. ### Eliminación de todos los conjuntos de datos + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/removeAll` + Argumentos: ninguno + Devuelve: un valor booleano que representa el estado de la solicitud. ### Obtención de las definiciones de conjuntos de datos del archivo listcat + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromListcat` + Argumentos: paramFilePath (obligatorio, cadena): la ruta al archivo listcat. + Devuelve: una lista de conjuntos de datos ### Obtener las definiciones de conjuntos de datos del archivo listcat cargado + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat` + Argumentos: ninguno + Devuelve: una lista de conjuntos de datos ### Obtención de un conjunto de datos + Método compatible: GET + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/bluesamservice/getDataSet` + Argumentos: name (obligatorio, cadena): el nombre del conjunto de datos. + Devuelve el conjunto de datos solicitado. ### Carga de listcat desde el archivo JSON + Método compatible: GET + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/loadListcatFromJsonFile` + Argumentos: filePath (obligatorio, cadena): la ruta al archivo listcat. + Devuelve: una lista de conjuntos de datos ## Registros Utilice los siguientes puntos de conexión para crear o administrar registros en un conjunto de datos. **Topics** + [Creación de un registro](#ba-create-record) + [Lectura de un conjunto de datos](#ba-read-data-set) + [Eliminación de un registro](#ba-delete-record) + [Actualización de un registro](#ba-update-record) + [Guardar un registro](#ba-save-record) + [Validación de un registro](#ba-validate-record) + [Obtención de un árbol de registros](#ba-get-record-tree) ### Creación de un registro Puede utilizar este punto de conexión para crear un nuevo registro. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/crud/createRecord` + Argumentos: conjunto de datos (obligatorio DataSet): el objeto del conjunto de datos mask (obligatorio, mask): el objeto de máscara. + Devuelve: el estado de la solicitud y el registro creado. ### Lectura de un conjunto de datos Puede usar este punto de conexión para leer un conjunto de datos. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/crud/readDataSet` + Argumentos: conjunto de datos (obligatorio DataSet): el objeto del conjunto de datos. + Devuelve el estado de la solicitud y del conjunto de datos con los registros. ### Eliminación de un registro Puede usar este punto de conexión para eliminar un registro de un conjunto de datos. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/crud/deleteRecord` + Argumentos: conjunto de datos (obligatorio DataSet): el objeto del conjunto de datos record (obligatorio, Record): el registro que se va a eliminar + Devuelve el estado de la eliminación. ### Actualización de un registro Puede usar este punto de conexión para actualizar un registro asociado a un conjunto de datos. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/crud/updateRecord` + Argumentos: conjunto de datos (obligatorio, DataSet): el objeto del conjunto de datos record (obligatorio, Record): el registro que se va a actualizar mask (opcional, máscara): el objeto de máscara que se aplicará durante la actualización. + Devuelve el estado de la solicitud y del conjunto de datos con los registros. ### Guardar un registro Puede usar este punto de conexión para guardar un registro en un conjunto de datos y usar una máscara. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/crud/saveRecord` + Argumentos: conjunto de datos (obligatorio DataSet): el objeto del conjunto de datos record (obligatorio, Record): el registro que se va a guardar mask (opcional, máscara): el objeto de máscara que se aplicará al guardar. + Devuelve el estado de la solicitud y del conjunto de datos con los registros. ### Validación de un registro Utilice este punto de conexión para validar un registro. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/crud/validateRecord` + Argumentos: conjunto de datos (obligatorio DataSet): el objeto del conjunto de datos record (opcional, registro): el registro a validar. mask (opcional, máscara): el objeto de máscara que se aplicará durante la validación. + Devuelve el estado de la solicitud y del conjunto de datos con los registros. ### Obtención de un árbol de registros Utilice este punto de conexión para obtener el árbol jerárquico de un registro. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/crud/getRecordTree` + Argumentos: conjunto de datos (obligatorio DataSet): el objeto del conjunto de datos record (obligatorio, Record): el registro que se recuperará mask (opcional, máscara): el objeto de máscara. + Devuelve el estado de la solicitud y el árbol jerárquico del registro solicitado. ## Máscaras Utilice los siguientes puntos de conexión para cargar o aplicar máscaras a un conjunto de datos. **Topics** + [Cargar máscaras](#ba-load-mask) + [Aplicar máscara](#ba-apply-mask) + [Aplicar filtro de máscara](#ba-apply-mask-filter) ### Cargar máscaras Puede usar este punto de conexión para recuperar todas las máscaras asociadas a un conjunto de datos específico. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/crud/loadMasks` + Variables de ruta: recordSize: .../loadMasks/{recordSize} (opcional, numérico): el tamaño del registro, filtra las máscaras cargadas que coinciden con este tamaño de registro + Argumentos: conjunto de datos (obligatorio DataSet): el objeto del conjunto de datos + Devuelve el estado de la solicitud y de la lista de máscaras. ### Aplicar máscara Puede usar este punto de conexión para aplicar una máscara a un conjunto de datos específico. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/crud/applyMask` + Argumentos: conjunto de datos (obligatorio, DataSet): el objeto del conjunto de datos mask (obligatorio, máscara): el objeto del conjunto de datos + Devuelve el estado de la solicitud y el conjunto de datos con la máscara aplicada. ### Aplicar filtro de máscara Puede usar este punto de conexión para aplicar una máscara y un filtro a un conjunto de datos específico. + Método compatible: POST + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/crud/applyMaskFilter` + Argumentos: conjunto de datos (obligatorio, DataSet): el objeto del conjunto de datos mask (obligatorio, máscara): el objeto de máscara filter (obligatorio, filtro): el objeto de filtro que se va a aplicar. + Devuelve el estado de la solicitud y el conjunto de datos con la máscara y el filtro aplicados. ## Otro Utilice los siguientes puntos de conexión para administrar la caché de un conjunto de datos o comprobar las características del conjunto de datos **Topics** + [Comprobación de la memoria caché de preparación](#ba-check-warm-up-cache) + [Comprobar que la caché está habilitada](#ba-check-cache-enabled) + [Habilitar caché](#ba-enable-cache) + [Comprobación de la memoria caché RAM asignada](#ba-check-allocated-ram-cache) + [Comprobar la persistencia](#ba-check-persistence) + [Comprobar los tipos de conjuntos de datos compatibles](#ba-check-supported-data-set-types) + [Comprobar el estado del servidor](#ba-check-server-health) + [Compruebe la configuración multiesquema de PostgreSQL](#ba-check-postgres-multi-schema) ### Comprobación de la memoria caché de preparación Comprueba si la caché de preparación está habilitada para un conjunto de datos específico. + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/warmupCache` + Argumentos: name (obligatorio, cadena): el nombre del conjunto de datos. + Devuelve: true si la memoria caché de preparación está habilitada y false en caso contrario. ### Comprobar que la caché está habilitada Comprueba si la caché está habilitada para un conjunto de datos específico. + Método compatible: GET + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/bluesamservice/isEnableCache` + Argumentos: ninguno + Devuelve true si el almacenamiento en caché está habilitado. ### Habilitar caché + Método compatible: POST + Requiere autenticación y los roles ROLE\_ADMIN y ROLE\_SUPER\_ADMIN. + Ruta: `/api/services/rest/bluesamservice/enableDisableCache/{enable}` + Argumentos: enable (obligatorio, booleano): si se establece en true, habilitará el almacenamiento en caché. conjunto de datos (obligatorio DataSet): el objeto del conjunto de datos. + Devuelve: nada ### Comprobación de la memoria caché RAM asignada Puede usar este punto de conexión para recuperar la memoria caché RAM asignada. + Método compatible: GET + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/bluesamservice/allocatedRamCache` + Argumentos: ninguno + Devuelve: el tamaño de la memoria en forma de cadena ### Comprobar la persistencia + Método compatible: GET + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/bluesamservice/persistence` + Argumentos: ninguno + Devuelve: la persistencia utilizada como cadena ### Comprobar los tipos de conjuntos de datos compatibles + Método compatible: GET + Ruta: `/api/services/rest/bluesamservice/getDataSetTypes` + Requiere autenticación y el rol ROLE\_USER. + Argumentos: ninguno + Devuelve: la lista de tipos de conjuntos de datos admitidos en forma de lista de cadenas. ### Comprobar el estado del servidor + Método compatible: GET + Ruta: `/api/services/rest/bluesamserver/serverIsUp` + Argumentos: ninguno + Devuelve: nada. El código de estado de respuesta HTTP 200 indica que el servidor está en funcionamiento. ### Compruebe la configuración multiesquema de PostgreSQL Comprueba si la configuración multiesquema de PostgreSQL está habilitada. + Método compatible: GET + Requiere autenticación y el rol ROLE\_USER. + Ruta: `/api/services/rest/bluesamservice/isPostgresMultiSchema` + Argumentos: ninguno + Devuelve: true si la configuración multiesquema de PostgreSQL está habilitada y false en caso contrario. ## Puntos de conexión de administración de usuarios de BAC Utilice los siguientes puntos de conexión para administrar las interacciones de los usuarios. **Topics** + [Registro de usuarios](#ba-log-user-in) + [Verificación de si existe al menos un usuario en el sistema](#ba-verify-at-least-one-user-exists) + [Registro de usuarios nuevos](#ba-record-new-user) + [Obtención de la información de los usuarios](#ba-user-info) + [Enumeración de usuarios](#ba-list-users) + [Eliminación de un usuario](#ba-delete-user) + [Cierre de sesión del usuario actual](#ba-log-user-out) ### Registro de usuarios + Método compatible: POST + Ruta: `/api/services/security/servicelogin/login` + Argumentos: ninguno + Devuelve la serialización JSON de un objeto `com.netfective.bluage.bac.entities.SignOn`, que representa al usuario cuyas credenciales se proporcionan en la solicitud actual. La contraseña está oculta en la vista del objeto devuelto. Se muestran las funciones asignadas al usuario. Respuesta de ejemplo: ``` { "login": "some-admin", "password": null, "roles": [ { "id": 0, "roleName": "ROLE_ADMIN" } ] } ``` ### Verificación de si existe al menos un usuario en el sistema + Método compatible: GET + Ruta: `/api/services/security/servicelogin/hasAccount` + Argumentos: ninguno + Devuelve el valor booleano `true` si se ha creado al menos un usuario distinto de la superadministrador predeterminado. De lo contrario, devuelve `false`. ### Registro de usuarios nuevos + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/security/servicelogin/recorduser` + Argumentos: la serialización en JSON de un objeto `com.netfective.bluage.bac.entities.SignOn` que representa al usuario que se agregará al almacenamiento. Se deben definir los roles de usuario; de lo contrario, es posible que el usuario no pueda utilizar las funciones y los puntos de conexión de BAC. + Devuelve el valor booleano `true` si el usuario se ha creado correctamente. De lo contrario, devuelve `false`. + JSON de solicitud de ejemplo: ``` { "login": "simpleuser", "password": "simplepassword", "roles": [ { "id": 2, "roleName": "ROLE_USER" } ] } ``` Los siguientes son los dos valores válidos para `roleName`: + `ROLE_ADMIN`: puede gestionar Blusam recursos y usuarios. + `ROLE_USER`: puede gestionar Blusam los recursos pero no los usuarios. ### Obtención de la información de los usuarios + Método compatible: GET + Ruta: `/api/services/security/servicelogin/userInfo` + Argumentos: ninguno + Devuelve el nombre de usuario y el rol del usuario actualmente conectado. ### Enumeración de usuarios + Método compatible: GET + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/security/servicelogin/listusers` + Argumentos: ninguno + Devuelve una lista de `com.netfective.bluage.bac.entities.SignOn`, serializada como JSON. ### Eliminación de un usuario **importante** Esta acción no se puede deshacer. El usuario eliminado no podrá volver a conectarse a la aplicación de BAC. + Método compatible: POST + Requiere autenticación y el rol ROLE\_ADMIN. + Ruta: `/api/services/security/servicelogin/deleteuser` + Argumentos: la serialización en JSON de un objeto `com.netfective.bluage.bac.entities.SignOn` que representa al usuario que se eliminará del almacenamiento. + Devuelve el valor booleano `true` si el usuario se ha eliminado correctamente. ### Cierre de sesión del usuario actual + Método compatible: GET + Ruta: `/api/services/security/servicelogout/logout` + Argumentos: ninguno + Devuelve el mensaje JSON `{"success":true}` si la sesión del usuario se ha cerrado correctamente. La sesión HTTP relacionada será invalidada.