POST /api/admin/data-scanner/results/export/

Creates a job to export data scan results to CSV. The exported file includes scan name, workspace, database, table, field, row ID, matched value, and timestamps for each result. Enterprise feature.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
csv_column_separator String No

The value used to separate columns in the resulting csv file.

  • , - ,
  • ; - ;
  • | - |
  • tab -
  • record_separator -
  • unit_separator -

Valid values:

  • "unit_separator"
  • ","
  • "|"
  • ";"
  • "tab"
  • "record_separator"

Default value: ","

filter_scan_id Integer No

Optional: Filter results by scan ID.

url String Yes
export_charset String No

The character set to use when creating the export file.

  • utf-8 - utf-8
  • iso-8859-6 - iso-8859-6
  • windows-1256 - windows-1256
  • iso-8859-4 - iso-8859-4
  • windows-1257 - windows-1257
  • iso-8859-14 - iso-8859-14
  • iso-8859-2 - iso-8859-2
  • windows-1250 - windows-1250
  • gbk - gbk
  • gb18030 - gb18030
  • big5 - big5
  • koi8-r - koi8-r
  • koi8-u - koi8-u
  • iso-8859-5 - iso-8859-5
  • windows-1251 - windows-1251
  • x-mac-cyrillic - mac-cyrillic
  • iso-8859-7 - iso-8859-7
  • windows-1253 - windows-1253
  • iso-8859-8 - iso-8859-8
  • windows-1255 - windows-1255
  • euc-jp - euc-jp
  • iso-2022-jp - iso-2022-jp
  • shift-jis - shift-jis
  • euc-kr - euc-kr
  • macintosh - macintosh
  • iso-8859-10 - iso-8859-10
  • iso-8859-16 - iso-8859-16
  • windows-874 - cp874
  • windows-1254 - windows-1254
  • windows-1258 - windows-1258
  • iso-8859-1 - iso-8859-1
  • windows-1252 - windows-1252
  • iso-8859-3 - iso-8859-3

Valid values:

  • "gb18030"
  • "iso-8859-10"
  • "shift-jis"
  • "iso-8859-14"
  • "koi8-u"
  • "euc-jp"
  • "windows-1253"
  • "windows-1255"
  • "windows-874"
  • "windows-1257"
  • "iso-8859-4"
  • "iso-2022-jp"
  • "iso-8859-2"
  • "gbk"
  • "iso-8859-8"
  • "iso-8859-6"
  • "windows-1251"
  • "x-mac-cyrillic"
  • "macintosh"
  • "iso-8859-1"
  • "koi8-r"
  • "big5"
  • "windows-1254"
  • "euc-kr"
  • "windows-1256"
  • "windows-1258"
  • "iso-8859-5"
  • "iso-8859-16"
  • "iso-8859-3"
  • "windows-1250"
  • "utf-8"
  • "iso-8859-7"
  • "windows-1252"

Default value: "utf-8"

csv_first_row_header Boolean No

Whether or not to generate a header row at the top of the csv file.

Default value: true

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.