Record

Record object is used to capture stateless data. For example a contact or an SKU Item is modeled as a record object. These are stateless data only used to store some amount of information.

At the core of it a record is defined by the following fields

data

data is a json field containing the actual data defining a record instance. the key is either the shortId or the id of the record attribute. all internal apis publish record data as id:value pair while external apis publish data as shortId:value pairs

Example:

{
  "first_name": "Cixin",
  "last_name": "Liu",
  "phone_num": "440123000"
}

fields

name	data type	type info	description
id	string	uuid	id of the record- auto generated
entity	string	uuid	id of the entity which this record belongs to
team	string	uuid	id of the team to which this record belongs to
createdBy	string	uuid	User id of the user who created the record
data	json		id:value json object storing the actual data
derivedData	json		id:value json object storing the derived data
createdAt	number	epoch ms	timestamp at which the record was created
updatedAt	number	epoch ms	timestamp at which the record was updated
isDeleted	boolean		flag indicating wether this record is deleted or not

data​

fields​

data

fields