v1

latestOpenAPI 3.0.02026-08-066425196.1 KB
Records

Get records which are immediate children of a specified parentNaId.

Get records which are immediate children of a specified parentNaId. Returns a JSON result.

get/records/parentNaId/{parentNaId}

Path parameters

parentNaIdstring required

id of parent whose immediate children to return

Query parameters

controlGroupstring

Specifies a Control Group number associated with an archival record and returns an Archival Description or Archival Descriptions within this Control Group.

pageinteger

Page number of the paginated result set in which to return.

limitinteger

Maximum number of results returned for each page of paginated data.

debugboolean

Turns on debug mode, showing metadata in the response body, if set to true.

abbreviatedboolean

Abbreviated results flag, which when true, returns a shorter version of the results.

ingestTimeStartstring

The ingestTimeStart parameter specifies the date or timestamp for fetching data.

Date only format: YYYY-MM-DD When provided in this format, the time defaults to 00:00:00.000000. Example: 2025-01-13 → interpreted as 2025-01-13 00:00:00.000000

Full timestamp format: YYYY-MM-DD HH:mm:ss.SSSSSS When provided in this format, data will be fetched for the exact timestamp specified. Example: 2025-01-13 14:30:15.123456 → data fetched at this precise datetime

Behavior: If both ingestTimeStart and ingestTimeEnd are provided, description records within that date/time range are retrieved. If only ingestTimeStart is provided, description records on and after that date/time are retrieved. If only ingestTimeEnd is provided, description records on and before that date/time are retrieved.

ingestTimeEndstring

The ingestTimeEnd parameter specifies the date or timestamp for fetching data.

Date only format: YYYY-MM-DD When provided in this format, the time defaults to 23:59:59.999999 Example: 2025-01-13 → interpreted as 2025-01-13 23:59:59.999999

Full timestamp format: YYYY-MM-DD HH:mm:ss.SSSSSS When provided in this format, data will be fetched for the exact timestamp specified. Example: 2025-01-13 14:30:15.123456 → data fetched at this precise datetime

Behavior: If both ingestTimeStart and ingestTimeEnd are provided, description records within that date/time range are retrieved. If only ingestTimeStart is provided, description records on and after that date/time are retrieved. If only ingestTimeEnd is provided, description records on and before that date/time are retrieved.

Response

A body of response data containing full record objects, if any were found.