Get
/relatedData/listDataSets
Returns a page of visible regular Related Data sets ordered by ID ascending. The status filter defaults to active. Pagination is not a snapshot across concurrent changes.
Query parameters
term
string
Optional literal name substring
status
string
active, archived or all (case-insensitive); defaults to active
page
integer (int32)
One-based page; defaults to 1
limit
integer (int32)
Page size, 1 to 500; defaults to 25
Responses
200
A page of data sets
object
dataSets
Array of object (RelatedDataSetSummary)
object
id
integer (int64)
name
string
description
string
keyType
string
linkedUserAttributeName
string
uniqueColumnName
string
archived
boolean
Defaultfalse
recordCount
integer (int64)
page
integer (int32)
limit
integer (int32)
totalCount
integer (int64)
400
Invalid status, page or limit
403
Missing Related Data read permission