Type Alias: VocabularyRecordRef
@kortexya/reasoninglayer / VocabularyRecordRef
Type Alias: VocabularyRecordRef
Section titled “Type Alias: VocabularyRecordRef”VocabularyRecordRef = {
by:"record";recordId:string; } | {by:"client_ref";clientRef:string; }
Defined in: src/types/vocabulary.ts:318
A reference to a record: an existing record by id, or a record created in the same request by its client reference.
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ by: "record"; recordId: string; }
by:
"record"
Discriminator: an existing record.
recordId
Section titled “recordId”recordId:
string
The record id (UUID).
Type Literal
Section titled “Type Literal”{ by: "client_ref"; clientRef: string; }
by:
"client_ref"
Discriminator: a record created in the same request.
clientRef
Section titled “clientRef”clientRef:
string
The client reference given to that record.
Remarks
Section titled “Remarks”Wire format: internally tagged by by — {"by":"record","record_id":…} or
{"by":"client_ref","client_ref":…}.