Skip to main content

PathsOutcomeResponse

Data returned for Paths Outcome. Required fields are entity, truncated, caps_fired, columns, rows, start_keys, and 3 more.

entityEntity (string)required

Terminal type of the definition

truncatedTruncated (boolean)required
caps_fired object[]required
  • Array [
    • op objectrequired
    anyOf
    integer
    capCap (string)required
    level objectrequired
    anyOf
    integer
  • ]
    • terminalTerminal (string)
    Constant value: paths
    Default value: paths
    columnsstring[]required
    rowsarray[]required
    start_keysarray[]required
    reachedarray[]required

    Key set materialized per hop

    partials object[]required

    Paths that stopped before the terminal

  • Array [
    • hopHop (integer)required
    keys objectrequired
    property name* undefined[]
  • Array [
  • ]
  • ]
    • unpairedarray[]required

    Terminal keys no path reached

    PathsOutcomeResponse
    {
      "entity": "string",
      "truncated": true,
      "caps_fired": [
        {
          "op": 0,
          "cap": "string",
          "level": 0
        }
      ],
      "terminal": "paths",
      "columns": [
        "string"
      ],
      "rows": [
        null
      ],
      "start_keys": [
        null
      ],
      "reached": [
        null
      ],
      "partials": [
        {
          "hop": 0,
          "keys": {}
        }
      ],
      "unpaired": [
        null
      ]
    }