Jobs

Job Status

get

Check the Job status by using its ID

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Path parameters
idstringRequired

Job ID

Responses
chevron-right
200

Job status details

application/json
get
/api/public/v1/jobs/{id}/status

Test the connection to a data source

post

Initiates a test connection job for the specified data source configuration. This job validates connectivity and configuration details for the given resource.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
databaseNamestringOptional

Database name

ownersobject[]Optional

Owners

jobClasspathstringOptional

Job classpath

driverClassNamestringOptional

Driver class name

resourceNamestringOptional

Resource name

resourceIdstringOptional

Resource ID

fqdnIdstringOptional

FQDN ID

configMethodstringOptional

Config method

hoststringOptional

Host

lastTestConnectionIdstringOptional

Last test connection ID

lastIngestIdstringOptional

Last ingest ID

affinityIdstringOptional

Affinity ID

portstringOptional

Port

uristringOptional

URI

databaseTypestringOptional

Database type

spiVersionstringOptional

SPI version

serviceTypestringOptional

Service type

descriptionstringOptional

Description

statusstringOptional

Status

usersstring[]Optional

Users

userNamestringOptional

User name

passwordstringOptional

Password

encryptedPasswordstringOptional

Encrypted password

notestringOptional

Note

oauthClientIdstringOptional

OAuth client ID

oauthClientSecretstringOptional

OAuth client secret

hdfsCredTypestringOptional

HDFS credential type

endpointstringOptional

Endpoint

accessKeystringOptional

Access key

containerstringOptional

Container

accessIdstringOptional

Access ID

secretKeystringOptional

Secret key

secretManagerKeystringOptional

Secret manager key

totalCapacitynumberOptional

Total capacity

projectstringOptional

Project

oAuthTypenumber · enumOptional

OAuth type

Possible values:
keyPathstringOptional

Key path

clientEmailstringOptional

Client email

warehousestringOptional

Warehouse

noAuthbooleanOptional

no auth

defaultEndpointsProtocolstringOptional

http or https protocol

schemaNamesstring[]Optional

Schema names to ingest

includePatternsstring[]Optional

Include patterns - Resources matching these patterns

excludePatternsstring[]Optional

Exclude patterns - Resources matching these patterns

includeSchemaPatternsstring[]Optional

Include schema patterns - Schemas matching these patterns

excludeSchemaPatternsstring[]Optional

Exclude schema patterns - Schemas matching these patterns

includeTablePatternsstring[]Optional

Include table patterns - Tables matching these patterns

excludeTablePatternsstring[]Optional

Exclude table patterns - Tables matching these patterns

deleteEmptyFoldersbooleanOptional

Delete empty folders after processing

regionstringOptional

AWS region

accountNumberstringOptional

AWS account number

iamUsernamestringOptional

IAM username

accessKeyIDstringOptional

AWS access key ID

secretAccessKeystringOptional

AWS secret access key

assumeRolestringOptional

Assume role

rolestringOptional

Role

externalIDstringOptional

External ID

sslTypestring · enumOptional

SSL type

Possible values:
trustStoreTypestringOptional

Trust store type

trustStoreLocationstringOptional

Trust store location

trustStorePasswordstringOptional

Trust store password

keyStoreTypestringOptional

Key store type

keyStoreLocationstringOptional

Key store location

keyStorePasswordstringOptional

Key store password

cipherSuitestringOptional

Cipher suite

serverDistinguishedNamestringOptional

Server distinguished name

connectionTypestringOptional

MSSQL connection type

fileSystemTypestringOptional

File system type

pathstringOptional

Path

followSymLinksstringOptional

Follow symbolic links

domainstringOptional

Domain

shareNamestringOptional

Share name

accountNamestringOptional

Account name

azureCredTypestringOptional

Azure credential type

azureSharedKeystringOptional

Azure shared key

azureTenantIdstringOptional

Azure tenant ID

availableForMigrationbooleanOptional

Available for migration

enabledForMigrationbooleanOptional

Enabled for migration

availableForWritingbooleanOptional

Available for writing

availableForDataMasteringbooleanOptional

Available for data mastering

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/test-connection

Trigger Delete Datasource Job

post

Deletes a datasource and cleans up associated metadata and data.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
idstringRequired

The unique identifier of the datasource to delete.

fqdnIdstringRequired

The fully qualified domain name ID of the datasource.

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/remove-datasource

Trigger Ingest Schemas or Scan Job

post

Starts a ingest schemas or scan job for the specified schemas and resource. This job can either ingest metadata for the given database and resource configuration, or perform a scan job to validate and preview schemas. Both operations fall under the same job type, differentiated by the example payloads provided below.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
databaseNamestringOptional

Database name

ownersobject[]Optional

Owners

jobClasspathstringOptional

Job classpath

driverClassNamestringOptional

Driver class name

resourceNamestringOptional

Resource name

resourceIdstringOptional

Resource ID

fqdnIdstringOptional

FQDN ID

configMethodstringOptional

Config method

hoststringOptional

Host

lastTestConnectionIdstringOptional

Last test connection ID

lastIngestIdstringOptional

Last ingest ID

affinityIdstringOptional

Affinity ID

portstringOptional

Port

uristringOptional

URI

databaseTypestringOptional

Database type

spiVersionstringOptional

SPI version

serviceTypestringOptional

Service type

descriptionstringOptional

Description

statusstringOptional

Status

usersstring[]Optional

Users

userNamestringOptional

User name

passwordstringOptional

Password

encryptedPasswordstringOptional

Encrypted password

notestringOptional

Note

oauthClientIdstringOptional

OAuth client ID

oauthClientSecretstringOptional

OAuth client secret

hdfsCredTypestringOptional

HDFS credential type

endpointstringOptional

Endpoint

accessKeystringOptional

Access key

containerstringOptional

Container

accessIdstringOptional

Access ID

secretKeystringOptional

Secret key

secretManagerKeystringOptional

Secret manager key

totalCapacitynumberOptional

Total capacity

projectstringOptional

Project

oAuthTypenumber · enumOptional

OAuth type

Possible values:
keyPathstringOptional

Key path

clientEmailstringOptional

Client email

warehousestringOptional

Warehouse

noAuthbooleanOptional

no auth

defaultEndpointsProtocolstringOptional

http or https protocol

schemaNamesstring[]Optional

Schema names to ingest

includePatternsstring[]Optional

Include patterns - Resources matching these patterns

excludePatternsstring[]Optional

Exclude patterns - Resources matching these patterns

includeSchemaPatternsstring[]Optional

Include schema patterns - Schemas matching these patterns

excludeSchemaPatternsstring[]Optional

Exclude schema patterns - Schemas matching these patterns

includeTablePatternsstring[]Optional

Include table patterns - Tables matching these patterns

excludeTablePatternsstring[]Optional

Exclude table patterns - Tables matching these patterns

deleteEmptyFoldersbooleanOptional

Delete empty folders after processing

regionstringOptional

AWS region

accountNumberstringOptional

AWS account number

iamUsernamestringOptional

IAM username

accessKeyIDstringOptional

AWS access key ID

secretAccessKeystringOptional

AWS secret access key

assumeRolestringOptional

Assume role

rolestringOptional

Role

externalIDstringOptional

External ID

sslTypestring · enumOptional

SSL type

Possible values:
trustStoreTypestringOptional

Trust store type

trustStoreLocationstringOptional

Trust store location

trustStorePasswordstringOptional

Trust store password

keyStoreTypestringOptional

Key store type

keyStoreLocationstringOptional

Key store location

keyStorePasswordstringOptional

Key store password

cipherSuitestringOptional

Cipher suite

serverDistinguishedNamestringOptional

Server distinguished name

connectionTypestringOptional

MSSQL connection type

fileSystemTypestringOptional

File system type

pathstringOptional

Path

followSymLinksstringOptional

Follow symbolic links

domainstringOptional

Domain

shareNamestringOptional

Share name

accountNamestringOptional

Account name

azureCredTypestringOptional

Azure credential type

azureSharedKeystringOptional

Azure shared key

azureTenantIdstringOptional

Azure tenant ID

availableForMigrationbooleanOptional

Available for migration

enabledForMigrationbooleanOptional

Enabled for migration

availableForWritingbooleanOptional

Available for writing

availableForDataMasteringbooleanOptional

Available for data mastering

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/metadata/ingest

Trigger Metadata Reingestion Job

post

Starts a metadata reingestion job for the specified entities. This job allows external systems or users to refresh and reload metadata for the given scope identifiers.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
scopestring · uuid[] · min: 1Required

List of entity UUIDs for which metadata should be reingested.

deleteEmptyFoldersbooleanOptional

Delete empty folders after reingestion

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/metadata/re-ingest

Trigger Data Profiling Job

post

Starts a data profiling job with configurable sampling and threading options.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
scopestring · uuid[] · min: 1Required

List of entity UUIDs to run data profiling.

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/data-profiling

Trigger Data Discovery Job

post

Starts a data discovery job with configuration options for sampling, ingestion, string scanning, and file handling.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
scopestring · uuid[] · min: 1Required

List of entity UUIDs to run data discovery.

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/data-discovery

Trigger Data Identification Job

post

Runs a Data Identification job that applies dictionary-based and pattern-based techniques to identify data content across data entities.

🚨 Prerequisite - Data Profiling and Data Discovery must be completed on the provided scope entity IDs before running this job.

This job performs:

Dictionary Matching - Word/term lists are transformed into bitsets, HLLs, and patterns. Matching is based on bitset comparison. Dictionary terms are lowercased during bitset creation to ensure consistent matching regardless of case.

Pattern Analysis - Regular expressions and profiling-derived patterns are used to identify structural patterns in column data. Substring containment is a commonly applied method in this stage.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
scopestring · uuid[] · min: 1Required

List of entity UUIDs for which metadata should be reingested.

dictionaryIdsstring[]Optional

Dictionary IDs - Used for dictionary matching

Default: []
dataPatternIdsstring[]Optional

Data patterns IDs - Used for pattern analysis

Default: []
Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/data-identification

Trigger Collection Data Profile Job

post

Generate statistical and intermediate data with default options.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
collectionIdstring · uuidRequired

The unique identifier of the collection to profile.

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/collections/data-profiling

Trigger Collection Data Aggregation Job

post

Summarization of stats at Collection level.

🚨 Note: The collectionId passed should be of type 'dataset'.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
collectionIdstring · uuidRequired

The unique identifier of the collection of type dataset to aggregate.

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/collections/data-aggregation

Trigger Business Rule Job

post

Executes business rules to validate data quality across entities.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
ruleIdstring[] · min: 1Required

List of business rule IDs to execute.

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/business-rule

Trigger Business Rule with Counter Job

post

Executes business rules and counts the number of rows that match the rule criteria across specified entities.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
ruleIdstring[] · min: 1Required

List of business rule IDs to execute.

scopestring · uuid[] · min: 1Required

List of entity UUIDs to run business rule counting on.

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/business-rule/with-row-counter

Trigger Usage Statistics Job

post

Generates usage statistics for specified entities within a date range.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
scopestring · uuid[] · min: 1Required

List of entity UUIDs to generate usage statistics for.

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/usage-statistics

Trigger PII Detection Job

post

Starts a PII detection job to analyze and identify appropriate column names for ML use

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
scopestring · uuid[] · min: 1Required

List of entity UUIDs to run PII detection.

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/pii-detection

Calculate trust score

post

Calculate trust score job for the specified data source configuration. This job calculates trust scores based on various factors to assess data reliability and quality.

Authorizations
AuthorizationstringRequired

Insert the JWT token here

Body
scopestring[]Required

scope of entity to calculate trust score

Responses
chevron-right
200

Default Response

application/json
post
/api/public/v1/jobs/execute/calculate-trust-score

Last updated

Was this helpful?