Interface: ObjectDefinition

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

Properties

alias?

optional 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.

display_name

display_name: string

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

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

fields

fields: FieldDefinition[]

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

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

name

name: string

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

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.

relations?

optional relations: RelationDefinition[]

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

Initial list of relation definitions, if any.