Skip to main content
GET
Get a where-used report

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

Identifier of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
node_id
string<shortuuid>
required

Identifier of the lot node, from the lot search.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

direction
enum<string>
default:downstream

Which way to walk.

Available options:
downstream,
upstream

Response

OK

A genealogy report for one lot, forward (where used) or reverse (input genealogy).

direction
string
required

downstream (where the lot went) or upstream (what went into it).

subject
string
required

The lot the report is about.

coverage
string
required

What we hold about the lot: recorded, no_links_recorded (indexed, nothing linked) or not_indexed. It says what we hold, never what the world contains.

max_depth
integer
required

The deepest step the walk takes.

truncated
boolean
required

Whether the walk stopped at max_depth with lots left to reach.

recalled_count
integer
required

How many listed lots are under an active recall.

rows
WhereUsedRowOut · object[]
required