Skip to main content
interface GetRecordsBySeriesRequest
encoding?: string;
limit?: number;
offset?: number;
options?: Record<string, string>;
table_name: string;
world_table_name: string;
encoding? limit? offset? options? table_name world_table_name
encoding?: string

Specifies the encoding for returned records; either binary or json.

limit?: number

A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.

offset?: number

A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results).

options?: Record<string, string>

Optional parameters.

table_name: string

Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules.

world_table_name: string

Name of the table containing the complete series/track information to be returned for the tracks present in the table_name, in [schema_name.]table_name format, using standard name resolution rules. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.