Terminales de la consola de aplicaciones Blusam REST - AWS Modernización de mainframe

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.

Terminales de la consola de aplicaciones Blusam REST

En esta sección, puede obtener información sobre la consola de aplicaciones Blusam, que está API diseñada para simplificar la administración de conjuntos de datos modernizados. VSAM Los puntos de conexión de la aplicación web de Blusam utilizan la ruta raíz /bac.

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.

Creación de un conjunto de datos

Puede usar este punto final para crear una definición de conjunto de datos.

  • Métodos compatibles: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • 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 JSON archivo 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

Puede usar este punto final para cargar archivos al servidor. El archivo se almacena en una carpeta temporal que corresponde a cada usuario específico. Utilice este punto final cada vez que necesite cargar un archivo.

  • Métodos compatibles: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • 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

Cargue un conjunto de datos (POST)

Después de createDataSet crear la definición del conjunto de datos, puede cargar los registros asociados al archivo cargado en un conjunto de datos específico.

  • Métodos compatibles: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • 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.

Cargue un conjunto de datos (GET)

  • Métodos compatibles: GET

  • Requiere autenticación y la ADMIN función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/loadDataSet

  • Argumentos:

    name

    (obligatorio, cadena): el nombre del conjunto de datos.

    archivo de conjunto de datos

    (obligatorio, cadena): el nombre del archivo del 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étodos compatibles: GET

  • Requiere autenticación y la ADMIN función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/loadDataSetFromS3

  • Argumentos:

    listcatFileUbicación de S3

    (obligatorio, cadena): la ubicación de Amazon S3 del archivo listcat.

    datasetFileUbicación de S3

    (obligatorio, cadena): la ubicación de Amazon S3 del archivo de conjunto de datos.

    región

    (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étodos compatibles: GET

  • Requiere autenticación y la ADMIN función ROLE _.

  • 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.

    región

    (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 la ADMIN función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/clearDataSet

  • Argumentos:

    name

    (obligatorio, cadena): el nombre del conjunto de datos que se va a borrar.

  • Devuelve: el estado de la solicitud.

Eliminar un conjunto de datos

Elimina la definición y los registros del conjunto de datos.

  • Métodos compatibles: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • 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 final devuelve el número de registros asociados a un conjunto de datos.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • 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.

Exportar conjuntos de datos (GET)

  • Métodos compatibles: GET

  • Requiere autenticación y la USER función ROLE _.

  • 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 en la que 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 ignora el valor de este parámetro.

  • Devuelve el estado de la solicitud y la ruta al archivo que contiene el conjunto de datos exportado (si lo hubiera). 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 indicado.

Exportar conjuntos de datos (POST)

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/exportDataSet

  • Argumentos:

    dumpParameters

    (obligatorioBACReadParameters): parámetros de lectura de Bluesam.

  • Devuelve el estado del conjunto de datos exportado.

Creación de varios conjuntos de datos

  • Métodos compatibles: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • 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étodos compatibles: GET

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/listDataSet

  • Argumentos: ninguno

  • Devuelve el estado de la solicitud y de la lista de conjuntos de datos.

Enumere directamente todos los conjuntos de datos

  • Métodos compatibles: GET

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/directListDataSet

  • Argumentos: ninguno

  • Devuelve el estado de la solicitud y de la lista de conjuntos de datos.

Enumere directamente todos los conjuntos de datos por página

  • Métodos compatibles: GET

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/directListDataSetByPage

  • Argumentos:

    datasetName

    (obligatorio, cadena): el nombre del conjunto de datos.

    pageNumber

    (obligatorio, int): el número de página.

    pageSize

    (obligatorio, int): el tamaño de la página.

  • Devuelve el estado de la solicitud y de la lista de conjuntos de datos.

Transmita el conjunto de datos

  • Métodos compatibles: GET

  • Requiere autenticación y la ADMIN función ROLE _.

  • 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étodos compatibles: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/removeAll

  • Argumentos: ninguno

  • Devuelve: un booleano que representa el estado de la solicitud.

Obtenga las definiciones de los conjuntos de datos del archivo list.cat

  • Métodos compatibles: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • 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étodos compatibles: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat

  • Argumentos: ninguno

  • Devuelve: una lista de conjuntos de datos

Obtenga un conjunto de datos

  • Métodos compatibles: GET

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/getDataSet

  • Argumentos:

    name

    (obligatorio, cadena): el nombre del conjunto de datos.

  • Devuelve el conjunto de datos solicitado.

Cargue listcat desde JSON el archivo

  • Métodos compatibles: GET

  • Requiere autenticación y la ADMIN función ROLE _.

  • 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.

Creación de un registro

Puede usar este punto final para crear un registro nuevo.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • 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 utilizar este punto final para leer un conjunto de datos.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • 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 utilizar este punto final para eliminar un registro de un conjunto de datos.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • 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 utilizar este punto final para actualizar un registro asociado a un conjunto de datos.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • 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

  • Devuelve el estado de la solicitud y del conjunto de datos con los registros.

Guardar un registro

Puede usar este punto final para guardar un registro en un conjunto de datos y usar una máscara.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • 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

  • Devuelve el estado de la solicitud y del conjunto de datos con los registros.

Validar un registro

Utilice este punto final para validar un registro.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/crud/validateRecord

  • 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.

Obtenga un árbol de registros

Utilice este punto final para obtener el árbol jerárquico de un registro.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/crud/getRecordTree

  • Argumentos:

    conjunto de datos

    (obligatorio, DataSet): el objeto del conjunto de datos

    record

    (obligatorio, registro): el registro a buscar

  • 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.

Cargar máscaras

Puede utilizar este punto final para recuperar todas las máscaras asociadas a un conjunto de datos específico.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • 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 utilizar este punto final para aplicar una máscara a un conjunto de datos específico.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • 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 utilizar este punto final para aplicar una máscara y un filtro a un conjunto de datos específico.

  • Métodos compatibles: POST

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/crud/applyMaskFilter

  • 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 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

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étodos compatibles: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • 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étodos compatibles: GET

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/isEnableCache

  • Argumentos: ninguno

  • Devuelve true si el almacenamiento en caché está habilitado.

Habilitar caché

  • Métodos compatibles: GET

  • Requiere autenticación y las ADMIN funciones ROLE ROLE _ ADMIN y SUPER _ _.

  • Ruta: /api/services/rest/bluesamservice/enableDisableCache/{enable}

  • Argumentos:

    enable

    (obligatorio, booleano): si se establece en true, habilitará el almacenamiento en caché.

  • Devuelve: nada

Compruebe la memoria caché asignada RAM

Puede utilizar este punto final para recuperar la memoria RAM caché asignada.

  • Métodos compatibles: GET

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/allocatedRamCache

  • Argumentos: ninguno

  • Devuelve: el tamaño de la memoria en forma de cadena

Comprobar la persistencia

  • Métodos compatibles: GET

  • Requiere autenticación y la USER función ROLE _.

  • Ruta: /api/services/rest/bluesamservice/persistence

  • Argumentos: ninguno

  • Devuelve: la persistencia utilizada como cadena

Comprobar los tipos de conjuntos de datos compatibles

  • Métodos compatibles: GET

  • Ruta: /api/services/rest/bluesamservice/getDataSetTypes

  • Requiere autenticación y la USER función ROLE _.

  • Argumentos: ninguno

  • Devuelve: la lista de tipos de conjuntos de datos admitidos en forma de lista de cadenas.

Comprobar el estado del servidor

  • Métodos compatibles: GET

  • Ruta: /api/services/rest/bluesamserver/serverIsUp

  • Argumentos: ninguno

  • Devoluciones: ninguna. HTTPel código de estado de respuesta 200 indica que el servidor está en funcionamiento.

BACpuntos finales de administración de usuarios

Utilice los siguientes puntos de conexión para administrar las interacciones de los usuarios.

Iniciar sesión con un usuario

  • Método compatible: POST

  • Ruta: /api/services/security/servicelogin/login

  • Argumentos: ninguno

  • Devuelve la JSON serialización de un com.netfective.bluage.bac.entities.SignOn objeto, 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" } ] }

Compruebe 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 del superadministrador predeterminado. Devuelve false lo contrario.

Registra un nuevo usuario

  • Método compatible: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • Ruta: /api/services/security/servicelogin/recorduser

  • Argumentos: la JSON serialización de un com.netfective.bluage.bac.entities.SignOn objeto que representa al usuario que se va a añadir al almacenamiento. Se deben definir las funciones del usuario; de lo contrario, es posible que el usuario no pueda utilizar la BAC función y los puntos finales.

  • Devuelve el valor booleano true si el usuario se creó correctamente. Devuelve false lo contrario.

  • Solicitud de muestraJSON:

    { "login": "simpleuser", "password": "simplepassword", "roles": [ { "id": 2, "roleName": "ROLE_USER" } ] }

    Los dos valores válidos pararoleName:

    • ROLE_ADMIN: puede gestionar los recursos y los usuarios de Blusam.

    • ROLE_USER: puede gestionar los recursos de Blusam pero no los usuarios.

Obtenga información de usuario

  • 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 la ADMIN función ROLE _.

  • Ruta: /api/services/security/servicelogin/listusers

  • Argumentos: ninguno

  • Devuelve una lista decom.netfective.bluage.bac.entities.SignOn, serializada comoJSON.

Eliminación de un usuario

importante

Esta acción no se puede deshacer. El usuario eliminado no podrá volver a conectarse a la BAC aplicación.

  • Método compatible: POST

  • Requiere autenticación y la ADMIN función ROLE _.

  • Ruta: /api/services/security/servicelogin/deleteuser

  • Argumentos: la JSON serialización de un com.netfective.bluage.bac.entities.SignOn objeto que representa al usuario que se va a eliminar del almacenamiento.

  • Devuelve el valor booleano true si el usuario se ha eliminado correctamente.

Cierre la sesión del usuario actual

  • Método compatible: GET

  • Ruta: /api/services/security/servicelogout/logout

  • Argumentos: ninguno

  • Devuelve el JSON mensaje {"success":true} si la sesión del usuario actual se ha cerrado correctamente. La HTTP sesión relacionada se invalidará.