28.2.4. ブランチ

ナレッジストア REST API は Business Central のブランチを管理するための以下のエンドポイントをサポートします。ナレッジストア REST API のベース URL は http://SERVER:PORT/business-central/rest/ です。ユーザーロール rest-all では、すべての要求で HTTP の Basic 認証またはトークンベースの認証が必要です。

[GET] /spaces/{spaceName}/projects/{projectName}/branches

指定のプロジェクトおよびスペースにあるブランチをすべて返します。

表28.16 要求パラメーター

Name説明タイプ要件

spaceName

取得するプロジェクトのスペース名

文字列

必須

projectName

ブランチを取得するためのプロジェクト名

文字列

必須

サーバーの応答例 (JSON)

[
  {
    "name":"master"
  }
]

[POST] /spaces/{spaceName}/projects/{projectName}/branches

指定のプロジェクトおよびスペースに、指定したブランチを追加します。

表28.17 要求パラメーター

Name説明タイプ要件

spaceName

プロジェクトのあるスペースの名前

文字列

必須

projectName

新しくブランチを作成する必要があるプロジェクトの名前

文字列

必須

ボディ

プロジェクトの newBranchNamebaseBranchName

要求ボディ

必須

要求ボディ (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}

指定のプロジェクトおよびスペースから、指定したブランチを削除します。

表28.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 ブランチに適用されます。

表28.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 ブランチに適用されます。

表28.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 ブランチに適用されます。

表28.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 ブランチに適用されます。

表28.22 要求パラメーター

Name説明タイプ要件

spaceName

プロジェクトのあるスペースの名前

文字列

必須

projectName

ブランチが配置されているプロジェクトの名前

文字列

必須

branchName

デプロイするブランチの名前

文字列

必須

サーバーの応答例 (JSON)

{
    "jobId":       "1576175811233-4",
    "status":      "APPROVED",
    "spaceName":   "Space123",
    "projectName": "ProjABC",
    "branchName":  "b1",
}