page

No

The number of the page to query. If omitted, the default value of 1 is taken (the first page).

page_size

No

The number of rows returned per-page. When omitted, the default value of 1000 items per page is used. The maximum allowed value can be configured by administrators via the MaxBatchSize setting (see API Configuration). Exceeding this range or providing invalid values will coerce the value to the configured maximum.

includeDataTypes

No (default: true)

This parameter is only relevant for CSV file requests.

If set to false, then the CSV will receive an extra token after the header name, which contains the desired value type, enclosed by square brackets.

If you omit this parameter or set it to true, the returned CSV will not have this extra information, and the CSV column names will be a 1-1 representation of the column names.

includeMetadata

No (default: false)

Delta Feature Only: When set to true, includes metadata columns (__dh_created_at, __dh_last_modified, __dh_md5_checksum). This parameter is only available when the backup & delta feature is enabled for the tenant. See Delta Comparison Feature for more information.

createdSince

No

Delta Feature Only: Retrieve only rows created on or after the specified timestamp. Format: ISO 8601 (e.g., "2025-01-15T10:30:00Z"). Can be combined with createdUntil to define a time span. Only available when delta feature is enabled.

createdUntil

No

Delta Feature Only: Retrieve only rows created before or on the specified timestamp. Format: ISO 8601 (e.g., "2025-01-31T23:59:59Z"). Only available when delta feature is enabled.

updatedSince

No

Delta Feature Only: Retrieve only rows updated on or after the specified timestamp. Format: ISO 8601 (e.g., "2025-01-15T10:30:00Z"). Can be combined with updatedUntil to define a time span. Only available when delta feature is enabled.

updatedUntil

No

Delta Feature Only: Retrieve only rows updated before or on the specified timestamp. Format: ISO 8601 (e.g., "2025-01-31T23:59:59Z"). Only available when delta feature is enabled.

ApiKey

Yes

Your API key (see chapter Authentication and authorization for more information how to get it).

Accept

Yes

This determines the format of the data. Available supported values are:

application/json
text/comma-separated-values

$dataHubApiKey = "M6KNS9Z-3404R00-Q42E4SG-1G4HKWT";

$dataHubHostName = "https://datahub.local";

$dataHubPort = 443;

$tableName = "CatalogSoftware";

$pageSize = 10;

$page = 1;

$urlAddress = "{0}:{1}/v1/resultDatabase/table/{2}/paged?page={3}&page_size={4}" -f $dataHubHostName, $dataHubPort, $tableName, $page, $pageSize

$headers = @{};

$headers["ApiKey"] = $dataHubApiKey;

$headers["Accept"] = "application/json";

$request = Invoke-WebRequest -Uri $urlAddress -Headers $headers -Method Get;

if ($request.StatusCode -eq 200) {

    $parsedContent = ConvertFrom-Json($request);

    Write-Host "Available columns:";

    foreach ($item in $parsedContent.columns) {

        Write-Host (" * {0} ({1}) " -f $item.name, $item.type);

    }

    Write-Host "";

    Write-Host "Number of records:";

    Write-Host $parsedContent.records.Count;

    Write-Host "";

    Write-Host "Pages":

    Write-Host (" * First:    {0}" -f $parsedContent.pagination.first);

    Write-Host (" * Previous: {0}" -f $parsedContent.pagination.previous);

    Write-Host (" * Next:     {0}" -f $parsedContent.pagination.next);

    Write-Host (" * Last:     {0}" -f $parsedContent.pagination.last);

} else {

    throw "Could not download the file. HTTP code $($req.StatusCode)";    

}