Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Custom Scan

Submit Data to Classify

Use this API to submit content for classification for a given custom connecter scan job.

post/v1/jobs/{jobId}/classify-data

Path parameters

jobIdinteger required

The custom connector scan job's identifier. This value can be obtained using the Get List of Scan Jobs API.

Request body

jobIdinteger required

The custom connector scan job's identifier. This value can be obtained using the Get List of Scan Jobs API.

datasourceIdstring required

The data source's identifier. This value can be obtained using the Get Data Sources API.

structuredboolean

Flag to determine whether the data source is a structured or unstructured source.

totalCountinteger

Total Count of rows or lines sent for a given column/file.

Example request

{
  "jobId": 10,
  "datasourceId": "123e4567-e89b-12d3-a456-426655440000",
  "structured": true,
  "totalCount": 100,
  "content": [
    {
      "entityName": "first_name",
      "entityType": "COLUMN",
      "parentEntityName": "Employee",
      "parentEntityType": "TABLE",
      "parentXpath": [
        "Company, Employee"
      ],
      "endOfContent": true,
      "data": [
        "Donald"
      ]
    }
  ]
}

Response

OK