Skip to content
getgeolens.com
GeoLens Docs

List Dataset Relationships

GET
/datasets/{dataset_id}/relationships/
 
curl --request GET \
  --url 'https://example.com/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/relationships/?skip=0&limit=100'

List FK relationships for a dataset.

Paginated via skip and limit to bound response size for datasets with large numbers of auto-detected relationships. Returns the standard list envelope (relationships + total) so callers can detect whether more pages exist (GAP-033); total counts the visible relationships before pagination.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
dataset_id
required
Dataset Id
string format: uuid

Query Parameters

Section titled “Query Parameters ”
skip
Skip

Number of relationships to skip.

integer
0

Number of relationships to skip.

limit
Limit

Maximum number of relationships to return (PERF-N16).

integer
default: 100 >= 1 <= 1000

Maximum number of relationships to return (PERF-N16).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
DatasetRelationshipListResponse

Paginated list envelope for dataset FK relationships (GAP-033).

Mirrors the {<entity>: [...], total: int} convention used by every other paginated list endpoint (e.g. AttributeMetadataListResponse, VrtGenerationListResponse) so callers can detect whether more pages exist. total is the count of visible relationships before skip/limit.

object
relationships
required
Relationships
Array<object>
DatasetRelationshipResponse
object
id
required
Id
string format: uuid
label
required
Any of:
string
relationship_type
required
Relationship Type
string
source_column
required
Source Column
string
source_dataset_id
required
Source Dataset Id
string format: uuid
target_column
required
Target Column
string
target_dataset_id
required
Target Dataset Id
string format: uuid
target_dataset_title
Any of:
string
total
required
Total
integer
Example generated
{
  "relationships": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "label": "example",
      "relationship_type": "example",
      "source_column": "example",
      "source_dataset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "target_column": "example",
      "target_dataset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "target_dataset_title": "example"
    }
  ],
  "total": 1
}

400

Section titled “400 ”

Bad request — invalid payload

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Section titled “401 ”

Unauthorized — missing or invalid credentials

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Section titled “403 ”

Forbidden — caller lacks write access

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Section titled “404 ”

Not found

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

409

Section titled “409 ”

Conflict — resource state prevents the operation

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Section titled “422 ”

Validation error

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Section titled “429 ”

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “500 ”

Internal server error

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Section titled “503 ”

Service unavailable — the database could not serve the request

Media type application/problem+json
ProblemDetail
object
detail
required
Any of:
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}