AWS Mainframe Modernization Service （受管執行期環境體驗） 不再開放給新客戶使用。對於與 AWS Mainframe Modernization Service （受管執行期環境體驗） 類似的功能，探索 AWS Mainframe Modernization Service （自我管理體驗）。現有客戶可以繼續正常使用該服務。如需詳細資訊，請參閱[AWS 大型主機現代化可用性變更](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html)。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Blusam 應用程式主控台 REST 端點
<a name="ba-endpoints-bac"></a>

在本節中，您可以了解Blusam應用程式主控台，這是一個 API，旨在簡化現代化 VSAM 資料集的管理。Blusam Web 應用程式的端點使用根路徑 `/bac`。

**Topics**
+ [資料集相關端點](#ba-endpoints-bac-datasets)
+ [大量資料集相關端點](#ba-endpoints-bac-bulk)
+ [記錄](#ba-endpoints-bac-records)
+ [遮罩](#ba-endpoints-bac-masks)
+ [其他](#ba-endpoints-bac-other)
+ [BAC 使用者管理端點](#ba-endpoints-bac-users)

## 資料集相關端點
<a name="ba-endpoints-bac-datasets"></a>

使用下列端點來建立或管理特定資料集。

**Topics**
+ [建立資料集](#ba-create-data-set)
+ [上傳檔案](#ba-upload-file)
+ [載入資料集 (POST)](#ba-load-data-set-post)
+ [載入資料集 (GET)](#ba-load-data-set-get)
+ [從 Amazon S3 儲存貯體載入資料集](#ba-load-data-set-s3)
+ [將資料集匯出至 Amazon S3 儲存貯體](#ba-export-data-set-s3)
+ [清除資料集](#ba-clear-data-set)
+ [刪除資料集](#ba-delete-data-set)
+ [計數資料集記錄](#ba-count-data-set-records)

### 建立資料集
<a name="ba-create-data-set"></a>

您可以使用此端點來建立資料集定義。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/createDataSet`
+ 引數：  
name  
（必要，字串）：資料集的名稱。  
type  
（必要，字串）：資料集類型。可能的值為：`ESDS`、`KSDS`、`RRDS`。  
recordSize  
（選用，字串）：資料集每個記錄的大小上限。  
fixedLength  
（選用，布林值） ：指出記錄長度是否固定。  
壓縮  
（選用，布林值） ：指出資料集是否已壓縮。  
cacheEnable  
（選用，布林值） ：指出是否已為資料集啟用快取。  
alternativeKeys  
（選用，金鑰清單）：  
  + 位移 （必要，數字）
  + length （必要，數字）
  + name （必要，數字）
+ 傳回代表新建立資料集的 JSON 檔案。

範例請求：

```
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
}
```

回應範例：

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

### 上傳檔案
<a name="ba-upload-file"></a>

您可以使用此端點將檔案上傳至伺服器。檔案會存放在對應至每個特定使用者的暫時資料夾中。每次您需要上傳檔案時，都使用此端點。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/upload`
+ 引數：  
file  
（必要，分段/表單資料）：要上傳的檔案。
+ 傳回反映上傳狀態的布林值

### 載入資料集 (POST)
<a name="ba-load-data-set-post"></a>

使用 `createDataSet`建立資料集定義後，您可以將與上傳檔案相關聯的記錄載入至特定資料集。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/loadDataSet`
+ 引數：  
name  
（必要，字串）：資料集的名稱。
+ 傳回請求的狀態和載入的資料集。

### 載入資料集 (GET)
<a name="ba-load-data-set-get"></a>
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/loadDataSet`
+ 引數：  
listcatFileOrDatasetName  
（必要，字串）：資料集的名稱。  
datasetFile  
（必要，字串）：資料集檔案名稱。
+ 傳回請求的狀態和載入的資料集。

### 從 Amazon S3 儲存貯體載入資料集
<a name="ba-load-data-set-s3"></a>

使用 listcat 檔案從 Amazon S3 儲存貯體載入資料集。
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/loadDataSetFromS3`
+ 引數：  
listcatFileS3Location  
（必要，字串）：Listcat 檔案的 Amazon S3 位置。  
datasetFileS3Location  
（必要，字串）：資料集檔案的 Amazon S3 位置。  
region  
（必要，字串）：存放檔案的 Amazon S3 AWS 區域 。
+ 傳回新建立的資料集

範例請求：

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

### 將資料集匯出至 Amazon S3 儲存貯體
<a name="ba-export-data-set-s3"></a>

將資料集匯出至指定的 Amazon S3 儲存貯體。
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/exportDataSetToS3`
+ 引數：  
s3Location  
（必要，字串）：匯出資料集的 Amazon S3 位置。  
datasetName   
（必要，字串）：要匯出的資料集名稱。  
region  
（必要，字串）：Amazon S3 儲存貯 AWS 區域 體的 。  
kmsKeyId  
（選用，字串）：用於將匯出資料集加密至 Amazon S3 儲存貯體的 AWS KMS ID。
+ 傳回匯出的資料集

範例請求：

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

### 清除資料集
<a name="ba-clear-data-set"></a>

 清除資料集中的所有記錄。
+ 支援的方法：POST、GET
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/clearDataSet`
+ 引數：  
name  
（必要，字串）：要清除的資料集名稱。使用 GET 方法時，參數名稱為 `datasetName`。
+ 傳回請求的狀態。

### 刪除資料集
<a name="ba-delete-data-set"></a>

刪除資料集定義和記錄。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/deleteDataSet`
+ 引數：  
name  
（必要，字串）：要刪除的資料集名稱。
+ 傳回請求的狀態和已刪除的資料集。

### 計數資料集記錄
<a name="ba-count-data-set-records"></a>

此端點會傳回與資料集相關聯的記錄數目。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/bluesamservice/countRecords`
+ 引數：  
name  
（必要，字串）：資料集的名稱。
+ 傳回：記錄的數量

## 大量資料集相關端點
<a name="ba-endpoints-bac-bulk"></a>

使用下列端點一次建立或管理多個資料集。

**Topics**
+ [匯出資料集 (GET)](#ba-export-data-sets-get)
+ [匯出資料集 (POST)](#ba-export-data-sets-post)
+ [建立多個資料集](#ba-create-multiple-data-sets)
+ [列出所有資料集](#ba-list-all-data-sets)
+ [直接列出所有資料集](#ba-direct-list-all-data-sets)
+ [依頁面直接列出所有資料集](#ba-direct-list-all-data-sets-by-page)
+ [串流資料集](#ba-stream-data-sets)
+ [刪除所有資料集](#ba-delete-all-data-sets)
+ [從 listcat 檔案取得資料集定義](#ba-get-definitions-listcat)
+ [從上傳的清單目錄檔案取得資料集定義](#ba-get-definitions-uploaded-listcat)
+ [取得資料集](#ba-get-data-set)
+ [從 JSON 檔案載入 listcat](#ba-load-listcat)

### 匯出資料集 (GET)
<a name="ba-export-data-sets-get"></a>
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/exportDataSet`
+ 引數：  
datasetName  
（必要，字串）：要匯出的資料集名稱。  
datasetOutputFile  
（必要，字串）：您要在伺服器上存放匯出資料集的資料夾路徑。  
rdw  
（必要，布林值）：您是否希望記錄描述項字詞 (RDW) 成為匯出記錄的一部分。如果資料集具有固定長度的記錄，則會忽略此參數的值。
+ 傳回請求的狀態，以及包含匯出資料集之檔案的路徑 （如果有的話）。如果回應中的資料集為 null，表示系統找不到具有指定名稱的資料集。

### 匯出資料集 (POST)
<a name="ba-export-data-sets-post"></a>
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/bluesamservice/exportDataSet`
+ 引數：  
dumpParameters  
（必要，BACReadParameters)：Bluesam 讀取參數。
+ 傳回匯出資料集的狀態。

### 建立多個資料集
<a name="ba-create-multiple-data-sets"></a>
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/createAllDataSets`
+ 引數：
  + 資料集清單  
name  
（必要，字串）：資料集的名稱。  
type  
（必要，字串）：資料集類型。可能的值為：`ESDS`、`KSDS`、`RRDS`。  
recordSize  
（選用，字串） ：資料集每個記錄的大小上限。  
fixedLength  
（選用，布林值） ：指出記錄長度是否固定。  
壓縮  
（選用，布林值） ：指出資料集是否已壓縮。  
cacheEnable  
（選用，布林值） ：指出是否已為資料集啟用快取。
+ 傳回：請求的狀態和新建立的資料集。

### 列出所有資料集
<a name="ba-list-all-data-sets"></a>
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/bluesamservice/listDataSet`
+ 引數：無
+ 傳回：請求的狀態和資料集的清單。

### 直接列出所有資料集
<a name="ba-direct-list-all-data-sets"></a>
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/bluesamservice/directListDataSet`
+ 引數：無
+ 傳回：請求的狀態和資料集的清單。

### 依頁面直接列出所有資料集
<a name="ba-direct-list-all-data-sets-by-page"></a>
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/bluesamservice/directListDataSetByPage`
+ 引數：  
name  
（必要，字串）：資料集的名稱。如果未指定，則預設為 `%`（所有資料集）。  
page  
（必要，整數）：頁碼 （最低 0)。  
pageSize  
（必要，整數）：頁面大小 （下限 1，上限為 500)。
+ 傳回：請求的狀態和資料集的清單。

### 串流資料集
<a name="ba-stream-data-sets"></a>
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/streamDataset`
+ 引數：  
datasetName  
（必要，字串）：資料集的名稱。
+ 傳回：請求的資料集串流。

### 刪除所有資料集
<a name="ba-delete-all-data-sets"></a>
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/removeAll`
+ 引數：無
+ 傳回：代表請求狀態的布林值。

### 從 listcat 檔案取得資料集定義
<a name="ba-get-definitions-listcat"></a>
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/getDataSetsDefinitionFromListcat`
+ 引數：  
paramFilePath  
（必要，字串）：Listcat 檔案的路徑。
+ 傳回：資料集清單

### 從上傳的清單目錄檔案取得資料集定義
<a name="ba-get-definitions-uploaded-listcat"></a>
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat`
+ 引數：無
+ 傳回：資料集清單

### 取得資料集
<a name="ba-get-data-set"></a>
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/bluesamservice/getDataSet`
+ 引數：  
name  
（必要，字串）：資料集的名稱。
+ 傳回請求的資料集。

### 從 JSON 檔案載入 listcat
<a name="ba-load-listcat"></a>
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/loadListcatFromJsonFile`
+ 引數：  
filePath  
（必要，字串）：Listcat 檔案的路徑。
+ 傳回：資料集清單

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

使用下列端點來建立或管理資料集內的記錄。

**Topics**
+ [建立記錄](#ba-create-record)
+ [讀取資料集](#ba-read-data-set)
+ [刪除記錄](#ba-delete-record)
+ [更新記錄](#ba-update-record)
+ [儲存記錄](#ba-save-record)
+ [驗證記錄](#ba-validate-record)
+ [取得記錄樹狀目錄](#ba-get-record-tree)

### 建立記錄
<a name="ba-create-record"></a>

您可以使用此端點來建立新的記錄。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/crud/createRecord`
+ 引數：  
dataset  
（必要，DataSet)：資料集物件  
遮罩  
（必要，遮罩）：遮罩物件。
+ 傳回請求的狀態和建立的記錄。

### 讀取資料集
<a name="ba-read-data-set"></a>

您可以使用此端點來讀取資料集。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/crud/readDataSet`
+ 引數：  
dataset  
（必要，DataSet)：資料集物件。
+ 傳回請求的狀態，以及包含記錄的資料集。

### 刪除記錄
<a name="ba-delete-record"></a>

您可以使用此端點從資料集刪除記錄。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/crud/deleteRecord`
+ 引數：  
dataset  
（必要，DataSet)：資料集物件  
record  
（必要，記錄）：要刪除的記錄
+ 傳回刪除的狀態。

### 更新記錄
<a name="ba-update-record"></a>

您可以使用此端點來更新與資料集相關聯的記錄。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/crud/updateRecord`
+ 引數：  
dataset  
（必要，DataSet)：資料集物件  
record  
（必要，記錄）：要更新的記錄  
遮罩  
（選用，遮罩）：更新期間要套用的遮罩物件。
+ 傳回請求的狀態，以及包含記錄的資料集。

### 儲存記錄
<a name="ba-save-record"></a>

您可以使用此端點，將記錄儲存至資料集並使用遮罩。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/crud/saveRecord`
+ 引數：  
dataset  
（必要，DataSet)：資料集物件  
record  
（必要，記錄）：要儲存的記錄  
遮罩  
（選用，遮罩）：儲存期間要套用的遮罩物件。
+ 傳回請求的狀態，以及包含記錄的資料集。

### 驗證記錄
<a name="ba-validate-record"></a>

使用此端點來驗證記錄。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/crud/validateRecord`
+ 引數：  
dataset  
（必要，DataSet)：資料集物件  
record  
（選用，記錄）：要驗證的記錄。  
遮罩  
（選用，遮罩）：驗證期間要套用的遮罩物件。
+ 傳回請求的狀態，以及包含記錄的資料集。

### 取得記錄樹狀目錄
<a name="ba-get-record-tree"></a>

使用此端點來取得記錄的階層樹狀目錄。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/crud/getRecordTree`
+ 引數：  
dataset  
（必要，DataSet)：資料集物件  
record  
（必要，記錄）：要擷取的記錄  
遮罩  
（選用，遮罩）：遮罩物件。
+ 傳回請求的狀態和請求記錄的階層樹狀目錄。

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

使用下列端點將遮罩載入或套用至資料集。

**Topics**
+ [載入遮罩](#ba-load-mask)
+ [套用遮罩](#ba-apply-mask)
+ [套用遮罩篩選條件](#ba-apply-mask-filter)

### 載入遮罩
<a name="ba-load-mask"></a>

您可以使用此端點來擷取與特定資料集相關聯的所有遮罩。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/crud/loadMasks`
+ 路徑變數：  
recordSize：.../loadMasks/\$1recordSize\$1  
（選用，數值）：記錄大小，篩選符合此記錄大小的已載入遮罩
+ 引數：  
dataset  
（必要，DataSet)：資料集物件
+ 傳回請求的狀態和遮罩清單。

### 套用遮罩
<a name="ba-apply-mask"></a>

您可以使用此端點將遮罩套用至特定資料集。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/crud/applyMask`
+ 引數：  
dataset  
（必要，DataSet)：資料集物件  
遮罩  
（必要，遮罩）：資料集物件
+ 傳回請求的狀態，以及已套用遮罩的資料集。

### 套用遮罩篩選條件
<a name="ba-apply-mask-filter"></a>

您可以使用此端點，將遮罩和篩選條件套用至特定資料集。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/crud/applyMaskFilter`
+ 引數：  
dataset  
（必要，DataSet)：資料集物件  
遮罩  
（必要，遮罩）：遮罩物件  
篩選條件  
（必要，篩選條件）：要套用的篩選條件物件。
+ 傳回請求的狀態，以及具有套用遮罩和篩選條件的資料集。

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

使用下列端點來管理資料集的快取或檢查資料集特性

**Topics**
+ [檢查暖機快取](#ba-check-warm-up-cache)
+ [檢查快取已啟用](#ba-check-cache-enabled)
+ [啟用快取](#ba-enable-cache)
+ [檢查配置的 RAM 快取](#ba-check-allocated-ram-cache)
+ [檢查持久性](#ba-check-persistence)
+ [檢查支援的資料集類型](#ba-check-supported-data-set-types)
+ [檢查伺服器運作狀態](#ba-check-server-health)
+ [檢查 PostgreSQL 多結構描述組態](#ba-check-postgres-multi-schema)

### 檢查暖機快取
<a name="ba-check-warm-up-cache"></a>

檢查是否已針對特定資料集啟用暖機快取。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/warmupCache`
+ 引數：  
name  
（必要，字串）：資料集的名稱。
+ 傳回：如果暖機快取已啟用，則為 true，否則為 false。

### 檢查快取已啟用
<a name="ba-check-cache-enabled"></a>

檢查是否針對特定資料集啟用快取。
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/bluesamservice/isEnableCache`
+ 引數：無
+ 如果啟用快取，則傳回 true。

### 啟用快取
<a name="ba-enable-cache"></a>
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 和 ROLE\$1SUPER\$1ADMIN 角色。
+ 路徑： `/api/services/rest/bluesamservice/enableDisableCache/{enable}`
+ 引數：  
啟用  
（必要，布林值）：如果設定為 true，則會啟用快取。  
dataset  
（必要，DataSet)：資料集物件。
+ 傳回無

### 檢查配置的 RAM 快取
<a name="ba-check-allocated-ram-cache"></a>

您可以使用此端點來擷取配置的 RAM 快取記憶體。
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/bluesamservice/allocatedRamCache`
+ 引數：無
+ 傳回：做為字串的記憶體大小

### 檢查持久性
<a name="ba-check-persistence"></a>
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/bluesamservice/persistence`
+ 引數：無
+ 傳回：用作字串的持久性

### 檢查支援的資料集類型
<a name="ba-check-supported-data-set-types"></a>
+ 支援的方法：GET
+ 路徑： `/api/services/rest/bluesamservice/getDataSetTypes`
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 引數：無
+ 傳回：支援的資料集類型清單做為字串清單。

### 檢查伺服器運作狀態
<a name="ba-check-server-health"></a>
+ 支援的方法：GET
+ 路徑： `/api/services/rest/bluesamserver/serverIsUp`
+ 引數：無
+ 傳回：無。HTTP 回應狀態碼 200 表示伺服器已啟動並執行。

### 檢查 PostgreSQL 多結構描述組態
<a name="ba-check-postgres-multi-schema"></a>

檢查是否已啟用 PostgreSQL 多結構描述組態。
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1USER 角色。
+ 路徑： `/api/services/rest/bluesamservice/isPostgresMultiSchema`
+ 引數：無
+ 如果 PostgreSQL 多結構描述組態已啟用，則傳回： true，否則傳回 false。

## BAC 使用者管理端點
<a name="ba-endpoints-bac-users"></a>

使用下列端點來管理使用者互動。

**Topics**
+ [在 中記錄使用者](#ba-log-user-in)
+ [驗證系統中是否至少有一個使用者](#ba-verify-at-least-one-user-exists)
+ [記錄新使用者](#ba-record-new-user)
+ [取得使用者資訊](#ba-user-info)
+ [列出使用者](#ba-list-users)
+ [刪除使用者](#ba-delete-user)
+ [登出目前的使用者](#ba-log-user-out)

### 在 中記錄使用者
<a name="ba-log-user-in"></a>
+ 支援的方法：POST
+ 路徑： `/api/services/security/servicelogin/login`
+ 引數：無
+ 傳回`com.netfective.bluage.bac.entities.SignOn`物件的 JSON 序列化，代表目前請求中提供其登入資料的使用者。密碼會從傳回物件的檢視中隱藏。正在列出提供給使用 的角色。

回應範例：

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

### 驗證系統中是否至少有一個使用者
<a name="ba-verify-at-least-one-user-exists"></a>
+ 支援的方法：GET
+ 路徑： `/api/services/security/servicelogin/hasAccount`
+ 引數：無
+ `true` 如果已建立預設超級管理員使用者以外的至少一個使用者，則傳回布林值。`false` 否則傳回 。

### 記錄新使用者
<a name="ba-record-new-user"></a>
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/security/servicelogin/recorduser`
+ 引數：代表要新增至儲存體之使用者的`com.netfective.bluage.bac.entities.SignOn`物件 JSON 序列化。必須定義使用者的角色，否則使用者可能無法使用 BAC 設施和端點。
+ `true` 如果使用者已成功建立，則傳回布林值。`false` 否則傳回 。
+ 請求 JSON 範例：

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

  以下是 的兩個有效值`roleName`：
  + `ROLE_ADMIN`： 可以管理Blusam資源和使用者。
  + `ROLE_USER`： 可以管理Blusam資源，但無法管理使用者。

### 取得使用者資訊
<a name="ba-user-info"></a>
+ 支援的方法：GET
+ 路徑： `/api/services/security/servicelogin/userInfo`
+ 引數：無
+ 傳回目前連線使用者的使用者名稱和角色

### 列出使用者
<a name="ba-list-users"></a>
+ 支援的方法：GET
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/security/servicelogin/listusers`
+ 引數：無
+ 傳回`com.netfective.bluage.bac.entities.SignOn`序列化為 JSON 的 清單。

### 刪除使用者
<a name="ba-delete-user"></a>

**重要**  
這個操作無法復原。刪除的使用者將無法再次連線至 BAC 應用程式。
+ 支援的方法：POST
+ 需要身分驗證和 ROLE\$1ADMIN 角色。
+ 路徑： `/api/services/security/servicelogin/deleteuser`
+ 引數：代表要從儲存體中移除之使用者的`com.netfective.bluage.bac.entities.SignOn`物件 JSON 序列化。
+ `true` 如果使用者已成功移除，則傳回布林值。

### 登出目前的使用者
<a name="ba-log-user-out"></a>
+ 支援的方法：GET
+ 路徑： `/api/services/security/servicelogout/logout`
+ 引數：無
+ `{"success":true}` 如果目前的使用者已成功登出，則傳回 JSON 訊息。相關的 HTTP 工作階段將會失效。