7.2.4. ブランチ
ナレッジストア REST API は Business Central のブランチを管理するための以下のエンドポイントをサポートします。ナレッジストア REST API のベース URL は http://SERVER:PORT/decision-central/rest/ です。ユーザーロール rest-all では、すべての要求で HTTP の Basic 認証またはトークンベースの認証が必要です。
- [GET] /spaces/{spaceName}/projects/{projectName}/branches
指定のプロジェクトおよびスペースにあるブランチをすべて返します。
表7.16 要求パラメーター
Name 説明 タイプ 要件 spaceName取得するプロジェクトのスペース名
文字列
必須
projectNameブランチを取得するためのプロジェクト名
文字列
必須
サーバーの応答例 (JSON)
[ { "name":"master" } ]- [POST] /spaces/{spaceName}/projects/{projectName}/branches
指定のプロジェクトおよびスペースに、指定したブランチを追加します。
表7.17 要求パラメーター
Name 説明 タイプ 要件 spaceNameプロジェクトのあるスペースの名前
文字列
必須
projectName新しくブランチを作成する必要があるプロジェクトの名前
文字列
必須
ボディ
プロジェクトの
newBranchNameとbaseBranchName要求ボディ
必須
要求ボディ (JSON) 例
{ "newBranchName": "branch01", "baseBranchName": "master" }サーバーの応答例 (JSON)
{ "jobId": "1576175811141-3", "status": "APPROVED", "spaceName": "Space123", "projectName": "ProjABC", "newBranchName": "b1", "baseBranchName": "master", "userIdentifier": "bc" }- [DELETE] /spaces/{spaceName}/projects/{projectName}/branches/{branchName}
指定のプロジェクトおよびスペースから、指定したブランチを削除します。
表7.18 要求パラメーター
Name 説明 タイプ 要件 spaceNameプロジェクトのあるスペースの名前
文字列
必須
projectNameブランチが配置されているプロジェクトの名前
文字列
必須
branchName削除するブランチの名前
文字列
必須
サーバーの応答例 (JSON)
{ "jobId": "1576175811421-5", "status": "APPROVED", "spaceName": "Space123", "projectName": "ProjABC", "branchName": "b1", "userIdentifier": "bc" }- [POST] /spaces/{spaceName}/projects/{projectName}/branches/{branchName}/maven/compile
指定のプロジェクトおよびスペースで、指定したブランチをコンパイルします。
branchNameが指定されていない場合、要求は Master ブランチに適用されます。表7.19 要求パラメーター
Name 説明 タイプ 要件 spaceNameプロジェクトのあるスペースの名前
文字列
必須
projectNameブランチが配置されているプロジェクトの名前
文字列
必須
branchNameコンパイルするブランチの名前
文字列
必須
サーバーの応答例 (JSON)
{ "jobId": "1576175811233-4", "status": "APPROVED", "spaceName": "Space123", "projectName": "ProjABC", "branchName": "b1", }- [POST] /spaces/{spaceName}/projects/{projectName}/branches/{branchName}/maven/install
指定のプロジェクトおよびスペースに、指定したブランチをインストールします。
branchNameが指定されていない場合、要求は Master ブランチに適用されます。表7.20 要求パラメーター
Name 説明 タイプ 要件 spaceNameプロジェクトのあるスペースの名前
文字列
必須
projectNameブランチが配置されているプロジェクトの名前
文字列
必須
branchNameインストールするブランチの名前
文字列
必須
サーバーの応答例 (JSON)
{ "jobId": "1576175811233-4", "status": "APPROVED", "spaceName": "Space123", "projectName": "ProjABC", "branchName": "b1", }- [POST] /spaces/{spaceName}/projects/{projectName}/branches/{branchName}/maven/test
指定のプロジェクトおよびスペースで、指定したブランチをテストします。
branchNameが指定されていない場合、要求は Master ブランチに適用されます。表7.21 要求パラメーター
Name 説明 タイプ 要件 spaceNameプロジェクトが配置されているスペースの名前
文字列
必須
projectNameブランチが配置されているプロジェクトの名前
文字列
必須
branchNameテストするブランチの名前
文字列
必須
サーバーの応答例 (JSON)
{ "jobId": "1576175811233-4", "status": "APPROVED", "spaceName": "Space123", "projectName": "ProjABC", "branchName": "b1", }- [POST] /spaces/{spaceName}/projects/{projectName}/branches/{branchName}/maven/deploy
指定のプロジェクトおよびスペースで、指定したブランチをデプロイします。
branchNameが指定されていない場合、要求は Master ブランチに適用されます。表7.22 要求パラメーター
Name 説明 タイプ 要件 spaceNameプロジェクトのあるスペースの名前
文字列
必須
projectNameブランチが配置されているプロジェクトの名前
文字列
必須
branchNameデプロイするブランチの名前
文字列
必須
サーバーの応答例 (JSON)
{ "jobId": "1576175811233-4", "status": "APPROVED", "spaceName": "Space123", "projectName": "ProjABC", "branchName": "b1", }