Current SaaS
SaaS
API
Help
BRIX website
Preparing search index...
The search index is not available
Getting started
[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Manage types
Global context and isolation
Manage apps
Batch actions with app items
Manage external services
Scripts in widgets
Web components
Access permissions
Getting started with processes
Getting started with signatures
Getting started with file previews
Getting started with the organizational chart
Getting started with users and groups
Getting started with the
Table data type
Getting started with the
Category data type
Dynamic event type calculation
Typical use cases
API
Object types
Data types
Global constants
Work with apps
Web requests
Access permissions
Document flow
Live Chats
“Code” widget
Signatures
Business calendars
Integration with IP telephony
Integration with email marketing services
Company configuration metadata
ApplicationScheme
ApplicationSchemeForms
ApplicationSchemeFormsCreateForm
ApplicationSchemeFormsDetailForm
ApplicationSchemeFormsEditForm
ApplicationSchemeFormsField
ApplicationSchemeFormsMassEditForm
ApplicationSchemeFormsTileForm
ApplicationSchemeFormsViewForm
ApplicationSchemeParams
ApplicationSchemePermissionSettings
ApplicationSchemeService
BaseApplicationScheme
BaseContractScheme
BaseModuleScheme
BaseNamespaceScheme
BasePageScheme
BaseProcessTemplateScheme
BaseReportScheme
BaseSolutionScheme
BaseWidgetScheme
ContractScheme
ContractSchemeService
ContractSchemeSource
FieldScheme
FieldSchemeAccountViewData
FieldSchemeBooleanViewData
FieldSchemeCategoryData
FieldSchemeDateTimeViewData
FieldSchemeEmailViewData
FieldSchemeEnumData
FieldSchemeEnumDataEnumItem
FieldSchemeLinkViewData
FieldSchemeMoneyViewData
FieldSchemePhoneViewData
FieldSchemeService
FieldSchemeStringData
FieldSchemeStringDataMask
FieldSchemeStringViewData
FieldSchemeSysCollectionData
FieldSchemeTableData
FieldSchemeTableDataField
FieldSchemeTableDataFieldView
FieldSchemeView
ModuleScheme
ModuleSchemeService
NamespaceScheme
NamespaceSchemeParams
NamespaceSchemeParamsField
NamespaceSchemeParamsFieldFieldView
NamespaceSchemeService
PageScheme
PageSchemeService
PermissionsScheme
PermissionsSchemeValue
PermissionsSchemeValueOrgUnit
ProcessTemplateScheme
ProcessTemplateSchemeItem
ProcessTemplateSchemeItemSettings
ProcessTemplateSchemeItemSettingsFormField
ProcessTemplateSchemeProcess
ProcessTemplateSchemeService
ReportScheme
ReportSchemeColumn
ReportSchemeService
SchemeService
SolutionScheme
SolutionSchemeItem
SolutionSchemeService
WidgetScheme
WidgetSchemeDescriptor
WidgetSchemeService
ApplicationSchemePermissionSettingsType
FieldSchemeAccountViewDataType
FieldSchemeDateTimeViewDataAdditionalType
FieldSchemeDateTimeViewDataDefaultTime
FieldSchemeEmailViewDataType
FieldSchemePhoneViewDataType
FieldSchemeStringViewDataAdditionalType
FieldSchemeType
PageSchemeType
PermissionsSchemeValueOrgUnitType
PermissionsSchemeValueType
SolutionSchemeItemKind
ApplicationSchemePermissionSettingsType
FieldSchemeAccountViewDataType
FieldSchemeDateTimeViewDataAdditionalType
FieldSchemeDateTimeViewDataDefaultTime
FieldSchemeEmailViewDataType
FieldSchemePhoneViewDataType
FieldSchemeStringViewDataAdditionalType
FieldSchemeType
PageSchemeType
PermissionsSchemeValueOrgUnitType
PermissionsSchemeValueType
SolutionSchemeItemKind
Activity stream metadata
API
Company configuration metadata
Company configuration metadata
module
Scheme
Type aliases
Application
Scheme
Permission
Settings
Type
Application
Scheme
Permission
Settings
Type
:
typeof ApplicationSchemePermissionSettingsType[keyof typeof ApplicationSchemePermissionSettingsType]
Field
Scheme
Account
View
Data
Type
Field
Scheme
Account
View
Data
Type
:
typeof FieldSchemeAccountViewDataType[keyof typeof FieldSchemeAccountViewDataType]
Field
Scheme
Date
Time
View
Data
Additional
Type
Field
Scheme
Date
Time
View
Data
Additional
Type
:
typeof FieldSchemeDateTimeViewDataAdditionalType[keyof typeof FieldSchemeDateTimeViewDataAdditionalType]
Field
Scheme
Date
Time
View
Data
Default
Time
Field
Scheme
Date
Time
View
Data
Default
Time
:
typeof FieldSchemeDateTimeViewDataDefaultTime[keyof typeof FieldSchemeDateTimeViewDataDefaultTime]
Field
Scheme
Email
View
Data
Type
Field
Scheme
Email
View
Data
Type
:
typeof FieldSchemeEmailViewDataType[keyof typeof FieldSchemeEmailViewDataType]
Field
Scheme
Phone
View
Data
Type
Field
Scheme
Phone
View
Data
Type
:
typeof FieldSchemePhoneViewDataType[keyof typeof FieldSchemePhoneViewDataType]
Field
Scheme
String
View
Data
Additional
Type
Field
Scheme
String
View
Data
Additional
Type
:
typeof FieldSchemeStringViewDataAdditionalType[keyof typeof FieldSchemeStringViewDataAdditionalType]
Field
Scheme
Type
Field
Scheme
Type
:
typeof FieldSchemeType[keyof typeof FieldSchemeType]
Page
Scheme
Type
Page
Scheme
Type
:
typeof PageSchemeType[keyof typeof PageSchemeType]
Permissions
Scheme
Value
Org
Unit
Type
Permissions
Scheme
Value
Org
Unit
Type
:
typeof PermissionsSchemeValueOrgUnitType[keyof typeof PermissionsSchemeValueOrgUnitType]
Permissions
Scheme
Value
Type
Permissions
Scheme
Value
Type
:
typeof PermissionsSchemeValueType[keyof typeof PermissionsSchemeValueType]
Solution
Scheme
Item
Kind
Solution
Scheme
Item
Kind
:
typeof SolutionSchemeItemKind[keyof typeof SolutionSchemeItemKind]
Variables
Const
Application
Scheme
Permission
Settings
Type
Application
Scheme
Permission
Settings
Type
:
object
= {none: "none", collection: "collection", row: "row", directory: "directory"} as const
Access type
Type declaration
collection
:
"collection"
Access permission settings for app
directory
:
"directory"
Access permission settings for folders
none
:
"none"
No access permission settings
row
:
"row"
Access settings for app items
Const
Field
Scheme
Account
View
Data
Type
Field
Scheme
Account
View
Data
Type
:
object
= {telegram: "telegram", whatsapp: "whatsapp", instagram: "instagram", viber: "viber", facebook: "facebook", vkontakte: "vkontakte", skype: "skype", google_talk: "google_talk", google_hangouts: "google_hangouts", we_chat: "we_chat", snapchat: "snapchat", line: "line", vk_teams: "vk_teams", other: "other", livechat: "livechat"} as const
Account type
Type declaration
facebook
:
"facebook"
Facebook
google_
hangouts
:
"google_hangouts"
Google Hangouts
google_
talk
:
"google_talk"
Google Talk
instagram
:
"instagram"
Instagram
line
:
"line"
Line
livechat
:
"livechat"
LiveChat
other
:
"other"
Other
skype
:
"skype"
Skype
snapchat
:
"snapchat"
Snapchat
telegram
:
"telegram"
Telegram
viber
:
"viber"
Viber
vk_
teams
:
"vk_teams"
VK Teams
vkontakte
:
"vkontakte"
VK
we_
chat
:
"we_chat"
WeChat
whatsapp
:
"whatsapp"
WhatsApp
Const
Field
Scheme
Date
Time
View
Data
Additional
Type
Field
Scheme
Date
Time
View
Data
Additional
Type
:
object
= {date: "date", time: "time", datetime: "datetime", datetime_short: "datetime_short"} as const
Date/Time field subtype
Type declaration
date
:
"date"
Date only
datetime
:
"datetime"
Date and time
datetime_
short
:
"datetime_short"
Date and time without seconds
time
:
"time"
Time only
Const
Field
Scheme
Date
Time
View
Data
Default
Time
Field
Scheme
Date
Time
View
Data
Default
Time
:
object
= {startOfDay: "startOfDay", endOfDay: "endOfDay", none: "none"} as const
Default time
Type declaration
end
OfDay
:
"endOfDay"
End of workday
none
:
"none"
No access permission settings
start
OfDay
:
"startOfDay"
Start of workday
Const
Field
Scheme
Email
View
Data
Type
Field
Scheme
Email
View
Data
Type
:
object
= {home: "home", work: "work", mobile: "mobile", main: "main"} as const
Email type
Type declaration
home
:
"home"
Home
main
:
"main"
Main
mobile
:
"mobile"
Mobile
work
:
"work"
Workspace
Const
Field
Scheme
Phone
View
Data
Type
Field
Scheme
Phone
View
Data
Type
:
object
= {home: "home", work: "work", mobile: "mobile", main: "main", home_fax: "home_fax", work_fax: "work_fax", pager: "pager"} as const
Phone type
Type declaration
home
:
"home"
Home
home_
fax
:
"home_fax"
Home fax
main
:
"main"
Main
mobile
:
"mobile"
Mobile
pager
:
"pager"
Pager
work
:
"work"
Workspace
work_
fax
:
"work_fax"
Work fax
Const
Field
Scheme
String
View
Data
Additional
Type
Field
Scheme
String
View
Data
Additional
Type
:
object
= {string: "string", text: "text"} as const
Subtype of the String field type
Type declaration
string
:
"string"
String
text
:
"text"
Text
Const
Field
Scheme
Type
Field
Scheme
Type
:
object
= {STRING: "STRING", FLOAT: "FLOAT", INTEGER: "INTEGER", BOOLEAN: "BOOLEAN", DATETIME: "DATETIME", CATEGORY: "CATEGORY", MONEY: "MONEY", FILE: "FILE", PHONE: "PHONE", EMAIL: "EMAIL", IMAGE: "IMAGE", STATUS: "STATUS", JSON: "JSON", SYS_USER: "SYS_USER", FULL_NAME: "FULL_NAME", LINK: "LINK", SYS_COLLECTION: "SYS_COLLECTION", REF_ITEM: "REF_ITEM", ENUM: "ENUM", TABLE: "TABLE", ACCOUNT: "ACCOUNT", ROLE: "ROLE", REPORT: "REPORT", UUID: "UUID", EVENT: "EVENT", COLLECTION_TYPE: "COLLECTION_TYPE", SYS_DIRECTORY: "SYS_DIRECTORY"} as const
Type
Type declaration
ACCOUNT
:
"ACCOUNT"
Account
BOOLEAN
:
"BOOLEAN"
Yes/No Switch
CATEGORY
:
"CATEGORY"
Category
COLLECTION_
TYPE
:
"COLLECTION_TYPE"
App type link
DATETIME
:
"DATETIME"
Date and time
EMAIL
:
"EMAIL"
Email
ENUM
:
"ENUM"
Enumeration
EVENT
:
"EVENT"
Event
FILE
:
"FILE"
File
FLOAT
:
"FLOAT"
Floating-point number
FULL_
NAME
:
"FULL_NAME"
Full name
IMAGE
:
"IMAGE"
Image
INTEGER
:
"INTEGER"
Integer
JSON
:
"JSON"
Arbitrary type (JSON)
LINK
:
"LINK"
Link
MONEY
:
"MONEY"
Money
PHONE
:
"PHONE"
Phone
REF_
ITEM
:
"REF_ITEM"
Link to an arbitrary app item
REPORT
:
"REPORT"
Report
ROLE
:
"ROLE"
Role
STATUS
:
"STATUS"
Status
STRING
:
"STRING"
String
SYS_
COLLECTION
:
"SYS_COLLECTION"
Link to an item of a specific app
SYS_
DIRECTORY
:
"SYS_DIRECTORY"
Folder link
SYS_
USER
:
"SYS_USER"
User
TABLE
:
"TABLE"
Table
UUID
:
"UUID"
UUID
Const
Page
Scheme
Type
Page
Scheme
Type
:
object
= {PAGE: "PAGE", NAMESPACE: "NAMESPACE", LINK: "LINK", APPLICATION: "APPLICATION", SEPARATOR: "SEPARATOR", PORTAL_PAGE: "PORTAL_PAGE", CONTRACT: "CONTRACT", REPORT: "REPORT"} as const
Page type
Type declaration
APPLICATION
:
"APPLICATION"
App
CONTRACT
:
"CONTRACT"
Contract
LINK
:
"LINK"
Link
NAMESPACE
:
"NAMESPACE"
Workspace
PAGE
:
"PAGE"
Page
PORTAL_
PAGE
:
"PORTAL_PAGE"
Portal
REPORT
:
"REPORT"
Report
SEPARATOR
:
"SEPARATOR"
Separator
Const
Permissions
Scheme
Value
Org
Unit
Type
Permissions
Scheme
Value
Org
Unit
Type
:
object
= {user: "user", group: "group", orgstruct: "orgstruct", role: "role"} as const
Org structure item type
Type declaration
group
:
"group"
Group
orgstruct
:
"orgstruct"
Org chart element
role
:
"role"
Role
user
:
"user"
User
Const
Permissions
Scheme
Value
Type
Permissions
Scheme
Value
Type
:
object
= {read: "read", create: "create", update: "update", delete: "delete", assign: "assign", bpmanage: "bpmanage", export: "export", import: "import"} as const
Types of permissions
Type declaration
assign
:
"assign"
Assign Permissions
bpmanage
:
"bpmanage"
Business Process Management
create
:
"create"
Create
delete
:
"delete"
Delete
export
:
"export"
Export
import
:
"import"
Import
read
:
"read"
Read/Download
update
:
"update"
Edit
Const
Solution
Scheme
Item
Kind
Solution
Scheme
Item
Kind
:
object
= {namespace: "namespace", extension: "extension"} as const
Component type included in the solution
Type declaration
extension
:
"extension"
Module (extension)
namespace
:
"namespace"
Workspace
Was this helpful?
Thanks for your feedback!
Your review is successfully sent!
Thanks for the feedback.
×
Please specify why:
Recommendations did not help me
Article is hard to understand
Didn`t answer my question
Content does not match the topic
Other
×
How we can improve it?
Yes
No
‹
In this article
Interfaces
Application
Scheme
Application
Scheme
Forms
Application
Scheme
Forms
Create
Form
Application
Scheme
Forms
Detail
Form
Application
Scheme
Forms
Edit
Form
Application
Scheme
Forms
Field
Application
Scheme
Forms
Mass
Edit
Form
Application
Scheme
Forms
Tile
Form
Application
Scheme
Forms
View
Form
Application
Scheme
Params
Application
Scheme
Permission
Settings
Application
Scheme
Service
Base
Application
Scheme
Base
Contract
Scheme
Base
Module
Scheme
Base
Namespace
Scheme
Base
Page
Scheme
Base
Process
Template
Scheme
Base
Report
Scheme
Base
Solution
Scheme
Base
Widget
Scheme
Contract
Scheme
Contract
Scheme
Service
Contract
Scheme
Source
Field
Scheme
Field
Scheme
Account
View
Data
Field
Scheme
Boolean
View
Data
Field
Scheme
Category
Data
Field
Scheme
Date
Time
View
Data
Field
Scheme
Email
View
Data
Field
Scheme
Enum
Data
Field
Scheme
Enum
Data
Enum
Item
Field
Scheme
Link
View
Data
Field
Scheme
Money
View
Data
Field
Scheme
Phone
View
Data
Field
Scheme
Service
Field
Scheme
String
Data
Field
Scheme
String
Data
Mask
Field
Scheme
String
View
Data
Field
Scheme
Sys
Collection
Data
Field
Scheme
Table
Data
Field
Scheme
Table
Data
Field
Field
Scheme
Table
Data
Field
View
Field
Scheme
View
Module
Scheme
Module
Scheme
Service
Namespace
Scheme
Namespace
Scheme
Params
Namespace
Scheme
Params
Field
Namespace
Scheme
Params
Field
Field
View
Namespace
Scheme
Service
Page
Scheme
Page
Scheme
Service
Permissions
Scheme
Permissions
Scheme
Value
Permissions
Scheme
Value
Org
Unit
Process
Template
Scheme
Process
Template
Scheme
Item
Process
Template
Scheme
Item
Settings
Process
Template
Scheme
Item
Settings
Form
Field
Process
Template
Scheme
Process
Process
Template
Scheme
Service
Report
Scheme
Report
Scheme
Column
Report
Scheme
Service
Scheme
Service
Solution
Scheme
Solution
Scheme
Item
Solution
Scheme
Service
Widget
Scheme
Widget
Scheme
Descriptor
Widget
Scheme
Service
Type aliases
Application
Scheme
Permission
Settings
Type
Field
Scheme
Account
View
Data
Type
Field
Scheme
Date
Time
View
Data
Additional
Type
Field
Scheme
Date
Time
View
Data
Default
Time
Field
Scheme
Email
View
Data
Type
Field
Scheme
Phone
View
Data
Type
Field
Scheme
String
View
Data
Additional
Type
Field
Scheme
Type
Page
Scheme
Type
Permissions
Scheme
Value
Org
Unit
Type
Permissions
Scheme
Value
Type
Solution
Scheme
Item
Kind
Variables
Application
Scheme
Permission
Settings
Type
Field
Scheme
Account
View
Data
Type
Field
Scheme
Date
Time
View
Data
Additional
Type
Field
Scheme
Date
Time
View
Data
Default
Time
Field
Scheme
Email
View
Data
Type
Field
Scheme
Phone
View
Data
Type
Field
Scheme
String
View
Data
Additional
Type
Field
Scheme
Type
Page
Scheme
Type
Permissions
Scheme
Value
Org
Unit
Type
Permissions
Scheme
Value
Type
Solution
Scheme
Item
Kind
Report a mistake
There is a mistake in the following text:
Your comment
Send
Cancel
Feedback sent successfully
Thank you for your input
Company configuration metadata
Scheme
Type aliases
ApplicationSchemePermissionSettingsType
FieldSchemeAccountViewDataType
FieldSchemeDateTimeViewDataAdditionalType
FieldSchemeDateTimeViewDataDefaultTime
FieldSchemeEmailViewDataType
FieldSchemePhoneViewDataType
FieldSchemeStringViewDataAdditionalType
FieldSchemeType
PageSchemeType
PermissionsSchemeValueOrgUnitType
PermissionsSchemeValueType
SolutionSchemeItemKind
Variables
Const ApplicationSchemePermissionSettingsType
Access type
Type declaration
collection: "collection"
Access permission settings for app
directory: "directory"
Access permission settings for folders
none: "none"
No access permission settings
row: "row"
Access settings for app items
Const FieldSchemeAccountViewDataType
Account type
Type declaration
facebook: "facebook"
Facebook
google_hangouts: "google_hangouts"
Google Hangouts
google_talk: "google_talk"
Google Talk
instagram: "instagram"
Instagram
line: "line"
Line
livechat: "livechat"
LiveChat
other: "other"
Other
skype: "skype"
Skype
snapchat: "snapchat"
Snapchat
telegram: "telegram"
Telegram
viber: "viber"
Viber
vk_teams: "vk_teams"
VK Teams
vkontakte: "vkontakte"
VK
we_chat: "we_chat"
WeChat
whatsapp: "whatsapp"
WhatsApp
Const FieldSchemeDateTimeViewDataAdditionalType
Date/Time field subtype
Type declaration
date: "date"
Date only
datetime: "datetime"
Date and time
datetime_short: "datetime_short"
Date and time without seconds
time: "time"
Time only
Const FieldSchemeDateTimeViewDataDefaultTime
Default time
Type declaration
endOfDay: "endOfDay"
End of workday
none: "none"
No access permission settings
startOfDay: "startOfDay"
Start of workday
Const FieldSchemeEmailViewDataType
Email type
Type declaration
home: "home"
Home
main: "main"
Main
mobile: "mobile"
Mobile
work: "work"
Workspace
Const FieldSchemePhoneViewDataType
Phone type
Type declaration
home: "home"
Home
home_fax: "home_fax"
Home fax
main: "main"
Main
mobile: "mobile"
Mobile
pager: "pager"
Pager
work: "work"
Workspace
work_fax: "work_fax"
Work fax
Const FieldSchemeStringViewDataAdditionalType
Subtype of the String field type
Type declaration
string: "string"
String
text: "text"
Text
Const FieldSchemeType
Type
Type declaration
ACCOUNT: "ACCOUNT"
Account
BOOLEAN: "BOOLEAN"
Yes/No Switch
CATEGORY: "CATEGORY"
Category
COLLECTION_TYPE: "COLLECTION_TYPE"
App type link
DATETIME: "DATETIME"
Date and time
EMAIL: "EMAIL"
Email
ENUM: "ENUM"
Enumeration
EVENT: "EVENT"
Event
FILE: "FILE"
File
FLOAT: "FLOAT"
Floating-point number
FULL_NAME: "FULL_NAME"
Full name
IMAGE: "IMAGE"
Image
INTEGER: "INTEGER"
Integer
JSON: "JSON"
Arbitrary type (JSON)
LINK: "LINK"
Link
MONEY: "MONEY"
Money
PHONE: "PHONE"
Phone
REF_ITEM: "REF_ITEM"
Link to an arbitrary app item
REPORT: "REPORT"
Report
ROLE: "ROLE"
Role
STATUS: "STATUS"
Status
STRING: "STRING"
String
SYS_COLLECTION: "SYS_COLLECTION"
Link to an item of a specific app
SYS_DIRECTORY: "SYS_DIRECTORY"
Folder link
SYS_USER: "SYS_USER"
User
TABLE: "TABLE"
Table
UUID: "UUID"
UUID
Const PageSchemeType
Page type
Type declaration
APPLICATION: "APPLICATION"
App
CONTRACT: "CONTRACT"
Contract
LINK: "LINK"
Link
NAMESPACE: "NAMESPACE"
Workspace
PAGE: "PAGE"
Page
PORTAL_PAGE: "PORTAL_PAGE"
Portal
REPORT: "REPORT"
Report
SEPARATOR: "SEPARATOR"
Separator
Const PermissionsSchemeValueOrgUnitType
Org structure item type
Type declaration
group: "group"
Group
orgstruct: "orgstruct"
Org chart element
role: "role"
Role
user: "user"
User
Const PermissionsSchemeValueType
Types of permissions
Type declaration
assign: "assign"
Assign Permissions
bpmanage: "bpmanage"
Business Process Management
create: "create"
Create
delete: "delete"
Delete
export: "export"
Export
import: "import"
Import
read: "read"
Read/Download
update: "update"
Edit
Const SolutionSchemeItemKind
Component type included in the solution
Type declaration
extension: "extension"
Module (extension)
namespace: "namespace"
Workspace
Feedback sent successfully
Thank you for your input