Versions Compared

Old Version 8

changes.mady.by.user Unknown User (m.van.der.blom)

Saved on

compared with

New Version 9

changes.mady.by.user Terry van der Griend

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Description

Handles a page event and returns the events that occurred in any of the sessions in heirarchy.

Headers

NameValue
Content-Typeapplication/json

Parameters

URL SegmentExpected TypeDescription
sessionIdstringThe 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
languagejs
{
	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
languagetext
titleExample request
{
	"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.

 

Code Block
languagejs
{
    events: { EventResponse }[]
}
Code Block
languagetext
titleExample response
{
   "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"
	}]
}

 

...