第28章 Business Central スペースおよびプロジェクト用のナレッジストア REST API

手順

1. 要求の送信先となる関連する API エンドポイント を特定します。Business Central からスペースを取得する [GET] /spaces などです。

2. REST クライアントまたは curl ユーティリティーで、/spaces への GET 要求に以下のコンポーネントを入力します。ご自分のユースケースに合わせて、要求詳細を調整します。

   REST クライアントの場合:

   • Authentication: rest-all ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

   • HTTP Headers: 以下のヘッダーを設定します。

     • Accept: application/json
   • HTTP method: GET に設定します。
   • URL: Process Server REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/spaces となります。

   curl ユーティリティーの場合:

   • -u: rest-all ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

   • -H: 以下のヘッダーを設定します。

     • Accept: application/json
   • -X: GET に設定します。
   • URL: Process Server 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 Server の応答を確認します。

   サーバー応答の例 (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 ユーティリティーで、/spaces/{spaceName}/projects への POST 要求を以下のコンポーネントで送信し、スペース内でプロジェクトを作成します。ご自分のユースケースに合わせて、要求詳細を調整します。

   REST クライアントの場合:

   • Authentication: rest-all ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

   • HTTP Headers: 以下のヘッダーを設定します。

     • Accept: application/json
     • accept-Language: en-US
     • Content-Type: application/json
   • HTTP method: POST に設定します。
   • URL: Process Server REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/spaces/MySpace/projects となります。
   • 要求のボディ: 新規プロジェクト用の ID データのある 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: rest-all ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

   • -H: 以下のヘッダーを設定します。

     • Accept: application/json
     • accept-Language: en-US (定義されていない場合は JVM のデフォルトのロケールが反映されます)
     • Content-Type: application/json
   • -X: POST に設定します。
   • URL: Process Server REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/spaces/MySpace/projects となります。
   • -d: 新規プロジェクト用の ID データのある 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 Server の応答を確認します。

   サーバー応答の例 (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."
   }

   要求エラーが発生した場合は、返されたエラーコードメッセージを確認して、それに応じて要求を調整します。