โ† API reference
Query / logistics

whatIf

First-class hypothetical impact: the delta between the baseline reachable set from seeds and the reachable set with extraEdges unioned in, plus whether the injected edges introduce a cycle. Requires provenance:read permission.

Arguments

seeds[ID!]!

TypeIDs of the entities to start the hypothetical walk from.

extraEdges[WhatIfEdgeInput!]!

Hypothetical edges to union into the walk (never persisted).

directionString

Traversal direction: "downstream", "upstream", or "both". Defaults to "downstream".

maxDepthInt

Maximum traversal depth. Defaults to 5.

graphString

Graph to walk: "fulfillment", "provenance", or "structural". Defaults to "structural".

Returns WhatIfResult!

Scalar fields at a glance

introducesCycleBoolean!
โ†— View the complete WhatIfResult type

Explore in a view

Fulfillment
View exact SDL
"""
First-class hypothetical impact: the delta between the baseline reachable set from seeds and the reachable set with extraEdges unioned in, plus whether the injected edges introduce a cycle. Requires provenance:read permission.
"""
whatIf(
  """TypeIDs of the entities to start the hypothetical walk from."""
  seeds: [ID!]!
  """Hypothetical edges to union into the walk (never persisted)."""
  extraEdges: [WhatIfEdgeInput!]!
  """
  Traversal direction: "downstream", "upstream", or "both". Defaults to "downstream".
  """
  direction: String
  """Maximum traversal depth. Defaults to 5."""
  maxDepth: Int
  """
  Graph to walk: "fulfillment", "provenance", or "structural". Defaults to "structural".
  """
  graph: String
): WhatIfResult! @topic(names: ["logistics"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.