21.2. Sending requests with the KIE Server REST API using the Swagger interface

Procedure

1. In a web browser, navigate to http://SERVER:PORT/kie-server/docs, such as http://localhost:8080/kie-server/docs, and log in with the user name and password of the KIE Server user with the kie-server role.
2. In the Swagger page, select the relevant API endpoint to which you want to send a request, such as KIE Server and KIE containers [GET] /server/containers to retrieve KIE containers from KIE Server.
3. Click Try it out and provide any optional parameters by which you want to filter results, if needed.
4. In the Response content type drop-down menu, select the desired format of the server response, such as application/json for JSON format.

5. Click Execute and review the KIE Server response.

   Example server response (JSON):

   {
     "type": "SUCCESS",
     "msg": "List of created containers",
     "result": {
       "kie-containers": {
         "kie-container": [
           {
             "container-id": "itorders_1.0.0-SNAPSHOT",
             "release-id": {
               "group-id": "itorders",
               "artifact-id": "itorders",
               "version": "1.0.0-SNAPSHOT"
             },
             "resolved-release-id": {
               "group-id": "itorders",
               "artifact-id": "itorders",
               "version": "1.0.0-SNAPSHOT"
             },
             "status": "STARTED",
             "scanner": {
               "status": "DISPOSED",
               "poll-interval": null
             },
             "config-items": [],
             "container-alias": "itorders"
           }
         ]
       }
     }
   }

6. For this example, copy or note the project group-id, artifact-id, and version (GAV) data from one of the deployed KIE containers returned in the response.
7. In the Swagger page, navigate to the KIE Server and KIE containers [PUT] /server/containers/{containerId} endpoint to send another request to deploy a new KIE container with the copied project GAV data. Adjust any request details according to your use case.

8. Click Try it out and enter the following components for the request:

   • containerId: Enter the ID of the new KIE container, such as MyContainer.
   • body: Set the Parameter content type to the desired request body format, such as application/json for JSON format, and add a request body with the configuration items for the new KIE container:

   {
     "config-items": [
       {
         "itemName": "RuntimeStrategy",
         "itemValue": "SINGLETON",
         "itemType": "java.lang.String"
       },
       {
         "itemName": "MergeMode",
         "itemValue": "MERGE_COLLECTIONS",
         "itemType": "java.lang.String"
       },
       {
         "itemName": "KBase",
         "itemValue": "",
         "itemType": "java.lang.String"
       },
       {
         "itemName": "KSession",
         "itemValue": "",
         "itemType": "java.lang.String"
       }
     ],
     "release-id": {
       "group-id": "itorders",
       "artifact-id": "itorders",
       "version": "1.0.0-SNAPSHOT"
     },
     "scanner": {
       "poll-interval": "5000",
       "status": "STARTED"
     }
   }

9. In the Response content type drop-down menu, select the desired format of the server response, such as application/json for JSON format.

10. Click Execute and review the KIE Server response.

    Example server response (JSON):

    {
      "type": "SUCCESS",
      "msg": "Container MyContainer successfully deployed with module itorders:itorders:1.0.0-SNAPSHOT.",
      "result": {
        "kie-container": {
          "container-id": "MyContainer",
          "release-id": {
            "group-id": "itorders",
            "artifact-id": "itorders",
            "version": "1.0.0-SNAPSHOT"
          },
          "resolved-release-id": {
            "group-id": "itorders",
            "artifact-id": "itorders",
            "version": "1.0.0-SNAPSHOT"
          },
          "status": "STARTED",
          "scanner": {
            "status": "STARTED",
            "poll-interval": 5000
          },
          "config-items": [],
          "messages": [
            {
              "severity": "INFO",
              "timestamp": {
                "java.util.Date": 1540584717937
              },
              "content": [
                "Container MyContainer successfully created with module itorders:itorders:1.0.0-SNAPSHOT."
              ]
            }
          ],
          "container-alias": null
        }
      }
    }

    If you encounter request errors, review the returned error code messages and adjust your request accordingly.