...

Code Block

language	js

{
	username: string,
	password: string
}

Code Block

language	js
title	Example request

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

Info

UI Text Box

type	note

Before release 12.10, Blueriq expected the username and password to be in the request parameters of the login request (e.g. http://.../api/v2/login?username=testUser&password=secret). Since release 12.10, the username and password are retrieved from the login request body. For backwards compatibility the login information can still be retrieved from the request parameters as well.

The material theme sends the login information in the request body by default from release 12.10. It is possible to configure the theme to still use the legacy request parameter method of logging in, by configuring the backend module in your theme:

Code Block

language	js
title	app.module.ts

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

Response

204 No Content, if successful.

401 Unauthorized, if unsuccessful.

...

Logout user

Code Block

language	js

POST /api/v2/logout

Parameters

Query Parameter	Expected Type	Description	Required
redirect_uri	string	URL to redirect to after logout	Conditional (see Response)

Description

Logout the current user and close all Blueriq sessions

Response

204 No Content

302 Found

if redirect_uri parameter is present
the Location header contains the redirect_uri

400 Bad Request

if the Runtime is configured with OpenID Connect and SSO Logout, and no redirect_uri parameter was received
if a whitelist is defined for the redirect_uri parameter and the received redirect_uri is not whitelisted

Starting a Blueriq session

Start Shortcut

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

Description

Starts a session by specifying the name of a shortcut.

Parameters

URL Segment	Expected Type	Description
shortcutName	string	The shortcut name, leave empty to start the default shortcut

Example response

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

Start Project

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

Description

Starts a session with project parameters. This endpoint may be disabled in production for security reasons, so using shortcuts is preferred.

Parameters

Query parameter	Expected Type	Description	Required
project	string	The project to start	Yes
flow	string	The flow to start	Only required if more than one exposed flow is present in the project
version	string	The branch version	No
languageCode	string	The project language	No
ui	string	The UI variant to use, by default only `mvc`is supported	No
theme	string	The project theme	No
channel	string	the project channel	No

Example response

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

Interacting with a session

...

Info

title	Serialization

The serialization of page element to datamodel is handled by the IApiRendererFactory, this renderer factory can be overridden to customize the serialization. In Java by use of the AquimaApiRendererFactory annotation.

...

Load session information

After a session has been created using /api/v2/start, the current state of the session can be obtained through:

Code Block

language	js

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

...

Parameters

URL Segment	Expected Type	Description
sessionId	string	The session id.

Response

204 No Content

Create widget

Code Block

language	js

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

Description

provides a service that creates a child-session using the provided sessionId as its parent, to be used for widgets.

Parameters

URL Segment	Expected Type	Description
sessionId	string	The session id
infoKey	string	The info key of the widget to load, available in `properties.info` of a page mode of type `dashboard_flowwidget`

Reponse

The sessionId of the existing or newly created session.

Code Block

language	js

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

Create external flow widget

Starting an external flow consists of multiple calls.

Init

Code Block

language	js

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

Requestbody

Code Block

language	js

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

Description

provides a service that initializes an external flow starting from your current session.

Parameters

URL Segment	Expected Type	Description
sessionId	string	The session id
configurationId	string	The info key of the widget to load, available in `properties.configurationId` of a page model of type `external_flow`

Reponse

Code Block

language	js

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

Start

Code Block

language	js

POST /api/v2/externalflow/start

Requestbody

Code Block

language	js

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

Description

provides a service that creates a child-session, to be used for widgets.

Parameters

URL Segment	Expected Type	Description
sessionId	string	The session id
configurationId	string	The info key of the widget to load, available in `properties.configurationId` of a page model of type `external_flow`

Reponse

The sessionId of the existing or newly created session. After starting a session its initial page contents may be obtained via a POST to /api/v2/session/{sessionId}/load.

Code Block

language	js

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

Handling files

Endpoints that go with AQ_File_Upload/AQ_File_Download containers.

Upload file

Code Block

language	js

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

Parameters

URL Segment	Expected Type	Description
sessionId	string	The session id.
configurationId	string	The configuration id.

Response body

Returns an event response, for more info about an event response see: REST Events V1.

Download a file

Code Block

language	js

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

Description

Gets the file from the specified connection based on its configuration

Parameters

URL Segment	Expected Type	Description
sessionId	string	The session id
configurationId	string	The property configuration id, available

Query Parameters

Query Parameter	Expected Type	Description
error-redirect	string	Optional. Specifies the URL to be redirected to if the file download fails. If not provided, the default JSON error output will be used instead.

Example response

The requested file, transferred using Content-Disposition: attachment.

Check authorization

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

Description

Check if the user has the authority to download the file.

Parameters

URL Segment	Expected Type	Description
sessionId	string	The session id
configurationId	string	The configuration id

Example response

200 OK, if the current user is authorized to download the file

401 Unauthorized, otherwise

Documents

Use to render a Blueriq document or page. A call to this service returns the binary data of the document or page.

Render a document

Code Block

language	js

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

Description

Renders a document and returns its binary value.

Parameters

URL Segment	Expected Type	Description
sessionId	string	The id of the session.
documentName	string	Name of the document.
type	string	Type of document (e.g. PDF).

Query Parameters

Query Parameter	Expected Type	Description
error-redirect	string	Optional. Specifies the URL to be redirected to if the document download fails. If not provided, the default JSON error output will be used instead.

Response body

Transfers the binary data of a document using Content-Disposition: attachment

Render a page

Code Block

language	js

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

Description

Renders a page and returns its binary value.

Parameters

URL Segment	Expected Type	Description
sessionId	string	The id of the session.
pageName	string	Name of the page.
type	string	Type of page (e.g. PDF).

Query Parameters

Query Parameter	Expected Type	Description
error-redirect	string	Optional. Specifies the URL to be redirected to if the document download fails. If not provided, the default JSON error output will be used instead.

Response body

Transfers the binary data of a page using Content-Disposition: attachment

Images

Retrieve an image

Code Block

language	js

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

Description

Returns the binary data of a named Blueriq image.

Parameters

URL Segment	Expected Type	Description
sessionId	string	The id of the session.
imageName	string	The name of the image.

Response body

Returns the binary data of an image.

Retrieve a QR Code image

Code Block

language	js

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

Description

Returns the binary data of a named Blueriq QR Code image.

Parameters

URL Segment	Expected Type	Description
sessionId	string	The id of the session.
imageName	string	The name of the image.
key	string	The element key of the image.

Response body

The binary data of an image.

Inference details

The DMN service is part of the development plugin and can be used to get inference details for attribute instances

Get Decision Tree

Code Block

language	js

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

Description

Gets a decision tree model for the specified attribute instance

Parameters

URL Segment	Expected Type	Description
sessionId	string	The session id to create an event response for
entityName	string	Entity name for the attribute for which the decision tree is requested
instanceId	string	Instance id for the attribute for which the decision tree is requested
attributeName	string	Name of the attribute for which the decision tree is requested

Example response

A decision tree for DMN starts with a rootNode and it is possible that there are 0 or more usedDecisions. A used decision describes an attribute that is used to derive the parent attribute.

Code Block

language	text

{
  "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"
  }
}

Language

Get current languages

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

Description

Returns a status code 200 if request was successful and a body containing a JSON Array with the available languages that are available in the current project.

Example response

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

Set language

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

Description

Sets the specified language in the languageCode parameter for the currently active project. If the specified language does not exist a Bad Request status code is returned.

Standard response codes

All services return a 200 response code on successful requests and a 500 response code if an error occurs. For more information about errors see REST Errors V2.

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 26

New Version 27

Key

Response

Logout user

Parameters

Description

Response

Starting a Blueriq session

Start Shortcut

Description

Parameters

Example response

Start Project

Description

Parameters

Example response

Interacting with a session

Load session information

Parameters

Response

Create widget

Description

Parameters

Reponse

Create external flow widget

Init

Requestbody

Description

Parameters

Reponse

Start

Requestbody

Description

Parameters

Reponse

Handling files

Upload file

Parameters

Response body

Download a file

Description

Parameters

Query Parameters

Check authorization

Description

Parameters

Example response

Documents

Render a document

Description

Parameters

Query Parameters

Response body

Render a page

Query Parameters

Images

Retrieve an image

Retrieve a QR Code image

Description

Inference details

Description

Parameters

Example response

Language

Get current languages

Description

Example response

Set language

Description

Standard response codes