Consultation API

Recover Bookmark

When an unauthenticated user opens a bookmark the content is stored and the user is redirected to the authentication. Calling this api after the authentication recovers the stored bookmark.

GET/rest/consultation/bookmarkForm
 Query parameters None
 Header
  • auth-token: value of the authentication token, it can be optionally specified in place of the query param
 Header/Parameter  tenant
 Body None
Returns ConsultationResponse
Required role USER
Managed errors
  • 404: kb not found
  • 401: insufficient privileges

Example request

curl 'http://localhost:8080/mwp/rest/consultation/bookmarkForm' -H 'consultationId: 0dac86ac6393a7f8d3830e4134d1149c' -H 'auth-token: 9d82e174-e3bc-419f-968f-fd1388310938' -H 'tenant:default'

Example response

{  
   "consultationId":"0dac86ac6393a7f8d3830e4134d1149c",
   "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":[  
            "aa"
         ],
         "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