FieldDefinition

8 min

ODP Node SDKODP Node SDK / ZaiusZaius / FieldDefinition

FieldDefinition

The Zaius Field definition payload for schema APIs. See V3 Schema APIV3 Schema API for details.

Index

Properties

descriptiondescription

display\_namedisplay_name

namename

primaryprimary

typetype

Properties

description?

string

Description of the field and how it will be referenced in the Zaius UI. While optional, it's use is strongly encouraged.

Defined in: src/Api/Types/Schema.ts:24

display_name

string

The user-friendly name used within Zaius. Must be unique across all display names within the object.

Defined in: src/Api/Types/Schema.ts:19

name

string

The name of the field. Lower snake case, alphanumeric, must start with an alpha character. Must be unique across all field names within the object.

Defined in: src/Api/Types/Schema.ts:11

primary?

boolean

Used when creating new objects to denote this field should be used as the primary key for the object. Should be undefined or false for all other fields.

Defined in: src/Api/Types/Schema.ts:29

type

"string" | "number" | "boolean" | "timestamp" | "vector"

The type of the field: string, number, timestamp, boolean or vector.

Defined in: src/Api/Types/Schema.ts:15