Skip to main content

OntologyCompileResponse

Data returned for Ontology Compile. Required fields are terminal, terminal_type, entity_types, relation_types, write_targets, derived, and 2 more.

terminalTerminal (string)required

The terminal the request carries

terminal_typeTerminal Type (string)required

The type the definition ends at

entity_typesstring[]required

Entity types the definition names

relation_typesstring[]required

Relation types the definition names

write_targets object[]required

What a write terminal writes — empty for a read or compile

  • Array [
  • object_typeObject Type (string)required

    entity_type or relation_type

    object_idObject Id (string)required
  • ]
  • derivedstring[]required

    Derived attribute names in scope at the terminal

    multiplicityMultiplicity (string)required

    A write over a DUPLICATE set is refused

    Possible values: [UNIQUE, DUPLICATE]

    walksWalks (integer)required

    Walks this definition spends of the budget

    OntologyCompileResponse
    {
    "terminal": "string",
    "terminal_type": "string",
    "entity_types": [
    "string"
    ],
    "relation_types": [
    "string"
    ],
    "write_targets": [
    {
    "object_type": "string",
    "object_id": "string"
    }
    ],
    "derived": [
    "string"
    ],
    "multiplicity": "UNIQUE",
    "walks": 0
    }