Consultation API
search

WhatIf

Rolls back the consultation to the specified question.

GET/rest/consultation/whatIf
 Query parameters
  • variable: (string) variable name
  • instanceBaseName: (string,optional) instance base name
  • instanceNumber: (string,optional) instance number

if instanceBaseName is not specified it's value is automatically set to empty and instanceNumber is set to 1
 Header
  • auth-token: value of the authentication token
  • Content-Type: application/json
  • consultationId: value of the consultationId
 Header/Parameter  tenant
 Body None
Returns ConsultationResponse
Required role USER
Managed errors
  • 400: bad request (validation issues)
  • 404: kb not found
  • 401: insufficient privileges

Example request

curl 'http://localhost:8080/mwp/rest/consultation/whatIf?variable=Credit%20limit' -H 'consultationId: 484500412b9a4bc59e70fdf31df7d92e' -H 'auth-token: 5f4a627d-d749-49ee-9cd7-616968462ffc' -H 'tenant:default'

Example response

{  
   "consultationId":"484500412b9a4bc59e70fdf31df7d92e",
   "variables":[  
      {  
         "id":"Order_Handling-Credit_limit-1",
         "name":"Credit limit",
         "instanceIndex":1,
         "instanceBaseName":null,
         "type":"qualitativeEnumeration",
         "question":"",
         "explanation":"",
         "domain":{  
            "alternatives":[  
               {  
                  "value":"Exceeded",
                  "explanation":null,
                  "multimediaExplanation":null
               },
               {  
                  "value":"Not exceeded",
                  "explanation":null,
                  "multimediaExplanation":null
               }
            ],
            "constraints":{  
               "numbersConstraints":null,
               "stringsConstraints":{  
                  "maxLength":0,
                  "minLength":0
               },
               "defaultValue":""
            },
            "exclusiveValue":null,
            "defaultValue":""
         },
         "display":false,
         "frameName":null,
         "maskedValue":null,
         "solvable":false,
         "metricSystem":"EU",
         "storedValues":[  
            "Exceeded"
         ],
         "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":null
}

Feedback