Skip to content

Common input options

David Megginson edited this page Jun 22, 2022 · 1 revision

These input options are common to most API endpoints for the HXL Proxy. They will be ignored if not relevant to the endpoint.

Property Type Description
url string The URL of the resource to be processed.
sheet integer (Excel only.) The index of the sheet to process, starting from 0. If omitted, the HXL Proxy will scan for the first HXLated resource.
timeout integer The timeout, in seconds, for downloading the resource.
skip_verify_ssl boolean If specified (e.g. "on"), do not verify SSL certificates when downloading the resource.
selector string (JSON only) If specified, look for HXLated JSON data under this top-level property. If omitted, the HXL Proxy will search the JSON for HXLated data.
encoding string (CSV only) The character encoding to use for CSV data. If omitted, use the encoding supplied by the web server, or default to UTF-8.
expand_merged boolean (Excel only) If specified (e.g. "on"), automatically fill merged areas in sheets with the top value.
scan_ckan_resources boolean (CKAN-hosted resources only) For a CKAN dataset/package link, scan resources for the first HXLated one. If omitted, always try to process the first resource.
Clone this wiki locally