Schema
We are no longer updating this site. For user documentation, please go to User Docs. For developer documentation, please go to Developer Docs. If you have any questions or feedback, please submit a ticket.
All data in Zaius is stored within collections called Objects (what many think of as a database table).
Objects are composed of Fields.
Fields link objects together via Relations.
Object Definition
{
"name": "object_name",
"display_name": "Display Name",
"alias": "object_alias",
"fields": [],
"relations": []
}
property | description |
name | plural name for the object |
display_name | user-friendly name shown within Zaius |
alias | singular name for the object |
fields | collection of Field objects constituting the Object |
relations | collection of Relation objects |
post
https://api.zaius.com/v3
/schema/objects
Create Object
Example Payload
{
"name": "objects",
"display_name": "Object",
"alias": "object",
"fields": [
{
"name": "object_id",
"display_name": "New Object Identifier",
"type": "string",
"primary": true
},{
"name": "another_field",
"display_name": "Another Fields",
"type": "string"
},{
"name": "child_id",
"display_name": "Child Identifier",
"type": "number"
}
],
"relations": [
{
"name": "my_relation",
"display_name": "My Relationship",
"child_object": "child",
"join_fields": [{
"parent": "child_id",
"child": "child_id"
}]
}
]
}
get
https://api.zaius.com/v3
/schema/objects
List Objects
Example Request
curl -iX GET \
'https://api.zaius.com/v3/schema/objects' \
-H 'x-api-key: example.apiKey'
get
https://api.zaius.com/v3
/schema/objects/{object_name}
Get Object
Example Request
curl -iX GET \
'https://api.zaius.com/v3/schema/objects/myobject' \
-H 'x-api-key: example.apiKey'
{
"name": "field_name",
"type": "number",
"auto": true,
"display_name": "Display Name",
"description": "Description of field",
"created_by": "zaius",
"primary_key": true
}
property | description |
name | name of the field |
type | field data type. options are number, timestamp, text, boolean |
auto | (read only) marks the field as one that is auto populated by Zaius |
display_name | the user-friendly name used within Zaius |
description | description of the field |
created_by | (read only) specifies what/who created the field. current values as zaius and account |
primary_key | marks the field as identifying for the containing object. only allowed during object creation. |
post
https://api.zaius.com/v3
/schema/objects/{object_name}/fields
Create Field
Example Payload
{
"name": "field_name",
"type": "number",
"display_name": "Display Name",
"description": "Description of field"
}
If you are attempting to create an identifier (e.g. an address for messaging or an internal reference to a customer record similar to an email, phone number or token), refer to the Identifier API documentation:
get
https://api.zaius.com/v3
/schema/objects/{object_name}/fields
List Fields
Example Payload
{
"name": "my_relation",
"display_name": "My Relationship",
"child_object": "child",
"join_fields": [{
"parent": "child_id",
"child": "child_id"
}]
}
Example Request
curl -iX GET \
'https://api.zaius.com/v3/schema/objects/{object_name}/fields' \
-H 'x-api-key: example.apiKey'
get
https://api.zaius.com/v3
/schema/objects/{object_name}/fields/{field_name}
Get Field
Example Request
curl -iX GET \
'https://api.zaius.com/v3/schema/objects/{object_name}/fields/{field_name}' \
-H 'x-api-key: example.apiKey'
Representation describing a relationship between two objects. The
Object containing the Relation definition is the parent object.{
"name": "relation_name",
"display_name": "Relation Display Name",
"child_object": "child_object_name",
"join_fields": [{
"parent": "child_id",
"child": "child_id"
}]
}
property | description |
name | name for the relation |
display_name | user-friendly name shown within Zaius |
child_object | child Object name |
join_fields | collection of parent child pairs. parent is the field name (foreign key) on the owning Object and child is the related Objects primary key. Multiple are allowed to support objects with compound primary keys. |
post
https://api.zaius.com/v3
/schema/objects/{object_name}/relations
Create Relationship
get
https://api.zaius.com/v3
/schema/objects/{object_name}/relations
List Relations
Example Request
curl -iX GET \
'https://api.zaius.com/v3/schema/objects/{object_name}/relations' \
-H 'x-api-key: example.apiKey'
get
https://api.zaius.com/v3
/schema/objects/{object_name}/relations/{relation_name}
Get Relation
Example Request
curl -iX GET \
'https://api.zaius.com/v3/schema/objects/{object_name}/relations/{relation_name}' \
-H 'x-api-key: example.apiKey'
Last modified 10mo ago