API Model

Consultation Response

It's the response of a consultation step

Field Type Mandatory Meaning
 consultationId  string yes consultation identifier
 variables  array of Variables  no each variable represent a question
 questionType enumeration  no
  • question: normal question during consultation
  • goalSelection: the question is a goal selection
  • goalReached: the consultation is completed
 tableName string  no name of the current table in the kb
 displayVariables array of Display Variables no each variable is a message that should be visualized
 downloads array of Downloads  no each entry represents a downloadable file
 answeredQuestions array of Answered Questions List  no each entry is a variable skipped in a fast forward
 visualizationConfiguration array of Visualization Configuration  no configurable visualization options for special variables and custom ui widget
 summaryChecklist Summary Checklist  no content of the Summary Checklist
 responseExtensions map  no messages generated by backend extensions