AWS Layanan Modernisasi Mainframe (Managed Runtime Environment experience) tidak lagi terbuka untuk pelanggan baru. Untuk kemampuan yang mirip dengan Layanan Modernisasi AWS Mainframe (pengalaman Lingkungan Runtime Terkelola), jelajahi Layanan Modernisasi AWS Mainframe (Pengalaman yang Dikelola Sendiri). Pelanggan yang sudah ada dapat terus menggunakan layanan ini seperti biasa. Untuk informasi selengkapnya, lihat Perubahan [AWS ketersediaan Modernisasi Mainframe](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html).

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

# Blusamkonsol aplikasi REST endpoint
<a name="ba-endpoints-bac"></a>

Di bagian ini, Anda dapat mempelajari tentang konsol Blusam aplikasi, yang merupakan API yang dirancang untuk menyederhanakan pengelolaan kumpulan data VSAM yang dimodernisasi. Endpoint untuk aplikasi Blusam web menggunakan jalur `/bac` root.

**Topics**
+ [Set data titik akhir terkait](#ba-endpoints-bac-datasets)
+ [Data massal menetapkan titik akhir terkait](#ba-endpoints-bac-bulk)
+ [Catatan](#ba-endpoints-bac-records)
+ [Masker](#ba-endpoints-bac-masks)
+ [Lainnya](#ba-endpoints-bac-other)
+ [Titik akhir manajemen pengguna BAC](#ba-endpoints-bac-users)

## Set data titik akhir terkait
<a name="ba-endpoints-bac-datasets"></a>

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

**Topics**
+ [Buat kumpulan data](#ba-create-data-set)
+ [Unggah sebuah file](#ba-upload-file)
+ [Memuat satu set data (POST)](#ba-load-data-set-post)
+ [Memuat satu set data (GET)](#ba-load-data-set-get)
+ [Memuat kumpulan data dari bucket Amazon S3](#ba-load-data-set-s3)
+ [Mengekspor kumpulan data ke bucket Amazon S3](#ba-export-data-set-s3)
+ [Hapus kumpulan data](#ba-clear-data-set)
+ [Hapus kumpulan data](#ba-delete-data-set)
+ [Hitung catatan kumpulan data](#ba-count-data-set-records)

### Buat kumpulan data
<a name="ba-create-data-set"></a>

Anda dapat menggunakan endpoint ini untuk membuat definisi kumpulan data.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ 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 file JSON 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
<a name="ba-upload-file"></a>

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
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ Jalan: `/api/services/rest/bluesamservice/upload`
+ Pendapat:  
file  
(wajib, multipart/form-data): File yang akan diunggah.
+ Mengembalikan boolean mencerminkan status upload

### Memuat satu set data (POST)
<a name="ba-load-data-set-post"></a>

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
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ Jalan: `/api/services/rest/bluesamservice/loadDataSet`
+ Pendapat:  
name  
(required, string): nama kumpulan data.
+ Mengembalikan status permintaan dan kumpulan data yang dimuat.

### Memuat satu set data (GET)
<a name="ba-load-data-set-get"></a>
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ Jalan: `/api/services/rest/bluesamservice/loadDataSet`
+ Pendapat:  
listcatFileOrDatasetName  
(required, string): nama kumpulan data.  
DatasetFile  
(wajib, string): nama file kumpulan data.
+ Mengembalikan status permintaan dan kumpulan data yang dimuat.

### Memuat kumpulan data dari bucket Amazon S3
<a name="ba-load-data-set-s3"></a>

Memuat kumpulan data menggunakan file listcat dari bucket Amazon S3.
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ 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
<a name="ba-export-data-set-s3"></a>

Mengekspor kumpulan data ke bucket Amazon S3 yang ditentukan.
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ 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
<a name="ba-clear-data-set"></a>

 Menghapus semua catatan dari kumpulan data.
+ Metode yang didukung: POST, GET
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ Jalan: `/api/services/rest/bluesamservice/clearDataSet`
+ Pendapat:   
name  
(required, string): nama kumpulan data untuk dihapus. Saat menggunakan metode GET, nama parameternya adalah`datasetName`.
+ Mengembalikan status permintaan.

### Hapus kumpulan data
<a name="ba-delete-data-set"></a>

Menghapus definisi dan catatan kumpulan data.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ 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
<a name="ba-count-data-set-records"></a>

Titik akhir ini mengembalikan jumlah catatan yang terkait dengan kumpulan data.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/bluesamservice/countRecords`
+ Pendapat:  
name  
(required, string): nama kumpulan data.
+ Pengembalian: jumlah catatan

## Data massal menetapkan titik akhir terkait
<a name="ba-endpoints-bac-bulk"></a>

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

**Topics**
+ [Ekspor set data (GET)](#ba-export-data-sets-get)
+ [Ekspor set data (POST)](#ba-export-data-sets-post)
+ [Buat beberapa set data](#ba-create-multiple-data-sets)
+ [Daftar semua set data](#ba-list-all-data-sets)
+ [Daftar langsung semua set data](#ba-direct-list-all-data-sets)
+ [Daftar langsung semua kumpulan data berdasarkan halaman](#ba-direct-list-all-data-sets-by-page)
+ [Kumpulan data aliran](#ba-stream-data-sets)
+ [Hapus semua set data](#ba-delete-all-data-sets)
+ [Dapatkan definisi kumpulan data dari file listcat](#ba-get-definitions-listcat)
+ [Dapatkan definisi kumpulan data dari file cat daftar yang diunggah](#ba-get-definitions-uploaded-listcat)
+ [Dapatkan kumpulan data](#ba-get-data-set)
+ [Muat listcat dari file JSON](#ba-load-listcat)

### Ekspor set data (GET)
<a name="ba-export-data-sets-get"></a>
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ 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  
(wajib, boolean): apakah Anda ingin kata deskriptor catatan (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)
<a name="ba-export-data-sets-post"></a>
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/bluesamservice/exportDataSet`
+ Pendapat:  
DumpParameter  
(wajib, BACRead Parameter): Parameter baca Bluesam.
+ Mengembalikan status kumpulan data yang diekspor.

### Buat beberapa set data
<a name="ba-create-multiple-data-sets"></a>
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ 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
<a name="ba-list-all-data-sets"></a>
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/bluesamservice/listDataSet`
+ Argumen: Tidak ada
+ Pengembalian: status permintaan dan daftar kumpulan data.

### Daftar langsung semua set data
<a name="ba-direct-list-all-data-sets"></a>
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/bluesamservice/directListDataSet`
+ Argumen: Tidak ada
+ Pengembalian: status permintaan dan daftar kumpulan data.

### Daftar langsung semua kumpulan data berdasarkan halaman
<a name="ba-direct-list-all-data-sets-by-page"></a>
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/bluesamservice/directListDataSetByPage`
+ Pendapat:  
name  
(required, string): nama kumpulan data. Default ke `%` (semua set data) jika tidak ditentukan.  
halaman  
(wajib, int): nomor halaman (minimal 0).  
pageSize  
(wajib, int): ukuran halaman (minimal 1, maksimum 500).
+ Pengembalian: status permintaan dan daftar kumpulan data.

### Kumpulan data aliran
<a name="ba-stream-data-sets"></a>
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ 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
<a name="ba-delete-all-data-sets"></a>
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ Jalan: `/api/services/rest/bluesamservice/removeAll`
+ Argumen: Tidak ada
+ Pengembalian: boolean yang mewakili status permintaan.

### Dapatkan definisi kumpulan data dari file listcat
<a name="ba-get-definitions-listcat"></a>
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ 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
<a name="ba-get-definitions-uploaded-listcat"></a>
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ Jalan: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat`
+ Argumen: Tidak ada
+ Pengembalian: daftar set data

### Dapatkan kumpulan data
<a name="ba-get-data-set"></a>
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/bluesamservice/getDataSet`
+ Pendapat:  
name  
(required, string): nama kumpulan data.
+ Mengembalikan kumpulan data yang diminta.

### Muat listcat dari file JSON
<a name="ba-load-listcat"></a>
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ Jalan: `/api/services/rest/bluesamservice/loadListcatFromJsonFile`
+ Pendapat:   
filePath  
(required, string): Jalur ke file listcat.
+ Pengembalian: daftar set data

## Catatan
<a name="ba-endpoints-bac-records"></a>

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

**Topics**
+ [Buat catatan](#ba-create-record)
+ [Baca kumpulan data](#ba-read-data-set)
+ [Hapus catatan](#ba-delete-record)
+ [Perbarui catatan](#ba-update-record)
+ [Simpan catatan](#ba-save-record)
+ [Validasi catatan](#ba-validate-record)
+ [Dapatkan pohon rekor](#ba-get-record-tree)

### Buat catatan
<a name="ba-create-record"></a>

Anda dapat menggunakan endpoint ini untuk membuat record baru.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ 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.

### Baca kumpulan data
<a name="ba-read-data-set"></a>

Anda dapat menggunakan endpoint ini untuk membaca kumpulan data.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/crud/readDataSet`
+ Pendapat:  
set data  
(required, DataSet): objek kumpulan data.
+ Mengembalikan status permintaan dan set data dengan catatan.

### Hapus catatan
<a name="ba-delete-record"></a>

Anda dapat menggunakan titik akhir ini untuk menghapus catatan dari kumpulan data.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ 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
<a name="ba-update-record"></a>

Anda dapat menggunakan titik akhir ini untuk memperbarui rekaman yang terkait dengan kumpulan data.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/crud/updateRecord`
+ Pendapat:  
set data  
(wajib, DataSet): objek kumpulan data  
catatan  
(wajib, Rekam): catatan untuk memperbarui  
mask  
(opsional, Mask): objek topeng untuk diterapkan selama pembaruan.
+ Mengembalikan status permintaan dan set data dengan catatan.

### Simpan catatan
<a name="ba-save-record"></a>

Anda dapat menggunakan titik akhir ini untuk menyimpan catatan ke kumpulan data dan menggunakan topeng.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/crud/saveRecord`
+ Pendapat:  
set data  
(wajib, DataSet): objek kumpulan data  
catatan  
(wajib, Rekam): catatan untuk disimpan  
mask  
(opsional, Mask): objek topeng untuk diterapkan selama penyimpanan.
+ Mengembalikan status permintaan dan set data dengan catatan.

### Validasi catatan
<a name="ba-validate-record"></a>

Gunakan titik akhir ini untuk memvalidasi catatan.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/crud/validateRecord`
+ Pendapat:  
set data  
(wajib, DataSet): objek kumpulan data  
catatan  
(opsional, Rekam): catatan untuk memvalidasi.  
mask  
(opsional, Mask): objek mask untuk diterapkan selama validasi.
+ Mengembalikan status permintaan dan set data dengan catatan.

### Dapatkan pohon rekor
<a name="ba-get-record-tree"></a>

Gunakan titik akhir ini untuk mendapatkan pohon hierarkis catatan.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/crud/getRecordTree`
+ Pendapat:  
set data  
(wajib, DataSet): objek kumpulan data  
catatan  
(wajib, Rekam): catatan yang akan diambil  
mask  
(opsional, Mask): objek topeng.
+ Mengembalikan status permintaan dan pohon hierarkis dari catatan yang diminta.

## Masker
<a name="ba-endpoints-bac-masks"></a>

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

**Topics**
+ [Muat masker](#ba-load-mask)
+ [Oleskan masker](#ba-apply-mask)
+ [Terapkan filter masker](#ba-apply-mask-filter)

### Muat masker
<a name="ba-load-mask"></a>

Anda dapat menggunakan endpoint ini untuk mengambil semua mask yang terkait dengan kumpulan data tertentu.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ 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
<a name="ba-apply-mask"></a>

Anda dapat menggunakan endpoint ini untuk menerapkan mask ke kumpulan data tertentu.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ 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
<a name="ba-apply-mask-filter"></a>

Anda dapat menggunakan endpoint ini untuk menerapkan mask dan filter ke kumpulan data tertentu.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/crud/applyMaskFilter`
+ Pendapat:  
set data  
(wajib, DataSet): objek kumpulan data  
mask  
(wajib, Mask): objek topeng  
filter  
(wajib, Filter): objek filter untuk diterapkan.
+ Mengembalikan status permintaan dan kumpulan data dengan masker dan filter yang diterapkan.

## Lainnya
<a name="ba-endpoints-bac-other"></a>

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

**Topics**
+ [Periksa cache pemanasan](#ba-check-warm-up-cache)
+ [Periksa cache diaktifkan](#ba-check-cache-enabled)
+ [Aktifkan cache](#ba-enable-cache)
+ [Periksa cache RAM yang dialokasikan](#ba-check-allocated-ram-cache)
+ [Periksa kegigihan](#ba-check-persistence)
+ [Periksa tipe kumpulan data yang didukung](#ba-check-supported-data-set-types)
+ [Periksa kesehatan server](#ba-check-server-health)
+ [Periksa konfigurasi multi-skema PostgreSQL](#ba-check-postgres-multi-schema)

### Periksa cache pemanasan
<a name="ba-check-warm-up-cache"></a>

Memeriksa apakah cache pemanasan diaktifkan untuk kumpulan data tertentu.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ 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
<a name="ba-check-cache-enabled"></a>

Memeriksa apakah cache diaktifkan untuk kumpulan data tertentu.
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/bluesamservice/isEnableCache`
+ Argumen: Tidak ada
+ Mengembalikan nilai true jika caching diaktifkan.

### Aktifkan cache
<a name="ba-enable-cache"></a>
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_ADMIN dan ROLE\_SUPER\_ADMIN.
+ Jalan: `/api/services/rest/bluesamservice/enableDisableCache/{enable}`
+ Pendapat:   
memungkinkan  
(required, boolean): jika disetel ke true, itu akan mengaktifkan caching.  
set data  
(required, DataSet): objek kumpulan data.
+ Mengembalikan Tidak Ada

### Periksa cache RAM yang dialokasikan
<a name="ba-check-allocated-ram-cache"></a>

Anda dapat menggunakan endpoint ini untuk mengambil memori cache RAM yang dialokasikan.
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/bluesamservice/allocatedRamCache`
+ Argumen: Tidak ada
+ Pengembalian: ukuran memori sebagai string

### Periksa kegigihan
<a name="ba-check-persistence"></a>
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/bluesamservice/persistence`
+ Argumen: Tidak ada
+ Pengembalian: persistensi digunakan sebagai string

### Periksa tipe kumpulan data yang didukung
<a name="ba-check-supported-data-set-types"></a>
+ Metode yang didukung: GET
+ Jalan: `/api/services/rest/bluesamservice/getDataSetTypes`
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Argumen: Tidak ada
+ Pengembalian: daftar tipe kumpulan data yang didukung sebagai daftar string.

### Periksa kesehatan server
<a name="ba-check-server-health"></a>
+ Metode yang didukung: GET
+ Jalan: `/api/services/rest/bluesamserver/serverIsUp`
+ Argumen: Tidak ada
+ Pengembalian: Tidak ada. Kode status respons HTTP 200 menunjukkan bahwa server aktif dan berjalan.

### Periksa konfigurasi multi-skema PostgreSQL
<a name="ba-check-postgres-multi-schema"></a>

Memeriksa apakah konfigurasi multi-skema PostgreSQL diaktifkan.
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_USER.
+ Jalan: `/api/services/rest/bluesamservice/isPostgresMultiSchema`
+ Argumen: Tidak ada
+ Pengembalian: true jika konfigurasi multi-skema PostgreSQL diaktifkan dan false sebaliknya.

## Titik akhir manajemen pengguna BAC
<a name="ba-endpoints-bac-users"></a>

Gunakan titik akhir berikut untuk mengelola interaksi pengguna.

**Topics**
+ [Masuk ke pengguna](#ba-log-user-in)
+ [Verifikasi apakah setidaknya ada satu pengguna dalam sistem](#ba-verify-at-least-one-user-exists)
+ [Rekam pengguna baru](#ba-record-new-user)
+ [Dapatkan info pengguna](#ba-user-info)
+ [Daftar pengguna](#ba-list-users)
+ [Hapus pengguna](#ba-delete-user)
+ [Log keluar pengguna saat ini](#ba-log-user-out)

### Masuk ke pengguna
<a name="ba-log-user-in"></a>
+ Metode yang didukung: POST
+ Jalan: `/api/services/security/servicelogin/login`
+ Argumen: Tidak ada
+ Mengembalikan serialisasi JSON `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
<a name="ba-verify-at-least-one-user-exists"></a>
+ 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
<a name="ba-record-new-user"></a>
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ Jalan: `/api/services/security/servicelogin/recorduser`
+ Argumen: serialisasi JSON dari `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 fasilitas BAC dan titik akhir.
+ Mengembalikan nilai boolean `true` jika pengguna berhasil dibuat. Mengembalikan `false` sebaliknya.
+ Permintaan sampel JSON:

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

  Berikut ini adalah dua nilai yang valid untuk`roleName`: 
  + `ROLE_ADMIN`: dapat mengelola Blusam sumber daya dan pengguna.
  + `ROLE_USER`: dapat mengelola Blusam sumber daya tetapi tidak pengguna.

### Dapatkan info pengguna
<a name="ba-user-info"></a>
+ 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
<a name="ba-list-users"></a>
+ Metode yang didukung: GET
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ Jalan: `/api/services/security/servicelogin/listusers`
+ Argumen: Tidak ada
+ Mengembalikan daftar`com.netfective.bluage.bac.entities.SignOn`, serial sebagai JSON.

### Hapus pengguna
<a name="ba-delete-user"></a>

**penting**  
Tindakan ini tidak dapat dibatalkan. Pengguna yang dihapus tidak akan dapat terhubung ke aplikasi BAC lagi.
+ Metode yang didukung: POST
+ Memerlukan otentikasi dan peran ROLE\_ADMIN.
+ Jalan: `/api/services/security/servicelogin/deleteuser`
+ Argumen: serialisasi JSON dari `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
<a name="ba-log-user-out"></a>
+ Metode yang didukung: GET
+ Jalan: `/api/services/security/servicelogout/logout`
+ Argumen: Tidak ada
+ Mengembalikan pesan JSON `{"success":true}` jika pengguna saat ini berhasil keluar. Sesi HTTP terkait akan dibatalkan.