Titik akhir konsol aplikasi Blusam REST - AWS Modernisasi Mainframe

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Titik akhir konsol aplikasi Blusam REST

Di bagian ini, Anda dapat mempelajari tentang konsol aplikasi Blusam, yang API dirancang untuk menyederhanakan pengelolaan kumpulan data modern. VSAM Titik akhir untuk aplikasi web Blusam menggunakan jalur root. /bac

Set data titik akhir terkait

Gunakan titik akhir berikut untuk membuat atau mengelola kumpulan data tertentu.

Buat kumpulan data

Anda dapat menggunakan endpoint ini untuk membuat definisi kumpulan data.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

  • Jalan: /api/services/rest/bluesamservice/createDataSet

  • Pendapat:

    name

    (required, string): nama kumpulan data.

    jenis

    (wajib, string): tipe kumpulan data. Nilai yang mungkin adalah:ESDS,KSDS,RRDS.

    recordSize

    (opsional, string): Ukuran maksimum setiap catatan kumpulan data.

    fixedLength

    (opsional, boolean): Menunjukkan jika panjang catatan diperbaiki.

    Kompresi

    (opsional, boolean): Menunjukkan apakah kumpulan data dikompresi.

    cacheEnable

    (opsional, boolean): Menunjukkan apakah caching diaktifkan untuk kumpulan data.

    alternativeKeys

    (opsional, daftar kunci):

    • offset (wajib, nomor)

    • panjang (diperlukan, nomor)

    • nama (wajib, nomor)

  • Mengembalikan JSON file yang mewakili set data yang baru dibuat.

Permintaan sampel:

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 }

Contoh respons:

{ "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 }

Unggah sebuah file

Anda dapat menggunakan endpoint ini untuk mengunggah file ke server. File disimpan dalam folder sementara yang sesuai dengan setiap pengguna tertentu. Gunakan titik akhir ini setiap kali Anda perlu mengunggah file.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

  • Jalan: /api/services/rest/bluesamservice/upload

  • Pendapat:

    file

    (wajib, multipart/form-data): File yang akan diunggah.

  • Mengembalikan boolean mencerminkan status upload

Memuat kumpulan data (POST)

Setelah digunakan createDataSet untuk membuat definisi kumpulan data, Anda dapat memuat rekaman yang terkait dengan file yang diunggah ke kumpulan data tertentu.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

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

  • Pendapat:

    name

    (required, string): nama kumpulan data.

  • Mengembalikan status permintaan dan kumpulan data yang dimuat.

Memuat kumpulan data (GET)

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

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

  • Pendapat:

    name

    (required, string): nama kumpulan data.

    berkas dataset

    (wajib, string): nama file kumpulan data.

  • Mengembalikan status permintaan dan kumpulan data yang dimuat.

Memuat kumpulan data dari bucket Amazon S3

Memuat kumpulan data menggunakan file listcat dari bucket Amazon S3.

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

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

  • Pendapat:

    listcatFileS3Lokasi

    (wajib, string): lokasi Amazon S3 dari file listcat.

    datasetFileS3Lokasi

    (wajib, string): lokasi Amazon S3 dari file kumpulan data.

    region

    (wajib, string): Amazon S3 Wilayah AWS tempat file disimpan.

  • Mengembalikan set data yang baru dibuat

Permintaan sampel:

/BAC/api/services/rest/bluesamservice/loadDataSetFromS3?region=us-east-1&listcatFileS3Location=s3://bucket-name/listcat.json&datasetFileS3Location=s3://bucket-name/dataset.DAT

Mengekspor kumpulan data ke bucket Amazon S3

Mengekspor kumpulan data ke bucket Amazon S3 yang ditentukan.

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

  • Jalan: /api/services/rest/bluesamservice/exportDataSetToS3

  • Pendapat:

    S3Lokasi

    (wajib, string): lokasi Amazon S3 untuk mengekspor kumpulan data ke.

    datasetName

    (required, string): nama kumpulan data yang akan diekspor.

    region

    (wajib, string): Wilayah AWS bucket Amazon S3.

    kmsKeyId

    (opsional, string): AWS KMS ID yang akan digunakan untuk enkripsi kumpulan data yang diekspor ke bucket Amazon S3.

  • Mengembalikan kumpulan data yang diekspor

Permintaan sampel:

/BAC/api/services/rest/bluesamservice/exportDataSetToS3?region=eu-west-1&s3Location=s3://bucket-name/dump&datasetName=dataset

Hapus kumpulan data

Menghapus semua catatan dari kumpulan data.

  • Metode yang didukung:POST, GET

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

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

  • Pendapat:

    name

    (required, string): nama kumpulan data untuk dihapus.

  • Mengembalikan status permintaan.

Hapus kumpulan data

Menghapus definisi dan catatan kumpulan data.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

  • Jalan: /api/services/rest/bluesamservice/deleteDataSet

  • Pendapat:

    name

    (required, string): nama kumpulan data yang akan dihapus.

  • Mengembalikan status permintaan dan kumpulan data yang dihapus.

Hitung catatan kumpulan data

Titik akhir ini mengembalikan jumlah catatan yang terkait dengan kumpulan data.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

  • Jalan: /api/services/rest/bluesamservice/countRecords

  • Pendapat:

    name

    (required, string): nama kumpulan data.

  • Pengembalian: jumlah catatan

Data massal menetapkan titik akhir terkait

Gunakan titik akhir berikut untuk membuat atau mengelola beberapa kumpulan data sekaligus.

Ekspor set data (GET)

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Pendapat:

    datasetName

    (required, string): nama kumpulan data yang akan diekspor.

    datasetOutputFile

    (required, string): jalur folder tempat Anda ingin menyimpan dataset yang diekspor di server.

    rdw

    (required, boolean): apakah Anda ingin record descriptor word (RDW) menjadi bagian dari catatan yang diekspor. Jika kumpulan data memiliki catatan panjang tetap, nilai parameter ini diabaikan.

  • Mengembalikan status permintaan dan jalur ke file yang berisi kumpulan data yang diekspor (jika ada). Jika dataset adalah nol dalam respons, itu berarti sistem tidak dapat menemukan kumpulan data dengan nama yang diberikan.

Ekspor set data (POST)

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Pendapat:

    dumpParameters

    (wajib,BACReadParameters): Parameter baca Bluesam.

  • Mengembalikan status kumpulan data yang diekspor.

Buat beberapa set data

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

  • Jalan: /api/services/rest/bluesamservice/createAllDataSets

  • Pendapat:

    • Daftar kumpulan data

      name

      (required, string): nama kumpulan data.

      jenis

      (wajib, string): tipe kumpulan data. Nilai yang mungkin adalah:ESDS,KSDS,RRDS.

      recordSize

      (opsional, string): Ukuran maksimum setiap catatan kumpulan data.

      fixedLength

      (opsional, boolean): Menunjukkan jika panjang catatan diperbaiki.

      Kompresi

      (opsional, boolean): Menunjukkan apakah kumpulan data dikompresi.

      cacheEnable

      (opsional, boolean): Menunjukkan apakah caching diaktifkan untuk kumpulan data.

  • Pengembalian: status permintaan dan kumpulan data yang baru dibuat.

Daftar semua set data

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Argumen: Tidak ada

  • Pengembalian: status permintaan dan daftar kumpulan data.

Daftar langsung semua set data

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Argumen: Tidak ada

  • Pengembalian: status permintaan dan daftar kumpulan data.

Daftar langsung semua kumpulan data berdasarkan halaman

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Pendapat:

    datasetName

    (required, string): nama kumpulan data.

    pageNumber

    (wajib, int): nomor halaman.

    pageSize

    (wajib, int): ukuran halaman.

  • Pengembalian: status permintaan dan daftar kumpulan data.

Kumpulan data aliran

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

  • Jalan: /api/services/rest/bluesamservice/streamDataset

  • Pendapat:

    datasetName

    (required, string): nama kumpulan data.

  • Pengembalian: Sebuah aliran dari set data yang diminta.

Hapus semua set data

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

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

  • Argumen: Tidak ada

  • Pengembalian: boolean yang mewakili status permintaan.

Dapatkan definisi kumpulan data dari file listcat

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

  • Jalan: /api/services/rest/bluesamservice/getDataSetsDefinitionFromListcat

  • Pendapat:

    paramFilePath

    (required, string): Jalur ke file listcat.

  • Pengembalian: daftar set data

Dapatkan definisi kumpulan data dari file cat daftar yang diunggah

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

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

  • Argumen: Tidak ada

  • Pengembalian: daftar set data

Dapatkan kumpulan data

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Pendapat:

    name

    (required, string): nama kumpulan data.

  • Mengembalikan kumpulan data yang diminta.

Muat listcat dari file JSON

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

  • Jalan: /api/services/rest/bluesamservice/loadListcatFromJsonFile

  • Pendapat:

    filePath

    (required, string): Jalur ke file listcat.

  • Pengembalian: daftar set data

Catatan

Gunakan titik akhir berikut untuk membuat atau mengelola catatan dalam kumpulan data.

Buat catatan

Anda dapat menggunakan endpoint ini untuk membuat record baru.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

  • Jalan: /api/services/rest/crud/createRecord

  • Pendapat:

    set data

    (wajib, DataSet): objek kumpulan data

    mask

    (wajib, topeng): objek topeng.

  • Mengembalikan status permintaan dan catatan yang dibuat.

Membaca kumpulan data

Anda dapat menggunakan endpoint ini untuk membaca kumpulan data.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

  • Jalan: /api/services/rest/crud/readDataSet

  • Pendapat:

    set data

    (required, DataSet): objek kumpulan data.

  • Mengembalikan status permintaan dan set data dengan catatan.

Hapus catatan

Anda dapat menggunakan titik akhir ini untuk menghapus catatan dari kumpulan data.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

  • Jalan: /api/services/rest/crud/deleteRecord

  • Pendapat:

    set data

    (wajib, DataSet): objek kumpulan data

    catatan

    (wajib, Rekam): catatan yang akan dihapus

  • Mengembalikan status penghapusan.

Perbarui catatan

Anda dapat menggunakan titik akhir ini untuk memperbarui rekaman yang terkait dengan kumpulan data.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

  • Jalan: /api/services/rest/crud/updateRecord

  • Pendapat:

    set data

    (wajib, DataSet): objek kumpulan data

    catatan

    (wajib, Rekam): catatan untuk memperbarui

  • Mengembalikan status permintaan dan set data dengan catatan.

Menyimpan catatan

Anda dapat menggunakan titik akhir ini untuk menyimpan catatan ke kumpulan data dan menggunakan topeng.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

  • Jalan: /api/services/rest/crud/saveRecord

  • Pendapat:

    set data

    (wajib, DataSet): objek kumpulan data

    catatan

    (wajib, Rekam): catatan untuk disimpan

  • Mengembalikan status permintaan dan set data dengan catatan.

Validasi catatan

Gunakan titik akhir ini untuk memvalidasi catatan.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Pendapat:

    set data

    (wajib, DataSet): objek kumpulan data

  • Mengembalikan status permintaan dan set data dengan catatan.

Dapatkan pohon rekaman

Gunakan titik akhir ini untuk mendapatkan pohon hierarkis catatan.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Pendapat:

    set data

    (wajib, DataSet): objek kumpulan data

    catatan

    (wajib, Rekam): catatan yang akan diambil

  • Mengembalikan status permintaan dan pohon hierarkis dari catatan yang diminta.

Masker

Gunakan titik akhir berikut untuk memuat atau menerapkan masker ke kumpulan data.

Muatkan masker

Anda dapat menggunakan endpoint ini untuk mengambil semua mask yang terkait dengan kumpulan data tertentu.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

  • Jalan: /api/services/rest/crud/loadMasks

  • Variabel jalur:

    recordSize: .../loadMasks/{recordSize}

    (opsional, numerik): ukuran rekaman, filter masker yang dimuat yang cocok dengan ukuran rekaman ini

  • Pendapat:

    set data

    (wajib, DataSet): objek kumpulan data

  • Mengembalikan status permintaan dan daftar topeng.

Oleskan masker

Anda dapat menggunakan endpoint ini untuk menerapkan mask ke kumpulan data tertentu.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

  • Jalan: /api/services/rest/crud/applyMask

  • Pendapat:

    set data

    (wajib, DataSet): objek kumpulan data

    mask

    (wajib, Mask): objek kumpulan data

  • Mengembalikan status permintaan dan set data dengan mask diterapkan.

Terapkan filter masker

Anda dapat menggunakan endpoint ini untuk menerapkan mask dan filter ke kumpulan data tertentu.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Pendapat:

    set data

    (wajib, DataSet): objek kumpulan data

    mask

    (wajib, Mask): objek kumpulan data

  • Mengembalikan status permintaan dan kumpulan data dengan masker dan filter yang diterapkan.

Lainnya

Gunakan titik akhir berikut untuk mengelola cache untuk kumpulan data atau memeriksa karakteristik kumpulan data

Periksa cache pemanasan

Memeriksa apakah cache pemanasan diaktifkan untuk kumpulan data tertentu.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

  • Jalan: /api/services/rest/bluesamservice/warmupCache

  • Pendapat:

    name

    (required, string): nama kumpulan data.

  • Pengembalian: true jika cache pemanasan diaktifkan dan false sebaliknya.

Periksa cache diaktifkan

Memeriksa apakah cache diaktifkan untuk kumpulan data tertentu.

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Argumen: Tidak ada

  • Mengembalikan nilai true jika caching diaktifkan.

Aktifkan cache

  • Metode yang didukung: GET

  • Memerlukan otentikasi dan ADMIN peran ROLE _ ADMIN dan ROLE _ SUPER _.

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

  • Pendapat:

    memungkinkan

    (required, boolean): jika disetel ke true, itu akan mengaktifkan caching.

  • Mengembalikan Tidak Ada

Periksa cache yang dialokasikan RAM

Anda dapat menggunakan endpoint ini untuk mengambil memori cache yang dialokasikanRAM.

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Argumen: Tidak ada

  • Pengembalian: ukuran memori sebagai string

Periksa kegigihan

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan USER peran ROLE _.

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

  • Argumen: Tidak ada

  • Pengembalian: persistensi digunakan sebagai string

Periksa tipe kumpulan data yang didukung

  • Metode yang didukung: GET

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

  • Membutuhkan otentikasi dan USER peran ROLE _.

  • Argumen: Tidak ada

  • Pengembalian: daftar tipe kumpulan data yang didukung sebagai daftar string.

Periksa kesehatan server

  • Metode yang didukung: GET

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

  • Argumen: Tidak ada

  • Pengembalian: Tidak ada. HTTPkode status respons 200 menunjukkan bahwa server aktif dan berjalan.

BACtitik akhir manajemen pengguna

Gunakan titik akhir berikut untuk mengelola interaksi pengguna.

Masuk ke pengguna

  • Metode yang didukung: POST

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

  • Argumen: Tidak ada

  • Mengembalikan JSON serialisasi com.netfective.bluage.bac.entities.SignOn objek, mewakili pengguna yang kredensialnya disediakan dalam permintaan saat ini. Kata sandi disembunyikan dari tampilan di objek yang dikembalikan. Peran yang diberikan kepada yang digunakan sedang terdaftar.

Contoh respons:

{ "login": "some-admin", "password": null, "roles": [ { "id": 0, "roleName": "ROLE_ADMIN" } ] }

Verifikasi apakah setidaknya ada satu pengguna dalam sistem

  • Metode yang didukung: GET

  • Jalan: /api/services/security/servicelogin/hasAccount

  • Argumen: Tidak ada

  • Mengembalikan nilai boolean true jika setidaknya satu pengguna selain pengguna admin super default telah dibuat. Mengembalikan false sebaliknya.

Rekam pengguna baru

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

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

  • Argumen: JSON serialisasi com.netfective.bluage.bac.entities.SignOn objek yang mewakili pengguna yang akan ditambahkan ke penyimpanan. Peran untuk pengguna harus ditentukan, jika tidak, pengguna mungkin tidak dapat menggunakan BAC fasilitas dan titik akhir.

  • Mengembalikan nilai boolean true jika pengguna berhasil dibuat. Mengembalikan false sebaliknya.

  • Permintaan sampelJSON:

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

    Berikut ini adalah dua nilai yang valid untukroleName:

    • ROLE_ADMIN: dapat mengelola sumber daya Blusam dan pengguna.

    • ROLE_USER: dapat mengelola sumber daya Blusam tetapi tidak pengguna.

Dapatkan info pengguna

  • Metode yang didukung: GET

  • Jalan: /api/services/security/servicelogin/userInfo

  • Argumen: Tidak ada

  • Mengembalikan nama pengguna dan peran pengguna yang saat ini terhubung

Daftar pengguna

  • Metode yang didukung: GET

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

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

  • Argumen: Tidak ada

  • Mengembalikan daftarcom.netfective.bluage.bac.entities.SignOn, serial sebagaiJSON.

Hapus pengguna

penting

Tindakan ini tidak dapat dibatalkan. Pengguna yang dihapus tidak akan dapat terhubung ke BAC aplikasi lagi.

  • Metode yang didukung: POST

  • Membutuhkan otentikasi dan ADMIN peran ROLE _.

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

  • Argumen: JSON serialisasi com.netfective.bluage.bac.entities.SignOn objek yang mewakili pengguna yang akan dihapus dari penyimpanan.

  • Mengembalikan nilai boolean true jika pengguna berhasil dihapus.

Log keluar pengguna saat ini

  • Metode yang didukung: GET

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

  • Argumen: Tidak ada

  • Mengembalikan JSON pesan {"success":true} jika pengguna saat ini berhasil keluar. HTTPSesi terkait akan dibatalkan.