Page History
...
In this example a field is added to the page. The available properties per element are listed in the REST Page Models V1.
Info | ||
---|---|---|
| ||
The serialization of page element to datamodel is handled by the |
...
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 | ||
---|---|---|
| ||
POST /api/v2/session/{sessionId}/load |
...
Response body
Contains a description of the current page model and language settings. For more information about the page elements see REST Page Models V1.
Code Block | ||
---|---|---|
| ||
{ 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' } |
...
Description
Headers
Name | Value |
---|---|
Content-Type | application/json |
Parameters
URL Segment | Expected Type | Description |
---|---|---|
sessionId | string | The session id. |
Request body
At least the element that triggered the event and all editable fields on the page must be included in the request.
Code Block | ||
---|---|---|
| ||
{ 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 } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "elementKey": "P960-C2-B1", "fields": [ { "key": "P960-C1-F0", "values": [ "testValue" ] }, { "key": "P960-C1-F6", "values": [ "testValue2" ] } ] } |
Response body
Returns an event response, for more info about an event response see: REST Events V1.
Code Block | ||
---|---|---|
| ||
{ events: { EventResponse }[] } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "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" }] } |
...
Response body
Returns an event response, for more info about an event response see: REST Events V1.
...
Close session
Code Block | ||
---|---|---|
| ||
POST /api/v2/session/{sessionId}/close |
...
Parameters
URL Segment | Expected Type | Description |
---|---|---|
sessionId | string | The session id. |
Response
204 No Content
Create widget
Code Block | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
{"sessionId":"a487f65e-6804-4803-bf4b-c89e45f97e38"} |
Handling files
Endpoints that go with AQ_File_Upload/AQ_File_Download containers.
Upload file
Code Block | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 |
Example response
The requested file, transferred using Content-Disposition: attachment
.
Check authorization
Code Block |
---|
GET /api/v2/session/{sessionId}/file/{configurationId}/checkauthorization |
Description
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 | ||
---|---|---|
| ||
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). |
Response body
Transfers the binary data of a document using Content-Disposition: attachment
Render a page
Code Block | ||
---|---|---|
| ||
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). |
Response body
Transfers the binary data of a page using Content-Disposition: attachment
Images
Retrieve an image
Code Block | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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. |
Response body
The binary data of an image.
Offline functionality
Prepare offline task
Code Block |
---|
POST api/v2/session/{sessionId}/offline/prepare/{taskId} |
Description
Prepares a task to be executed in offline mode
Parameters
URL Segment | Expected Type | Description |
---|---|---|
sessionId | string | The session id. |
taskId | string | The id of the task to prepare offline mode for |
Response body
A PageModel instance with the page contents started by the task. For more information about the page contents (elements) see: REST Page Models V1.
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
{ "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" } } |
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 V1.