> 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/models.md). # Models ## The AbstractJobScheduleConfigurationDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}} ``` ## The AbstractOutlierDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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}}}}}} ``` ## The ColMatchDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}}} ``` ## The Connection object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}}} ``` ## The DatasetDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"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"}}}}}} ``` ## The DupeDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}} ``` ## The EnvDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"EnvDefDTO":{"type":"object","properties":{"dataset":{"type":"string"},"jdbcPrincipal":{"type":"string"},"jdbcKeyTab":{"type":"string"}}}}}} ``` ## The Identifier object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` ## The IdentifierDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` ## The KafkaDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}} ``` ## The LoadDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}} ``` ## The OutlierDefColumnSensitivitySettingsDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}} ``` ## The OutlierDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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}}}} ``` ## The PatternDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"]}}}}}} ``` ## The ProfileDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}} ``` ## The PullupOutlierDefConfigurationDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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}}}}}} ``` ## The PullupOutlierDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}},"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"},"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}}}}}} ``` ## The PushDownDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}} ``` ## The PushdownOutlierDefConfigurationDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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}}}}}} ``` ## The PushdownOutlierDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}},"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"},"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}}}}}} ``` ## The RecordDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"]}}}}}} ``` ## The RuleDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"RuleDefDTO":{"type":"object","properties":{"on":{"type":"boolean"},"only":{"type":"boolean"},"lib":{"type":"string"},"name":{"type":"string"},"absoluteScoring":{"type":"boolean"},"ruleBreakPreviewLimit":{"type":"integer","format":"int32"}}}}}} ``` ## The ShapeColumnSettingsDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"ShapeColumnSettingsDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"}}}}}} ``` ## The ShapeDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}} ``` ## The SourceDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}}} ``` ## The SparkDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}}} ``` ## The StreamDefDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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"}}}}}} ``` ## The RuleDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"RuleDTO":{"required":["dataset","perc","points","ruleNm","ruleRepo","ruleType","ruleValue"],"type":"object","properties":{"dataset":{"type":"string"},"ruleNm":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9-_]+$","type":"string"},"ruleType":{"type":"string"},"ruleValue":{"type":"string"},"points":{"type":"integer","format":"int32"},"perc":{"type":"number","format":"double"},"ruleRepo":{"type":"string"},"isActive":{"type":"integer","format":"int32"},"userNm":{"type":"string"},"exception":{"type":"string"},"columnName":{"type":"string"},"businessCategory":{"type":"string"},"businessDesc":{"type":"string"},"dimId":{"type":"integer","format":"int32"},"dimName":{"type":"string"},"ruleValueBuilder":{"type":"string"},"previewLimit":{"type":"integer","format":"int32"},"runTimeLimit":{"type":"number","format":"double"},"scoringScheme":{"type":"integer","format":"int32"},"filterQuery":{"type":"string"}}}}}} ``` ## The RuleCopyDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"RuleCopyDTO":{"required":["sourceDataset","sourceRuleName","targetDataset"],"type":"object","properties":{"sourceDataset":{"type":"string","description":"Source dataset name"},"sourceRuleName":{"type":"string","description":"Source rule name"},"targetDataset":{"type":"string","description":"Target dataset name"},"generatedRuleName":{"type":"string","description":"Target rule name. Generated if not provided"}},"description":"Rule Copy DTO"}}}} ``` ## The JobDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"JobDTO":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64"},"jobUuid":{"type":"string","format":"uuid"},"agentId":{"type":"integer","format":"int32"},"agentUuid":{"type":"string","format":"uuid"},"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"status":{"type":"string"},"activity":{"type":"string"},"activityStatus":{"type":"string"},"cmdLine":{"type":"string"},"description":{"type":"string"},"jobException":{"type":"string"},"username":{"type":"string"},"updtTs":{"type":"string","format":"date-time"},"pid":{"type":"string"},"remoteJobId":{"type":"string"},"notified":{"type":"integer","format":"int32"},"startTime":{"type":"string","format":"date-time"},"agentJobId":{"type":"integer","format":"int64"},"agentJobUuid":{"type":"string","format":"uuid"}}}}}} ``` ## The CmdLineDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"CmdLineDTO":{"required":["cmdLine"],"type":"object","properties":{"cmdLine":{"type":"string"}}}}}} ``` ## The DatasetDefFindAllFilterDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"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"]}}}}}}} ``` ## The DatasetFilteredResultDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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."}}}} ``` ## The PagedResponseDatasetFilteredResultDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"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."}}}} ``` ## The AlertDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"AlertDTO":{"type":"object","properties":{"dataset":{"type":"string"},"alertNm":{"type":"string"},"alertCond":{"type":"string"},"alertTriggerType":{"type":"integer","description":"Deprecated: Use alertTypes field instead.\nAlert trigger type mapping:\n0 - Condition\n1 - Job Failure\n2 - Job Complete\n","format":"int32","writeOnly":true,"deprecated":true},"alertFormat":{"type":"string"},"alertFormatValue":{"type":"string"},"alertMsg":{"type":"string"},"batchName":{"type":"string"},"addRuleDetails":{"type":"boolean"},"alertTypes":{"uniqueItems":true,"type":"array","description":"Alert types. If not provided, alertTriggerType will be used to determine alert types.","items":{"type":"string","description":"Alert types. If not provided, alertTriggerType will be used to determine alert types.","enum":["CONDITION","JOB_FAILURE","JOB_COMPLETE","BREAKING","EXCEPTION","PASSING"]}}}}}}} ``` ## The AuthenticationRequest object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"AuthenticationRequest":{"type":"object","properties":{"username":{"type":"string","description":"Username"},"password":{"type":"string","description":"Password"},"iss":{"type":"string","description":"Issuer (tenant name)"}}}}}} ``` ## The RuleBreaksDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"RuleBreaksDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"ruleNm":{"type":"string"},"linkId":{"type":"string"}}}}}} ``` ## The RuleDefinitionDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"RuleDefinitionDTO":{"required":["dataset","perc","points","ruleNm","ruleRepo","ruleType","ruleValue"],"type":"object","properties":{"dataset":{"type":"string"},"ruleNm":{"maxLength":100,"minLength":0,"pattern":"^[a-zA-Z0-9-_]+$","type":"string"},"ruleType":{"type":"string"},"ruleValue":{"type":"string"},"points":{"type":"integer","format":"int32"},"perc":{"type":"number","format":"double"},"ruleRepo":{"type":"string"},"isActive":{"type":"integer","format":"int32"},"userNm":{"type":"string"},"exception":{"type":"string"},"columnName":{"type":"string"},"businessCategory":{"type":"string"},"businessDesc":{"type":"string"},"dimId":{"type":"integer","format":"int32"},"dimName":{"type":"string"},"ruleValueBuilder":{"type":"string"},"previewLimit":{"type":"integer","format":"int32"},"runTimeLimit":{"type":"number","format":"double"},"scoringScheme":{"type":"integer","format":"int32"},"filterQuery":{"type":"string"},"dbNm":{"type":"string"},"tableNm":{"type":"string"}}}}}} ``` ## The ReportDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"ReportDTO":{"type":"object","properties":{"schema":{"type":"object","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"type":"object"}}},"description":"Report Data Transfer Object containing schema and data"}}}} ``` ## The ColumnBaseline object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"ColumnBaseline":{"type":"object","properties":{"field_nm":{"type":"string"},"avg_nulls":{"type":"number","format":"double"},"std_nulls":{"type":"number","format":"double"},"avg_empties":{"type":"number","format":"double"},"std_empties":{"type":"number","format":"double"},"avg_uniques":{"type":"number","format":"double"},"std_uniques":{"type":"number","format":"double"},"avg_unique_cnt":{"type":"number","format":"double"},"std_unique_cnt":{"type":"number","format":"double"},"median_unique_cnt":{"type":"number","format":"double"},"median_unique_ratio":{"type":"number","format":"double"},"avg_types":{"type":"number","format":"double"},"std_type":{"type":"number","format":"double"},"avg_min_abs_num":{"type":"number","format":"double"},"std_min_abs_num":{"type":"number","format":"double"},"min_min_abs_num":{"type":"number","format":"double"},"avg_max_abs_num":{"type":"number","format":"double"},"std_max_abs_num":{"type":"number","format":"double"},"min_max_abs_num":{"type":"number","format":"double"},"avg_mean_abs_num":{"type":"number","format":"double"},"std_mean_abs_num":{"type":"number","format":"double"},"avg_filled_ratio":{"type":"number","format":"double"},"avg_mean":{"type":"number","format":"double"},"std_mean":{"type":"number","format":"double"},"avg_min":{"type":"number","format":"double"},"std_min":{"type":"number","format":"double"},"avg_max":{"type":"number","format":"double"},"std_max":{"type":"number","format":"double"},"max_max":{"type":"number","format":"double"},"min_min":{"type":"number","format":"double"}}}}}} ``` ## The DatasetField object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"DatasetField":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"fieldNm":{"type":"string"},"nullRatio":{"type":"number","format":"double"},"emptyRatio":{"type":"number","format":"double"},"uniqueRatio":{"type":"number","format":"double"},"uniqueCnt":{"type":"number","format":"double"},"typeRatio":{"type":"number","format":"double"},"meanAbs":{"type":"string"},"minAbs":{"type":"string"},"maxAbs":{"type":"string"},"updtTs":{"type":"string","format":"date-time"},"passFail":{"type":"integer","format":"int32"},"minAbsNum":{"type":"number","format":"double"},"maxAbsNum":{"type":"number","format":"double"},"meanAbsNum":{"type":"number","format":"double"},"actualDataType":{"type":"string"},"filledRatio":{"type":"number","format":"double"},"minPrecision":{"type":"integer","format":"int32"},"maxPrecision":{"type":"integer","format":"int32"},"minScale":{"type":"integer","format":"int32"},"maxScale":{"type":"integer","format":"int32"},"maxLength":{"type":"integer","format":"int32"},"minLength":{"type":"integer","format":"int32"}}}}}} ``` ## The DatasetProfile object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"DatasetProfile":{"type":"object","properties":{"dataset":{"type":"string"},"colName":{"type":"string"},"dtcnt":{"type":"object"},"ncnt":{"type":"object"},"ecnt":{"type":"object"},"cardinality":{"type":"integer","format":"int32"},"unique":{"type":"number","format":"double"},"colSchema":{"type":"string"},"colTyp":{"type":"string"},"min":{"type":"string"},"max":{"type":"string"},"mean":{"type":"string"},"semantic":{"type":"string"},"runId":{"type":"string","format":"date-time"}}}}}} ``` ## The DatasetSchema object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"DatasetSchema":{"type":"object","properties":{"dataset":{"type":"string"},"colNm":{"type":"string"},"colSchema":{"type":"string"},"colTyps":{"type":"string"},"isKey":{"type":"integer","format":"int32"},"colSemantic":{"type":"string"},"doShape":{"type":"integer","format":"int32"},"isPii":{"type":"integer","format":"int32"},"isMnpi":{"type":"integer","format":"int32"},"isMasked":{"type":"integer","format":"int32"},"busTerm":{"type":"string"},"busDesc":{"type":"string"},"kpi":{"type":"integer","format":"int32"},"sensitiveLabelId":{"type":"integer","format":"int32"},"sensitiveLabelName":{"type":"string"},"version":{"type":"integer","format":"int32"},"updatedAt":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"}}}}}} ``` ## The ProfileShiftDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"ProfileShiftDTO":{"type":"object","properties":{"aggProfile":{"$ref":"#/components/schemas/DatasetProfile"},"runProfile":{"$ref":"#/components/schemas/DatasetProfile"},"baseline":{"$ref":"#/components/schemas/ColumnBaseline"},"datasetField":{"$ref":"#/components/schemas/DatasetField"},"historicalSchema":{"$ref":"#/components/schemas/DatasetSchema"},"currentSchema":{"$ref":"#/components/schemas/DatasetSchema"},"dataset":{"type":"string"},"colName":{"type":"string"},"colSchema":{"type":"string"},"colTypes":{"type":"string"},"dtcntDelta":{"type":"number","format":"double"},"ncntDelta":{"type":"number","format":"double"},"ecntDelta":{"type":"number","format":"double"},"uniqueDelta":{"type":"number","format":"double"},"uniqueDeltaPercent":{"type":"number","format":"double"},"validValuesRule":{"type":"string"},"changePercent":{"type":"number","format":"double"},"changePercentWithUniques":{"type":"number","format":"double"}}},"DatasetProfile":{"type":"object","properties":{"dataset":{"type":"string"},"colName":{"type":"string"},"dtcnt":{"type":"object"},"ncnt":{"type":"object"},"ecnt":{"type":"object"},"cardinality":{"type":"integer","format":"int32"},"unique":{"type":"number","format":"double"},"colSchema":{"type":"string"},"colTyp":{"type":"string"},"min":{"type":"string"},"max":{"type":"string"},"mean":{"type":"string"},"semantic":{"type":"string"},"runId":{"type":"string","format":"date-time"}}},"ColumnBaseline":{"type":"object","properties":{"field_nm":{"type":"string"},"avg_nulls":{"type":"number","format":"double"},"std_nulls":{"type":"number","format":"double"},"avg_empties":{"type":"number","format":"double"},"std_empties":{"type":"number","format":"double"},"avg_uniques":{"type":"number","format":"double"},"std_uniques":{"type":"number","format":"double"},"avg_unique_cnt":{"type":"number","format":"double"},"std_unique_cnt":{"type":"number","format":"double"},"median_unique_cnt":{"type":"number","format":"double"},"median_unique_ratio":{"type":"number","format":"double"},"avg_types":{"type":"number","format":"double"},"std_type":{"type":"number","format":"double"},"avg_min_abs_num":{"type":"number","format":"double"},"std_min_abs_num":{"type":"number","format":"double"},"min_min_abs_num":{"type":"number","format":"double"},"avg_max_abs_num":{"type":"number","format":"double"},"std_max_abs_num":{"type":"number","format":"double"},"min_max_abs_num":{"type":"number","format":"double"},"avg_mean_abs_num":{"type":"number","format":"double"},"std_mean_abs_num":{"type":"number","format":"double"},"avg_filled_ratio":{"type":"number","format":"double"},"avg_mean":{"type":"number","format":"double"},"std_mean":{"type":"number","format":"double"},"avg_min":{"type":"number","format":"double"},"std_min":{"type":"number","format":"double"},"avg_max":{"type":"number","format":"double"},"std_max":{"type":"number","format":"double"},"max_max":{"type":"number","format":"double"},"min_min":{"type":"number","format":"double"}}},"DatasetField":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"fieldNm":{"type":"string"},"nullRatio":{"type":"number","format":"double"},"emptyRatio":{"type":"number","format":"double"},"uniqueRatio":{"type":"number","format":"double"},"uniqueCnt":{"type":"number","format":"double"},"typeRatio":{"type":"number","format":"double"},"meanAbs":{"type":"string"},"minAbs":{"type":"string"},"maxAbs":{"type":"string"},"updtTs":{"type":"string","format":"date-time"},"passFail":{"type":"integer","format":"int32"},"minAbsNum":{"type":"number","format":"double"},"maxAbsNum":{"type":"number","format":"double"},"meanAbsNum":{"type":"number","format":"double"},"actualDataType":{"type":"string"},"filledRatio":{"type":"number","format":"double"},"minPrecision":{"type":"integer","format":"int32"},"maxPrecision":{"type":"integer","format":"int32"},"minScale":{"type":"integer","format":"int32"},"maxScale":{"type":"integer","format":"int32"},"maxLength":{"type":"integer","format":"int32"},"minLength":{"type":"integer","format":"int32"}}},"DatasetSchema":{"type":"object","properties":{"dataset":{"type":"string"},"colNm":{"type":"string"},"colSchema":{"type":"string"},"colTyps":{"type":"string"},"isKey":{"type":"integer","format":"int32"},"colSemantic":{"type":"string"},"doShape":{"type":"integer","format":"int32"},"isPii":{"type":"integer","format":"int32"},"isMnpi":{"type":"integer","format":"int32"},"isMasked":{"type":"integer","format":"int32"},"busTerm":{"type":"string"},"busDesc":{"type":"string"},"kpi":{"type":"integer","format":"int32"},"sensitiveLabelId":{"type":"integer","format":"int32"},"sensitiveLabelName":{"type":"string"},"version":{"type":"integer","format":"int32"},"updatedAt":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"}}}}}} ``` ## The JobLogDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"JobLogDTO":{"type":"object","properties":{"logId":{"type":"integer","format":"int64"},"jobId":{"$ref":"#/components/schemas/IdentifierDTO"},"activity":{"type":"string"},"stage":{"type":"string"},"logDesc":{"type":"string"},"logHint":{"type":"string"},"stagePerfTier":{"type":"string"},"stagePerfDesc":{"type":"string"},"stageTime":{"type":"integer","format":"int64"},"prettyStageTime":{"type":"string"}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` ## The AlertOutputDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"AlertOutputDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"alertNm":{"type":"string"},"alertCond":{"type":"string"},"alertFormat":{"type":"string"},"alertFormatValue":{"type":"string"},"alertMsg":{"type":"string"},"alertOutputId":{"type":"integer","format":"int32"},"updtTs":{"type":"string","format":"date-time"},"alertTypes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["CONDITION","JOB_FAILURE","JOB_COMPLETE","BREAKING","EXCEPTION","PASSING"]}}}}}}} ``` ## The DatashapeDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"DatashapeDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"colName":{"type":"string"},"colFormat":{"type":"string"},"colFormatCnt":{"type":"integer","format":"int32"},"owlRank":{"type":"integer","format":"int32"},"linkId":{"type":"string"},"assignmentId":{"$ref":"#/components/schemas/IdentifierDTO"},"percent":{"type":"number","format":"double"},"rowCountTotal":{"type":"integer","format":"int64"},"definedSchema":{"type":"string"},"shapePerColumn":{"type":"number","format":"double"}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` ## The JobFindingsDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"JobFindingsDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string"},"runDate":{"type":"string","format":"date-time"},"rows":{"type":"integer","format":"int64"},"passFail":{"type":"integer","format":"int32"},"passFailLimit":{"type":"integer","format":"int32"},"peak":{"type":"integer","format":"int32"},"dayOfWeek":{"type":"string"},"timeZone":{"type":"string"},"avgRows":{"type":"integer","format":"int32"},"cols":{"type":"integer","format":"int32"},"activeRules":{"type":"integer","format":"int32"},"activeAlerts":{"type":"integer","format":"int32"},"runTime":{"type":"string"},"dqItems":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MetricDTO"}},"datashapes":{"type":"array","items":{"$ref":"#/components/schemas/DatashapeDTO"}},"observations":{"type":"array","items":{"$ref":"#/components/schemas/ObservationDTO"}},"outliers":{"type":"array","items":{"$ref":"#/components/schemas/OutlierDTO"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/ValidateSourceDTO"}},"patterns":{"type":"array","items":{"$ref":"#/components/schemas/ObservationDTO"}},"rules":{"type":"array","items":{"$ref":"#/components/schemas/RuleOutputDTO"}},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AlertOutputDTO"}},"dupes":{"type":"array","items":{"$ref":"#/components/schemas/ObservationDTO"}},"shapeScore":{"type":"integer","format":"int32"},"dupeScore":{"type":"integer","format":"int32"},"patternScore":{"type":"integer","format":"int32"},"outlierScore":{"type":"integer","format":"int32"},"schemaScore":{"type":"integer","format":"int32"},"recordScore":{"type":"integer","format":"int32"},"ruleScore":{"type":"integer","format":"int32"},"sourceScore":{"type":"integer","format":"int32"},"behaviorScore":{"type":"integer","format":"int32"}}},"MetricDTO":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"stndDev":{"type":"number","format":"double"},"zscore":{"type":"number","format":"double"},"mean":{"type":"number","format":"double"},"value":{"type":"number","format":"double"},"score":{"type":"integer","format":"int32"},"perChange":{"type":"number","format":"double"},"verbose":{"type":"string"},"type":{"type":"string"},"linkId":{"type":"string"},"dqType":{"type":"string"},"lbAbs":{"type":"number","format":"double"},"ubAbs":{"type":"number","format":"double"},"lbZscore":{"type":"number","format":"double"},"ubZscore":{"type":"number","format":"double"},"chartType":{"type":"string"},"chartHistory":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"chartHistoryRange":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"chartHistoryPassFail":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"chartHistoryPassFailString":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"chartHistoryMean":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"passFail":{"type":"integer","format":"int32"},"isManual":{"type":"boolean"},"isRootCause":{"type":"boolean"},"status":{"type":"string"},"adaptiveTier":{"type":"string"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"neverNegative":{"type":"boolean"},"manual":{"type":"boolean"},"rootCause":{"type":"boolean"}}},"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}},"DatashapeDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"colName":{"type":"string"},"colFormat":{"type":"string"},"colFormatCnt":{"type":"integer","format":"int32"},"owlRank":{"type":"integer","format":"int32"},"linkId":{"type":"string"},"assignmentId":{"$ref":"#/components/schemas/IdentifierDTO"},"percent":{"type":"number","format":"double"},"rowCountTotal":{"type":"integer","format":"int64"},"definedSchema":{"type":"string"},"shapePerColumn":{"type":"number","format":"double"}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}},"ObservationDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"obsType":{"type":"string"},"obs":{"type":"string"},"obsKey":{"type":"string"},"obsScore":{"type":"integer","format":"int32"},"owlRank":{"type":"integer","format":"int32"},"linkId":{"type":"string"},"obsId":{"type":"integer","format":"int64"},"assignmentId":{"$ref":"#/components/schemas/IdentifierDTO"},"obsSubType":{"type":"string"}}},"OutlierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"outKeyColumn":{"type":"string"},"outKey":{"type":"string"},"outColumn":{"type":"string"},"outValue":{"type":"string"},"obsSubType":{"type":"string"},"outMedian":{"type":"string"},"outCount":{"type":"integer","format":"int32"},"keyArr":{"type":"array","items":{"type":"string"}},"lb":{"type":"number","format":"double"},"ub":{"type":"number","format":"double"},"confidence":{"type":"integer","format":"int32"},"owlRank":{"type":"integer","format":"int32"},"linkId":{"type":"string"},"linkIdArr":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"assignmentId":{"$ref":"#/components/schemas/IdentifierDTO"}}},"ValidateSourceDTO":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/IdentifierDTO"},"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"obsSubType":{"type":"string"},"obsCount":{"type":"integer","format":"int32"},"counts":{"type":"array","items":{"$ref":"#/components/schemas/ValidateSourceCount"}},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/ValidateSourceSchema"}},"values":{"type":"array","items":{"$ref":"#/components/schemas/ValidateSourceValue"}}}},"ValidateSourceCount":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Identifier"},"validateSourceId":{"$ref":"#/components/schemas/Identifier"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"obsSubType":{"type":"string"},"targetCount":{"type":"integer","format":"int64"},"sourceCount":{"type":"integer","format":"int64"},"confidence":{"type":"integer","format":"int32"}}},"ValidateSourceSchema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Identifier"},"validateSourceId":{"$ref":"#/components/schemas/Identifier"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"obsSubType":{"type":"string"},"targetColNm":{"type":"string"},"targetColType":{"type":"string"},"sourceColNm":{"type":"string"},"sourceColType":{"type":"string"},"confidence":{"type":"integer","format":"int32"}}},"ValidateSourceValue":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Identifier"},"validateSourceId":{"$ref":"#/components/schemas/Identifier"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"obsSubType":{"type":"string"},"keyColNm":{"type":"string"},"keyColArr":{"type":"array","items":{"type":"string"}},"keyColValue":{"type":"string"},"keyColValueArr":{"type":"array","items":{"type":"string"}},"targetColNm":{"type":"string"},"sourceColNm":{"type":"string"},"targetColValue":{"type":"string"},"sourceColValue":{"type":"string"},"targetSourceValue":{"type":"string"},"targetLinkId":{"type":"string"},"sourceLinkId":{"type":"string"},"confidence":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"targetLinkIdArr":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"sourceLinkIdArr":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"RuleOutputDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"ruleNm":{"type":"string"},"ruleType":{"type":"string"},"ruleValue":{"type":"string"},"score":{"type":"integer","format":"int32"},"perc":{"type":"number","format":"double"},"exception":{"type":"string"},"owlId":{"type":"string"},"breakMsg":{"type":"string"},"assignmentId":{"$ref":"#/components/schemas/IdentifierDTO"},"dimId":{"type":"integer","format":"int32"},"dimName":{"type":"string"}}},"AlertOutputDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"alertNm":{"type":"string"},"alertCond":{"type":"string"},"alertFormat":{"type":"string"},"alertFormatValue":{"type":"string"},"alertMsg":{"type":"string"},"alertOutputId":{"type":"integer","format":"int32"},"updtTs":{"type":"string","format":"date-time"},"alertTypes":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["CONDITION","JOB_FAILURE","JOB_COMPLETE","BREAKING","EXCEPTION","PASSING"]}}}}}}} ``` ## The MetricDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"MetricDTO":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"stndDev":{"type":"number","format":"double"},"zscore":{"type":"number","format":"double"},"mean":{"type":"number","format":"double"},"value":{"type":"number","format":"double"},"score":{"type":"integer","format":"int32"},"perChange":{"type":"number","format":"double"},"verbose":{"type":"string"},"type":{"type":"string"},"linkId":{"type":"string"},"dqType":{"type":"string"},"lbAbs":{"type":"number","format":"double"},"ubAbs":{"type":"number","format":"double"},"lbZscore":{"type":"number","format":"double"},"ubZscore":{"type":"number","format":"double"},"chartType":{"type":"string"},"chartHistory":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"chartHistoryRange":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"chartHistoryPassFail":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"chartHistoryPassFailString":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"chartHistoryMean":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"passFail":{"type":"integer","format":"int32"},"isManual":{"type":"boolean"},"isRootCause":{"type":"boolean"},"status":{"type":"string"},"adaptiveTier":{"type":"string"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"neverNegative":{"type":"boolean"},"manual":{"type":"boolean"},"rootCause":{"type":"boolean"}}},"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` ## The ObservationDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"ObservationDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"obsType":{"type":"string"},"obs":{"type":"string"},"obsKey":{"type":"string"},"obsScore":{"type":"integer","format":"int32"},"owlRank":{"type":"integer","format":"int32"},"linkId":{"type":"string"},"obsId":{"type":"integer","format":"int64"},"assignmentId":{"$ref":"#/components/schemas/IdentifierDTO"},"obsSubType":{"type":"string"}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` ## The OutlierDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"OutlierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"outKeyColumn":{"type":"string"},"outKey":{"type":"string"},"outColumn":{"type":"string"},"outValue":{"type":"string"},"obsSubType":{"type":"string"},"outMedian":{"type":"string"},"outCount":{"type":"integer","format":"int32"},"keyArr":{"type":"array","items":{"type":"string"}},"lb":{"type":"number","format":"double"},"ub":{"type":"number","format":"double"},"confidence":{"type":"integer","format":"int32"},"owlRank":{"type":"integer","format":"int32"},"linkId":{"type":"string"},"linkIdArr":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"assignmentId":{"$ref":"#/components/schemas/IdentifierDTO"}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` ## The RuleOutputDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"RuleOutputDTO":{"type":"object","properties":{"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"ruleNm":{"type":"string"},"ruleType":{"type":"string"},"ruleValue":{"type":"string"},"score":{"type":"integer","format":"int32"},"perc":{"type":"number","format":"double"},"exception":{"type":"string"},"owlId":{"type":"string"},"breakMsg":{"type":"string"},"assignmentId":{"$ref":"#/components/schemas/IdentifierDTO"},"dimId":{"type":"integer","format":"int32"},"dimName":{"type":"string"}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` ## The ValidateSourceCount object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"ValidateSourceCount":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Identifier"},"validateSourceId":{"$ref":"#/components/schemas/Identifier"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"obsSubType":{"type":"string"},"targetCount":{"type":"integer","format":"int64"},"sourceCount":{"type":"integer","format":"int64"},"confidence":{"type":"integer","format":"int32"}}},"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` ## The ValidateSourceDTO object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"ValidateSourceDTO":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/IdentifierDTO"},"dataset":{"type":"string"},"runId":{"type":"string","format":"date-time"},"obsSubType":{"type":"string"},"obsCount":{"type":"integer","format":"int32"},"counts":{"type":"array","items":{"$ref":"#/components/schemas/ValidateSourceCount"}},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/ValidateSourceSchema"}},"values":{"type":"array","items":{"$ref":"#/components/schemas/ValidateSourceValue"}}}},"IdentifierDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}},"ValidateSourceCount":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Identifier"},"validateSourceId":{"$ref":"#/components/schemas/Identifier"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"obsSubType":{"type":"string"},"targetCount":{"type":"integer","format":"int64"},"sourceCount":{"type":"integer","format":"int64"},"confidence":{"type":"integer","format":"int32"}}},"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}},"ValidateSourceSchema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Identifier"},"validateSourceId":{"$ref":"#/components/schemas/Identifier"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"obsSubType":{"type":"string"},"targetColNm":{"type":"string"},"targetColType":{"type":"string"},"sourceColNm":{"type":"string"},"sourceColType":{"type":"string"},"confidence":{"type":"integer","format":"int32"}}},"ValidateSourceValue":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Identifier"},"validateSourceId":{"$ref":"#/components/schemas/Identifier"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"obsSubType":{"type":"string"},"keyColNm":{"type":"string"},"keyColArr":{"type":"array","items":{"type":"string"}},"keyColValue":{"type":"string"},"keyColValueArr":{"type":"array","items":{"type":"string"}},"targetColNm":{"type":"string"},"sourceColNm":{"type":"string"},"targetColValue":{"type":"string"},"sourceColValue":{"type":"string"},"targetSourceValue":{"type":"string"},"targetLinkId":{"type":"string"},"sourceLinkId":{"type":"string"},"confidence":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"targetLinkIdArr":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"sourceLinkIdArr":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}}}}} ``` ## The ValidateSourceSchema object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"ValidateSourceSchema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Identifier"},"validateSourceId":{"$ref":"#/components/schemas/Identifier"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"obsSubType":{"type":"string"},"targetColNm":{"type":"string"},"targetColType":{"type":"string"},"sourceColNm":{"type":"string"},"sourceColType":{"type":"string"},"confidence":{"type":"integer","format":"int32"}}},"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` ## The ValidateSourceValue object ```json {"openapi":"3.0.1","info":{"title":"Collibra DQ Product API","version":"v3"},"components":{"schemas":{"ValidateSourceValue":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Identifier"},"validateSourceId":{"$ref":"#/components/schemas/Identifier"},"assignmentId":{"$ref":"#/components/schemas/Identifier"},"obsSubType":{"type":"string"},"keyColNm":{"type":"string"},"keyColArr":{"type":"array","items":{"type":"string"}},"keyColValue":{"type":"string"},"keyColValueArr":{"type":"array","items":{"type":"string"}},"targetColNm":{"type":"string"},"sourceColNm":{"type":"string"},"targetColValue":{"type":"string"},"sourceColValue":{"type":"string"},"targetSourceValue":{"type":"string"},"targetLinkId":{"type":"string"},"sourceLinkId":{"type":"string"},"confidence":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"targetLinkIdArr":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"sourceLinkIdArr":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"Identifier":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"}}}}}} ``` --- # 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/models.md?ask= ``` 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.