Skip to main content
POST
/
utils
/
{resource_type}
/
{resource_uri}
/
fk-edges
/
expand
Expand table selection via FK relationships
curl --request POST \
  --url https://api.example.com/utils/{resource_type}/{resource_uri}/fk-edges/expand \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Project-ID: <x-project-id>' \
  --data '
{
  "table_fqns": [
    "<string>"
  ],
  "max_hops": 2,
  "include_input_tables": true
}
'
{
  "tables": [
    "<string>"
  ],
  "junction_tables": [
    "<string>"
  ],
  "edges_examined": 123
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Project-ID
string
required

Path Parameters

​
resource_type
string
required
​
resource_uri
string
required

Body

application/json

Request to expand table selection via FK relationships.

​
table_fqns
string[]
required

Table FQNs to expand from (max 100)

Required array length: 1 - 100 elements
​
max_hops
integer
default:2

Maximum BFS depth (1-10, default 2)

Required range: 1 <= x <= 10
​
include_input_tables
boolean
default:true

Include input tables in result

Response

Successful Response

Response for table expansion.

​
tables
string[]
required

Expanded table FQNs (deduplicated)

​
junction_tables
string[]
required

Junction tables discovered

​
edges_examined
integer
required

Number of FK edges examined during BFS