ODP Node SDK / ODP / ObjectDefinition

ObjectDefinition

The ODP Object definition payload for schema APIs.
See V3 Schema API
for details.

Index

Properties

• alias
• display_name
• fields
• name
• relations

Properties

alias?

string

An alias for the object that can be used during ingest. Should be the singular form of the name.
Must be unique across all object names and aliases within the schema.
Will be automatically derived if not specified.

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

display_name

string

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

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

fields

FieldDefinition[]

Initial list of field definitions. Must at least contain a primary key field.

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

name

string

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

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

relations?

RelationDefinition[]

Initial list of relation definitions, if any.

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