v1

latestOpenAPI 3.0.02026-07-263039205.4 KB
Bulk Enhance

Download Results of Bulkjob

Download the result of a completed Enhance Bulkjob

get/kg/v3/enhance/bulk/{bulkjobId}

Path parameters

bulkjobIdstring required

Enhance Bulkjob ID

Query parameters

headinteger

Return first n results

frominteger

1-based index of the first result to return (1 = first result).

sizeinteger

Maximum number of results to return starting from the 'from' position.

onlyMatches'true' | 'false'

Return only records that have a match

format'json' | 'jsonl' | 'csv' | 'xls' | 'xlsx'

Export format

exportspecstring

The spec defines the columns to export. This is applicable for csv, xls and xslx formats.<br><br>Export spec specifies how to export the entity JSON to a csv. A simple export spec looks like name;summary. To specify more complex export spec, including specifying how many of a list of industries to return, or the ideal employment record, see Exporting Columnar Format and JsonPath Filtering.

exportfilestring

File name of the export file

exportseparatorstring

Separator for multi-value fields when exporting columnar results

exportquery'true' | 'false'

Prefixes the enhance query parameters to the CSV export result

filterstring

Semi-colon separated path filter to filter response json. You can use a simple dot notation skills.name or a JsonPath expression such as such as $.name;$.locations.country.name. For more advanced options, see JsonPath Filtering for syntax.

filterExcludestring

Semi-colon separated path filter to filter and exclude data from response json. You can use a simple dot notation skills.name or a JsonPath expression such as such as $.name;$.locations.country.name. For more advanced options, see JsonPath Filtering for syntax.

waitinteger

Seconds to wait for bulkjob results to export. Results will continue to export in the background. To only trigger an export, use 0.

Response

Result data. Depends on format (default is json lines).

JsonNode required