control.events scripts (1.0.0)

Download OpenAPI specification:Download

Support: support@control.events URL: https://control.events

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

Payload

Content type

application/json

{"timeout": 30,
"ops": [{"conv_id": "{{CONV_ID}}",
"company_id": "{{COMPANY_ID}}",
"type": "create",
"obj": "task",
"data": {"body": {"page": "index",
"context": {"actorId": "111",
"rootActorId": "123",
"appId": "124"
},
"query": { }
},
"path": "/get",
"sessionData": {"userInfo": {"id": "12",
"nick": "John Doe",
"login": "john.doe@corezod.com"
}
}
}
}
]
}

Response samples

200

Content type

application/json

Example

{"code": 200,
"data": {"viewModel": {"key": "value"
}
}
}

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

Payload

Content type

application/json

{"timeout": 30,
"ops": [{"conv_id": "{{CONV_ID}}",
"company_id": "{{COMPANY_ID}}",
"type": "create",
"obj": "task",
"data": {"body": {"page": "index",
"query": { },
"context": {"actorId": "111",
"rootActorId": "123",
"appId": "124"
},
"formId": "logIn",
"sectionId": "credentials",
"buttonId": "submit",
"data": {"login": "admin",
"password": "qwerty"
}
},
"path": "/send",
"sessionData": {"userInfo": {"id": "12",
"nick": "John Doe",
"login": "john.doe@corezod.com"
}
}
}
}
]
}

Response samples

200

Content type

application/json

Example

{"code": 200,
"data": {"changes": [{"id": "componentId",
"visibility": "hidden"
}
]
}
}

Page

	Array of objects (Form)
	object
	Array of objects (notification)

{"forms": [{"id": "string",
"visibility": "visible",
"grid": {"type": "string",
"components": { },
"styleClass": "my-custom-class"
},
"sections": [{"id": "string",
"type": "body",
"visibility": "visible",
"header": [{"id": "component-1",
"visibility": "visible",
"row": "1",
"w": "100",
"styleClass": "my-custom-class",
"class": "label",
"tooltip": "tooltip text",
"value": "Lorem ipsulum",
"align": "left"
}
],
"contentLoop": [{"key": "value"
}
],
"content": [{ }
]
}
]
}
],
"grid": {"type": "string",
"components": { },
"header": {"class": "string"
},
"sideBar": {"type": "default",
"components": {"center": ["id1"
]
},
"styleClass": "my-custom-class"
}
},
"notifications": [{"type": "success",
"title": "Error",
"helperText": "api timeout",
"expire": "auto"
}
]
}

Form

id	string
visibility	string Enum: "visible" "hidden" "disabled" Component visibility : visible - component is displayed on the page, can be used hidden - component is not displayed 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": {"type": "string",
"components": { },
"styleClass": "my-custom-class"
},
"sections": [{"id": "string",
"type": "body",
"visibility": "visible",
"header": [{"id": "component-1",
"visibility": "visible",
"row": "1",
"w": "100",
"styleClass": "my-custom-class",
"class": "label",
"tooltip": "tooltip text",
"value": "Lorem ipsulum",
"align": "left"
}
],
"contentLoop": [{"key": "value"
}
],
"content": [{ }
]
}
]
}

Button

id required	string Identifier of the component (must be unique within the scope of the form)
visibility	string Default: "visible" Enum: "visible" "hidden" "disabled" Component visibility : visible - component is displayed on the page, can be used hidden - component is not displayed on the page disabled - component is displayed, but cannot be used
row	string Row number. Components with the same row number will be aligned in one row
w	string Relative width of the component in the row (%). If not specified, the width will be the same for all components 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" default default text secondary tertiary quaternary
tooltip	string Tooltips display informative text when users hover over an element.
	object extra settings
title	string Title text

Example

{"id": "component-1",
"visibility": "visible",
"row": "1",
"w": "100",
"styleClass": "my-custom-class",
"class": "button",
"type": "default",
"tooltip": "tooltip text",
"extra": {