latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

DQ Dataset Definitions API

Create or update the dataset definition of a DQ Job

Creates or updates the dataset definition of a DQ Job. Pre-authorization requirements:

  • hasRole('ROLE_ADMIN') or hasRole('ROLE_DATASET_MANAGER') or hasDatasetAccess(#datasetDef.dataset)
post/v3/datasetDefs

Request body

datasetstring
runIdstring
runIdEndstring
runState'DRAFT' | 'DRY' | 'CERTIFIED'
passFailinteger
passFailLimitinteger
jobDescriptionstring
coreMaxActiveConnectionsinteger
linkIdstring[]
licenseKeystring
logFilestring
logLevelstring
hootOnlyboolean
prettyPrintboolean
useTemplateboolean
parallelboolean
planboolean
dataPreviewOffboolean
datasetSafeOffboolean
obslimitinteger
pgUserstring
pgPasswordstring
hoststring
portstring
userstring
alertEmailstring
scheduleTimestring
schemaScorenumber double
optionAppendstring
keyDelimiterstring
pipelinestring[]
runDatestring date-time
runDateEndstring date-time
metaTagsstring[]
connectionType'PULLUP' | 'PUSHDOWN'

Response

Returns the created or updated dataset definition

datasetstring
runIdstring
runIdEndstring
runState'DRAFT' | 'DRY' | 'CERTIFIED'
passFailinteger
passFailLimitinteger
jobDescriptionstring
coreMaxActiveConnectionsinteger
linkIdstring[]
licenseKeystring
logFilestring
logLevelstring
hootOnlyboolean
prettyPrintboolean
useTemplateboolean
parallelboolean
planboolean
dataPreviewOffboolean
datasetSafeOffboolean
obslimitinteger
pgUserstring
pgPasswordstring
hoststring
portstring
userstring
alertEmailstring
scheduleTimestring
schemaScorenumber double
optionAppendstring
keyDelimiterstring
pipelinestring[]
runDatestring date-time
runDateEndstring date-time
metaTagsstring[]
connectionType'PULLUP' | 'PUSHDOWN'