GET records/v1/children/{parentId}
gov.uk:uk-national-archives-discovery-api
Summary: Get collection of related records within one cataloguing level
Operation ID: getRecordChildren
Auth: unknown
Operation ID: getRecordChildren
Auth: unknown
Description
Retrieve child records of a parent record. Values of parentId, batchStartRecordId and batchStartMark are case sensitive.
Parameters (6)
batchStartMark
(string, query, optional)
Value of a record's SortKey field from which the next page will start
batchStartRecordId
(string, query, optional)
Value of a record's ID field from which the next page will start
direction
(string, query, optional)
Paging direction
Constraints: {'enum': ['NEXT', 'PREV']}
includeCursor
(boolean, query, optional)
Include or exclude cursor in the list of records returned by the query
limit
(integer, query, optional, default: 30)
Number of records returned by the request. Range [1,500], default 30
Constraints: {'minimum': 1, 'maximum': 500}
parentId
(string, path, required)
ID of the parent record
No probe data for this endpoint yet.