latestSwagger 2.02026-08-2053114259.7 KB

41da8739a690

Dataset Management

Get all datasets (paginated)

Returns a paginated response of the datasets that the user has access to. Optionally filter by dataset name using the search parameter. Each dataset contains a set of minimal info, for more detailed information on a given dataset use the /api/dataset/{datasetId} endpoint.

get/api/Dataset/paginated

Query parameters

sortBystring

The field to sort by. Defaults to LastUpdated.

sortDirectionstring

The sort direction. Defaults to Desc (newest first for LastUpdated, Z-A for Name).

offsetinteger

Gets the offset for pagination.

limitinteger

Gets the limit for pagination.

filterSynthesizedboolean

When true, excludes synthesized datasets from results

searchstring

Filter datasets by name

tagsstring[]

Filter datasets that match any of the specified tags

createdBystring[]

Filter datasets by creator user IDs

fileSourcesFileSource[]

Filter datasets by source type

fileTypesFileTypeEnum[]

Filter datasets by file type

requireOperationstring

When specified, only returns datasets where the user has this operation

Response

Returns paginated list of datasets

offsetinteger

The offset from the first item in the results. For example, 20 indicates that this batch of results starts with the 21st result.

limitinteger

The number of items the request limited the search to. The number of returned items can be less than the limit if not enough items exist or match the filter criteria.

pageNumberinteger

The number for this page of the results, starting at 1.

totalPagesinteger

The total number of pages in the results.

totalRecordsinteger

The total number of records in the results.

absoluteTotalRecordsinteger

The absolute total number of records available (unfiltered). This represents the total count without any search or filter applied.

hasPreviousPageboolean

Whether there is a previous page of results.

hasNextPageboolean

Whether there is a next page of results.