ODP Node SDK / ODP / Schema

Interface: Schema

Defined in: src/Api/Schema/index.ts:18

Properties

createField()

createField: (object, field) => Promise<HttpResponse<FieldDefinition>>

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

Parameters

object

string

field

FieldDefinition

Returns

Promise<HttpResponse<FieldDefinition>>

createIdentifier()

createIdentifier: (identifier) => Promise<HttpResponse<CreateIdentifierResponse>>

Defined in: src/Api/Schema/index.ts:20

Parameters

identifier

IdentifierDefinition

Returns

Promise<HttpResponse<CreateIdentifierResponse>>

createObject()

createObject: (object) => Promise<HttpResponse<ObjectDefinition>>

Defined in: src/Api/Schema/index.ts:25

Parameters

object

ObjectDefinition

Returns

Promise<HttpResponse<ObjectDefinition>>

createRelation()

createRelation: (object, relation) => Promise<HttpResponse<RelationDefinition>>

Defined in: src/Api/Schema/index.ts:26

Parameters

object

string

relation

RelationDefinition

Returns

Promise<HttpResponse<RelationDefinition>>

enableModule()

enableModule: (module) => Promise<HttpResponse<ModulesResponse>>

Defined in: src/Api/Schema/index.ts:21

Parameters

module

string

Returns

Promise<HttpResponse<ModulesResponse>>

getAllObjects()

getAllObjects: () => Promise<HttpResponse<ObjectDefinition[]>>

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

Returns

Promise<HttpResponse<ObjectDefinition[]>>

getEnabledModules()

getEnabledModules: () => Promise<HttpResponse<ModulesResponse>>

Defined in: src/Api/Schema/index.ts:22

Returns

Promise<HttpResponse<ModulesResponse>>

getObject()

getObject: (name) => Promise<HttpResponse<ObjectDefinition>>

Defined in: src/Api/Schema/index.ts:23

Parameters

name

string

Returns

Promise<HttpResponse<ObjectDefinition>>