> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/dq-product/dq-dataset-definitions-api.md).

# DQ Dataset Definitions API

The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs.

## 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)\`<br>

```json
{"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"tags":[{"name":"DQ Dataset Definitions API","description":"The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs."}],"servers":[{"url":"https://<host-name>","description":"Generated server url"}],"security":[{"bearer-jwt":[]}],"components":{"securitySchemes":{"bearer-jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DatasetDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string"},"runIdEnd":{"type":"string"},"runState":{"type":"string","enum":["DRAFT","DRY","CERTIFIED"]},"passFail":{"type":"integer","format":"int32"},"passFailLimit":{"type":"integer","format":"int32"},"jobDescription":{"type":"string"},"jobId":{"$ref":"#/components/schemas/IdentifierDTO"},"coreMaxActiveConnections":{"type":"integer","format":"int32"},"linkId":{"type":"array","items":{"type":"string"}},"licenseKey":{"type":"string"},"logFile":{"type":"string"},"logLevel":{"type":"string"},"hootOnly":{"type":"boolean"},"prettyPrint":{"type":"boolean"},"useTemplate":{"type":"boolean"},"parallel":{"type":"boolean"},"plan":{"type":"boolean"},"dataPreviewOff":{"type":"boolean"},"datasetSafeOff":{"type":"boolean"},"obslimit":{"type":"integer","format":"int32"},"pgUser":{"type":"string"},"pgPassword":{"type":"string"},"host":{"type":"string"},"port":{"type":"string"},"user":{"type":"string"},"alertEmail":{"type":"string"},"scheduleTime":{"type":"string"},"schemaScore":{"type":"number","format":"double"},"optionAppend":{"type":"string"},"keyDelimiter":{"type":"string"},"agentId":{"$ref":"#/components/schemas/IdentifierDTO"},"load":{"$ref":"#/components/schemas/LoadDefDTO"},"pushdown":{"$ref":"#/components/schemas/PushDownDefDTO"},"outliers":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/OutlierDefDTO"}},"patterns":{"type":"array","items":{"$ref":"#/components/schemas/PatternDefDTO"}},"dupe":{"$ref":"#/components/schemas/DupeDefDTO"},"profile":{"$ref":"#/components/schemas/ProfileDefDTO"},"source":{"$ref":"#/components/schemas/SourceDefDTO"},"rule":{"$ref":"#/components/schemas/RuleDefDTO"},"colMatch":{"$ref":"#/components/schemas/ColMatchDefDTO"},"spark":{"$ref":"#/components/schemas/SparkDefDTO"},"env":{"$ref":"#/components/schemas/EnvDefDTO"},"record":{"$ref":"#/components/schemas/RecordDefDTO"},"stream":{"$ref":"#/components/schemas/StreamDefDTO"},"pipeline":{"type":"array","items":{"type":"string"}},"runDate":{"type":"string","format":"date-time","writeOnly":true},"runDateEnd":{"type":"string","format":"date-time","writeOnly":true},"metaTags":{"type":"array","items":{"type":"string"}},"outlierConfiguration":{"$ref":"#/components/schemas/AbstractOutlierDefDTO"},"shape":{"$ref":"#/components/schemas/ShapeDefDTO"},"jobSchedule":{"$ref":"#/components/schemas/AbstractJobScheduleConfigurationDTO"},"connectionType":{"type":"string","readOnly":true,"enum":["PULLUP","PUSHDOWN"]}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}},"LoadDefDTO":{"type":"object","properties":{"readonly":{"type":"boolean"},"passwordManager":{"type":"string"},"alias":{"type":"string"},"query":{"type":"string"},"queryHistory":{"type":"string"},"key":{"type":"string"},"expression":{"type":"string"},"addDateColumn":{"type":"boolean"},"zeroFillNull":{"type":"boolean"},"replaceNulls":{"type":"string"},"stringMode":{"type":"boolean"},"operator":{"type":"string"},"dateColumn":{"type":"string"},"transform":{"type":"string"},"filter":{"type":"string"},"filterNot":{"type":"string"},"sample":{"type":"number","format":"double"},"backRun":{"type":"integer","format":"int32"},"backRunBin":{"type":"string","enum":["MINUTE","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"unionLookBack":{"type":"boolean"},"unionLookBackMinRow":{"type":"integer","format":"int32"},"cache":{"type":"boolean"},"dateFormat":{"type":"string"},"timeFormat":{"type":"string"},"timestamp":{"type":"boolean"},"filePath":{"type":"string"},"fileQuery":{"type":"string"},"fullFile":{"type":"boolean"},"fileHeader":{"type":"string"},"inferSchema":{"type":"boolean"},"fileType":{"type":"string"},"delimiter":{"type":"string"},"fileCharSet":{"type":"string"},"skipLines":{"type":"integer","format":"int32"},"avroSchema":{"type":"string"},"xmlRowTag":{"type":"string"},"flatten":{"type":"boolean"},"handleMaps":{"type":"boolean"},"handleMixedJson":{"type":"boolean"},"multiLine":{"type":"boolean"},"lib":{"type":"string"},"additionalLib":{"type":"string"},"driverName":{"type":"string"},"connectionName":{"type":"string"},"connectionUrl":{"type":"string"},"userName":{"type":"string"},"password":{"type":"string"},"connectionProperties":{"type":"object","additionalProperties":{"type":"string"}},"hiveNative":{"type":"boolean"},"hiveNativeHWC":{"type":"boolean"},"useSql":{"type":"boolean"},"columnName":{"type":"string"},"lowerBound":{"type":"string"},"upperBound":{"type":"string"},"numPartitions":{"type":"integer","format":"int32"},"partitionNumber":{"type":"integer","format":"int32"},"escapeWithBackTick":{"type":"boolean"},"escapeWithSingleQuote":{"type":"boolean"},"escapeWithDoubleQuote":{"type":"boolean"},"escapeCharacter":{"type":"string"},"checkHeader":{"type":"boolean"},"archiveConnection":{"type":"string"},"coreFetchMode":{"type":"boolean"},"archiveBreaks":{"type":"boolean"},"ruleSerial":{"type":"boolean"}}},"PushDownDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"connectionName":{"type":"string"},"maxConnections":{"type":"integer","format":"int32"},"sourceQuery":{"type":"string"},"backRuns":{"type":"integer","format":"int32"},"backRunBin":{"type":"string"},"dateFormatType":{"type":"string"},"threads":{"type":"integer","format":"int32"},"manualSourceQuery":{"type":"boolean"},"key":{"type":"string"},"sourceOutputSchema":{"type":"string"},"sourceBreakRules":{"type":"boolean"},"sourceBreakOutliers":{"type":"boolean"},"sourceBreakDupes":{"type":"boolean"},"sourceBreakShapes":{"type":"boolean"},"sourceBreakResults":{"type":"boolean"},"sqlLoggingToggle":{"type":"boolean"},"unionLookback":{"type":"boolean"},"unionLookbackMin":{"type":"integer","format":"int32"}}},"OutlierDefDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"timeColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"timeBinQuery":{"type":"string"},"categorical":{"type":"boolean"},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}},"deprecated":true},"PatternDefDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"score":{"type":"number","format":"double"},"minSupport":{"type":"number","format":"double"},"confidence":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"},"query":{"type":"string"},"filter":{"type":"string"},"timeBin":{"type":"string","enum":["MINUTE","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]}}},"DupeDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"depth":{"type":"integer","format":"int32"},"lowerBound":{"type":"integer","format":"int32"},"upperBound":{"type":"integer","format":"int32"},"approximate":{"type":"integer","format":"int32"},"limitPerDupe":{"type":"integer","format":"int32"},"checkHeader":{"type":"boolean"},"filter":{"type":"string"},"ignoreCase":{"type":"boolean"},"score":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"}}},"ProfileDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"correlation":{"type":"boolean"},"histogram":{"type":"boolean"},"semantic":{"type":"boolean"},"dataConceptId":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"histogramLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"shape":{"type":"boolean","deprecated":true},"shapeTotalScore":{"type":"integer","format":"int32","deprecated":true},"shapeSensitivity":{"type":"number","format":"double","deprecated":true},"shapeMaxPerCol":{"type":"integer","format":"int32","deprecated":true},"shapeMaxColSize":{"type":"integer","format":"int32","deprecated":true},"shapeGranular":{"type":"boolean","deprecated":true},"behavioralDimension":{"type":"string"},"behavioralDimensionGroup":{"type":"string"},"behavioralValueColumn":{"type":"string"},"behaviorScoreOff":{"type":"boolean"},"behaviorLookback":{"type":"integer","format":"int32"},"behaviorMinSupport":{"type":"integer","format":"int32"},"profilePushDown":{"type":"array","items":{"type":"string"}},"behaviorRowCheck":{"type":"boolean"},"behaviorTimeCheck":{"type":"boolean"},"behaviorMinValueCheck":{"type":"boolean"},"behaviorMaxValueCheck":{"type":"boolean"},"behaviorMeanValueCheck":{"type":"boolean"},"behaviorNullCheck":{"type":"boolean"},"behaviorEmptyCheck":{"type":"boolean"},"behaviorUniqueCheck":{"type":"boolean"},"profileStringLength":{"type":"boolean"},"detectStringNumerics":{"type":"boolean"},"detectTopnBotn":{"type":"boolean"},"detectScalePrecision":{"type":"boolean"},"adaptiveTier":{"type":"string"},"advancedTier":{"type":"boolean"},"filter":{"type":"string"}}},"SourceDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"validateValues":{"type":"boolean"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"includeSrc":{"type":"array","items":{"type":"string"}},"excludeSrc":{"type":"array","items":{"type":"string"}},"map":{"type":"object","additionalProperties":{"type":"string"}},"score":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"},"sourcePushDownCount":{"type":"boolean"},"checkType":{"type":"boolean"},"checkCase":{"type":"boolean"},"validateSchemaOrder":{"type":"boolean"},"matches":{"type":"boolean"},"validateValuesThreshold":{"type":"number","format":"double"},"validateValuesThresholdStrictDownScore":{"type":"boolean"},"validateValuesShowAll":{"type":"boolean"},"validateValuesIgnoreNull":{"type":"boolean"},"validateValuesIgnoreEmpty":{"type":"boolean"},"validateValuesIgnorePrecision":{"type":"boolean"},"validateValuesTrim":{"type":"boolean"},"validateValuesShowMissingKeys":{"type":"boolean"},"validateSrcJoinOnly":{"type":"boolean"},"validateValuesFilter":{"type":"string"},"dataset":{"type":"string"},"driverName":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"},"passwordManager":{"type":"string"},"connectionName":{"type":"string"},"connectionUrl":{"type":"string"},"query":{"type":"string"},"lib":{"type":"string"},"connectionProperties":{"type":"object","additionalProperties":{"type":"string"}},"filePath":{"type":"string"},"fileQuery":{"type":"string"},"fullFile":{"type":"boolean"},"header":{"type":"string"},"skipLines":{"type":"integer","format":"int32"},"inferSchema":{"type":"boolean"},"fileType":{"type":"string"},"delimiter":{"type":"string"},"fileCharSet":{"type":"string"},"avroSchema":{"type":"string"},"xmlRowTag":{"type":"string"},"flatten":{"type":"boolean"},"handleMaps":{"type":"boolean"},"handleMixedJson":{"type":"boolean"},"multiLine":{"type":"boolean"},"filterCols":{"type":"array","items":{"type":"string"}}}},"RuleDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"lib":{"type":"string"},"name":{"type":"string"},"absoluteScoring":{"type":"boolean"},"ruleBreakPreviewLimit":{"type":"integer","format":"int32"}}},"ColMatchDefDTO":{"type":"object","properties":{"colMatchParallelProcesses":{"type":"integer","format":"int32"},"colMatchDurationMins":{"type":"integer","format":"int32"},"colMatchBatchSize":{"type":"integer","format":"int32"},"level":{"type":"string"},"fuzzyDistance":{"type":"integer","format":"int32"},"connectionList":{"type":"array","items":{"$ref":"#/components/schemas/Connection"}}}},"Connection":{"type":"object","properties":{"dataset":{"type":"string"},"url":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"},"query":{"type":"string"},"filePath":{"type":"string"},"driver":{"type":"string"},"driverProps":{"type":"object","additionalProperties":{"type":"string"}}}},"SparkDefDTO":{"type":"object","properties":{"numExecutors":{"type":"integer","format":"int32"},"driverMemory":{"type":"string"},"executorMemory":{"type":"string"},"executorCores":{"type":"integer","format":"int32"},"conf":{"type":"string"},"queue":{"type":"string"},"master":{"type":"string"},"principal":{"type":"string"},"keyTab":{"type":"string"},"deployMode":{"type":"string"},"jars":{"type":"array","items":{"type":"string"}},"packages":{"type":"array","items":{"type":"string"}},"files":{"type":"array","items":{"type":"string"}}}},"EnvDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"jdbcPrincipal":{"type":"string"},"jdbcKeyTab":{"type":"string"}}},"RecordDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"in":{"type":"string"},"notIn":{"type":"string"},"include":{"type":"array","items":{"type":"string"}},"percDeltaLimit":{"type":"number","format":"double"},"score":{"type":"number","format":"double"},"dataset":{"type":"string"},"dateColumn":{"type":"string"},"keyColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]}}},"StreamDefDTO":{"type":"object","properties":{"type":{"type":"string","enum":["Kafka"]},"kafkaDef":{"$ref":"#/components/schemas/KafkaDefDTO"}}},"KafkaDefDTO":{"type":"object","properties":{"kafkaGroup":{"type":"string"},"kafkaBroker":{"type":"string"},"kafkaPort":{"type":"string"},"kafkaTopic":{"type":"string"},"kafkaKeySerde":{"type":"string"},"kafkaValSerde":{"type":"string"},"kafkaSaslEnabled":{"type":"boolean"},"kafkaSaslService":{"type":"string"},"kafkaSslEnabled":{"type":"boolean"},"streamSchemaRegistryUrl":{"type":"string"},"streamSchemaRegistryUser":{"type":"string"},"streamSchemaRegistryPassword":{"type":"string"},"streamInterval":{"type":"string"},"streamSchema":{"type":"string"},"streamFormat":{"type":"string"},"streamMaxLull":{"type":"string"}}},"AbstractOutlierDefDTO":{"type":"object","properties":{"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"type":"object"}}},"description":"Outlier configurations","oneOf":[{"$ref":"#/components/schemas/PullupOutlierDefDTO"},{"$ref":"#/components/schemas/PushdownOutlierDefDTO"}]},"OutlierDefColumnSensitivitySettingsDTO":{"type":"object","properties":{"name":{"type":"string"},"weight":{"type":"number","format":"double"},"unit":{"type":"string","enum":["DEFAULT","UNIT_0_001","UNIT_0_01","UNIT_0_1","UNIT_1_0","UNIT_10_0","UNIT_100_0","UNIT_1000_0","UNIT_10000_0","UNIT_100000_0","UNIT_1000000_0","UNIT_10000000_0"]}},"description":"List of column sensitivity settings"},"PullupOutlierDefDTO":{"type":"object","properties":{"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"dateColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categorical":{"type":"boolean"},"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/PullupOutlierDefConfigurationDTO"}}}},"PullupOutlierDefConfigurationDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"timeColumn":{"type":"string"},"timeBinQuery":{"type":"string"},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}}},"PushdownOutlierDefDTO":{"type":"object","properties":{"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/PushdownOutlierDefConfigurationDTO"}}}},"PushdownOutlierDefConfigurationDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"timeColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"timeBinQuery":{"type":"string"},"categorical":{"type":"boolean"},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}}},"ShapeDefDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"totalScore":{"type":"integer","format":"int32"},"sensitivity":{"type":"number","format":"double"},"maxPerCol":{"type":"integer","format":"int32"},"maxColSize":{"type":"integer","format":"int32"},"granular":{"type":"boolean"},"columnSettings":{"type":"array","items":{"$ref":"#/components/schemas/ShapeColumnSettingsDTO"}}}},"ShapeColumnSettingsDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"}}},"AbstractJobScheduleConfigurationDTO":{"required":["agentId","dataset","runDateFormat"],"type":"object","properties":{"enabled":{"type":"boolean"},"dataset":{"type":"string"},"agentId":{"$ref":"#/components/schemas/Identifier"},"runDateFormat":{"pattern":"yyyy-MM-dd HH:mm:ss|yyyy-MM-dd HH:mm|yyyy-MM-dd HH|yyyy-MM-dd","type":"string"},"scheduleFrequency":{"type":"string","enum":["DAILY","MONTHLY","QUARTERLY"]},"updatedAt":{"type":"string","format":"date-time"},"scheduleTime":{"pattern":"HH:mm:ss","type":"string"}},"discriminator":{"propertyName":"scheduleFrequency"}},"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}},"paths":{"/v3/datasetDefs":{"post":{"tags":["DQ Dataset Definitions API"],"summary":"Create or update the dataset definition of a DQ Job","description":"Creates or updates the dataset definition of a DQ Job. \nPre-authorization requirements: \n\n- `hasRole('ROLE_ADMIN') or hasRole('ROLE_DATASET_MANAGER') or hasDatasetAccess(#datasetDef.dataset)`\n","operationId":"create","requestBody":{"description":"Dataset definition to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDefDTO"}}},"required":true},"responses":{"200":{"description":"Returns the created or updated dataset definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDefDTO"}}}}}}}}}
```

## 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)\`<br>

```json
{"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"tags":[{"name":"DQ Dataset Definitions API","description":"The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs."}],"servers":[{"url":"https://<host-name>","description":"Generated server url"}],"security":[{"bearer-jwt":[]}],"components":{"securitySchemes":{"bearer-jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DatasetDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string"},"runIdEnd":{"type":"string"},"runState":{"type":"string","enum":["DRAFT","DRY","CERTIFIED"]},"passFail":{"type":"integer","format":"int32"},"passFailLimit":{"type":"integer","format":"int32"},"jobDescription":{"type":"string"},"jobId":{"$ref":"#/components/schemas/IdentifierDTO"},"coreMaxActiveConnections":{"type":"integer","format":"int32"},"linkId":{"type":"array","items":{"type":"string"}},"licenseKey":{"type":"string"},"logFile":{"type":"string"},"logLevel":{"type":"string"},"hootOnly":{"type":"boolean"},"prettyPrint":{"type":"boolean"},"useTemplate":{"type":"boolean"},"parallel":{"type":"boolean"},"plan":{"type":"boolean"},"dataPreviewOff":{"type":"boolean"},"datasetSafeOff":{"type":"boolean"},"obslimit":{"type":"integer","format":"int32"},"pgUser":{"type":"string"},"pgPassword":{"type":"string"},"host":{"type":"string"},"port":{"type":"string"},"user":{"type":"string"},"alertEmail":{"type":"string"},"scheduleTime":{"type":"string"},"schemaScore":{"type":"number","format":"double"},"optionAppend":{"type":"string"},"keyDelimiter":{"type":"string"},"agentId":{"$ref":"#/components/schemas/IdentifierDTO"},"load":{"$ref":"#/components/schemas/LoadDefDTO"},"pushdown":{"$ref":"#/components/schemas/PushDownDefDTO"},"outliers":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/OutlierDefDTO"}},"patterns":{"type":"array","items":{"$ref":"#/components/schemas/PatternDefDTO"}},"dupe":{"$ref":"#/components/schemas/DupeDefDTO"},"profile":{"$ref":"#/components/schemas/ProfileDefDTO"},"source":{"$ref":"#/components/schemas/SourceDefDTO"},"rule":{"$ref":"#/components/schemas/RuleDefDTO"},"colMatch":{"$ref":"#/components/schemas/ColMatchDefDTO"},"spark":{"$ref":"#/components/schemas/SparkDefDTO"},"env":{"$ref":"#/components/schemas/EnvDefDTO"},"record":{"$ref":"#/components/schemas/RecordDefDTO"},"stream":{"$ref":"#/components/schemas/StreamDefDTO"},"pipeline":{"type":"array","items":{"type":"string"}},"runDate":{"type":"string","format":"date-time","writeOnly":true},"runDateEnd":{"type":"string","format":"date-time","writeOnly":true},"metaTags":{"type":"array","items":{"type":"string"}},"outlierConfiguration":{"$ref":"#/components/schemas/AbstractOutlierDefDTO"},"shape":{"$ref":"#/components/schemas/ShapeDefDTO"},"jobSchedule":{"$ref":"#/components/schemas/AbstractJobScheduleConfigurationDTO"},"connectionType":{"type":"string","readOnly":true,"enum":["PULLUP","PUSHDOWN"]}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}},"LoadDefDTO":{"type":"object","properties":{"readonly":{"type":"boolean"},"passwordManager":{"type":"string"},"alias":{"type":"string"},"query":{"type":"string"},"queryHistory":{"type":"string"},"key":{"type":"string"},"expression":{"type":"string"},"addDateColumn":{"type":"boolean"},"zeroFillNull":{"type":"boolean"},"replaceNulls":{"type":"string"},"stringMode":{"type":"boolean"},"operator":{"type":"string"},"dateColumn":{"type":"string"},"transform":{"type":"string"},"filter":{"type":"string"},"filterNot":{"type":"string"},"sample":{"type":"number","format":"double"},"backRun":{"type":"integer","format":"int32"},"backRunBin":{"type":"string","enum":["MINUTE","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"unionLookBack":{"type":"boolean"},"unionLookBackMinRow":{"type":"integer","format":"int32"},"cache":{"type":"boolean"},"dateFormat":{"type":"string"},"timeFormat":{"type":"string"},"timestamp":{"type":"boolean"},"filePath":{"type":"string"},"fileQuery":{"type":"string"},"fullFile":{"type":"boolean"},"fileHeader":{"type":"string"},"inferSchema":{"type":"boolean"},"fileType":{"type":"string"},"delimiter":{"type":"string"},"fileCharSet":{"type":"string"},"skipLines":{"type":"integer","format":"int32"},"avroSchema":{"type":"string"},"xmlRowTag":{"type":"string"},"flatten":{"type":"boolean"},"handleMaps":{"type":"boolean"},"handleMixedJson":{"type":"boolean"},"multiLine":{"type":"boolean"},"lib":{"type":"string"},"additionalLib":{"type":"string"},"driverName":{"type":"string"},"connectionName":{"type":"string"},"connectionUrl":{"type":"string"},"userName":{"type":"string"},"password":{"type":"string"},"connectionProperties":{"type":"object","additionalProperties":{"type":"string"}},"hiveNative":{"type":"boolean"},"hiveNativeHWC":{"type":"boolean"},"useSql":{"type":"boolean"},"columnName":{"type":"string"},"lowerBound":{"type":"string"},"upperBound":{"type":"string"},"numPartitions":{"type":"integer","format":"int32"},"partitionNumber":{"type":"integer","format":"int32"},"escapeWithBackTick":{"type":"boolean"},"escapeWithSingleQuote":{"type":"boolean"},"escapeWithDoubleQuote":{"type":"boolean"},"escapeCharacter":{"type":"string"},"checkHeader":{"type":"boolean"},"archiveConnection":{"type":"string"},"coreFetchMode":{"type":"boolean"},"archiveBreaks":{"type":"boolean"},"ruleSerial":{"type":"boolean"}}},"PushDownDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"connectionName":{"type":"string"},"maxConnections":{"type":"integer","format":"int32"},"sourceQuery":{"type":"string"},"backRuns":{"type":"integer","format":"int32"},"backRunBin":{"type":"string"},"dateFormatType":{"type":"string"},"threads":{"type":"integer","format":"int32"},"manualSourceQuery":{"type":"boolean"},"key":{"type":"string"},"sourceOutputSchema":{"type":"string"},"sourceBreakRules":{"type":"boolean"},"sourceBreakOutliers":{"type":"boolean"},"sourceBreakDupes":{"type":"boolean"},"sourceBreakShapes":{"type":"boolean"},"sourceBreakResults":{"type":"boolean"},"sqlLoggingToggle":{"type":"boolean"},"unionLookback":{"type":"boolean"},"unionLookbackMin":{"type":"integer","format":"int32"}}},"OutlierDefDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"timeColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"timeBinQuery":{"type":"string"},"categorical":{"type":"boolean"},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}},"deprecated":true},"PatternDefDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"score":{"type":"number","format":"double"},"minSupport":{"type":"number","format":"double"},"confidence":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"},"query":{"type":"string"},"filter":{"type":"string"},"timeBin":{"type":"string","enum":["MINUTE","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]}}},"DupeDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"depth":{"type":"integer","format":"int32"},"lowerBound":{"type":"integer","format":"int32"},"upperBound":{"type":"integer","format":"int32"},"approximate":{"type":"integer","format":"int32"},"limitPerDupe":{"type":"integer","format":"int32"},"checkHeader":{"type":"boolean"},"filter":{"type":"string"},"ignoreCase":{"type":"boolean"},"score":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"}}},"ProfileDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"correlation":{"type":"boolean"},"histogram":{"type":"boolean"},"semantic":{"type":"boolean"},"dataConceptId":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"histogramLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"shape":{"type":"boolean","deprecated":true},"shapeTotalScore":{"type":"integer","format":"int32","deprecated":true},"shapeSensitivity":{"type":"number","format":"double","deprecated":true},"shapeMaxPerCol":{"type":"integer","format":"int32","deprecated":true},"shapeMaxColSize":{"type":"integer","format":"int32","deprecated":true},"shapeGranular":{"type":"boolean","deprecated":true},"behavioralDimension":{"type":"string"},"behavioralDimensionGroup":{"type":"string"},"behavioralValueColumn":{"type":"string"},"behaviorScoreOff":{"type":"boolean"},"behaviorLookback":{"type":"integer","format":"int32"},"behaviorMinSupport":{"type":"integer","format":"int32"},"profilePushDown":{"type":"array","items":{"type":"string"}},"behaviorRowCheck":{"type":"boolean"},"behaviorTimeCheck":{"type":"boolean"},"behaviorMinValueCheck":{"type":"boolean"},"behaviorMaxValueCheck":{"type":"boolean"},"behaviorMeanValueCheck":{"type":"boolean"},"behaviorNullCheck":{"type":"boolean"},"behaviorEmptyCheck":{"type":"boolean"},"behaviorUniqueCheck":{"type":"boolean"},"profileStringLength":{"type":"boolean"},"detectStringNumerics":{"type":"boolean"},"detectTopnBotn":{"type":"boolean"},"detectScalePrecision":{"type":"boolean"},"adaptiveTier":{"type":"string"},"advancedTier":{"type":"boolean"},"filter":{"type":"string"}}},"SourceDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"validateValues":{"type":"boolean"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"includeSrc":{"type":"array","items":{"type":"string"}},"excludeSrc":{"type":"array","items":{"type":"string"}},"map":{"type":"object","additionalProperties":{"type":"string"}},"score":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"},"sourcePushDownCount":{"type":"boolean"},"checkType":{"type":"boolean"},"checkCase":{"type":"boolean"},"validateSchemaOrder":{"type":"boolean"},"matches":{"type":"boolean"},"validateValuesThreshold":{"type":"number","format":"double"},"validateValuesThresholdStrictDownScore":{"type":"boolean"},"validateValuesShowAll":{"type":"boolean"},"validateValuesIgnoreNull":{"type":"boolean"},"validateValuesIgnoreEmpty":{"type":"boolean"},"validateValuesIgnorePrecision":{"type":"boolean"},"validateValuesTrim":{"type":"boolean"},"validateValuesShowMissingKeys":{"type":"boolean"},"validateSrcJoinOnly":{"type":"boolean"},"validateValuesFilter":{"type":"string"},"dataset":{"type":"string"},"driverName":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"},"passwordManager":{"type":"string"},"connectionName":{"type":"string"},"connectionUrl":{"type":"string"},"query":{"type":"string"},"lib":{"type":"string"},"connectionProperties":{"type":"object","additionalProperties":{"type":"string"}},"filePath":{"type":"string"},"fileQuery":{"type":"string"},"fullFile":{"type":"boolean"},"header":{"type":"string"},"skipLines":{"type":"integer","format":"int32"},"inferSchema":{"type":"boolean"},"fileType":{"type":"string"},"delimiter":{"type":"string"},"fileCharSet":{"type":"string"},"avroSchema":{"type":"string"},"xmlRowTag":{"type":"string"},"flatten":{"type":"boolean"},"handleMaps":{"type":"boolean"},"handleMixedJson":{"type":"boolean"},"multiLine":{"type":"boolean"},"filterCols":{"type":"array","items":{"type":"string"}}}},"RuleDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"lib":{"type":"string"},"name":{"type":"string"},"absoluteScoring":{"type":"boolean"},"ruleBreakPreviewLimit":{"type":"integer","format":"int32"}}},"ColMatchDefDTO":{"type":"object","properties":{"colMatchParallelProcesses":{"type":"integer","format":"int32"},"colMatchDurationMins":{"type":"integer","format":"int32"},"colMatchBatchSize":{"type":"integer","format":"int32"},"level":{"type":"string"},"fuzzyDistance":{"type":"integer","format":"int32"},"connectionList":{"type":"array","items":{"$ref":"#/components/schemas/Connection"}}}},"Connection":{"type":"object","properties":{"dataset":{"type":"string"},"url":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"},"query":{"type":"string"},"filePath":{"type":"string"},"driver":{"type":"string"},"driverProps":{"type":"object","additionalProperties":{"type":"string"}}}},"SparkDefDTO":{"type":"object","properties":{"numExecutors":{"type":"integer","format":"int32"},"driverMemory":{"type":"string"},"executorMemory":{"type":"string"},"executorCores":{"type":"integer","format":"int32"},"conf":{"type":"string"},"queue":{"type":"string"},"master":{"type":"string"},"principal":{"type":"string"},"keyTab":{"type":"string"},"deployMode":{"type":"string"},"jars":{"type":"array","items":{"type":"string"}},"packages":{"type":"array","items":{"type":"string"}},"files":{"type":"array","items":{"type":"string"}}}},"EnvDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"jdbcPrincipal":{"type":"string"},"jdbcKeyTab":{"type":"string"}}},"RecordDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"in":{"type":"string"},"notIn":{"type":"string"},"include":{"type":"array","items":{"type":"string"}},"percDeltaLimit":{"type":"number","format":"double"},"score":{"type":"number","format":"double"},"dataset":{"type":"string"},"dateColumn":{"type":"string"},"keyColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]}}},"StreamDefDTO":{"type":"object","properties":{"type":{"type":"string","enum":["Kafka"]},"kafkaDef":{"$ref":"#/components/schemas/KafkaDefDTO"}}},"KafkaDefDTO":{"type":"object","properties":{"kafkaGroup":{"type":"string"},"kafkaBroker":{"type":"string"},"kafkaPort":{"type":"string"},"kafkaTopic":{"type":"string"},"kafkaKeySerde":{"type":"string"},"kafkaValSerde":{"type":"string"},"kafkaSaslEnabled":{"type":"boolean"},"kafkaSaslService":{"type":"string"},"kafkaSslEnabled":{"type":"boolean"},"streamSchemaRegistryUrl":{"type":"string"},"streamSchemaRegistryUser":{"type":"string"},"streamSchemaRegistryPassword":{"type":"string"},"streamInterval":{"type":"string"},"streamSchema":{"type":"string"},"streamFormat":{"type":"string"},"streamMaxLull":{"type":"string"}}},"AbstractOutlierDefDTO":{"type":"object","properties":{"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"type":"object"}}},"description":"Outlier configurations","oneOf":[{"$ref":"#/components/schemas/PullupOutlierDefDTO"},{"$ref":"#/components/schemas/PushdownOutlierDefDTO"}]},"OutlierDefColumnSensitivitySettingsDTO":{"type":"object","properties":{"name":{"type":"string"},"weight":{"type":"number","format":"double"},"unit":{"type":"string","enum":["DEFAULT","UNIT_0_001","UNIT_0_01","UNIT_0_1","UNIT_1_0","UNIT_10_0","UNIT_100_0","UNIT_1000_0","UNIT_10000_0","UNIT_100000_0","UNIT_1000000_0","UNIT_10000000_0"]}},"description":"List of column sensitivity settings"},"PullupOutlierDefDTO":{"type":"object","properties":{"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"dateColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categorical":{"type":"boolean"},"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/PullupOutlierDefConfigurationDTO"}}}},"PullupOutlierDefConfigurationDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"timeColumn":{"type":"string"},"timeBinQuery":{"type":"string"},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}}},"PushdownOutlierDefDTO":{"type":"object","properties":{"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/PushdownOutlierDefConfigurationDTO"}}}},"PushdownOutlierDefConfigurationDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"timeColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"timeBinQuery":{"type":"string"},"categorical":{"type":"boolean"},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}}},"ShapeDefDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"totalScore":{"type":"integer","format":"int32"},"sensitivity":{"type":"number","format":"double"},"maxPerCol":{"type":"integer","format":"int32"},"maxColSize":{"type":"integer","format":"int32"},"granular":{"type":"boolean"},"columnSettings":{"type":"array","items":{"$ref":"#/components/schemas/ShapeColumnSettingsDTO"}}}},"ShapeColumnSettingsDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"}}},"AbstractJobScheduleConfigurationDTO":{"required":["agentId","dataset","runDateFormat"],"type":"object","properties":{"enabled":{"type":"boolean"},"dataset":{"type":"string"},"agentId":{"$ref":"#/components/schemas/Identifier"},"runDateFormat":{"pattern":"yyyy-MM-dd HH:mm:ss|yyyy-MM-dd HH:mm|yyyy-MM-dd HH|yyyy-MM-dd","type":"string"},"scheduleFrequency":{"type":"string","enum":["DAILY","MONTHLY","QUARTERLY"]},"updatedAt":{"type":"string","format":"date-time"},"scheduleTime":{"pattern":"HH:mm:ss","type":"string"}},"discriminator":{"propertyName":"scheduleFrequency"}},"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}},"paths":{"/v3/datasetDefs":{"put":{"tags":["DQ Dataset Definitions API"],"summary":"Create or update the dataset definition of a DQ Job","description":"Creates or updates the dataset definition of a DQ Job. \nPre-authorization requirements: \n\n- `hasRole('ROLE_ADMIN') or hasRole('ROLE_DATASET_MANAGER') or hasDatasetAccess(#datasetDef.dataset)`\n","operationId":"create_1","requestBody":{"description":"Dataset definition to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDefDTO"}}},"required":true},"responses":{"200":{"description":"Returns the created or updated dataset definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDefDTO"}}}}}}}}}
```

## Delete dataset definitions by dataset name

> Hard deletes dataset definitions by given dataset names. This also deletes the associated DQ Jobs and referenced data.

```json
{"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"tags":[{"name":"DQ Dataset Definitions API","description":"The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs."}],"servers":[{"url":"https://<host-name>","description":"Generated server url"}],"security":[{"bearer-jwt":[]}],"components":{"securitySchemes":{"bearer-jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/v3/datasetDefs":{"delete":{"tags":["DQ Dataset Definitions API"],"summary":"Delete dataset definitions by dataset name","description":"Hard deletes dataset definitions by given dataset names. This also deletes the associated DQ Jobs and referenced data.","operationId":"delete_2","parameters":[{"name":"datasets","in":"query","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"in":"query","description":"Set of dataset names to delete","required":true}],"responses":{"200":{"description":"Returns a map of dataset names and their deletion status","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"}}}}}}}}}}
```

## Return a list of dataset definitions by a given filter

> Returns a list of dataset definitions by given filter criteria. \
> Pre-authorization requirements: \
> \
> \- \`hasRole('ROLE\_ADMIN') or hasRole('ROLE\_CONNECTION\_MANAGER')\`<br>

```json
{"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"tags":[{"name":"DQ Dataset Definitions API","description":"The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs."}],"servers":[{"url":"https://<host-name>","description":"Generated server url"}],"security":[{"bearer-jwt":[]}],"components":{"securitySchemes":{"bearer-jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DatasetDefFindAllFilterDTO":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"searchValue":{"type":"string"},"sensitivityLabels":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"runModes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["DRAFT","PUBLISHED"]}},"sources":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"dataClasses":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"columnNames":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"businessUnitNames":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"dataCategoryNames":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"rowCountOptions":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["RC_1K","RC_100K","RC_1M","RC_10M","RC_10M_PLUS"]}},"columnCountOptions":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["CC_0_10","CC_11_40","CC_41_100","CC_101_200","CC_200_PLUS"]}},"scanCountOptions":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["SC_0_10","SC_11_50","SC_51_100","SC_101_PLUS"]}},"integrations":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["DATA_INTELLIGENCE_CLOUD"]}},"connectionTypes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["PULLUP","PUSHDOWN"]}},"attributes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["ALERTS","RULES"]}}}},"PagedResponseDatasetFilteredResultDTO":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of results.","format":"int64"},"offset":{"type":"integer","description":"The offset for the results.","format":"int64","deprecated":true},"limit":{"type":"integer","description":"The maximum number of results to be returned.","format":"int64"},"results":{"type":"array","description":"The list of results.","items":{"$ref":"#/components/schemas/DatasetFilteredResultDTO"}}},"description":"Response containing the paged information."},"DatasetFilteredResultDTO":{"type":"object","properties":{"dataset":{"type":"string"},"datasetAlias":{"type":"string"},"source":{"type":"string"},"databaseName":{"type":"string"},"tableName":{"type":"string"},"host":{"type":"string"},"timeZone":{"type":"string"},"runMode":{"type":"string"},"dataConceptId":{"type":"integer","format":"int32"},"sourceName":{"type":"string"},"connType":{"type":"string"},"ruleCount":{"type":"integer","format":"int32"},"alertCount":{"type":"integer","format":"int32"},"businessUnitName":{"type":"string"},"dgcIntegrationActive":{"type":"boolean"},"dgcAssetUrl":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"updateTs":{"type":"string"}},"description":"The list of results."}}},"paths":{"/v3/datasetDefs/find":{"post":{"tags":["DQ Dataset Definitions API"],"summary":"Return a list of dataset definitions by a given filter","description":"Returns a list of dataset definitions by given filter criteria. \nPre-authorization requirements: \n\n- `hasRole('ROLE_ADMIN') or hasRole('ROLE_CONNECTION_MANAGER')`\n","operationId":"find","requestBody":{"description":"Filter criteria for dataset definitions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDefFindAllFilterDTO"}}},"required":true},"responses":{"200":{"description":"Returns a list of dataset definitions by given filter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseDatasetFilteredResultDTO"}}}}}}}}}
```

## Update the Spark information of one or more datasets

> \
> \
> Bulk updates the Spark information for multiple dataset definitions. It is secured and can only be accessed by users with the 'ROLE\_ADMIN' role. \
> Pre-authorization requirements: \
> \
> \- \`hasRole('ROLE\_ADMIN')\`<br>

```json
{"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"tags":[{"name":"DQ Dataset Definitions API","description":"The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs."}],"servers":[{"url":"https://<host-name>","description":"Generated server url"}],"security":[{"bearer-jwt":[]}],"components":{"securitySchemes":{"bearer-jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/v3/datasetDefs/batch/spark":{"patch":{"tags":["DQ Dataset Definitions API"],"summary":"Update the Spark information of one or more datasets","description":"\n\nBulk updates the Spark information for multiple dataset definitions. It is secured and can only be accessed by users with the 'ROLE_ADMIN' role. \nPre-authorization requirements: \n\n- `hasRole('ROLE_ADMIN')`\n","operationId":"batchUpdateSpark","parameters":[{"name":"datasets","in":"query","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"numExecutors","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"driverMemory","in":"query","required":false,"schema":{"type":"string"}},{"name":"executorMemory","in":"query","required":false,"schema":{"type":"string"}},{"name":"executorCores","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"conf","in":"query","required":false,"schema":{"type":"string"}},{"name":"master","in":"query","required":false,"schema":{"type":"string"}},{"name":"deployMode","in":"query","required":false,"schema":{"type":"string"}},{"in":"query","description":"The deploy mode for the spark job"}],"responses":{"200":{"description":"Returns the number of datasets for which the spark information was updated","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}},"404":{"description":"Some dataset not found","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}},"422":{"description":"Updating agent for pushdown datasets is not allowed"}}}}}}
```

## Update the host information of one or more datasets

> Bulk updates the host information in the dataset definitions of one or more given datasets. \
> Pre-authorization requirements: \
> \
> \- \`hasRole('ROLE\_ADMIN')\`<br>

```json
{"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"tags":[{"name":"DQ Dataset Definitions API","description":"The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs."}],"servers":[{"url":"https://<host-name>","description":"Generated server url"}],"security":[{"bearer-jwt":[]}],"components":{"securitySchemes":{"bearer-jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/v3/datasetDefs/batch/host":{"patch":{"tags":["DQ Dataset Definitions API"],"summary":"Update the host information of one or more datasets","description":"Bulk updates the host information in the dataset definitions of one or more given datasets. \nPre-authorization requirements: \n\n- `hasRole('ROLE_ADMIN')`\n","operationId":"batchUpdateHost","parameters":[{"name":"datasets","in":"query","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"host","in":"query","required":true,"schema":{"type":"string"}},{"in":"query","description":"The host information to be updated","required":true}],"responses":{"200":{"description":"Returns the number of datasets for which the host information was updated","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}}}}}}}
```

## Update the agent information of one or more datasets

> \
> \
> Updates the agent information for multiple dataset definitions in bulk. It is secured and can only be accessed by users with the 'ROLE\_ADMIN' role. At least one of agentName, agentId or agentUuid must be provided. If agentId or agentUuid is provided, the method will update the agent information using the Identifier formed from agentId and agentUuid. If agentName is provided and agentId and agentUuid are not provided, the method will update the agent information using the agentName. Returns the number of datasets for which the agent information was updated.\
> Pre-authorization requirements: \
> \
> \- \`hasRole('ROLE\_ADMIN')\`<br>

```json
{"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"tags":[{"name":"DQ Dataset Definitions API","description":"The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs."}],"servers":[{"url":"https://<host-name>","description":"Generated server url"}],"security":[{"bearer-jwt":[]}],"components":{"securitySchemes":{"bearer-jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/v3/datasetDefs/batch/agent":{"patch":{"tags":["DQ Dataset Definitions API"],"summary":"Update the agent information of one or more datasets","description":"\n\nUpdates the agent information for multiple dataset definitions in bulk. It is secured and can only be accessed by users with the 'ROLE_ADMIN' role. At least one of agentName, agentId or agentUuid must be provided. If agentId or agentUuid is provided, the method will update the agent information using the Identifier formed from agentId and agentUuid. If agentName is provided and agentId and agentUuid are not provided, the method will update the agent information using the agentName. Returns the number of datasets for which the agent information was updated.\nPre-authorization requirements: \n\n- `hasRole('ROLE_ADMIN')`\n","operationId":"batchUpdateAgent","parameters":[{"name":"datasets","in":"query","required":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"agentName","in":"query","required":false,"schema":{"type":"string"}},{"name":"agentId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"agentUuid","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"in":"query","description":"The UUID of the agent."}],"responses":{"200":{"description":"Returns the number of datasets for which the agent information was updated","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}},"404":{"description":"Some dataset not found","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}},"422":{"description":"Updating agent for pushdown datasets is not allowed"}}}}}}
```

## Retrieve the dataset definition of a given dataset

> Retrieves the dataset definition of a given dataset. \
> Pre-authorization requirements: \
> \
> \- \`hasRole('ROLE\_ADMIN') or hasRole('ROLE\_DATASET\_MANAGER') or hasDatasetAccess(#dataset)\`<br>

```json
{"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"tags":[{"name":"DQ Dataset Definitions API","description":"The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs."}],"servers":[{"url":"https://<host-name>","description":"Generated server url"}],"security":[{"bearer-jwt":[]}],"components":{"securitySchemes":{"bearer-jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DatasetDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string"},"runIdEnd":{"type":"string"},"runState":{"type":"string","enum":["DRAFT","DRY","CERTIFIED"]},"passFail":{"type":"integer","format":"int32"},"passFailLimit":{"type":"integer","format":"int32"},"jobDescription":{"type":"string"},"jobId":{"$ref":"#/components/schemas/IdentifierDTO"},"coreMaxActiveConnections":{"type":"integer","format":"int32"},"linkId":{"type":"array","items":{"type":"string"}},"licenseKey":{"type":"string"},"logFile":{"type":"string"},"logLevel":{"type":"string"},"hootOnly":{"type":"boolean"},"prettyPrint":{"type":"boolean"},"useTemplate":{"type":"boolean"},"parallel":{"type":"boolean"},"plan":{"type":"boolean"},"dataPreviewOff":{"type":"boolean"},"datasetSafeOff":{"type":"boolean"},"obslimit":{"type":"integer","format":"int32"},"pgUser":{"type":"string"},"pgPassword":{"type":"string"},"host":{"type":"string"},"port":{"type":"string"},"user":{"type":"string"},"alertEmail":{"type":"string"},"scheduleTime":{"type":"string"},"schemaScore":{"type":"number","format":"double"},"optionAppend":{"type":"string"},"keyDelimiter":{"type":"string"},"agentId":{"$ref":"#/components/schemas/IdentifierDTO"},"load":{"$ref":"#/components/schemas/LoadDefDTO"},"pushdown":{"$ref":"#/components/schemas/PushDownDefDTO"},"outliers":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/OutlierDefDTO"}},"patterns":{"type":"array","items":{"$ref":"#/components/schemas/PatternDefDTO"}},"dupe":{"$ref":"#/components/schemas/DupeDefDTO"},"profile":{"$ref":"#/components/schemas/ProfileDefDTO"},"source":{"$ref":"#/components/schemas/SourceDefDTO"},"rule":{"$ref":"#/components/schemas/RuleDefDTO"},"colMatch":{"$ref":"#/components/schemas/ColMatchDefDTO"},"spark":{"$ref":"#/components/schemas/SparkDefDTO"},"env":{"$ref":"#/components/schemas/EnvDefDTO"},"record":{"$ref":"#/components/schemas/RecordDefDTO"},"stream":{"$ref":"#/components/schemas/StreamDefDTO"},"pipeline":{"type":"array","items":{"type":"string"}},"runDate":{"type":"string","format":"date-time","writeOnly":true},"runDateEnd":{"type":"string","format":"date-time","writeOnly":true},"metaTags":{"type":"array","items":{"type":"string"}},"outlierConfiguration":{"$ref":"#/components/schemas/AbstractOutlierDefDTO"},"shape":{"$ref":"#/components/schemas/ShapeDefDTO"},"jobSchedule":{"$ref":"#/components/schemas/AbstractJobScheduleConfigurationDTO"},"connectionType":{"type":"string","readOnly":true,"enum":["PULLUP","PUSHDOWN"]}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}},"LoadDefDTO":{"type":"object","properties":{"readonly":{"type":"boolean"},"passwordManager":{"type":"string"},"alias":{"type":"string"},"query":{"type":"string"},"queryHistory":{"type":"string"},"key":{"type":"string"},"expression":{"type":"string"},"addDateColumn":{"type":"boolean"},"zeroFillNull":{"type":"boolean"},"replaceNulls":{"type":"string"},"stringMode":{"type":"boolean"},"operator":{"type":"string"},"dateColumn":{"type":"string"},"transform":{"type":"string"},"filter":{"type":"string"},"filterNot":{"type":"string"},"sample":{"type":"number","format":"double"},"backRun":{"type":"integer","format":"int32"},"backRunBin":{"type":"string","enum":["MINUTE","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"unionLookBack":{"type":"boolean"},"unionLookBackMinRow":{"type":"integer","format":"int32"},"cache":{"type":"boolean"},"dateFormat":{"type":"string"},"timeFormat":{"type":"string"},"timestamp":{"type":"boolean"},"filePath":{"type":"string"},"fileQuery":{"type":"string"},"fullFile":{"type":"boolean"},"fileHeader":{"type":"string"},"inferSchema":{"type":"boolean"},"fileType":{"type":"string"},"delimiter":{"type":"string"},"fileCharSet":{"type":"string"},"skipLines":{"type":"integer","format":"int32"},"avroSchema":{"type":"string"},"xmlRowTag":{"type":"string"},"flatten":{"type":"boolean"},"handleMaps":{"type":"boolean"},"handleMixedJson":{"type":"boolean"},"multiLine":{"type":"boolean"},"lib":{"type":"string"},"additionalLib":{"type":"string"},"driverName":{"type":"string"},"connectionName":{"type":"string"},"connectionUrl":{"type":"string"},"userName":{"type":"string"},"password":{"type":"string"},"connectionProperties":{"type":"object","additionalProperties":{"type":"string"}},"hiveNative":{"type":"boolean"},"hiveNativeHWC":{"type":"boolean"},"useSql":{"type":"boolean"},"columnName":{"type":"string"},"lowerBound":{"type":"string"},"upperBound":{"type":"string"},"numPartitions":{"type":"integer","format":"int32"},"partitionNumber":{"type":"integer","format":"int32"},"escapeWithBackTick":{"type":"boolean"},"escapeWithSingleQuote":{"type":"boolean"},"escapeWithDoubleQuote":{"type":"boolean"},"escapeCharacter":{"type":"string"},"checkHeader":{"type":"boolean"},"archiveConnection":{"type":"string"},"coreFetchMode":{"type":"boolean"},"archiveBreaks":{"type":"boolean"},"ruleSerial":{"type":"boolean"}}},"PushDownDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"connectionName":{"type":"string"},"maxConnections":{"type":"integer","format":"int32"},"sourceQuery":{"type":"string"},"backRuns":{"type":"integer","format":"int32"},"backRunBin":{"type":"string"},"dateFormatType":{"type":"string"},"threads":{"type":"integer","format":"int32"},"manualSourceQuery":{"type":"boolean"},"key":{"type":"string"},"sourceOutputSchema":{"type":"string"},"sourceBreakRules":{"type":"boolean"},"sourceBreakOutliers":{"type":"boolean"},"sourceBreakDupes":{"type":"boolean"},"sourceBreakShapes":{"type":"boolean"},"sourceBreakResults":{"type":"boolean"},"sqlLoggingToggle":{"type":"boolean"},"unionLookback":{"type":"boolean"},"unionLookbackMin":{"type":"integer","format":"int32"}}},"OutlierDefDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"timeColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"timeBinQuery":{"type":"string"},"categorical":{"type":"boolean"},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}},"deprecated":true},"PatternDefDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"score":{"type":"number","format":"double"},"minSupport":{"type":"number","format":"double"},"confidence":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"},"query":{"type":"string"},"filter":{"type":"string"},"timeBin":{"type":"string","enum":["MINUTE","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]}}},"DupeDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"depth":{"type":"integer","format":"int32"},"lowerBound":{"type":"integer","format":"int32"},"upperBound":{"type":"integer","format":"int32"},"approximate":{"type":"integer","format":"int32"},"limitPerDupe":{"type":"integer","format":"int32"},"checkHeader":{"type":"boolean"},"filter":{"type":"string"},"ignoreCase":{"type":"boolean"},"score":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"}}},"ProfileDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"correlation":{"type":"boolean"},"histogram":{"type":"boolean"},"semantic":{"type":"boolean"},"dataConceptId":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"histogramLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"shape":{"type":"boolean","deprecated":true},"shapeTotalScore":{"type":"integer","format":"int32","deprecated":true},"shapeSensitivity":{"type":"number","format":"double","deprecated":true},"shapeMaxPerCol":{"type":"integer","format":"int32","deprecated":true},"shapeMaxColSize":{"type":"integer","format":"int32","deprecated":true},"shapeGranular":{"type":"boolean","deprecated":true},"behavioralDimension":{"type":"string"},"behavioralDimensionGroup":{"type":"string"},"behavioralValueColumn":{"type":"string"},"behaviorScoreOff":{"type":"boolean"},"behaviorLookback":{"type":"integer","format":"int32"},"behaviorMinSupport":{"type":"integer","format":"int32"},"profilePushDown":{"type":"array","items":{"type":"string"}},"behaviorRowCheck":{"type":"boolean"},"behaviorTimeCheck":{"type":"boolean"},"behaviorMinValueCheck":{"type":"boolean"},"behaviorMaxValueCheck":{"type":"boolean"},"behaviorMeanValueCheck":{"type":"boolean"},"behaviorNullCheck":{"type":"boolean"},"behaviorEmptyCheck":{"type":"boolean"},"behaviorUniqueCheck":{"type":"boolean"},"profileStringLength":{"type":"boolean"},"detectStringNumerics":{"type":"boolean"},"detectTopnBotn":{"type":"boolean"},"detectScalePrecision":{"type":"boolean"},"adaptiveTier":{"type":"string"},"advancedTier":{"type":"boolean"},"filter":{"type":"string"}}},"SourceDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"validateValues":{"type":"boolean"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"includeSrc":{"type":"array","items":{"type":"string"}},"excludeSrc":{"type":"array","items":{"type":"string"}},"map":{"type":"object","additionalProperties":{"type":"string"}},"score":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"},"sourcePushDownCount":{"type":"boolean"},"checkType":{"type":"boolean"},"checkCase":{"type":"boolean"},"validateSchemaOrder":{"type":"boolean"},"matches":{"type":"boolean"},"validateValuesThreshold":{"type":"number","format":"double"},"validateValuesThresholdStrictDownScore":{"type":"boolean"},"validateValuesShowAll":{"type":"boolean"},"validateValuesIgnoreNull":{"type":"boolean"},"validateValuesIgnoreEmpty":{"type":"boolean"},"validateValuesIgnorePrecision":{"type":"boolean"},"validateValuesTrim":{"type":"boolean"},"validateValuesShowMissingKeys":{"type":"boolean"},"validateSrcJoinOnly":{"type":"boolean"},"validateValuesFilter":{"type":"string"},"dataset":{"type":"string"},"driverName":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"},"passwordManager":{"type":"string"},"connectionName":{"type":"string"},"connectionUrl":{"type":"string"},"query":{"type":"string"},"lib":{"type":"string"},"connectionProperties":{"type":"object","additionalProperties":{"type":"string"}},"filePath":{"type":"string"},"fileQuery":{"type":"string"},"fullFile":{"type":"boolean"},"header":{"type":"string"},"skipLines":{"type":"integer","format":"int32"},"inferSchema":{"type":"boolean"},"fileType":{"type":"string"},"delimiter":{"type":"string"},"fileCharSet":{"type":"string"},"avroSchema":{"type":"string"},"xmlRowTag":{"type":"string"},"flatten":{"type":"boolean"},"handleMaps":{"type":"boolean"},"handleMixedJson":{"type":"boolean"},"multiLine":{"type":"boolean"},"filterCols":{"type":"array","items":{"type":"string"}}}},"RuleDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"lib":{"type":"string"},"name":{"type":"string"},"absoluteScoring":{"type":"boolean"},"ruleBreakPreviewLimit":{"type":"integer","format":"int32"}}},"ColMatchDefDTO":{"type":"object","properties":{"colMatchParallelProcesses":{"type":"integer","format":"int32"},"colMatchDurationMins":{"type":"integer","format":"int32"},"colMatchBatchSize":{"type":"integer","format":"int32"},"level":{"type":"string"},"fuzzyDistance":{"type":"integer","format":"int32"},"connectionList":{"type":"array","items":{"$ref":"#/components/schemas/Connection"}}}},"Connection":{"type":"object","properties":{"dataset":{"type":"string"},"url":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"},"query":{"type":"string"},"filePath":{"type":"string"},"driver":{"type":"string"},"driverProps":{"type":"object","additionalProperties":{"type":"string"}}}},"SparkDefDTO":{"type":"object","properties":{"numExecutors":{"type":"integer","format":"int32"},"driverMemory":{"type":"string"},"executorMemory":{"type":"string"},"executorCores":{"type":"integer","format":"int32"},"conf":{"type":"string"},"queue":{"type":"string"},"master":{"type":"string"},"principal":{"type":"string"},"keyTab":{"type":"string"},"deployMode":{"type":"string"},"jars":{"type":"array","items":{"type":"string"}},"packages":{"type":"array","items":{"type":"string"}},"files":{"type":"array","items":{"type":"string"}}}},"EnvDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"jdbcPrincipal":{"type":"string"},"jdbcKeyTab":{"type":"string"}}},"RecordDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"in":{"type":"string"},"notIn":{"type":"string"},"include":{"type":"array","items":{"type":"string"}},"percDeltaLimit":{"type":"number","format":"double"},"score":{"type":"number","format":"double"},"dataset":{"type":"string"},"dateColumn":{"type":"string"},"keyColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]}}},"StreamDefDTO":{"type":"object","properties":{"type":{"type":"string","enum":["Kafka"]},"kafkaDef":{"$ref":"#/components/schemas/KafkaDefDTO"}}},"KafkaDefDTO":{"type":"object","properties":{"kafkaGroup":{"type":"string"},"kafkaBroker":{"type":"string"},"kafkaPort":{"type":"string"},"kafkaTopic":{"type":"string"},"kafkaKeySerde":{"type":"string"},"kafkaValSerde":{"type":"string"},"kafkaSaslEnabled":{"type":"boolean"},"kafkaSaslService":{"type":"string"},"kafkaSslEnabled":{"type":"boolean"},"streamSchemaRegistryUrl":{"type":"string"},"streamSchemaRegistryUser":{"type":"string"},"streamSchemaRegistryPassword":{"type":"string"},"streamInterval":{"type":"string"},"streamSchema":{"type":"string"},"streamFormat":{"type":"string"},"streamMaxLull":{"type":"string"}}},"AbstractOutlierDefDTO":{"type":"object","properties":{"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"type":"object"}}},"description":"Outlier configurations","oneOf":[{"$ref":"#/components/schemas/PullupOutlierDefDTO"},{"$ref":"#/components/schemas/PushdownOutlierDefDTO"}]},"OutlierDefColumnSensitivitySettingsDTO":{"type":"object","properties":{"name":{"type":"string"},"weight":{"type":"number","format":"double"},"unit":{"type":"string","enum":["DEFAULT","UNIT_0_001","UNIT_0_01","UNIT_0_1","UNIT_1_0","UNIT_10_0","UNIT_100_0","UNIT_1000_0","UNIT_10000_0","UNIT_100000_0","UNIT_1000000_0","UNIT_10000000_0"]}},"description":"List of column sensitivity settings"},"PullupOutlierDefDTO":{"type":"object","properties":{"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"dateColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categorical":{"type":"boolean"},"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/PullupOutlierDefConfigurationDTO"}}}},"PullupOutlierDefConfigurationDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"timeColumn":{"type":"string"},"timeBinQuery":{"type":"string"},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}}},"PushdownOutlierDefDTO":{"type":"object","properties":{"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/PushdownOutlierDefConfigurationDTO"}}}},"PushdownOutlierDefConfigurationDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"timeColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"timeBinQuery":{"type":"string"},"categorical":{"type":"boolean"},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}}},"ShapeDefDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"totalScore":{"type":"integer","format":"int32"},"sensitivity":{"type":"number","format":"double"},"maxPerCol":{"type":"integer","format":"int32"},"maxColSize":{"type":"integer","format":"int32"},"granular":{"type":"boolean"},"columnSettings":{"type":"array","items":{"$ref":"#/components/schemas/ShapeColumnSettingsDTO"}}}},"ShapeColumnSettingsDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"}}},"AbstractJobScheduleConfigurationDTO":{"required":["agentId","dataset","runDateFormat"],"type":"object","properties":{"enabled":{"type":"boolean"},"dataset":{"type":"string"},"agentId":{"$ref":"#/components/schemas/Identifier"},"runDateFormat":{"pattern":"yyyy-MM-dd HH:mm:ss|yyyy-MM-dd HH:mm|yyyy-MM-dd HH|yyyy-MM-dd","type":"string"},"scheduleFrequency":{"type":"string","enum":["DAILY","MONTHLY","QUARTERLY"]},"updatedAt":{"type":"string","format":"date-time"},"scheduleTime":{"pattern":"HH:mm:ss","type":"string"}},"discriminator":{"propertyName":"scheduleFrequency"}},"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}},"paths":{"/v3/datasetDefs/{dataset}":{"get":{"tags":["DQ Dataset Definitions API"],"summary":"Retrieve the dataset definition of a given dataset","description":"Retrieves the dataset definition of a given dataset. \nPre-authorization requirements: \n\n- `hasRole('ROLE_ADMIN') or hasRole('ROLE_DATASET_MANAGER') or hasDatasetAccess(#dataset)`\n","operationId":"get","parameters":[{"name":"dataset","in":"path","description":"Dataset name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a single dataset definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDefDTO"}}}},"404":{"description":"Dataset not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDefDTO"}}}}}}}}}
```

## Retrieve the dataset definition of a given dataset as a command line string

> Retrieves the dataset definition of a given dataset as a command line string. \
> Pre-authorization requirements: \
> \
> \- \`hasRole('ROLE\_ADMIN') or hasRole('ROLE\_DATASET\_MANAGER') or hasDatasetAccess(#dataset)\`<br>

```json
{"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"tags":[{"name":"DQ Dataset Definitions API","description":"The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs."}],"servers":[{"url":"https://<host-name>","description":"Generated server url"}],"security":[{"bearer-jwt":[]}],"components":{"securitySchemes":{"bearer-jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CmdLineDTO":{"required":["cmdLine"],"type":"object","properties":{"cmdLine":{"type":"string"}}}}},"paths":{"/v3/datasetDefs/{dataset}/cmdLine":{"get":{"tags":["DQ Dataset Definitions API"],"summary":"Retrieve the dataset definition of a given dataset as a command line string","description":"Retrieves the dataset definition of a given dataset as a command line string. \nPre-authorization requirements: \n\n- `hasRole('ROLE_ADMIN') or hasRole('ROLE_DATASET_MANAGER') or hasDatasetAccess(#dataset)`\n","operationId":"getCmdline","parameters":[{"name":"dataset","in":"path","description":"Dataset name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a single dataset definition as a cmdline string","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmdLineDTO"}}}},"404":{"description":"Dataset not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmdLineDTO"}}}},"422":{"description":"Command line not supported for Pushdown jobs"}}}}}}
```

## Retrieve a template of a new dataset definition

> Retrieves a template of a new dataset definition with sample or default values only.

```json
{"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"tags":[{"name":"DQ Dataset Definitions API","description":"The DQ Dataset Definitions API allows you to manage dataset definitions, which are used to define DQ Jobs."}],"servers":[{"url":"https://<host-name>","description":"Generated server url"}],"security":[{"bearer-jwt":[]}],"components":{"securitySchemes":{"bearer-jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DatasetDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string"},"runIdEnd":{"type":"string"},"runState":{"type":"string","enum":["DRAFT","DRY","CERTIFIED"]},"passFail":{"type":"integer","format":"int32"},"passFailLimit":{"type":"integer","format":"int32"},"jobDescription":{"type":"string"},"jobId":{"$ref":"#/components/schemas/IdentifierDTO"},"coreMaxActiveConnections":{"type":"integer","format":"int32"},"linkId":{"type":"array","items":{"type":"string"}},"licenseKey":{"type":"string"},"logFile":{"type":"string"},"logLevel":{"type":"string"},"hootOnly":{"type":"boolean"},"prettyPrint":{"type":"boolean"},"useTemplate":{"type":"boolean"},"parallel":{"type":"boolean"},"plan":{"type":"boolean"},"dataPreviewOff":{"type":"boolean"},"datasetSafeOff":{"type":"boolean"},"obslimit":{"type":"integer","format":"int32"},"pgUser":{"type":"string"},"pgPassword":{"type":"string"},"host":{"type":"string"},"port":{"type":"string"},"user":{"type":"string"},"alertEmail":{"type":"string"},"scheduleTime":{"type":"string"},"schemaScore":{"type":"number","format":"double"},"optionAppend":{"type":"string"},"keyDelimiter":{"type":"string"},"agentId":{"$ref":"#/components/schemas/IdentifierDTO"},"load":{"$ref":"#/components/schemas/LoadDefDTO"},"pushdown":{"$ref":"#/components/schemas/PushDownDefDTO"},"outliers":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/OutlierDefDTO"}},"patterns":{"type":"array","items":{"$ref":"#/components/schemas/PatternDefDTO"}},"dupe":{"$ref":"#/components/schemas/DupeDefDTO"},"profile":{"$ref":"#/components/schemas/ProfileDefDTO"},"source":{"$ref":"#/components/schemas/SourceDefDTO"},"rule":{"$ref":"#/components/schemas/RuleDefDTO"},"colMatch":{"$ref":"#/components/schemas/ColMatchDefDTO"},"spark":{"$ref":"#/components/schemas/SparkDefDTO"},"env":{"$ref":"#/components/schemas/EnvDefDTO"},"record":{"$ref":"#/components/schemas/RecordDefDTO"},"stream":{"$ref":"#/components/schemas/StreamDefDTO"},"pipeline":{"type":"array","items":{"type":"string"}},"runDate":{"type":"string","format":"date-time","writeOnly":true},"runDateEnd":{"type":"string","format":"date-time","writeOnly":true},"metaTags":{"type":"array","items":{"type":"string"}},"outlierConfiguration":{"$ref":"#/components/schemas/AbstractOutlierDefDTO"},"shape":{"$ref":"#/components/schemas/ShapeDefDTO"},"jobSchedule":{"$ref":"#/components/schemas/AbstractJobScheduleConfigurationDTO"},"connectionType":{"type":"string","readOnly":true,"enum":["PULLUP","PUSHDOWN"]}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}},"LoadDefDTO":{"type":"object","properties":{"readonly":{"type":"boolean"},"passwordManager":{"type":"string"},"alias":{"type":"string"},"query":{"type":"string"},"queryHistory":{"type":"string"},"key":{"type":"string"},"expression":{"type":"string"},"addDateColumn":{"type":"boolean"},"zeroFillNull":{"type":"boolean"},"replaceNulls":{"type":"string"},"stringMode":{"type":"boolean"},"operator":{"type":"string"},"dateColumn":{"type":"string"},"transform":{"type":"string"},"filter":{"type":"string"},"filterNot":{"type":"string"},"sample":{"type":"number","format":"double"},"backRun":{"type":"integer","format":"int32"},"backRunBin":{"type":"string","enum":["MINUTE","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"unionLookBack":{"type":"boolean"},"unionLookBackMinRow":{"type":"integer","format":"int32"},"cache":{"type":"boolean"},"dateFormat":{"type":"string"},"timeFormat":{"type":"string"},"timestamp":{"type":"boolean"},"filePath":{"type":"string"},"fileQuery":{"type":"string"},"fullFile":{"type":"boolean"},"fileHeader":{"type":"string"},"inferSchema":{"type":"boolean"},"fileType":{"type":"string"},"delimiter":{"type":"string"},"fileCharSet":{"type":"string"},"skipLines":{"type":"integer","format":"int32"},"avroSchema":{"type":"string"},"xmlRowTag":{"type":"string"},"flatten":{"type":"boolean"},"handleMaps":{"type":"boolean"},"handleMixedJson":{"type":"boolean"},"multiLine":{"type":"boolean"},"lib":{"type":"string"},"additionalLib":{"type":"string"},"driverName":{"type":"string"},"connectionName":{"type":"string"},"connectionUrl":{"type":"string"},"userName":{"type":"string"},"password":{"type":"string"},"connectionProperties":{"type":"object","additionalProperties":{"type":"string"}},"hiveNative":{"type":"boolean"},"hiveNativeHWC":{"type":"boolean"},"useSql":{"type":"boolean"},"columnName":{"type":"string"},"lowerBound":{"type":"string"},"upperBound":{"type":"string"},"numPartitions":{"type":"integer","format":"int32"},"partitionNumber":{"type":"integer","format":"int32"},"escapeWithBackTick":{"type":"boolean"},"escapeWithSingleQuote":{"type":"boolean"},"escapeWithDoubleQuote":{"type":"boolean"},"escapeCharacter":{"type":"string"},"checkHeader":{"type":"boolean"},"archiveConnection":{"type":"string"},"coreFetchMode":{"type":"boolean"},"archiveBreaks":{"type":"boolean"},"ruleSerial":{"type":"boolean"}}},"PushDownDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"connectionName":{"type":"string"},"maxConnections":{"type":"integer","format":"int32"},"sourceQuery":{"type":"string"},"backRuns":{"type":"integer","format":"int32"},"backRunBin":{"type":"string"},"dateFormatType":{"type":"string"},"threads":{"type":"integer","format":"int32"},"manualSourceQuery":{"type":"boolean"},"key":{"type":"string"},"sourceOutputSchema":{"type":"string"},"sourceBreakRules":{"type":"boolean"},"sourceBreakOutliers":{"type":"boolean"},"sourceBreakDupes":{"type":"boolean"},"sourceBreakShapes":{"type":"boolean"},"sourceBreakResults":{"type":"boolean"},"sqlLoggingToggle":{"type":"boolean"},"unionLookback":{"type":"boolean"},"unionLookbackMin":{"type":"integer","format":"int32"}}},"OutlierDefDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"timeColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"timeBinQuery":{"type":"string"},"categorical":{"type":"boolean"},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}},"deprecated":true},"PatternDefDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"score":{"type":"number","format":"double"},"minSupport":{"type":"number","format":"double"},"confidence":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"},"query":{"type":"string"},"filter":{"type":"string"},"timeBin":{"type":"string","enum":["MINUTE","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]}}},"DupeDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"depth":{"type":"integer","format":"int32"},"lowerBound":{"type":"integer","format":"int32"},"upperBound":{"type":"integer","format":"int32"},"approximate":{"type":"integer","format":"int32"},"limitPerDupe":{"type":"integer","format":"int32"},"checkHeader":{"type":"boolean"},"filter":{"type":"string"},"ignoreCase":{"type":"boolean"},"score":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"}}},"ProfileDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"correlation":{"type":"boolean"},"histogram":{"type":"boolean"},"semantic":{"type":"boolean"},"dataConceptId":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"histogramLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"shape":{"type":"boolean","deprecated":true},"shapeTotalScore":{"type":"integer","format":"int32","deprecated":true},"shapeSensitivity":{"type":"number","format":"double","deprecated":true},"shapeMaxPerCol":{"type":"integer","format":"int32","deprecated":true},"shapeMaxColSize":{"type":"integer","format":"int32","deprecated":true},"shapeGranular":{"type":"boolean","deprecated":true},"behavioralDimension":{"type":"string"},"behavioralDimensionGroup":{"type":"string"},"behavioralValueColumn":{"type":"string"},"behaviorScoreOff":{"type":"boolean"},"behaviorLookback":{"type":"integer","format":"int32"},"behaviorMinSupport":{"type":"integer","format":"int32"},"profilePushDown":{"type":"array","items":{"type":"string"}},"behaviorRowCheck":{"type":"boolean"},"behaviorTimeCheck":{"type":"boolean"},"behaviorMinValueCheck":{"type":"boolean"},"behaviorMaxValueCheck":{"type":"boolean"},"behaviorMeanValueCheck":{"type":"boolean"},"behaviorNullCheck":{"type":"boolean"},"behaviorEmptyCheck":{"type":"boolean"},"behaviorUniqueCheck":{"type":"boolean"},"profileStringLength":{"type":"boolean"},"detectStringNumerics":{"type":"boolean"},"detectTopnBotn":{"type":"boolean"},"detectScalePrecision":{"type":"boolean"},"adaptiveTier":{"type":"string"},"advancedTier":{"type":"boolean"},"filter":{"type":"string"}}},"SourceDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"validateValues":{"type":"boolean"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"includeSrc":{"type":"array","items":{"type":"string"}},"excludeSrc":{"type":"array","items":{"type":"string"}},"map":{"type":"object","additionalProperties":{"type":"string"}},"score":{"type":"number","format":"double"},"limit":{"type":"integer","format":"int32"},"sourcePushDownCount":{"type":"boolean"},"checkType":{"type":"boolean"},"checkCase":{"type":"boolean"},"validateSchemaOrder":{"type":"boolean"},"matches":{"type":"boolean"},"validateValuesThreshold":{"type":"number","format":"double"},"validateValuesThresholdStrictDownScore":{"type":"boolean"},"validateValuesShowAll":{"type":"boolean"},"validateValuesIgnoreNull":{"type":"boolean"},"validateValuesIgnoreEmpty":{"type":"boolean"},"validateValuesIgnorePrecision":{"type":"boolean"},"validateValuesTrim":{"type":"boolean"},"validateValuesShowMissingKeys":{"type":"boolean"},"validateSrcJoinOnly":{"type":"boolean"},"validateValuesFilter":{"type":"string"},"dataset":{"type":"string"},"driverName":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"},"passwordManager":{"type":"string"},"connectionName":{"type":"string"},"connectionUrl":{"type":"string"},"query":{"type":"string"},"lib":{"type":"string"},"connectionProperties":{"type":"object","additionalProperties":{"type":"string"}},"filePath":{"type":"string"},"fileQuery":{"type":"string"},"fullFile":{"type":"boolean"},"header":{"type":"string"},"skipLines":{"type":"integer","format":"int32"},"inferSchema":{"type":"boolean"},"fileType":{"type":"string"},"delimiter":{"type":"string"},"fileCharSet":{"type":"string"},"avroSchema":{"type":"string"},"xmlRowTag":{"type":"string"},"flatten":{"type":"boolean"},"handleMaps":{"type":"boolean"},"handleMixedJson":{"type":"boolean"},"multiLine":{"type":"boolean"},"filterCols":{"type":"array","items":{"type":"string"}}}},"RuleDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"lib":{"type":"string"},"name":{"type":"string"},"absoluteScoring":{"type":"boolean"},"ruleBreakPreviewLimit":{"type":"integer","format":"int32"}}},"ColMatchDefDTO":{"type":"object","properties":{"colMatchParallelProcesses":{"type":"integer","format":"int32"},"colMatchDurationMins":{"type":"integer","format":"int32"},"colMatchBatchSize":{"type":"integer","format":"int32"},"level":{"type":"string"},"fuzzyDistance":{"type":"integer","format":"int32"},"connectionList":{"type":"array","items":{"$ref":"#/components/schemas/Connection"}}}},"Connection":{"type":"object","properties":{"dataset":{"type":"string"},"url":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"},"query":{"type":"string"},"filePath":{"type":"string"},"driver":{"type":"string"},"driverProps":{"type":"object","additionalProperties":{"type":"string"}}}},"SparkDefDTO":{"type":"object","properties":{"numExecutors":{"type":"integer","format":"int32"},"driverMemory":{"type":"string"},"executorMemory":{"type":"string"},"executorCores":{"type":"integer","format":"int32"},"conf":{"type":"string"},"queue":{"type":"string"},"master":{"type":"string"},"principal":{"type":"string"},"keyTab":{"type":"string"},"deployMode":{"type":"string"},"jars":{"type":"array","items":{"type":"string"}},"packages":{"type":"array","items":{"type":"string"}},"files":{"type":"array","items":{"type":"string"}}}},"EnvDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"jdbcPrincipal":{"type":"string"},"jdbcKeyTab":{"type":"string"}}},"RecordDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"in":{"type":"string"},"notIn":{"type":"string"},"include":{"type":"array","items":{"type":"string"}},"percDeltaLimit":{"type":"number","format":"double"},"score":{"type":"number","format":"double"},"dataset":{"type":"string"},"dateColumn":{"type":"string"},"keyColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]}}},"StreamDefDTO":{"type":"object","properties":{"type":{"type":"string","enum":["Kafka"]},"kafkaDef":{"$ref":"#/components/schemas/KafkaDefDTO"}}},"KafkaDefDTO":{"type":"object","properties":{"kafkaGroup":{"type":"string"},"kafkaBroker":{"type":"string"},"kafkaPort":{"type":"string"},"kafkaTopic":{"type":"string"},"kafkaKeySerde":{"type":"string"},"kafkaValSerde":{"type":"string"},"kafkaSaslEnabled":{"type":"boolean"},"kafkaSaslService":{"type":"string"},"kafkaSslEnabled":{"type":"boolean"},"streamSchemaRegistryUrl":{"type":"string"},"streamSchemaRegistryUser":{"type":"string"},"streamSchemaRegistryPassword":{"type":"string"},"streamInterval":{"type":"string"},"streamSchema":{"type":"string"},"streamFormat":{"type":"string"},"streamMaxLull":{"type":"string"}}},"AbstractOutlierDefDTO":{"type":"object","properties":{"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"type":"object"}}},"description":"Outlier configurations","oneOf":[{"$ref":"#/components/schemas/PullupOutlierDefDTO"},{"$ref":"#/components/schemas/PushdownOutlierDefDTO"}]},"OutlierDefColumnSensitivitySettingsDTO":{"type":"object","properties":{"name":{"type":"string"},"weight":{"type":"number","format":"double"},"unit":{"type":"string","enum":["DEFAULT","UNIT_0_001","UNIT_0_01","UNIT_0_1","UNIT_1_0","UNIT_10_0","UNIT_100_0","UNIT_1000_0","UNIT_10000_0","UNIT_100000_0","UNIT_1000000_0","UNIT_10000000_0"]}},"description":"List of column sensitivity settings"},"PullupOutlierDefDTO":{"type":"object","properties":{"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"dateColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categorical":{"type":"boolean"},"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/PullupOutlierDefConfigurationDTO"}}}},"PullupOutlierDefConfigurationDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"timeColumn":{"type":"string"},"timeBinQuery":{"type":"string"},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}}},"PushdownOutlierDefDTO":{"type":"object","properties":{"columnSensitivitySettings":{"type":"array","description":"List of column sensitivity settings","items":{"$ref":"#/components/schemas/OutlierDefColumnSensitivitySettingsDTO"}},"configurations":{"type":"array","items":{"$ref":"#/components/schemas/PushdownOutlierDefConfigurationDTO"}}}},"PushdownOutlierDefConfigurationDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"only":{"type":"boolean"},"lookback":{"type":"integer","format":"int32"},"key":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}},"dateColumn":{"type":"string"},"timeColumn":{"type":"string"},"timeBin":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"timeBinQuery":{"type":"string"},"categorical":{"type":"boolean"},"by":{"type":"string","enum":["MIN","HOUR","DAY","WEEK","MONTH","QUARTER","YEAR"]},"limit":{"type":"integer","format":"int32"},"minHistory":{"type":"integer","format":"int32"},"historyLimit":{"type":"integer","format":"int32"},"score":{"type":"number","format":"double"},"aggFunc":{"type":"string"},"aggQuery":{"type":"string"},"query":{"type":"string"},"q1":{"type":"number","format":"double"},"q3":{"type":"number","format":"double"},"categoricalColumnConcatenation":{"type":"boolean"},"limitCategorical":{"type":"integer","format":"int32"},"measurementUnit":{"type":"string"},"multiplierUpper":{"type":"number","format":"double"},"multiplierLower":{"type":"number","format":"double"},"record":{"type":"boolean"},"filter":{"type":"string"},"combine":{"type":"boolean"},"categoricalConfidenceType":{"type":"string"},"categoricalTopN":{"type":"integer","format":"int32"},"categoricalBottomN":{"type":"integer","format":"int32"},"categoricalMaxConfidence":{"type":"number","format":"double"},"categoricalMaxFrequencyPercentile":{"type":"number","format":"double"},"categoricalMinFrequency":{"type":"integer","format":"int32"},"categoricalMinVariance":{"type":"number","format":"double"},"categoricalMaxCategoryN":{"type":"integer","format":"int32"},"categoricalParallel":{"type":"boolean"},"categoricalAlgorithm":{"type":"string"},"categoricalAlgorithmParameters":{"type":"object","additionalProperties":{"type":"string"}},"categoricalAlgorithmParametersString":{"type":"string","writeOnly":true}}},"ShapeDefDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"totalScore":{"type":"integer","format":"int32"},"sensitivity":{"type":"number","format":"double"},"maxPerCol":{"type":"integer","format":"int32"},"maxColSize":{"type":"integer","format":"int32"},"granular":{"type":"boolean"},"columnSettings":{"type":"array","items":{"$ref":"#/components/schemas/ShapeColumnSettingsDTO"}}}},"ShapeColumnSettingsDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"}}},"AbstractJobScheduleConfigurationDTO":{"required":["agentId","dataset","runDateFormat"],"type":"object","properties":{"enabled":{"type":"boolean"},"dataset":{"type":"string"},"agentId":{"$ref":"#/components/schemas/Identifier"},"runDateFormat":{"pattern":"yyyy-MM-dd HH:mm:ss|yyyy-MM-dd HH:mm|yyyy-MM-dd HH|yyyy-MM-dd","type":"string"},"scheduleFrequency":{"type":"string","enum":["DAILY","MONTHLY","QUARTERLY"]},"updatedAt":{"type":"string","format":"date-time"},"scheduleTime":{"pattern":"HH:mm:ss","type":"string"}},"discriminator":{"propertyName":"scheduleFrequency"}},"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}},"paths":{"/v3/datasetDefs/template":{"get":{"tags":["DQ Dataset Definitions API"],"summary":"Retrieve a template of a new dataset definition","description":"Retrieves a template of a new dataset definition with sample or default values only.","operationId":"getTemplate","responses":{"200":{"description":"Returns a template of a new dataset definition with sample/default values only","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDefDTO"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.collibra.com/api/references/dq-product/dq-dataset-definitions-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.