GET records/children/{parentId}
gov.uk:uk-national-archives-discovery-api
Summary: Get collection of related records within one cataloguing level
Operation ID: Records_GetChildren_2
Auth: unknown
Operation ID: Records_GetChildren_2
Auth: unknown
Description
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. <para>Can be used with {batchStartRecordId} but {batchStartMark} takes precedence</para>
batchStartRecordId
(string, query, optional)
Value of a record's ID field from which the next page will start. <para>Can be used with {batchStartMark} but {batchStartMark} takes precedence</para>
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)
Number of records returned by the request. <b>Range [1,500], default 30</b>
parentId
(string, path, required)
ID of the parent record
No probe data for this endpoint yet.