Consultation API
search

Start

Starts a consultation.

GET/rest/consultation/start
 Query parameters
  • kbId: (optional) id of the KBA
  • kbName: (optional) name of the KBA
  • safeMode: (optional) parameter to use the safe-mode in the consultation (default="true")
  • password: (optional) encrypted bookmark password
  • detached: (optional) set to "true" to start a consultation in background
  • detachedTaskName: (optional) task name for constations that run in the background

kbName is used only if kbId is empty and it's mandatory to specify one of the two parameters
 Header auth-token: (optional) value of the authentication token. This value is not needed when the consultation is with an anonymous user.
 Header/Parameter  tenant
 Body  none
Returns ConsultationResponse

In case of anonymous consultation Headers with:

ANONYMOUS-ROLES -> USER

ANONYMOUS-TOKEN -> Token id which will be needed for further steps in the consultation

ANONYMOUS-USERNAME -> Generic username
Required role USER
Managed errors
  • 404: kb not found
  • 401: insufficient privileges

Example request

curl 'http://localhost:8080/mwp/rest/consultation/start?kbId=72ac8a5d-e9b0-4eb3-9574-e6dc7fc7bff4' -H 'auth-token: 6bc7e5ba-71bf-4623-8788-a7f7ef44a74e' -H 'tenant:default'

Example response

{
    "consultationId": "02b3e3a6e74cb30fbfed508948ab4219",
    "variables": [
        {
            "id": "Order_Handling-Client_name-1",
            "name": "Client name",
            "instanceIndex": 1,
            "instanceBaseName": null,
            "type": "qualitativeLength",
            "question": "What is the name of the client?",
            "explanation": "",
            "domain": {
                "alternatives": [],
                "constraints": {
                    "numbersConstraints": null,
                    "stringsConstraints": {
                        "maxLength": 100,
                        "minLength": 0
                    },
                    "defaultValue": ""
                },
                "exclusiveValue": null,
                "defaultValue": ""
            },
            "display": false,
            "frameName": "Client Information",
            "maskedValue": null,
            "solvable": false,
            "metricSystem": "EU",
            "storedValues": null,
            "decimalSeparator": null,
            "thousandsSeparator": null
        }
    ],
    "questionType": "question",
    "tableName": "Order Handling",
    "displayVariables": [],
    "downloads": null,
    "answeredQuestions": null,
    "visualizationConfiguration": [],
    "summaryChecklist": {
        "type": "NONE",
        "content": null
    },
    "responseExtensions": null,
    "feedback": null,
    "userType": "NORMAL_USER"
}

Feedback