Definition

Shared request and response schema. Request: Data accepted by Execute Ontology Request. The required field is from. Response: Fields that define Definition. The required field is from.

from objectrequired

Where a definition starts: one type (entity or relation) and, optionally, the rows to start from. anchors are {column: value} maps that name every key column of the type (compile checks); extra columns are only meaningful under upsert, where the anchor row is the row written.

entity object

EntityType id

anyOf

• string
• null

string

relation object

RelationType id

anyOf

• string
• null

string

anchors object

Start rows as {key column: value} maps

anyOf

• object[]
• null

Array [

property name*any

]

ops object[]

Array [

where object

anyOf

• object
• null

object

traverse object

anyOf

• string
• string[]
• null

string

direction object

anyOf

• string
• null

string

Possible values: [out, in]

depth object

anyOf

• integer
• null

integer

Possible values: >= 1

to object

anyOf

• string
• null

string

Constant value: link

alias object

anyOf

• string
• null

string

Possible values: non-empty

union object

anyOf

• Option 1
• null

intersect object

anyOf

• Option 1
• null

subtract object

anyOf

• Option 1
• null

derive object

anyOf

• object
• null

object

]

caps object

anyOf

• Caps
• null

depth object

anyOf

• integer
• null

integer

Possible values: >= 1

frontier_per_level object

anyOf

• integer
• null

integer

Possible values: >= 1

max_nodes object

anyOf

• integer
• null

integer

Possible values: >= 1

max_edges object

anyOf

• integer
• null

integer

Possible values: >= 1

intermediate object

anyOf

• integer
• null

integer

Possible values: >= 1

matching object

anyOf

• integer
• null

integer

Possible values: >= 1

pin object

anyOf

• Pin
• null

txn objectrequired

anyOf

• integer
• object

integer

versions object

anyOf

• object
• null

object

Definition

{
  "from": {
    "entity": "string",
    "relation": "string",
    "anchors": [
      {}
    ]
  },
  "ops": [
    {
      "where": {},
      "traverse": "string",
      "direction": "out",
      "depth": 0,
      "to": "link",
      "alias": "string",
      "derive": {}
    }
  ],
  "caps": {
    "depth": 0,
    "frontier_per_level": 0,
    "max_nodes": 0,
    "max_edges": 0,
    "intermediate": 0,
    "matching": 0
  },
  "pin": {
    "txn": 0,
    "versions": {}
  }
}