control.events scripts (1.0.0)

Download OpenAPI specification:Download

get page

json

The request is sent to the corezoid process before the page is loaded. The corezoid process decides whether to display the requested page or to redirect the user to another page. Optionally, data for dynamic injection into the page body can be sent in the response.

Request Body schema: application/json
timeout
number
Default: 30
Array of objects

The list of request results

Responses

Request samples

Content type
application/json
{
  • "timeout": 30,
  • "ops": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "200",
  • "data": {
    },
  • "notifications": [
    ]
}

send form

json

The request is sent to the corezoid process when a button is clicked or when interacting with a component whose submitOnChange property is set to true. The body of the request contains all information about the component that initiated the request and the values of all fields of the current form. The corezoid process makes decisions about the changes on the existing page, about displaying notifications or redirecting the user to another page.

Request Body schema: application/json
timeout
number
Default: 30
Array of objects

The list of request results

Responses

Request samples

Content type
application/json
{
  • "timeout": 30,
  • "ops": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 200,
  • "data": {
    }
}

Page

Array of objects (Form)
object
Array of objects (notification)
{
  • "forms": [
    ],
  • "grid": {
    },
  • "notifications": [
    ]
}

Form

id
string
visibility
string
Enum: "visible" "hidden" "disabled"

Component visibility :

  • visible - displayed on the page
  • hidden - not visible on the page
  • disabled - component is displayed, but cannot be used
object (grid)
Array of objects (Container for groupping the components)
{
  • "id": "string",
  • "visibility": "visible",
  • "grid": {
    },
  • "sections": [
    ]
}

Button

id
required
string

Identifier of the component (Should be unique in the scope of the Form)

visibility
string
Default: "visible"
Enum: "visible" "hidden" "disabled"

Component visibility :

  • visible - displayed on the page
  • hidden - not visible on the page
  • disabled - component is displayed, but cannot be used
row
string

Row number

w
string

Relative width of the component in the row (%). If not specified, width will be equal for every component in the row

styleClass
string

css class that is defined in 'styles.css'

class
required
string
Value: "button"

Class of the component

type
string
Default: "default"
Enum: "default" "text" "secondary" "tertiary" "quaternary"
object