Skip to main content
GET
Get the derivation graph around an attribute.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

attribute_name_or_id
required

Either an attribute name or an attribute id Unique identifier

Query Parameters

direction
enum<string>
default:both

Which way to walk from the attribute. descendants follows rules from source to target and reaches what can be derived from the attribute; ancestors follows them from target to source and reaches what the attribute can be derived from. The default walks both ways.

Available options:
descendants,
ancestors,
both

Response

OK

The part of the derivation graph reachable from one attribute through active rules the caller may use, over attributes the caller can view. nodes and edges are flat lists rather than a nested tree because the graph can contain cycles (a rule from birthdate to age and one from age to birthdate are both legitimate). A program walks the adjacency through edges; a person reads paths.

The walk goes as far as query resolution can chain rules, which is one rule today, so every path listed is one a query can use. At most 50 paths are returned, descendants before ancestors.

attribute_id
integer<int64>
required
attribute_name
string
required

An short identifier for the attribute to be used when it is referenced in validations.

Attribute names must consist of only alphanumeric characters or underscores and be < 255 characters long.

direction
enum<string>
required

The direction the walk followed, as requested.

Available options:
descendants,
ancestors,
both
edges
object[]
required

Every rule connecting two of the nodes, in rule id order.

nodes
object[]
required

The requested attribute first, then the rest by distance and then by id.

paths
object[]
required