The Blueriq web application is equipped with a REST API to expose methods to allow clients to control the flowing of the application. This page gives a description about the available services. For all of the below endpoints, an Accept header of application/json must be present in the request.

Authentication

POST /api/v2/login

Login the user with the provided credentials

Request body

{
	username: string,
	password: string
}

{
	"username": "testUser",
	"password": "secret"
}

    V2BackendModule.forRoot({
      baseUrl: ....,
      legacyLoginWithQueryParams: true,
    }),

POST /api/v2/logout

POST /api/v2/start/{shortcutName?}

{
    "sessionId": "2f177274-514d-4be9-aa3d-4a550ab9e724",
    "sessionTimeout": 1800
}

POST /api/v2/start?project=export-kinderbijslag&flow=Main

{
    "sessionId": "2f177274-514d-4be9-aa3d-4a550ab9e724",
    "sessionTimeout": 1800
}

After having started a session using one of the /api/v2/start endpoints, its initial page contents may be obtained via a POST to /api/v2/session/{sessionId}/load. The result of this call is the full page model, necessary for initial rendering of the page. Subsequently, events may be submitted to the runtime via a POST to /api/v2/session/{sessionId}/event, resulting in a response containing all changes (add, update, delete). In Blueriq each session may be part of a hierarchy of sessions. For example, in a DCM application, the session of a flow widget is a child session of the main dashboard session. An event in one session may cause changes in other sessions if Portal Messages are thrown. Therefore, the response  of /api/v2/session{sessionId}/event endpoint will contain changes in all sessions in the heirarchy. An example response containing the changes:

{"events":[
	{"sessionId":"27390ee2-4968-4f27-ae71-3d6516ba06ec",
	 "changes": {
		"changes":[
			{"type":"add",
		 	"key":"P521-C0-F1",
		 	 "model":{
				"key":"P521-C0-F1",
				"name":"e.a2",
				"properties":{},
				"questionText":"q2",
				"explainText":null,
				"dataType":"boolean",
				"rejectedValue":null,
				"readonly":false,
				"required":false,
				"hasDomain":false,
				"multiValued":false,
				"refresh":false,
				"displayLength":-1,
				"domain":[],
				"messages":[],
				"values":[],
				"type":"field",
				"styles":[]
				}
			}
		]
	}
]}

In this example a field is added to the page. The available properties per element are listed in the REST Page Models.

POST /api/v2/session/{sessionId}/load

 {
   "elements": [
     {
       "key": "P381-C1",
       "name": "Single",
       "properties": {
         
       },
       "children": [
         "P381-C1-F0",
         "P381-C1-F1",
         "P381-C1-F7"
       ],
       "displayName": "Single Items",
       "contentStyle": "container",
       "type": "container",
       "styles": [
         
       ]
     }
   ],
   "language": {
     "patterns": {
       "datetime": "yyyy-mm-dd hh:mm:ss",
       "date": "yyyy-mm-dd"
     },
     "languageCode": "en-GB"
   }
 }

{
	language {
    	languageCode: string,                  // Current language of the session
	    patterns: { [string]: string },        // Formatter patterns for dates
	},                                         // Language information of the session
	elements [{
    	type: string,
		key: string,
		name: string,
		styles: string[],
		properties: { [string]: string },
	}]                                         // All elements of the currently active Blueriq page. Further explained under 'REST Page Models'
}

POST /api/v2/session/{sessionId}/event

{
	elementKey: string,               // Key of the element the event originates from
	fields: [{
	    key: string,                  // Key of the field
    	values: string[],             // Values of the field, an array even if the field is not multivalued
	}],                               // Data of all fields on the page
	parameters: { [string]: string }  // Additional parameters that may be passed to the backend
}

{
	"elementKey": "P960-C2-B1",
	"fields": [
		{
       		"key": "P960-C1-F0",
			"values": [
				"testValue"
			]
		},   
		{
			"key": "P960-C1-F6",
			"values": [  
				"testValue2"      
			]
		}
	]
}

{
    events: { EventResponse }[]
}

{
   "events": [{
		"sessionId": "45992123-f893-4b22-a6a3-ff648b63267c",
		"changes": {
         "changes": [
           {
             "type": "add",
             "key": "P501-C1-B0",
             "model": {
               "key": "P501-C1-B0",
               "name": "Annuleer",
               "properties": {
                 
               },
               "disabled": false,
               "refresh": false,
               "caption": "Annuleer",
               "type": "button",
               "styles": [
                 
               ]
             }
           },   		 
		},
		"type": "page"
	}]
}

POST /api/v2/session/{sessionId}/flow/{flowName}

{
	"events": [{
		"sessionId": "7c2868f4-4fe9-48b6-841a-cf3e4831750a",
		"changes": {
			"changes": [{
				"type": "delete",
				"key": "P977-C1",
				"model": null
			}]
		},
		"type": "page"
	}]
}

Close session

POST /api/v2/session/{sessionId}/close

POST /api/v2/session/{sessionId}/keepalive

POST /api/v2/session/{sessionId}/widget/{infoKey}

{"sessionId":"a487f65e-6804-4803-bf4b-c89e45f97e38"}

POST /api/v2/session/{sessionId}/externalflow/init

{"configurationId":"fd308ecf-bf93-4061-bbc7-7cace2cde764","baseUrl":""}

{"configurationId":"fd308ecf-bf93-4061-bbc7-7cace2cde764","baseUrl":""}

POST /api/v2/externalflow/start

{"configurationId":"fd308ecf-bf93-4061-bbc7-7cace2cde764"}

{"sessionId":"9f79ac63-f994-4b9e-8a4d-86ef5a561291"}

POST /api/v2/session/{sessionId}/file/{configurationId}/upload

GET /api/v2/session/{sessionId}/file/{configurationId}/download

GET /api/v2/session/{sessionId}/file/{configurationId}/checkauthorization

configurationId

GET /api/v2/session/{sessionId}/document/{documentName}/{type}

GET /api/v2/session/{sessionId}/document/page/{pageName}/{type}

GET api/v2/session/{sessionId}/image/{imageName}

GET api/v2/session/{sessionId}/image/{imageName}/key/{key}

GET /api/v2/session/{sessionId}/dmn/{entityName}/{instanceId}/{attributeName}

{
  "rootNode": {
    "ruleName": "DMNEntity.DataRuleEndResult",
    "justification": null,
    "usedDecisions": [
      {
        "ruleName": "DataRuleForPage",
        "justification": null,
        "usedDecisions": [],
        "entityName": "DMNEntity",
        "attributeName": "DataRule",
        "attributeValues": [
          "44"
        ],
        "sourceType": "System",
        "defaultRuleType": null,
        "instanceId": "40c05cc5-8ddf-48a3-8d5d-53228ca7305c"
      }
    ],
    "entityName": "DMNEntity",
    "attributeName": "DataRuleEndResult",
    "attributeValues": [
      "1342"
    ],
    "sourceType": "Default",
    "defaultRuleType": "expression",
    "instanceId": "40c05cc5-8ddf-48a3-8d5d-53228ca7305c"
  }
}

GET /api/v2/session/{sessionId}/language

[
  {
   "code": "nl-NL",
   "name": "Nederlands"
  },
  {
   "code": "en-US",
   "name": "English"
  }
]

POST /api/v2/session/{sessionId}/language/current?languageCode=nl-NL