第 28 章 知识存储 Business Central 空间和项目的 REST API

流程

1. 识别您要向其发送 请求的相关 API 端点，如 [GET] /spaces 以检索 Business Central 中的空格。

2. 在 REST 客户端或 curl 工具中，为对 /space 的 GET 请求输入以下组件。根据您的用例调整任何请求详情。

   对于 REST 客户端：

   • 身份验证 ：使用 rest-all 角色输入 Business Central 用户的用户名和密码。

   • HTTP Headers ：设置以下标头：

     • 接受:application/json
   • HTTP 方法 ：设置为 GET。
   • URL ：输入知识库 REST API 基本 URL 和端点，如 http://localhost:8080/business-central/rest/spaces。

   对于 curl 工具：

   • - U ：输入 Business Central 用户的用户名和密码，以及 rest-all 角色。

   • - h : 设置以下标头：

     • 接受:application/json
   • -x ：设置为 GET。
   • URL ：输入知识库 REST API 基本 URL 和端点，如 http://localhost:8080/business-central/rest/spaces。

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -X GET "http://localhost:8080/business-central/rest/spaces"

3. 执行请求并查看 KIE 服务器响应。

   服务器响应示例(JSON)：

   [
     {
       "name": "MySpace",
       "description": null,
       "projects": [
         {
           "name": "Employee_Rostering",
           "spaceName": "MySpace",
           "groupId": "employeerostering",
           "version": "1.0.0-SNAPSHOT",
           "description": "Employee rostering problem optimisation using Planner. Assigns employees to shifts based on their skill.",
           "publicURIs": [
             {
               "protocol": "git",
               "uri": "git://localhost:9418/MySpace/example-Employee_Rostering"
             },
             {
               "protocol": "ssh",
               "uri": "ssh://localhost:8001/MySpace/example-Employee_Rostering"
             }
           ]
         },
         {
           "name": "Mortgage_Process",
           "spaceName": "MySpace",
           "groupId": "mortgage-process",
           "version": "1.0.0-SNAPSHOT",
           "description": "Getting started loan approval process in BPMN2, decision table, business rules, and forms.",
           "publicURIs": [
             {
               "protocol": "git",
               "uri": "git://localhost:9418/MySpace/example-Mortgage_Process"
             },
             {
               "protocol": "ssh",
               "uri": "ssh://localhost:8001/MySpace/example-Mortgage_Process"
             }
           ]
         }
       ],
       "owner": "admin",
       "defaultGroupId": "com.myspace"
     },
     {
       "name": "MySpace2",
       "description": null,
       "projects": [
         {
           "name": "IT_Orders",
           "spaceName": "MySpace",
           "groupId": "itorders",
           "version": "1.0.0-SNAPSHOT",
           "description": "Case Management IT Orders project",
           "publicURIs": [
             {
               "protocol": "git",
               "uri": "git://localhost:9418/MySpace/example-IT_Orders-1"
             },
             {
               "protocol": "ssh",
               "uri": "ssh://localhost:8001/MySpace/example-IT_Orders-1"
             }
           ]
         }
       ],
       "owner": "admin",
       "defaultGroupId": "com.myspace"
     }
   ]

4. 在 REST 客户端或 curl 实用程序中，发送另外一个带有以下组件的 API 请求，它向 /spaces/{spaceName}/projects 发送一个 POST 请求，以便在一个空间内创建一个项目。根据您的用例调整任何请求详情。

   对于 REST 客户端：

   • 身份验证 ：使用 rest-all 角色输入 Business Central 用户的用户名和密码。

   • HTTP Headers ：设置以下标头：

     • 接受:application/json
     • 接受语言:en-US
     • Content-Type:application/json
   • HTTP 方法 ：设置为 POST。
   • URL ：输入知识库 REST API 基本 URL 和端点，如 http://localhost:8080/business-central/rest/spaces/MySpace/projects。
   • 请求正文 ：添加带有新项目标识数据的 JSON 请求正文：

   {
     "name": "Employee_Rostering",
     "groupId": "employeerostering",
     "version": "1.0.0-SNAPSHOT",
     "description": "Employee rostering problem optimisation using Planner. Assigns employees to shifts based on their skill."
   }

   对于 curl 工具：

   • - U ：输入 Business Central 用户的用户名和密码，以及 rest-all 角色。

   • - h ：设置以下标头：

     • 接受:application/json
     • 接受语言 ：en-US （如果未定义，则 JVM 中的默认区域设置会反映）
     • Content-Type:application/json
   • -x ：设置为 POST。
   • URL ：输入知识库 REST API 基本 URL 和端点，如 http://localhost:8080/business-central/rest/spaces/MySpace/projects。
   • -d ：添加一个 JSON 请求正文或文件(@file.json)，带有新项目的标识数据：

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Accept-Language: en-US" -H "Content-Type: application/json" -X POST "http://localhost:8080/business-central/rest/spaces/MySpace/projects" -d "{ \"name\": \"Employee_Rostering\", \"groupId\": \"employeerostering\", \"version\": \"1.0.0-SNAPSHOT\", \"description\": \"Employee rostering problem optimisation using Planner. Assigns employees to shifts based on their skill.\"}"

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Accept-Language: en-US" -H "Content-Type: application/json" -X POST "http://localhost:8080/business-central/rest/spaces/MySpace/projects" -d @my-project.json

5. 执行请求并查看 KIE 服务器响应。

   服务器响应示例(JSON)：

   {
     "jobId": "1541017411591-6",
     "status": "APPROVED",
     "spaceName": "MySpace",
     "projectName": "Employee_Rostering",
     "projectGroupId": "employeerostering",
     "projectVersion": "1.0.0-SNAPSHOT",
     "description": "Employee rostering problem optimisation using Planner. Assigns employees to shifts based on their skill."
   }

   如果您遇到请求错误，请检查返回的错误消息并相应地调整您的请求。