{"openapi":"3.1.0","info":{"title":"Catalog Server API","version":"1.0","description":"Complete API reference for the Acceldata Catalog Server. Covers crawlers, rules, custom assets, persistence configs, UDF templates, and UDT packages."},"paths":{"/catalog-server/api/crawlers/status":{"get":{"operationId":"listCrawlerStatus","tags":["Crawler Status"],"summary":"List crawler status","description":"Returns the current status of all crawlers, optionally filtered\nby integration ID. Includes execution schedule information by default.","parameters":[{"name":"integrationID","in":"query","description":"Filter by integration ID","schema":{"type":"string"}},{"name":"withExecutionSchedule","in":"query","description":"Include execution schedule details (default true)","schema":{"type":"string"}}],"responses":{"200":{"description":"List of crawler statuses wrapped in StandardResponse","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/crawlers/tracker":{"put":{"operationId":"updateCrawlerTracker","tags":["Crawler Tracking"],"summary":"Update crawler tracker","description":"Updates the tracking information for a crawler instance.","requestBody":{"description":"Tracker update payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTrackerRequest"}}}},"responses":{"204":{"description":"Tracker updated successfully"}}}},"/catalog-server/api/crawlers/heartbeat":{"put":{"operationId":"updateCrawlerHeartbeat","tags":["Crawler Tracking"],"summary":"Update crawler heartbeat","description":"Records a heartbeat signal from a running crawler instance.","requestBody":{"description":"Heartbeat update payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHeartbeatRequest"}}}},"responses":{"204":{"description":"Heartbeat recorded successfully"}}}},"/catalog-server/api/crawlers/progress":{"put":{"operationId":"updateCrawlerProgress","tags":["Crawler Tracking"],"summary":"Update crawler execution progress","description":"Reports progress from a running crawler execution.","requestBody":{"description":"Progress update payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProgressRequest"}}}},"responses":{"204":{"description":"Progress recorded successfully"}}}},"/catalog-server/api/crawlers/job/submit":{"post":{"operationId":"submitCrawlerJob","tags":["Crawler Jobs"],"summary":"Submit an async crawler job","description":"Creates and submits an asynchronous crawler job to the dataplane.","requestBody":{"description":"Async crawler job specification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncCrawlerRequest"}}}},"responses":{"200":{"description":"Dataplane job submission response"}}}},"/catalog-server/api/crawlers/job/status/{requestId}":{"get":{"operationId":"getCrawlerJobStatus","tags":["Crawler Jobs"],"summary":"Get crawler job status","description":"Returns the current status of an async crawler job by request ID.","parameters":[{"name":"requestId","in":"path","description":"Job request ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Job status (jobSpec and request fields are excluded)"}}}},"/catalog-server/api/crawler/{id}":{"post":{"operationId":"startCrawlerByDatasource","tags":["Crawler Operations"],"summary":"Start a crawler by datasource name","description":"Starts a crawler for the given datasource (assembly) name.\nOptionally accepts a list of asset UIDs for selective crawling.\nRequires DATASOURCE_VIEW permission.","parameters":[{"name":"id","in":"path","description":"Datasource (assembly) name","required":true,"schema":{"type":"string"}},{"name":"assets","in":"query","description":"Comma-separated asset UIDs for selective crawling","schema":{"type":"string"}}],"requestBody":{"description":"Optional selective crawling request with specific asset list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectiveCrawlerRequest"}}}},"responses":{"200":{"description":"Crawler start response wrapped in StandardResponse","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}},"delete":{"operationId":"removeCrawler","tags":["Crawler Operations"],"summary":"Remove a crawler","description":"Removes the crawler for the given assembly ID.\nRequires DATASOURCE_VIEW permission.","parameters":[{"name":"id","in":"path","description":"Assembly ID of the crawler to remove","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Removal response wrapped in StandardResponse","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}},"get":{"operationId":"getCrawlerStatus","tags":["Crawler Status"],"summary":"Get crawler status by datasource","description":"Returns the current status of a crawler by its assembly ID.\nRequires DATASOURCE_VIEW permission.","parameters":[{"name":"id","in":"path","description":"Assembly ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Crawler status wrapped in StandardResponse","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/crawler/{id}/restart":{"post":{"operationId":"restartCrawler","tags":["Crawler Operations"],"summary":"Restart a crawler","description":"Restarts the crawler for the given assembly ID.\nRequires DATASOURCE_VIEW permission.","parameters":[{"name":"id","in":"path","description":"Assembly ID of the crawler to restart","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Restart response wrapped in StandardResponse","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/crawler/listing":{"get":{"operationId":"listCrawlerExecutions","tags":["Crawler Status"],"summary":"List crawler executions with pagination","description":"Returns a paginated list of crawler executions.\nSupports filtering and sorting based on CrawlerExecutionTable columns.\nWhen fetchLatest=true, returns only the most recent execution per crawler.\nRequires DATASOURCE_VIEW permission.","parameters":[{"name":"fetchLatest","in":"query","description":"Return only the latest execution per crawler (default false)","schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"string"}},{"name":"size","in":"query","description":"Number of items per page (default 25)","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort field and direction (e.g., startTime:desc)","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated list of crawler executions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrawlerExecutionResponse"}}}}}}},"/catalog-server/api/crawler/{integration}/start":{"post":{"operationId":"startCrawlerByIntegration","tags":["Crawler Operations"],"summary":"Start a crawler by integration ID","description":"Starts a crawler using the integration ID.\nOptionally accepts a list of asset UIDs for selective crawling.\nRequires DATASOURCE_VIEW permission.","parameters":[{"name":"integration","in":"path","description":"Integration identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Optional selective crawling request with specific asset list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectiveCrawlerRequest"}}}},"responses":{"200":{"description":"Crawler start response wrapped in StandardResponse","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}},"400":{"description":"Integration ID is empty"}}}},"/catalog-server/api/crawler/{assemblyId}/selective/details":{"get":{"operationId":"getSelectiveCrawlerDetails","tags":["Crawler Status"],"summary":"Get selective crawler details","description":"Returns details about selective crawling configuration for a given assembly.\nRequires DATASOURCE_VIEW permission.","parameters":[{"name":"assemblyId","in":"path","description":"Assembly ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Selective crawler details wrapped in StandardResponse","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/custom-assets/sql-view":{"post":{"operationId":"createSqlView","tags":["Custom Assets"],"summary":"Create a SQL view custom asset","description":"Creates a new SQL view-based custom asset. The request body contains\nthe SQL definition, target assembly, and metadata for the custom asset.","requestBody":{"description":"SQL view definition and metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSqlViewRequest"}}}},"responses":{"200":{"description":"Created custom asset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAssetResponse"}}}}}}},"/catalog-server/api/custom-assets/sql-view/{id}":{"put":{"operationId":"updateSqlView","tags":["Custom Assets"],"summary":"Update a SQL view custom asset","description":"Updates an existing SQL view custom asset definition.","parameters":[{"name":"id","in":"path","description":"Custom asset ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated SQL view definition and metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSqlViewRequest"}}}},"responses":{"200":{"description":"Updated custom asset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAssetResponse"}}}}}},"delete":{"operationId":"deleteSqlView","tags":["Custom Assets"],"summary":"Delete a SQL view custom asset","description":"Deletes a SQL view custom asset by its ID.","parameters":[{"name":"id","in":"path","description":"Custom asset ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"SQL view deleted successfully"}}},"get":{"operationId":"getSqlView","tags":["Custom Assets"],"summary":"Get a SQL view custom asset","description":"Returns the SQL view custom asset definition by its ID.","parameters":[{"name":"id","in":"path","description":"Custom asset ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SQL view custom asset details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomAssetResponse"}}}},"404":{"description":"Custom asset not found"}}}},"/catalog-server/api/persistence/configs":{"post":{"operationId":"createPersistenceConfig","tags":["Persistence Configs"],"summary":"Create a persistence configuration","description":"Creates a new persistence storage configuration. Defines the target storage\nlocation, format, and partitioning strategy for analytics outputs.","requestBody":{"description":"Persistence configuration definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistenceStorageConfig"}}}},"responses":{"201":{"description":"Persistence configuration created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistenceStorageConfig"}}}}}},"get":{"operationId":"listPersistenceConfigs","tags":["Persistence Configs"],"summary":"List all persistence configurations","description":"Returns all persistence storage configurations. These configs define where\nand how rule execution results, profiling data, and other analytics outputs\nare persisted.","responses":{"200":{"description":"List of persistence configurations","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersistenceStorageConfig"}}}}}}}},"/catalog-server/api/persistence/configs/default":{"get":{"operationId":"getDefaultPersistenceConfig","tags":["Persistence Configs"],"summary":"Get the default persistence configuration","description":"Returns the persistence configuration marked as the default.","responses":{"200":{"description":"Default persistence configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistenceStorageConfig"}}}}}}},"/catalog-server/api/persistence/configs/{id}":{"put":{"operationId":"updatePersistenceConfig","tags":["Persistence Configs"],"summary":"Update a persistence configuration","description":"Updates an existing persistence storage configuration.","parameters":[{"name":"id","in":"path","description":"Persistence config ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated persistence configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistenceStorageConfig"}}}},"responses":{"200":{"description":"Updated persistence configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistenceStorageConfig"}}}}}},"delete":{"operationId":"deletePersistenceConfig","tags":["Persistence Configs"],"summary":"Delete a persistence configuration","description":"Deletes a persistence configuration. Fails if any policies still reference it.\nUse the referencing-policies endpoint to check before deletion.","parameters":[{"name":"id","in":"path","description":"Persistence config ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Configuration deleted successfully"},"409":{"description":"Config is still in use by policies"}}},"get":{"operationId":"getPersistenceConfigById","tags":["Persistence Configs"],"summary":"Get a persistence configuration by ID","description":"Returns a specific persistence configuration identified by its ID.","parameters":[{"name":"id","in":"path","description":"Persistence config ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Persistence configuration details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistenceStorageConfig"}}}},"404":{"description":"Configuration not found"}}}},"/catalog-server/api/persistence/configs/{id}/referencing-policies":{"get":{"operationId":"getReferencingPolicies","tags":["Persistence Configs"],"summary":"Get policies referencing a persistence config","description":"Returns all policies that reference the specified persistence configuration.\nUseful for impact analysis before modifying or deleting a config.","parameters":[{"name":"id","in":"path","description":"Persistence config ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of policies referencing this config"}}}},"/catalog-server/api/persistence/configs/{id}/set-default":{"post":{"operationId":"setDefaultPersistenceConfig","tags":["Persistence Configs"],"summary":"Set a persistence configuration as default","description":"Marks the specified persistence configuration as the default for new policies.","parameters":[{"name":"id","in":"path","description":"Persistence config ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Config set as default"}}}},"/catalog-server/api/persistence/configs/variables":{"get":{"operationId":"getPersistenceConfigVariables","tags":["Persistence Configs"],"summary":"Get available template variables","description":"Returns the list of template variables that can be used in persistence\nconfiguration paths (e.g., {{tenant}}, {{assembly}}, {{date}}).","responses":{"200":{"description":"List of available template variables"}}}},"/catalog-server/api/persistence/configs/preview/{recordCategory}":{"post":{"operationId":"previewPersistenceConfig","tags":["Persistence Configs"],"summary":"Preview a persistence configuration path","description":"Previews the resolved storage path for a given record category using the\nprovided configuration. Useful for validating path templates before saving.","parameters":[{"name":"recordCategory","in":"path","description":"Record category to preview (e.g., profiling, data-quality)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Persistence config with path template to preview","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistenceStorageConfig"}}}},"responses":{"200":{"description":"Resolved path preview"}}}},"/catalog-server/api/persistence/configs/validate":{"post":{"operationId":"validatePersistenceConfig","tags":["Persistence Configs"],"summary":"Validate a persistence configuration","description":"Validates a persistence configuration by checking connectivity to the\ntarget storage location and verifying write permissions.","requestBody":{"description":"Persistence config to validate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersistenceStorageConfig"}}}},"responses":{"200":{"description":"Validation result"}}}},"/catalog-server/api/rules":{"get":{"operationId":"listRulesWithLatestExecution","tags":["Rules"],"summary":"List all rules with latest execution","description":"Returns a paginated list of all rules along with their latest execution status.\nSupports filtering by asset IDs, assembly IDs, rule status, and tags.","parameters":[{"name":"assetIds","in":"query","description":"Comma-separated asset IDs to filter by","schema":{"type":"string"}},{"name":"assemblyIds","in":"query","description":"Comma-separated assembly IDs to filter by","schema":{"type":"string"}},{"name":"ruleStatus","in":"query","description":"Filter by rule status","schema":{"type":"string"}},{"name":"tag","in":"query","description":"Comma-separated tag IDs to filter by","schema":{"type":"string"}},{"name":"withLatestExecution","in":"query","description":"Include latest execution info (default true)","schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"string"}},{"name":"size","in":"query","description":"Number of items per page","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort field and direction","schema":{"type":"string"}}],"responses":{"200":{"description":"Rules with latest execution details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualityRule"}}}}}}},"/catalog-server/api/rules/{identifier}":{"get":{"operationId":"getRuleByIdentifier","tags":["Rules"],"summary":"Get a rule by ID or name","description":"Returns details of a specific rule identified by its numeric ID or name.","parameters":[{"name":"identifier","in":"path","description":"Rule ID (numeric) or rule name (string)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Rule details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualityRule"}}}},"404":{"description":"Rule not found"}}}},"/catalog-server/api/rules/{id}/enable":{"put":{"operationId":"enableOrDisableRule","tags":["Rules"],"summary":"Enable or disable a rule","description":"Enables or disables a rule by its ID. The request body specifies whether\nthe rule should be enabled or disabled.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Enable/disable flag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableRuleRequest"}}}},"responses":{"200":{"description":"Updated rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleResponse"}}}}}}},"/catalog-server/api/rules/{id}/tags":{"post":{"operationId":"addRuleTags","tags":["Rule Tags"],"summary":"Add tags to a rule","description":"Associates one or more tags with the specified rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tags to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleTagRequest"}}}},"responses":{"200":{"description":"Updated rule tags"}}}},"/catalog-server/api/rules/{id}/tags/{tagId}":{"delete":{"operationId":"deleteRuleTag","tags":["Rule Tags"],"summary":"Remove a tag from a rule","description":"Removes the specified tag from a rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","description":"Tag ID to remove","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Tag removal result"}}}},"/catalog-server/api/rules/{id}/tag":{"post":{"operationId":"addRuleTag","tags":["Rule Tags"],"summary":"Add a single tag to a rule","description":"Associates a single tag with the specified rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tag to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleTagRequest"}}}},"responses":{"200":{"description":"Updated rule tag"}}}},"/catalog-server/api/rules/{id}/tag/{tagId}":{"delete":{"operationId":"deleteRuleSingleTag","tags":["Rule Tags"],"summary":"Remove a single tag from a rule","description":"Removes the specified tag from a rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","description":"Tag ID to remove","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Tag removal result"}}}},"/catalog-server/api/rules/{id}/configuration":{"get":{"operationId":"getRuleConfiguration","tags":["Rule Configuration"],"summary":"Get rule configuration","description":"Returns the full configuration for the specified rule (policy).","parameters":[{"name":"id","in":"path","description":"Policy/Rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Rule configuration details"}}}},"/catalog-server/api/rules/execution/{id}/cancel":{"put":{"operationId":"cancelRuleExecution","tags":["Rules"],"summary":"Cancel a rule execution","description":"Cancels a running rule execution by its execution ID.","parameters":[{"name":"id","in":"path","description":"Execution ID to cancel","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Cancellation result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionCancellationResponse"}}}}}}},"/catalog-server/api/rules/data-quality/{identifier}":{"get":{"operationId":"getDataQualityRule","tags":["Data Quality Rules"],"summary":"Get a data quality rule","description":"Returns details of a data quality rule by its ID or name, including child rules\nand items. Optionally specify a version or request only the last executed version.","parameters":[{"name":"identifier","in":"path","description":"Rule ID (numeric) or rule name","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"Specific rule version to retrieve","schema":{"type":"string"}},{"name":"onlyExecutedVersion","in":"query","description":"Return only the last executed version (default false)","schema":{"type":"string"}}],"responses":{"200":{"description":"Data quality rule with children","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataQuality.RuleResponse"}}}},"404":{"description":"Data quality rule not found"}}}},"/catalog-server/api/rules/data-quality/{id}/executions":{"post":{"operationId":"triggerDataQualityExecution","tags":["Data Quality Rules"],"summary":"Trigger a data quality rule execution","description":"Starts a new execution for the specified data quality rule.\nThe request body can specify execution type and spark resource config.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Execution request configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyExecutionRequest"}}}},"responses":{"200":{"description":"Execution details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Execution"}}}}}},"get":{"operationId":"listDataQualityExecutions","tags":["Data Quality Rules"],"summary":"List executions for a data quality rule","description":"Returns a paginated list of executions for the specified data quality rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"string"}},{"name":"size","in":"query","description":"Number of items per page","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort field and direction","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated list of executions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionsResponse"}}}}}}},"/catalog-server/api/rules/data-quality/{id}":{"put":{"operationId":"updateDataQualityRule","tags":["Data Quality Rules"],"summary":"Update a data quality rule","description":"Updates an existing data quality rule by ID.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated data quality rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataQuality"}}}},"responses":{"200":{"description":"Updated data quality rule"}}},"delete":{"operationId":"deleteDataQualityRule","tags":["Data Quality Rules"],"summary":"Delete a data quality rule","description":"Deletes (archives) a data quality rule by ID.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Rule deleted successfully"},"404":{"description":"Rule not found"}}}},"/catalog-server/api/rules/data-quality/{id}/unarchive":{"post":{"operationId":"unarchiveDataQualityRule","tags":["Data Quality Rules"],"summary":"Unarchive a data quality rule","description":"Restores a previously archived data quality rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Unarchived rule"}}}},"/catalog-server/api/rules/data-quality/{id}/schedule":{"put":{"operationId":"setDataQualitySchedule","tags":["Data Quality Rules"],"summary":"Set schedule for a data quality rule","description":"Updates the execution schedule for a data quality rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Schedule configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleRequest"}}}},"responses":{"200":{"description":"Updated schedule"}}}},"/catalog-server/api/rules/data-quality/{id}/items":{"get":{"operationId":"getDataQualityItems","tags":["Data Quality Rules"],"summary":"Get data quality rule items","description":"Returns the individual check items configured within a data quality rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of rule items"}}}},"/catalog-server/api/rules/data-quality/executions/{id}":{"get":{"operationId":"getDataQualityExecutionDetail","tags":["Data Quality Rules"],"summary":"Get data quality execution detail","description":"Returns details of a specific data quality rule execution.","parameters":[{"name":"id","in":"path","description":"Execution ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Execution detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Execution"}}}},"404":{"description":"Execution not found"}}}},"/catalog-server/api/rules/data-quality/executions/{id}/result":{"get":{"operationId":"getDataQualityExecutionResult","tags":["Data Quality Rules"],"summary":"Get data quality execution result","description":"Returns the result of a data quality rule execution including measure outcomes.","parameters":[{"name":"id","in":"path","description":"Execution ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Execution result with measure outcomes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionResult"}}}}}}},"/catalog-server/api/rules/data-quality":{"post":{"operationId":"createDataQualityRule","tags":["Data Quality Rules"],"summary":"Create a data quality rule","description":"Creates a new data quality rule with the specified configuration, items, and schedule.","requestBody":{"description":"Data quality rule definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataQuality"}}}},"responses":{"200":{"description":"Created data quality rule"}}},"get":{"operationId":"listDataQualityRules","tags":["Data Quality Rules"],"summary":"List all data quality rules","description":"Returns all data quality rules with optional filtering and pagination.","parameters":[{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"string"}},{"name":"size","in":"query","description":"Number of items per page","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated list of data quality rules"}}}},"/catalog-server/api/rules/data-quality/byName/{name}":{"put":{"operationId":"updateDataQualityByName","tags":["Data Quality Rules"],"summary":"Update a data quality rule by name","description":"Updates an existing data quality rule identified by its name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated data quality rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataQuality"}}}},"responses":{"200":{"description":"Updated data quality rule"}}},"delete":{"operationId":"deleteDataQualityByName","tags":["Data Quality Rules"],"summary":"Delete a data quality rule by name","description":"Deletes (archives) a data quality rule identified by its name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Rule deleted successfully"},"404":{"description":"Rule not found"}}},"get":{"operationId":"getDataQualityByName","tags":["Data Quality Rules"],"summary":"Get a data quality rule by name","description":"Returns a data quality rule identified by its name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data quality rule details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualityRule"}}}}}}},"/catalog-server/api/rules/data-quality/byName/{name}/schedule":{"put":{"operationId":"setDataQualityScheduleByName","tags":["Data Quality Rules"],"summary":"Set schedule for a data quality rule by name","description":"Updates the execution schedule for a data quality rule identified by name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Schedule configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleRequest"}}}},"responses":{"200":{"description":"Updated schedule"}}}},"/catalog-server/api/rules/data-quality/byName/{name}/items":{"get":{"operationId":"getDataQualityItemsByName","tags":["Data Quality Rules"],"summary":"Get data quality rule items by name","description":"Returns the individual check items configured within a data quality rule identified by name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of rule items"}}}},"/catalog-server/api/rules/data-quality/byName/{name}/unarchive":{"post":{"operationId":"unarchiveDataQualityByName","tags":["Data Quality Rules"],"summary":"Unarchive a data quality rule by name","description":"Restores a previously archived data quality rule identified by its name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Unarchived rule"}}}},"/catalog-server/api/rules/data-quality/byName/{name}/executions":{"post":{"operationId":"triggerDataQualityExecutionByName","tags":["Data Quality Rules"],"summary":"Trigger execution of a data quality rule by name","description":"Triggers a new execution for the data quality rule identified by name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Execution request configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyExecutionRequest"}}}},"responses":{"200":{"description":"Execution details"}}},"get":{"operationId":"getDataQualityExecutionsByName","tags":["Data Quality Rules"],"summary":"List executions for a data quality rule by name","description":"Returns execution history for the data quality rule identified by name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of executions"}}}},"/catalog-server/api/rules/reconciliation/{identifier}":{"get":{"operationId":"getReconciliationRule","tags":["Reconciliation Rules"],"summary":"Get a reconciliation rule","description":"Returns details of a reconciliation rule by its ID or name.\nOptionally specify a version or request only the last executed version.","parameters":[{"name":"identifier","in":"path","description":"Rule ID (numeric) or rule name","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"Specific rule version to retrieve","schema":{"type":"string"}},{"name":"onlyExecutedVersion","in":"query","description":"Return only the last executed version (default false)","schema":{"type":"string"}}],"responses":{"200":{"description":"Reconciliation rule details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reconciliation.RuleResponse"}}}},"404":{"description":"Reconciliation rule not found"}}}},"/catalog-server/api/rules/reconciliation/{id}/executions":{"post":{"operationId":"triggerReconciliationExecution","tags":["Reconciliation Rules"],"summary":"Trigger a reconciliation rule execution","description":"Starts a new execution for the specified reconciliation rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Execution request configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyExecutionRequest"}}}},"responses":{"200":{"description":"Execution details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reconciliation.Execution"}}}}}},"get":{"operationId":"listReconciliationExecutions","tags":["Reconciliation Rules"],"summary":"List executions for a reconciliation rule","description":"Returns a paginated list of executions for the specified reconciliation rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"string"}},{"name":"size","in":"query","description":"Number of items per page","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort field and direction","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated list of reconciliation executions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reconciliation.ExecutionsResponse"}}}}}}},"/catalog-server/api/rules/reconciliation/{id}":{"put":{"operationId":"updateReconciliationRule","tags":["Reconciliation Rules"],"summary":"Update a reconciliation rule","description":"Updates an existing reconciliation rule by ID.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated reconciliation rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reconciliation"}}}},"responses":{"200":{"description":"Updated reconciliation rule"}}},"delete":{"operationId":"deleteReconciliationRule","tags":["Reconciliation Rules"],"summary":"Delete a reconciliation rule","description":"Deletes (archives) a reconciliation rule by ID.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Rule deleted successfully"},"404":{"description":"Rule not found"}}}},"/catalog-server/api/rules/reconciliation/{id}/unarchive":{"post":{"operationId":"unarchiveReconciliationRule","tags":["Reconciliation Rules"],"summary":"Unarchive a reconciliation rule","description":"Restores a previously archived reconciliation rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Unarchived rule"}}}},"/catalog-server/api/rules/reconciliation/{id}/schedule":{"put":{"operationId":"setReconciliationSchedule","tags":["Reconciliation Rules"],"summary":"Set schedule for a reconciliation rule","description":"Updates the execution schedule for a reconciliation rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Schedule configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleRequest"}}}},"responses":{"200":{"description":"Updated schedule"}}}},"/catalog-server/api/rules/reconciliation/executions/{id}":{"get":{"operationId":"getReconciliationExecutionDetail","tags":["Reconciliation Rules"],"summary":"Get reconciliation execution detail","description":"Returns details of a specific reconciliation rule execution.","parameters":[{"name":"id","in":"path","description":"Execution ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Execution detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reconciliation.Execution"}}}},"404":{"description":"Execution not found"}}}},"/catalog-server/api/rules/reconciliation/executions/{id}/result":{"get":{"operationId":"getReconciliationExecutionResult","tags":["Reconciliation Rules"],"summary":"Get reconciliation execution result","description":"Returns the result of a reconciliation rule execution.","parameters":[{"name":"id","in":"path","description":"Execution ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Execution result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionResult"}}}}}}},"/catalog-server/api/rules/reconciliation":{"post":{"operationId":"createReconciliationRule","tags":["Reconciliation Rules"],"summary":"Create a reconciliation rule","description":"Creates a new reconciliation rule with source/target mappings and configuration.","requestBody":{"description":"Reconciliation rule definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reconciliation"}}}},"responses":{"200":{"description":"Created reconciliation rule"}}},"get":{"operationId":"listReconciliationRules","tags":["Reconciliation Rules"],"summary":"List all reconciliation rules","description":"Returns all reconciliation rules with optional filtering and pagination.","parameters":[{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"string"}},{"name":"size","in":"query","description":"Number of items per page","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated list of reconciliation rules"}}}},"/catalog-server/api/rules/reconciliation/byName/{name}":{"put":{"operationId":"updateReconciliationByName","tags":["Reconciliation Rules"],"summary":"Update a reconciliation rule by name","description":"Updates an existing reconciliation rule identified by its name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated reconciliation rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reconciliation"}}}},"responses":{"200":{"description":"Updated reconciliation rule"}}},"delete":{"operationId":"deleteReconciliationByName","tags":["Reconciliation Rules"],"summary":"Delete a reconciliation rule by name","description":"Deletes (archives) a reconciliation rule identified by its name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Rule deleted successfully"},"404":{"description":"Rule not found"}}},"get":{"operationId":"getReconciliationByName","tags":["Reconciliation Rules"],"summary":"Get a reconciliation rule by name","description":"Returns a reconciliation rule identified by its name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Reconciliation rule details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reconciliation"}}}}}}},"/catalog-server/api/rules/reconciliation/byName/{name}/schedule":{"put":{"operationId":"setReconciliationScheduleByName","tags":["Reconciliation Rules"],"summary":"Set schedule for a reconciliation rule by name","description":"Updates the execution schedule for a reconciliation rule identified by name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Schedule configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleRequest"}}}},"responses":{"200":{"description":"Updated schedule"}}}},"/catalog-server/api/rules/reconciliation/byName/{name}/unarchive":{"post":{"operationId":"unarchiveReconciliationByName","tags":["Reconciliation Rules"],"summary":"Unarchive a reconciliation rule by name","description":"Restores a previously archived reconciliation rule identified by its name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Unarchived rule"}}}},"/catalog-server/api/rules/reconciliation/byName/{name}/executions":{"post":{"operationId":"triggerReconciliationExecutionByName","tags":["Reconciliation Rules"],"summary":"Trigger execution of a reconciliation rule by name","description":"Triggers a new execution for the reconciliation rule identified by name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Execution request configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyExecutionRequest"}}}},"responses":{"200":{"description":"Execution details"}}},"get":{"operationId":"getReconciliationExecutionsByName","tags":["Reconciliation Rules"],"summary":"List executions for a reconciliation rule by name","description":"Returns execution history for the reconciliation rule identified by name.","parameters":[{"name":"name","in":"path","description":"Rule name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of executions"}}}},"/catalog-server/api/rules/data-cadence/{identifier}":{"get":{"operationId":"getDataCadenceRule","tags":["Data Cadence Rules"],"summary":"Get a data cadence rule","description":"Returns details of a data cadence rule by its ID or name.\nOptionally specify a version to retrieve a specific version.","parameters":[{"name":"identifier","in":"path","description":"Rule ID (numeric) or rule name","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"Specific rule version to retrieve","schema":{"type":"string"}}],"responses":{"200":{"description":"Data cadence rule details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataCadenceRule.RuleResponse"}}}},"404":{"description":"Data cadence rule not found"}}}},"/catalog-server/api/rules/data-cadence/{id}/executions":{"post":{"operationId":"triggerDataCadenceExecution","tags":["Data Cadence Rules"],"summary":"Trigger a data cadence rule execution","description":"Starts a new execution for the specified data cadence rule.","parameters":[{"name":"id","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Execution request configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyExecutionRequest"}}}},"responses":{"200":{"description":"Execution details"}}}},"/catalog-server/api/rules/data-cadence/executions/{executionId}/result":{"get":{"operationId":"getDataCadenceExecutionResult","tags":["Data Cadence Rules"],"summary":"Get data cadence execution result","description":"Returns the result of a data cadence rule execution.","parameters":[{"name":"executionId","in":"path","description":"Execution ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Execution result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionResult"}}}}}}},"/catalog-server/api/rules/data-cadence/byAsset/{identifier}":{"get":{"operationId":"getDataCadenceByAsset","tags":["Data Cadence Rules"],"summary":"Get data cadence rules by asset","description":"Returns data cadence rules associated with the specified asset.","parameters":[{"name":"identifier","in":"path","description":"Asset identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data cadence rules for the asset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataCadenceRule"}}}}}}},"/catalog-server/api/rules/profile-anomaly":{"post":{"operationId":"createProfileAnomaly","tags":["Profile Anomaly Rules"],"summary":"Create a profile anomaly rule","description":"Creates a new profile anomaly detection rule for an asset.","requestBody":{"description":"Profile anomaly rule definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleRequest"}}}},"responses":{"200":{"description":"Created profile anomaly rule"}}}},"/catalog-server/api/rules/profile-anomaly/byAsset/{identifier}":{"get":{"operationId":"getProfileAnomalyByAsset","tags":["Profile Anomaly Rules"],"summary":"Get profile anomaly rules by asset","description":"Returns profile anomaly rules associated with the specified asset.","parameters":[{"name":"identifier","in":"path","description":"Asset identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Profile anomaly rules for the asset"}}}},"/catalog-server/api/rules/profile-anomaly/executions/{executionId}/result":{"get":{"operationId":"getProfileAnomalyExecutionResult","tags":["Profile Anomaly Rules"],"summary":"Get profile anomaly execution result","description":"Returns the result of a profile anomaly rule execution.","parameters":[{"name":"executionId","in":"path","description":"Execution ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Execution result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionResult"}}}}}}},"/catalog-server/api/rules/data-drift/executions/{id}/result":{"get":{"operationId":"getDataDriftExecutionResult","tags":["Data Drift Rules"],"summary":"Get data drift execution result","description":"Returns the result of a data drift rule execution.","parameters":[{"name":"id","in":"path","description":"Execution ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Execution result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionResult"}}}}}}},"/catalog-server/api/rules/schema-drift/executions/{id}/result":{"get":{"operationId":"getSchemaDriftExecutionResult","tags":["Schema Drift Rules"],"summary":"Get schema drift execution result","description":"Returns the result of a schema drift rule execution.","parameters":[{"name":"id","in":"path","description":"Execution ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Execution result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionResult"}}}}}}},"/catalog-server/api/rules/tags":{"get":{"operationId":"getRuleTags","tags":["Rule Tags"],"summary":"List all rule tags","description":"Returns all tags associated with rules.","responses":{"200":{"description":"List of rule tags"}}}},"/catalog-server/api/rules/byName/{name}/configuration":{"get":{"operationId":"getRuleConfigurationByName","tags":["Rule Configuration"],"summary":"Get rule configuration by name","description":"Returns the full configuration for a rule identified by its policy name.","parameters":[{"name":"name","in":"path","description":"Policy name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Rule configuration details"}}}},"/catalog-server/api/rules/export/policy-definitions/pre-check":{"get":{"operationId":"exportPolicyDefinitionsPreCheck","tags":["Policy Import/Export"],"summary":"Pre-check policy export","description":"Validates and previews what will be exported before performing the actual export.","responses":{"200":{"description":"Pre-check result with exportable items"}}}},"/catalog-server/api/rules/export/policy-definitions":{"get":{"operationId":"exportPolicyDefinitions","tags":["Policy Import/Export"],"summary":"Export policy definitions","description":"Exports policy definitions as a downloadable configuration file.","responses":{"200":{"description":"Exported policy definitions"}}}},"/catalog-server/api/rules/import/policy-definitions/upload-config":{"post":{"operationId":"uploadPolicyConfig","tags":["Policy Import/Export"],"summary":"Upload policy configuration for import","description":"Uploads a policy configuration file for validation before applying.","requestBody":{"description":"Policy configuration file","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Any"}}}}},"responses":{"200":{"description":"Upload and validation result"}}}},"/catalog-server/api/rules/import/policy-definitions/apply-config":{"post":{"operationId":"applyPolicyConfig","tags":["Policy Import/Export"],"summary":"Apply imported policy configuration","description":"Applies a previously uploaded and validated policy configuration.","requestBody":{"description":"Configuration to apply","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyPolicyDefinitionRequest"}}}},"responses":{"200":{"description":"Import result"}}}},"/catalog-server/api/rules/business-rules":{"post":{"operationId":"createBusinessRule","tags":["Business Rules"],"summary":"Create a business rule (deprecated)","description":"This endpoint is deprecated and always returns HTTP 410. Creating new Data Policy Templates is no longer supported.","responses":{"200":{"description":"Never returned — endpoint always responds with 410 Gone"}},"deprecated":true},"get":{"operationId":"listBusinessRules","tags":["Business Rules"],"summary":"List business rules","description":"Returns all business rules with optional filtering and pagination.","responses":{"200":{"description":"List of business rules"}}}},"/catalog-server/api/rules/business-rules/{id}":{"delete":{"operationId":"deleteBusinessRule","tags":["Business Rules"],"summary":"Delete a business rule","description":"Deletes a business rule by its ID.","parameters":[{"name":"id","in":"path","description":"Business rule ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Business rule deleted successfully"}}},"get":{"operationId":"getBusinessRule","tags":["Business Rules"],"summary":"Get a business rule by ID","description":"Returns a specific business rule by its ID.","parameters":[{"name":"id","in":"path","description":"Business rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Business rule details"}}}},"/catalog-server/api/rules/business-rules/{id}/items":{"get":{"operationId":"getBusinessRuleItems","tags":["Business Rules"],"summary":"Get business rule items","description":"Returns the individual check items within a business rule.","parameters":[{"name":"id","in":"path","description":"Business rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of business rule items"}}}},"/catalog-server/api/udf/template":{"post":{"operationId":"createUdfTemplate","tags":["UDF Templates"],"summary":"Create a UDF template","description":"Creates a new User-Defined Function template. The request body includes\nthe function name, code, language, type, and optional validation settings.\nRequires USER_DEFINED_FUNCTION_CREATE permission.","requestBody":{"description":"UDF template definition (UdfTemplateRequestWithValidation)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UdfTemplateRequestWithValidation"}}}},"responses":{"200":{"description":"Created UDF template","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}},"get":{"operationId":"listUdfTemplates","tags":["UDF Templates"],"summary":"List UDF templates","description":"Returns a paginated list of User-Defined Function (UDF) templates.\nSupports filtering and sorting via standard list-control query parameters.","parameters":[{"name":"isPaginated","in":"query","description":"Enable pagination (default false)","schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"string"}},{"name":"size","in":"query","description":"Number of items per page","schema":{"type":"string"}}],"responses":{"200":{"description":"List of UDF templates","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/udf/template/{id}":{"put":{"operationId":"updateUdfTemplate","tags":["UDF Templates"],"summary":"Update a UDF template","description":"Updates an existing UDF template by its ID.\nRequires USER_DEFINED_FUNCTION_MODIFY permission.","parameters":[{"name":"id","in":"path","description":"UDF template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated UDF template definition (UdfTemplateRequestWithValidation)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UdfTemplateRequestWithValidation"}}}},"responses":{"200":{"description":"Updated UDF template","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}},"delete":{"operationId":"deleteUdfTemplate","tags":["UDF Templates"],"summary":"Delete a UDF template","description":"Deletes a UDF template by its ID. Requires USER_DEFINED_FUNCTION_MODIFY permission.","parameters":[{"name":"id","in":"path","description":"UDF template ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Template deleted"},"404":{"description":"Template not found"}}},"get":{"operationId":"getUdfTemplate","tags":["UDF Templates"],"summary":"Get a UDF template by ID","description":"Returns a specific UDF template by its ID.","parameters":[{"name":"id","in":"path","description":"UDF template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"UDF template details","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}},"422":{"description":"Could not fetch UDF template"}}}},"/catalog-server/api/udf/template/{id}/validate/async":{"post":{"operationId":"validateUdfTemplateAsync","tags":["UDF Validation"],"summary":"Validate a UDF template asynchronously","description":"Submits an asynchronous validation job for the specified UDF template.\nReturns a request ID that can be used to poll for the validation result.","parameters":[{"name":"id","in":"path","description":"UDF template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template validation request (UdfTemplateValidationRequest)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UdfTemplateValidationRequest"}}}},"responses":{"200":{"description":"Validation job submitted","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/udf/template/{id}/generateCode":{"post":{"operationId":"generateUdfCode","tags":["UDF Templates"],"summary":"Generate code from a UDF template","description":"Applies variable values to a UDF template and generates the resulting code.\nReturns the rendered code output.","parameters":[{"name":"id","in":"path","description":"UDF template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Code generation request with variable values and asset ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateCodeRequest"}}}},"responses":{"200":{"description":"Generated code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateCodeResponse"}}}}}}},"/catalog-server/api/udf/template/bulk":{"post":{"operationId":"bulkCreateOrUpdateUdfTemplates","tags":["UDF Templates"],"summary":"Bulk create or update UDF templates","description":"Creates or updates multiple UDF templates in a single request.\nRequires USER_DEFINED_FUNCTION_CREATE permission.","requestBody":{"description":"Bulk UDF template requests (UdfTemplateBulkRequestsWithValidation)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UdfTemplateBulkRequestsWithValidation"}}}},"responses":{"200":{"description":"Bulk create/update results","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/udf/template/validate/async":{"post":{"operationId":"validateUdfVariablesAsync","tags":["UDF Validation"],"summary":"Validate UDF variables asynchronously","description":"Submits an asynchronous validation job for UDF variables.\nReturns a request ID that can be used to poll for the validation result.","requestBody":{"description":"Variables validation request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UdfVariablesValidationRequest"}}}},"responses":{"200":{"description":"Validation job submitted with request ID","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/udf/template/validate/result/{requestId}":{"get":{"operationId":"getUdfValidationResult","tags":["UDF Validation"],"summary":"Get UDF validation result","description":"Returns the result of a previously submitted UDF validation job.","parameters":[{"name":"requestId","in":"path","description":"Validation request ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Validation result","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/udf/template/validate/analysis-result":{"put":{"operationId":"processUdfAnalysisResult","tags":["UDF Validation"],"summary":"Process UDF validation analysis result","description":"Receives and processes the analysis result from a data plane UDF validation job.","requestBody":{"description":"Analysis result from data plane UDF validation job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UdfValidationAnalysisResult"}}}},"responses":{"200":{"description":"Result processed","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/udf/template/execution/{id}/cancel":{"put":{"operationId":"cancelUdfExecution","tags":["UDF Validation"],"summary":"Cancel a UDF validation execution","description":"Cancels a running UDF validation execution by its ID.","parameters":[{"name":"id","in":"path","description":"Execution ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cancellation request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UdfVariablesCancellationValidationRequest"}}}},"responses":{"200":{"description":"Cancellation result","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/udf/package":{"get":{"operationId":"listUdtPackages","tags":["UDT Packages"],"summary":"List UDT packages","description":"Returns a paginated list of User-Defined Transform (UDT) packages.\nA package bundles multiple UDF templates together for reuse across assets.\nSupports filtering and sorting via standard list-control query parameters.","parameters":[{"name":"isPaginated","in":"query","description":"Enable pagination (default false)","schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"string"}},{"name":"size","in":"query","description":"Number of items per page","schema":{"type":"string"}}],"responses":{"200":{"description":"List of UDT packages","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}}}}},"/catalog-server/api/udf/package/{id}":{"delete":{"operationId":"deleteUdtPackage","tags":["UDT Packages"],"summary":"Delete a UDT package","description":"Deletes a UDT package by its ID. Requires USER_DEFINED_FUNCTION_MODIFY permission.","parameters":[{"name":"id","in":"path","description":"UDT package ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Package deleted"}}},"get":{"operationId":"getUdtPackage","tags":["UDT Packages"],"summary":"Get a UDT package by ID","description":"Returns a specific UDT package by its ID, including a summary of its UDF template definitions.","parameters":[{"name":"id","in":"path","description":"UDT package ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"UDT package details with summary","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Any"}}}}}},"422":{"description":"Could not fetch package"}}}},"/catalog-server/api/udf/package/createOrUpdate":{"post":{"operationId":"createOrUpdateUdtPackage","tags":["UDT Packages"],"summary":"Create or update a UDT package","description":"Creates a new UDT package or updates an existing one. The request body includes\nthe package metadata (name, version, language, storage config) and the UDF\ntemplate definitions to bundle within the package.\nRequires USER_DEFINED_FUNCTION_CREATE permission.","requestBody":{"description":"Package definition with UDF template definitions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageUDfCreateOrUpdateRequestWithUdfDefinitions"}}}},"responses":{"200":{"description":"Created or updated package with UDF template results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageCreateOrUpdateResponse"}}}}}}}},"components":{"schemas":{"Any":{"type":"object","title":"Any"},"DateTime":{"type":"object","title":"DateTime"},"CrawlerTracker":{"type":"object","title":"CrawlerTracker","required":["assetTypeId","parentUUID","startedAt","status"],"properties":{"assetTypeId":{"type":"integer"},"endedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"id":{"type":"integer"},"parentUUID":{"type":"string"},"startedAt":{"$ref":"#/components/schemas/DateTime"},"status":{"type":"string","enum":["STARTED","FINISHED"]}}},"UpdateTrackerRequest":{"type":"object","title":"UpdateTrackerRequest","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CrawlerTracker"}}},"Heartbeat":{"type":"object","title":"Heartbeat","required":["alive","assemblyId","assemblyName"],"properties":{"alive":{"type":"boolean"},"assemblyId":{"type":"integer"},"assemblyName":{"type":"string"},"error":{"type":["string","null"]}}},"UpdateHeartbeatRequest":{"type":"object","title":"UpdateHeartbeatRequest","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Heartbeat"}}},"FailedAssetDetail":{"type":"object","title":"FailedAssetDetail","required":["assetName","errorMessage"],"properties":{"assetName":{"type":"string"},"errorMessage":{"type":"string"}}},"FailedSummary":{"type":"object","title":"FailedSummary","required":["count","details"],"properties":{"count":{"type":"integer"},"details":{"type":"array","items":{"$ref":"#/components/schemas/FailedAssetDetail"}}}},"AssetProgress":{"type":"object","title":"AssetProgress","required":["completed","discovered","failed"],"properties":{"completed":{"type":"integer"},"discovered":{"type":"integer"},"failed":{"$ref":"#/components/schemas/FailedSummary"}}},"AssetProgressDetails":{"type":"object","title":"AssetProgressDetails","required":["assets","summary"],"properties":{"assets":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssetProgressDetails"}},"summary":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssetProgress"}}}},"CrawlerProgress":{"type":"object","title":"CrawlerProgress","required":["assemblyId","endedAt","progress","snapshotUUID","startedAt"],"properties":{"assemblyId":{"type":"string"},"endedAt":{"$ref":"#/components/schemas/DateTime"},"progress":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssetProgressDetails"}},"snapshotUUID":{"type":"string"},"startedAt":{"$ref":"#/components/schemas/DateTime"}}},"UpdateProgressRequest":{"type":"object","title":"UpdateProgressRequest","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CrawlerProgress"}}},"Artifact":{"type":"object","title":"Artifact","required":["name","path","version"],"properties":{"name":{"type":"string"},"path":{"type":"string"},"version":{"type":"string"}}},"ProcessorConfig":{"type":"object","title":"ProcessorConfig"},"Processor":{"type":"object","title":"Processor","required":["className","config"],"properties":{"className":{"type":"string"},"config":{"$ref":"#/components/schemas/ProcessorConfig"}}},"PartitionConfiguration":{"type":"object","title":"PartitionConfiguration","required":["partitionColumn","tableName"],"properties":{"numberOfPartitions":{"type":"integer"},"partitionColumn":{"type":"string"},"tableName":{"type":"string"}}},"SampleRequestConfig":{"type":"object","title":"SampleRequestConfig","required":["fractionPart","limit","randomSample","sampleData","trialEnvironment","viewProtectedRecordData"],"properties":{"filesCollectSizeRestrictionInBytes":{"type":"integer"},"filter":{"type":["string","null"]},"fractionPart":{"type":"integer"},"limit":{"type":"integer"},"randomSample":{"type":"boolean"},"sampleData":{"type":"boolean"},"trialEnvironment":{"type":"boolean"},"viewProtectedRecordData":{"type":"boolean"}}},"TransformUDFColumnDef":{"type":"object","title":"TransformUDFColumnDef","required":["code","columnNames","id","isPackage","language","name","udfDataType","udfType"],"properties":{"className":{"type":["string","null"]},"code":{"type":"string"},"columnNames":{"type":"array","items":{"type":"string"}},"id":{"type":"integer"},"isPackage":{"type":"boolean"},"language":{"type":"string"},"name":{"type":"string"},"udfDataType":{"type":"string"},"udfType":{"type":"string"},"variables":{"type":["object","null"],"additionalProperties":{"type":"string"}}}},"TransformUDFsConfig":{"type":"object","title":"TransformUDFsConfig","required":["requests"],"properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/TransformUDFColumnDef"}},"transformUDFRequired":{"type":"boolean"}}},"ConnectorConfig":{"type":"object","title":"ConnectorConfig","required":["additionalProperties","assetUid","isPartitioningEnabled","processorRequestConfig","readerOptions","sampleRequestConfig","selectedColumns","source"],"properties":{"additionalProperties":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]}},"assetUid":{"type":"string"},"customQuery":{"type":["string","null"]},"isPartitioningEnabled":{"type":"boolean"},"partitionConfiguration":{"oneOf":[{"$ref":"#/components/schemas/PartitionConfiguration"},{"type":"null"}]},"processorRequestConfig":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Any"}},"readerOptions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Any"}},"sampleRequestConfig":{"$ref":"#/components/schemas/SampleRequestConfig"},"selectedColumns":{"type":"array","items":{"type":"string"}},"source":{"type":"string"},"sparkFilter":{"type":["string","null"]},"tableAlias":{"type":["string","null"]},"transformUdfConfig":{"oneOf":[{"$ref":"#/components/schemas/TransformUDFsConfig"},{"type":"null"}]}}},"Connector":{"type":"object","title":"Connector","required":["className","config"],"properties":{"className":{"type":"string"},"config":{"$ref":"#/components/schemas/ConnectorConfig"}}},"Reader":{"type":"object","title":"Reader","properties":{"connector":{"oneOf":[{"$ref":"#/components/schemas/Connector"},{"type":"null"}]}}},"SparkJobSpec":{"type":"object","title":"SparkJobSpec","required":["additionalSparkConfigurations","artifactFacts","assemblyIds","assetIds","processor","reader","scheduler"],"properties":{"additionalSparkConfigurations":{"type":"object","additionalProperties":{"type":"string"}},"artifactFacts":{"type":"array","items":{"$ref":"#/components/schemas/Artifact"}},"assemblyIds":{"type":"array","items":{"type":"integer"}},"assetIds":{"type":"array","items":{"type":"integer"}},"processor":{"$ref":"#/components/schemas/Processor"},"reader":{"$ref":"#/components/schemas/Reader"},"scheduler":{"type":"string"}}},"AsyncCrawlerRequest":{"type":"object","title":"AsyncCrawlerRequest","required":["analyticsPipelineId","assemblyId","assemblyName","assetName","jobType","sparkJobSpec"],"properties":{"analyticsPipelineId":{"type":"integer"},"assemblyId":{"type":"integer"},"assemblyName":{"type":"string"},"assetName":{"type":"string"},"jobType":{"type":"string","enum":["SAMPLE_DATA","FILE_INFO_CRAWLER","SAMPLE_DATA_CRAWLER","UDF_VALIDATION","SQL_VIEW_SAMPLE_DATA","VISUAL_VIEW_SAMPLE_DATA","DATA_VIOLATIONS_SAMPLE_DATA","DATA_VIOLATIONS_SAMPLE_DATA_S3","DATA_VIOLATIONS_SAMPLE_DATA_ADLS","DATA_VIOLATIONS_SAMPLE_DATA_GCS","DATA_VIOLATIONS_SAMPLE_DATA_HDFS","DATA_VIOLATIONS_SAMPLE_DATA_LOCAL","PROFILE","DATA_QUALITY","RECONCILIATION","ROW_COUNT_EQUALITY","FILE_CRAWLER","KAFKA_CRAWLER","PUBSUB_CRAWLER","CRAWLER","ASSET_FILE_MONITORING","ASSET_MONITORING","ASSET_REFERENCE_VALIDATION","AUTO_TAG","EXECUTION_RESULT","CONNECTION_VALIDATION","PARENT_LIST","CADENCE","AUTO_ANOMALY","SQL_VALIDATION","RESULT","DATA_VIOLATIONS","DOWNLOAD_DATA_VIOLATIONS","FRESHNESS","DATA_SOURCE_QUERY"]},"sparkJobSpec":{"$ref":"#/components/schemas/SparkJobSpec"}}},"SelectiveCrawlerRequest":{"type":"object","title":"SelectiveCrawlerRequest","required":["selectedAssets"],"properties":{"selectedAssets":{"type":"array","items":{"type":"string"}}}},"CrawlerExecution":{"type":"object","title":"CrawlerExecution","required":["assemblyId","crawlingType"],"properties":{"assemblyId":{"type":"integer"},"assemblyName":{"type":["string","null"]},"crawlingType":{"type":"string","enum":["SELECTIVE","FULL"]},"createdAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"errorMessage":{"type":["string","null"]},"id":{"type":"integer"},"progress":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/AssetProgressDetails"}},"selectedAssets":{"type":["array","null"],"items":{"type":"string"}},"snapshotUUID":{"type":["string","null"]},"status":{"type":["string","null"],"enum":["STARTING","RUNNING","COMPLETED","FAILED"]},"updatedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]}}},"MetaData":{"type":"object","title":"MetaData","required":["count","page","size"],"properties":{"count":{"type":"integer"},"page":{"type":"integer"},"size":{"type":"integer"}}},"CrawlerExecutionResponse":{"type":"object","title":"CrawlerExecutionResponse","required":["executions","metaData"],"properties":{"executions":{"type":"array","items":{"$ref":"#/components/schemas/CrawlerExecution"}},"metaData":{"$ref":"#/components/schemas/MetaData"}}},"MetaDataItemRequest":{"type":"object","title":"MetaDataItemRequest","required":["dataType","key","source","value"],"properties":{"dataType":{"type":"string"},"key":{"type":"string"},"source":{"type":"string"},"value":{"type":"string"}}},"CreateAsset":{"type":"object","title":"CreateAsset","required":["assemblyId","derivedFromImprintList","description","isCustom","isDeleted","name","uid"],"properties":{"assemblyId":{"type":"integer"},"assetType":{"type":["string","null"],"enum":["HBASE_NAMESPACE","DATABASE","SCHEMA","TABLE","COLUMN","COLUMN_FAMILY","BUCKET","OBJECT","DIRECTORY","ARCHIVE","FILE","FILE_COLUMN","BIG_QUERY_DATASET","BIG_QUERY_FIELD","KAFKA_TOPIC","KAFKA_TOPIC_COLUMN","PUBSUB_TOPIC","PUBSUB_TOPIC_COLUMN","CATALOG","PROJECT","WORKBOOK","SHEET","DASHBOARD","DATASOURCE","FIELD","VIEW","MATERIALIZED_VIEW","COLLECTION","DOCUMENT_KEY","ML_MODEL","ML_FEATURE","ML_FEATURE_SET","DICTIONARY","VIRTUAL_VIEW","KEY_SPACE","POWERBI_WORKSPACE","POWERBI_DATAFLOW","POWERBI_DATAFLOW_ENTITY","POWERBI_DATAFLOW_ATTRIBUTE","POWERBI_SEMANTIC_MODEL","POWERBI_SEMANTIC_MODEL_TABLE","POWERBI_SEMANTIC_MODEL_COLUMN","POWERBI_DATASOURCE","POWERBI_REPORT","POWERBI_DASHBOARD","POWERBI_TILE","POWERBI_PAGE","TABLEAU_PROJECT","TABLEAU_FLOW","TABLEAU_WORKBOOK","TABLEAU_SHEET","TABLEAU_DASHBOARD","TABLEAU_DATASOURCE","TABLEAU_FIELD","TABLEAU_DATABASE","TABLEAU_TABLE","TABLEAU_COLUMN","ADF_FACTORY","ADF_PIPELINE","ADF_LINKEDSERVICE","ADF_DATASET","ADF_DATAFLOW","SQL_VIEW","SQL_VIEW_COLUMN","VISUAL_VIEW","VISUAL_VIEW_COLUMN","CUSTOM_SQL","AUTOSYS_JOB","ICEBERG_NAMESPACE"]},"assetTypeId":{"type":"integer"},"backingAssetUID":{"type":["string","null"]},"currentSnapshot":{"type":["string","null"]},"derivedFromImprintList":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"id":{"type":"integer"},"imprint":{"type":["string","null"]},"isCustom":{"type":"boolean"},"isDeleted":{"type":"boolean"},"metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/MetaDataItemRequest"}},"metadataHash":{"type":["string","null"]},"name":{"type":"string"},"parentId":{"type":"integer"},"parentUid":{"type":["string","null"]},"snapshots":{"type":["array","null"],"items":{"type":"string"}},"sourceType":{"type":["string","null"],"enum":["BIGQUERY","AZURE_COSMOSDB_CASSANDRA","CASSANDRA","REDSHIFT","SNOWFLAKE","TERADATA","HIVE","HBASE","ADF","AZURE_MSSQL","AZURE_BLOB","AZURE_COSMOSDB_NOSQL","AZURE_COSMOSDB_POSTGRESQL","AMAZON_RDS_POSTGRESQL","AMAZON_AURORA_POSTGRESQL","AZURE_DATALAKE","AWS_GLUE","AWS_S3","HDFS","GCS","ICEBERG","KAFKA","PUBSUB","MYSQL","MARIADB","MEMSQL","POSTGRESQL","POWERBI","TABLEAU","ORACLE","AWS_ATHENA","DATABRICKS","MONGO","MODEL_BAG","FEATURE_BAG","PRESTO","TRINO","DB2","CLICKHOUSE","SFTP","SAP_HANA","AMAZON_RDS_MYSQL","AMAZON_AURORA_MYSQL","AMAZON_RDS_MARIADB","AZURE_SYNAPSE_ANALYTICS","VIRTUAL_DATASOURCE","AUTOSYS","DBT_CLOUD","FIVETRAN","SNAPLOGIC","SALESFORCE"]},"sourceTypeId":{"type":"integer"},"uid":{"type":"string"}}},"SqlViewDetails":{"type":"object","title":"SqlViewDetails","required":["description","query","queryType"],"properties":{"description":{"type":"string"},"query":{"type":"string"},"queryType":{"type":"string","enum":["SQL_QUERY","FILTER","AGGREGATION_PIPELINE"]},"tableAlias":{"type":["string","null"]}}},"SqlViewColumn":{"type":"object","title":"SqlViewColumn","required":["name","nullable","type"],"properties":{"name":{"type":"string"},"nullable":{"type":"boolean"},"type":{"type":"string"}}},"CreateSqlView":{"type":"object","title":"CreateSqlView","required":["asset","details","schema"],"properties":{"asset":{"$ref":"#/components/schemas/CreateAsset"},"details":{"$ref":"#/components/schemas/SqlViewDetails"},"schema":{"type":"array","items":{"$ref":"#/components/schemas/SqlViewColumn"}}}},"CreateSqlViewRequest":{"type":"object","title":"CreateSqlViewRequest","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CreateSqlView"}}},"HostedDPDeploymentResponse":{"type":"object","title":"HostedDPDeploymentResponse","required":["dataplaneName","deploymentName","message","namespace","status","uid"],"properties":{"dataplaneName":{"type":"string"},"deploymentName":{"type":"string"},"message":{"type":"string"},"namespace":{"type":"string"},"status":{"type":"string"},"uid":{"type":"string"}}},"AnalyticsPipelineEndpoint":{"type":"object","title":"AnalyticsPipelineEndpoint","required":["type","useCertificate"],"properties":{"analyticsPipelineId":{"type":"integer"},"caRoot":{"type":["string","null"]},"certificate":{"type":["string","null"]},"createdAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"expiresAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"id":{"type":"integer"},"key":{"type":["string","null"]},"tenantId":{"type":["string","null"]},"type":{"type":"string","enum":["EXTERNAL","TUNNEL_V1","TUNNEL_V2"]},"updatedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"url":{"type":["string","null"]},"useCertificate":{"type":"boolean"}}},"GlobalStorageConfigDTO":{"type":"object","title":"GlobalStorageConfigDTO","required":["measureResultFsType"],"properties":{"adlsGeneration":{"type":["string","null"]},"adlsStorageAccountName":{"type":["string","null"]},"adlsStorageContainerName":{"type":["string","null"]},"gcsBucketName":{"type":["string","null"]},"gcsProjectId":{"type":["string","null"]},"hdfsDirectory":{"type":["string","null"]},"measureResultADLSAccessMode":{"type":["string","null"]},"measureResultFsType":{"type":"string"},"measureResultGCSAccessMode":{"type":["string","null"]},"measureResultS3AAccessInstanceProfileARN":{"type":["string","null"]},"measureResultS3AAccessMode":{"type":["string","null"]},"s3BucketName":{"type":["string","null"]},"s3Region":{"type":["string","null"]}}},"KubernetesMetrics":{"type":"object","title":"KubernetesMetrics","required":["reportingTime","status"],"properties":{"reportingTime":{"$ref":"#/components/schemas/DateTime"},"status":{"type":"string"}}},"ProcessMetrics":{"type":"object","title":"ProcessMetrics","required":["reportingTime","status"],"properties":{"reportingTime":{"$ref":"#/components/schemas/DateTime"},"status":{"type":"string"}}},"DataplaneHealthMetrics":{"type":"object","title":"DataplaneHealthMetrics","required":["process","reportingTime"],"properties":{"kubernetes":{"oneOf":[{"$ref":"#/components/schemas/KubernetesMetrics"},{"type":"null"}]},"process":{"$ref":"#/components/schemas/ProcessMetrics"},"reportingTime":{"$ref":"#/components/schemas/DateTime"}}},"DatabricksComputeConfig":{"type":"object","title":"DatabricksComputeConfig","properties":{"clusterDriverType":{"type":["string","null"]},"clusterWorkerType":{"type":["string","null"]},"isEnabled":{"type":"boolean"},"jobClusterType":{"type":["string","null"]},"maxWorkers":{"type":"integer"},"minWorkers":{"type":"integer"}}},"DataprocComputeConfig":{"type":"object","title":"DataprocComputeConfig","properties":{"clusterMasterType":{"type":["string","null"]},"clusterWorkerType":{"type":["string","null"]},"isEnabled":{"type":"boolean"},"numMasterNodes":{"type":"integer"},"numWorkerNodes":{"type":"integer"}}},"LivyComputeConfig":{"type":"object","title":"LivyComputeConfig","required":["driverCores","driverMemory"],"properties":{"driverCores":{"type":"integer"},"driverMemory":{"type":"string"},"executorCores":{"type":"integer"},"executorMemory":{"type":["string","null"]},"isEnabled":{"type":"boolean"},"numExecutors":{"type":"integer"}}},"YunikornComputeConfig":{"type":"object","title":"YunikornComputeConfig","required":["driverCores","driverMemory"],"properties":{"driverCoreLimit":{"type":["string","null"]},"driverCoreRequest":{"type":["string","null"]},"driverCores":{"type":"integer"},"driverMemory":{"type":"string"},"executorCoreLimit":{"type":["string","null"]},"executorCoreRequest":{"type":["string","null"]},"executorCores":{"type":"integer"},"executorMemory":{"type":["string","null"]},"isEnabled":{"type":"boolean"},"maxExecutors":{"type":"integer"},"minExecutors":{"type":"integer"}}},"PipelineComputeConfig":{"type":"object","title":"PipelineComputeConfig","properties":{"databricks":{"oneOf":[{"$ref":"#/components/schemas/DatabricksComputeConfig"},{"type":"null"}]},"dataproc":{"oneOf":[{"$ref":"#/components/schemas/DataprocComputeConfig"},{"type":"null"}]},"livy":{"oneOf":[{"$ref":"#/components/schemas/LivyComputeConfig"},{"type":"null"}]},"yunikorn":{"oneOf":[{"$ref":"#/components/schemas/YunikornComputeConfig"},{"type":"null"}]}}},"SecretManagerConfiguration":{"type":"object","title":"SecretManagerConfiguration","required":["name","type"],"properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SecretManagerConfigurationWithOption":{"type":"object","title":"SecretManagerConfigurationWithOption","required":["defaultOption","secretManagerConfig"],"properties":{"defaultOption":{"type":"boolean"},"secretManagerConfig":{"type":"array","items":{"$ref":"#/components/schemas/SecretManagerConfiguration"}}}},"AnalyticsPipeline":{"type":"object","title":"AnalyticsPipeline","required":["dataplaneType","isHosted","isInternalCall","isPaused","isRequestSentByDataplane","isRotationInProgress","name","statusReportInterval","tenantId","version"],"properties":{"accessKey":{"type":["string","null"]},"accessKeyExpiry":{"type":"integer"},"additionalConfiguration":{"type":["object","null"],"additionalProperties":{"type":"string"}},"autoRetryEnabled":{"type":"boolean"},"cloudProvider":{"type":["string","null"]},"connectionCount":{"type":"integer"},"createdAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"dataplaneAccessKey":{"type":["string","null"]},"dataplaneSecretKey":{"type":["string","null"]},"dataplaneType":{"type":"string"},"dataplaneVersion":{"type":["string","null"]},"deploymentDetails":{"oneOf":[{"$ref":"#/components/schemas/HostedDPDeploymentResponse"},{"type":"null"}]},"deploymentStackId":{"type":["string","null"]},"deploymentStackRegion":{"type":["string","null"]},"deploymentStatus":{"type":["string","null"]},"description":{"type":["string","null"]},"endpoint":{"oneOf":[{"$ref":"#/components/schemas/AnalyticsPipelineEndpoint"},{"type":"null"}]},"externalUrl":{"type":["string","null"]},"globalStorageBasePath":{"type":["string","null"]},"globalStorageConfig":{"oneOf":[{"$ref":"#/components/schemas/GlobalStorageConfigDTO"},{"type":"null"}]},"hbaseEnabled":{"type":"boolean"},"hdfsEnabled":{"type":"boolean"},"healthReport":{"oneOf":[{"$ref":"#/components/schemas/DataplaneHealthMetrics"},{"type":"null"}]},"helmTemplateValues":{"type":["object","null"],"additionalProperties":{"type":"string"}},"hiveEnabled":{"type":"boolean"},"id":{"type":"integer"},"ingestKey":{"type":["string","null"]},"installationType":{"type":["string","null"]},"isHosted":{"type":"boolean"},"isInternalCall":{"type":"boolean"},"isPaused":{"type":"boolean"},"isRequestSentByDataplane":{"type":"boolean"},"isRotationInProgress":{"type":"boolean"},"kerberosEnabled":{"type":"boolean"},"lastStatusReportTime":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"measureResultFsType":{"type":["string","null"]},"name":{"type":"string"},"namespace":{"type":["string","null"]},"parentPipelineId":{"type":"integer"},"pausedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"pausedBy":{"type":["string","null"]},"pipelineComputeConfig":{"oneOf":[{"$ref":"#/components/schemas/PipelineComputeConfig"},{"type":"null"}]},"pipelineType":{"type":["string","null"],"enum":["ANALYSIS","MONITOR","QUERY_ANALYSIS"]},"registryPrefix":{"type":["string","null"]},"registryUrl":{"type":["string","null"]},"resourceStrategyType":{"type":["string","null"],"enum":["INVENTORY","CUSTOM"]},"rotationAccessKey":{"type":["string","null"]},"rotationIngestKey":{"type":["string","null"]},"rotationSecretKey":{"type":["string","null"]},"secretKey":{"type":["string","null"]},"secretsManagerConfiguration":{"oneOf":[{"$ref":"#/components/schemas/SecretManagerConfigurationWithOption"},{"type":"null"}]},"selectedResourceInventory":{"type":["string","null"]},"serviceUserId":{"type":["string","null"]},"sparkMajorVersion":{"type":["string","null"]},"sparkRuntime":{"type":["string","null"]},"status":{"type":["string","null"]},"statusReportInterval":{"type":"integer"},"tenantId":{"type":"string"},"updatedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"upgradeAvailable":{"type":"boolean"},"url":{"type":["string","null"]},"version":{"type":"string"}}},"ConnectionType":{"type":"object","title":"ConnectionType","required":["id","type"],"properties":{"id":{"type":"integer"},"type":{"type":"string"}}},"ConfigProperty":{"type":"object","title":"ConfigProperty","required":["key","value"],"properties":{"id":{"type":"integer"},"key":{"type":"string"},"value":{"type":"string"}}},"Connection":{"type":"object","title":"Connection","required":["analyticsPipeline","assembliesCount","connectionType","createdAt","name","properties","updatedAt"],"properties":{"analyticsPipeline":{"$ref":"#/components/schemas/AnalyticsPipeline"},"assembliesCount":{"type":"integer"},"configuration":{"type":["object","null"],"additionalProperties":{"type":"string"}},"connectionType":{"$ref":"#/components/schemas/ConnectionType"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"description":{"type":["string","null"]},"id":{"type":"integer"},"name":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ConfigProperty"}},"updatedAt":{"$ref":"#/components/schemas/DateTime"}}},"None":{"type":"object","title":"None"},"Crawler":{"type":"object","title":"Crawler","required":["name"],"properties":{"name":{"type":"string"}}},"SecurityConfig":{"type":"object","title":"SecurityConfig","required":["config","type"],"properties":{"config":{"type":"object","additionalProperties":{"type":"string"}},"type":{"type":"string"}}},"SourceModel":{"type":"object","title":"SourceModel","required":["name"],"properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"SourceType":{"type":"object","title":"SourceType","required":["miniProfiling","name"],"properties":{"connectionTypeId":{"type":"integer"},"id":{"type":"integer"},"miniProfiling":{"type":"boolean"},"name":{"type":"string"},"sourceModel":{"oneOf":[{"$ref":"#/components/schemas/SourceModel"},{"type":"null"}]}}},"Assembly":{"type":"object","title":"Assembly","required":["autoProfile","crawler","createdAt","description","isSecured","isVirtual","name","sourceType","status","tenantId","timeZone","updatedAt"],"properties":{"analyticsPipelineId":{"type":"integer"},"assemblyProperties":{"type":["object","null"],"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]}},"autoProfile":{"type":"boolean"},"configuration":{"type":["object","null"],"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]}},"conn":{"oneOf":[{"$ref":"#/components/schemas/Connection"},{"type":"null"}]},"connectionId":{"type":"integer"},"crawler":{"$ref":"#/components/schemas/Crawler"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"createdBy":{"type":["string","null"]},"currentSnapshot":{"type":["string","null"]},"description":{"type":"string"},"id":{"type":"integer"},"integrationId":{"type":["string","null"]},"isProtectedResource":{"type":"boolean"},"isSecured":{"type":"boolean"},"isVirtual":{"type":"boolean"},"name":{"type":"string"},"schedule":{"type":["string","null"]},"securityConfig":{"oneOf":[{"$ref":"#/components/schemas/SecurityConfig"},{"type":"null"}]},"sourceType":{"$ref":"#/components/schemas/SourceType"},"status":{"type":"string","enum":["ACTIVE","MARKED_FOR_DELETED"]},"tenantId":{"type":"string"},"timeZone":{"type":"string"},"updatedAt":{"$ref":"#/components/schemas/DateTime"}}},"AssetType":{"type":"object","title":"AssetType","required":["canMonitor","canProfile","canSample","name"],"properties":{"canMonitor":{"type":"boolean"},"canProfile":{"type":"boolean"},"canSample":{"type":"boolean"},"id":{"type":"integer"},"name":{"type":"string"}}},"Asset":{"type":"object","title":"Asset","required":["assembly","assetType","createdAt","description","isActive","isCustom","isDeleted","isSegmented","name","sourceType","uid","updatedAt"],"properties":{"alias":{"type":["string","null"]},"assembly":{"$ref":"#/components/schemas/Assembly"},"assetType":{"$ref":"#/components/schemas/AssetType"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"currentSnapshot":{"type":["string","null"]},"customAssetType":{"type":["string","null"],"enum":["SQL_VIEW","SQL_VIEW_COLUMN","VISUAL_VIEW","VISUAL_VIEW_COLUMN"]},"description":{"type":"string"},"id":{"type":"integer"},"imprint":{"type":["string","null"]},"isActive":{"type":"boolean"},"isCustom":{"type":"boolean"},"isDeleted":{"type":"boolean"},"isSegmented":{"type":"boolean"},"name":{"type":"string"},"parentId":{"type":"integer"},"snapshots":{"type":["array","null"],"items":{"type":"string"}},"sourceType":{"$ref":"#/components/schemas/SourceType"},"uid":{"type":"string"},"updatedAt":{"$ref":"#/components/schemas/DateTime"}}},"SqlView":{"type":"object","title":"SqlView","required":["asset","createdAt","query","queryType","updatedAt"],"properties":{"asset":{"$ref":"#/components/schemas/Asset"},"backingAssetId":{"type":"integer"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"description":{"type":["string","null"]},"id":{"type":"integer"},"query":{"type":"string"},"queryType":{"type":"string","enum":["SQL_QUERY","FILTER","AGGREGATION_PIPELINE"]},"tableAlias":{"type":["string","null"]},"updatedAt":{"$ref":"#/components/schemas/DateTime"}}},"CustomAssetResponse":{"type":"object","title":"CustomAssetResponse","required":["customAsset"],"properties":{"customAsset":{"$ref":"#/components/schemas/SqlView"}}},"UpdateSqlView":{"type":"object","title":"UpdateSqlView","required":["details","schema"],"properties":{"details":{"$ref":"#/components/schemas/SqlViewDetails"},"name":{"type":["string","null"]},"schema":{"type":"array","items":{"$ref":"#/components/schemas/SqlViewColumn"}}}},"UpdateSqlViewRequest":{"type":"object","title":"UpdateSqlViewRequest","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UpdateSqlView"}}},"SingleCategoryPersistenceConfig":{"type":"object","title":"SingleCategoryPersistenceConfig","required":["format","suffixTemplate"],"properties":{"format":{"type":"string","enum":["PARQUET","ORC","CSV","JSON"]},"suffixTemplate":{"type":"string"}}},"MetadataPersistenceConfig":{"type":"object","title":"MetadataPersistenceConfig","required":["suffixTemplate"],"properties":{"suffixTemplate":{"type":"string"}}},"CategoriesPersistenceConfig":{"type":"object","title":"CategoriesPersistenceConfig","required":["bad","good"],"properties":{"bad":{"$ref":"#/components/schemas/SingleCategoryPersistenceConfig"},"good":{"$ref":"#/components/schemas/SingleCategoryPersistenceConfig"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/MetadataPersistenceConfig"},{"type":"null"}]}}},"PersistenceStorageConfig":{"type":"object","title":"PersistenceStorageConfig","required":["categoriesConfig","createdAt","createdBy","isDefault","lastUpdatedBy","name","tenantId","updatedAt"],"properties":{"categoriesConfig":{"$ref":"#/components/schemas/CategoriesPersistenceConfig"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"createdBy":{"type":"string"},"description":{"type":["string","null"]},"id":{"type":"integer"},"isDefault":{"type":"boolean"},"lastUpdatedBy":{"type":"string"},"name":{"type":"string"},"policyCount":{"type":"integer"},"tenantId":{"type":"string"},"updatedAt":{"$ref":"#/components/schemas/DateTime"}}},"MarkerConfig":{"type":"object","title":"MarkerConfig","required":["type"],"properties":{"type":{"type":"string"}}},"BackingAsset":{"type":"object","title":"BackingAsset","properties":{"customQuery":{"type":["string","null"]},"customTableAssetIds":{"type":["array","null"],"items":{"type":"integer"}},"id":{"type":"integer"},"marker":{"oneOf":[{"$ref":"#/components/schemas/MarkerConfig"},{"type":"null"}]},"ruleId":{"type":"integer"},"tableAlias":{"type":["string","null"]},"tableAssetId":{"type":"integer"},"tableAssetUid":{"type":["string","null"]}}},"JobSchedule":{"type":"object","title":"JobSchedule","required":["cronExpression","enabled","scheduleType","timeZone"],"properties":{"backingAssetId":{"type":"integer"},"cronExpression":{"type":"string"},"enabled":{"type":"boolean"},"id":{"type":"integer"},"marker":{"oneOf":[{"$ref":"#/components/schemas/MarkerConfig"},{"type":"null"}]},"name":{"type":["string","null"]},"scheduleType":{"type":"string"},"tenantId":{"type":["string","null"]},"timeZone":{"type":"string"}}},"Label":{"type":"object","title":"Label","required":["key","value"],"properties":{"key":{"type":"string"},"labelType":{"type":["string","null"],"enum":["ASSET","RULE","DQ_RULE_ITEM","RECONCILIATION_COLUMN_MAPPING","POLICY_TEMPLATE_MEASURE","USER_DEFINED_FUNCTION"]},"value":{"type":"string"}}},"ColumnMetadata":{"type":"object","title":"ColumnMetadata","required":["name","type"],"properties":{"name":{"type":"string"},"type":{"type":"string"}}},"ColumnVariable":{"type":"object","title":"ColumnVariable","required":["getOnlyWithVariableName","isNumber","name"],"properties":{"format":{"type":["string","null"]},"getOnlyWithVariableName":{"$ref":"#/components/schemas/ColumnVariable"},"isNumber":{"type":"boolean"},"name":{"type":"string"},"value":{"type":["string","null"]}}},"CustomSqlConfig":{"type":"object","title":"CustomSqlConfig","required":["columnMetadataList","columnVariables","queryType","ruleVersion","sanitizedQuery","sqlExpression"],"properties":{"columnMetadataList":{"type":"array","items":{"$ref":"#/components/schemas/ColumnMetadata"}},"columnVariables":{"type":"array","items":{"$ref":"#/components/schemas/ColumnVariable"}},"queryType":{"type":"string"},"ruleVersion":{"type":"integer"},"sanitizedQuery":{"type":"string"},"sqlExpression":{"type":"string"},"tableAlias":{"type":["string","null"]}}},"NotificationPayload":{"type":"object","title":"NotificationPayload","required":["alertsEnabled","configuredNotificationGroupIds","notifyOn","notifyOnSuccess","notifyOnWarning","reNotifyMode"],"properties":{"alertsEnabled":{"type":"boolean"},"configuredNotificationGroupIds":{"type":"array","items":{"type":"integer"}},"notifyOn":{"type":"array","items":{"type":"string","enum":["ERROR","WARNING","SUCCESS","ALL"]}},"notifyOnSuccess":{"type":"boolean"},"notifyOnWarning":{"type":"boolean"},"reNotifyFactor":{"type":"integer"},"reNotifyMode":{"type":"string","enum":["INTERVAL","RULE_CHANGE"]},"severity":{"type":["string","null"],"enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"tags":{"type":["array","null"],"items":{"type":"string"}}}},"PolicyGroup":{"type":"object","title":"PolicyGroup","properties":{"createdAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"description":{"type":["string","null"]},"id":{"type":"integer"},"name":{"type":["string","null"]},"tenantId":{"type":["string","null"]},"updatedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]}}},"UdfVariable":{"type":"object","title":"UdfVariable","required":["key"],"properties":{"isColumnVariable":{"type":"boolean"},"key":{"type":"string"},"value":{"type":["string","null"]}}},"PolicyTransformUDF":{"type":"object","title":"PolicyTransformUDF","required":["assetId","name","parameters","udfId"],"properties":{"assetId":{"type":"integer"},"columnNames":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"integer"},"name":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/UdfVariable"}},"ruleId":{"type":"integer"},"udfId":{"type":"integer"}}},"Mapping":{"type":"object","title":"Mapping","required":["key"],"properties":{"isColumnVariable":{"type":"boolean"},"key":{"type":"string"},"value":{"type":["string","null"]}}},"RuleSparkSQLDynamicFilterVariableMapping":{"type":"object","title":"RuleSparkSQLDynamicFilterVariableMapping","required":["mapping","ruleName"],"properties":{"mapping":{"type":"array","items":{"$ref":"#/components/schemas/Mapping"}},"ruleId":{"type":"integer"},"ruleName":{"type":"string"}}},"ShortSegment":{"type":"object","title":"ShortSegment","required":["type"],"properties":{"id":{"type":"integer"},"name":{"type":["string","null"]},"type":{"type":"string"}}},"DataBricksSparkResourceConfig":{"type":"object","title":"DataBricksSparkResourceConfig","properties":{"clusterDriverType":{"type":["string","null"]},"clusterWorkerType":{"type":["string","null"]},"maxWorkers":{"type":"integer"},"minWorkers":{"type":"integer"}}},"DataprocSparkResourceConfig":{"type":"object","title":"DataprocSparkResourceConfig","properties":{"clusterMasterType":{"type":["string","null"]},"clusterWorkerType":{"type":["string","null"]},"numMasterNodes":{"type":"integer"},"numWorkerNodes":{"type":"integer"}}},"LivySparkResourceConfig":{"type":"object","title":"LivySparkResourceConfig","properties":{"driverCores":{"type":"integer"},"driverMemory":{"type":["string","null"]},"executorCores":{"type":"integer"},"executorMemory":{"type":["string","null"]},"numExecutors":{"type":"integer"}}},"YunikornSparkResourceConfig":{"type":"object","title":"YunikornSparkResourceConfig","properties":{"driverCores":{"type":"integer"},"driverLimitCores":{"type":["string","null"]},"driverMemory":{"type":["string","null"]},"driverMemoryOverhead":{"type":["string","null"]},"driverMemoryOverheadFactor":{"type":"number"},"driverRequestCores":{"type":["string","null"]},"executorCores":{"type":"integer"},"executorLimitCores":{"type":["string","null"]},"executorMemory":{"type":["string","null"]},"executorMemoryOverhead":{"type":["string","null"]},"executorMemoryOverheadFactor":{"type":"number"},"executorRequestCores":{"type":["string","null"]},"maxExecutors":{"type":"integer"},"minExecutors":{"type":"integer"}}},"SparkResourceConfig":{"type":"object","title":"SparkResourceConfig","required":["invalidFields"],"properties":{"additionalConfiguration":{"type":["object","null"],"additionalProperties":{"type":"string"}},"databricks":{"oneOf":[{"$ref":"#/components/schemas/DataBricksSparkResourceConfig"},{"type":"null"}]},"dataproc":{"oneOf":[{"$ref":"#/components/schemas/DataprocSparkResourceConfig"},{"type":"null"}]},"invalidFields":{"type":"array","items":{"type":"string"}},"livy":{"oneOf":[{"$ref":"#/components/schemas/LivySparkResourceConfig"},{"type":"null"}]},"yunikorn":{"oneOf":[{"$ref":"#/components/schemas/YunikornSparkResourceConfig"},{"type":"null"}]}}},"RuleTag":{"type":"object","title":"RuleTag","required":["name"],"properties":{"id":{"type":"integer"},"name":{"type":"string"},"ruleId":{"type":"integer"},"tagId":{"type":"integer"},"tenantId":{"type":["string","null"]}}},"AboveConfigs":{"type":"object","title":"AboveConfigs","required":["direction","success"],"properties":{"direction":{"type":"string","enum":["ABOVE","BELOW","RANGE","CHANGES_BY","DECREASED_BY","INCREASED_BY"]},"success":{"type":"number"},"warning":{"type":"number"}}},"BelowConfigs":{"type":"object","title":"BelowConfigs","required":["direction","success"],"properties":{"direction":{"type":"string","enum":["ABOVE","BELOW","RANGE","CHANGES_BY","DECREASED_BY","INCREASED_BY"]},"success":{"type":"number"},"warning":{"type":"number"}}},"RangeConfigs":{"type":"object","title":"RangeConfigs","required":["direction","lowerSuccess","upperSuccess"],"properties":{"direction":{"type":"string","enum":["ABOVE","BELOW","RANGE","CHANGES_BY","DECREASED_BY","INCREASED_BY"]},"lowerSuccess":{"type":"number"},"lowerWarning":{"type":"number"},"upperSuccess":{"type":"number"},"upperWarning":{"type":"number"}}},"AbsoluteConfigs":{"type":"object","title":"AbsoluteConfigs","oneOf":[{"$ref":"#/components/schemas/AboveConfigs"},{"$ref":"#/components/schemas/BelowConfigs"},{"$ref":"#/components/schemas/RangeConfigs"}],"discriminator":{"propertyName":"type","mapping":{"io.ad.catalog.api.model.quality.AboveConfigs":"#/components/schemas/AboveConfigs","io.ad.catalog.api.model.quality.BelowConfigs":"#/components/schemas/BelowConfigs","io.ad.catalog.api.model.quality.RangeConfigs":"#/components/schemas/RangeConfigs"}}},"AbsoluteThresholdConfig":{"type":"object","title":"AbsoluteThresholdConfig","required":["config","type"],"properties":{"config":{"$ref":"#/components/schemas/AbsoluteConfigs"},"success":{"type":"number"},"type":{"type":"string","enum":["ANOMALY","RELATIVE","TIME_BASED","ABSOLUTE"]},"warning":{"type":"number"}}},"AnomalyConfig":{"type":"object","title":"AnomalyConfig","required":["successSensitivityLevel"],"properties":{"successSensitivityLevel":{"type":"string","enum":["HIGH","MEDIUM","LOW"]},"warningSensitivityLevel":{"type":["string","null"],"enum":["HIGH","MEDIUM","LOW"]}}},"AnomalyThresholdConfig":{"type":"object","title":"AnomalyThresholdConfig","required":["config","type"],"properties":{"config":{"$ref":"#/components/schemas/AnomalyConfig"},"success":{"type":"number"},"type":{"type":"string","enum":["ANOMALY","RELATIVE","TIME_BASED","ABSOLUTE"]},"warning":{"type":"number"}}},"ChangesByConfig":{"type":"object","title":"ChangesByConfig","required":["direction","operator","success","unit","isDirectional"],"properties":{"direction":{"type":"string","enum":["ABOVE","BELOW","RANGE","CHANGES_BY","DECREASED_BY","INCREASED_BY"]},"operator":{"type":"string","enum":["LEGACY","EQ","NEQ","GT","GTE","LT","LTE"]},"success":{"type":"number"},"unit":{"type":"string","enum":["PERCENTAGE","ABSOLUTE"]},"warning":{"type":"number"},"isDirectional":{"type":"boolean"}}},"DecreasedByConfig":{"type":"object","title":"DecreasedByConfig","required":["direction","operator","success","unit","isDirectional"],"properties":{"direction":{"type":"string","enum":["ABOVE","BELOW","RANGE","CHANGES_BY","DECREASED_BY","INCREASED_BY"]},"operator":{"type":"string","enum":["LEGACY","EQ","NEQ","GT","GTE","LT","LTE"]},"success":{"type":"number"},"unit":{"type":"string","enum":["PERCENTAGE","ABSOLUTE"]},"warning":{"type":"number"},"isDirectional":{"type":"boolean"}}},"IncreasedByConfig":{"type":"object","title":"IncreasedByConfig","required":["direction","operator","success","unit","isDirectional"],"properties":{"direction":{"type":"string","enum":["ABOVE","BELOW","RANGE","CHANGES_BY","DECREASED_BY","INCREASED_BY"]},"operator":{"type":"string","enum":["LEGACY","EQ","NEQ","GT","GTE","LT","LTE"]},"success":{"type":"number"},"unit":{"type":"string","enum":["PERCENTAGE","ABSOLUTE"]},"warning":{"type":"number"},"isDirectional":{"type":"boolean"}}},"RelativeConfig":{"type":"object","title":"RelativeConfig","oneOf":[{"$ref":"#/components/schemas/ChangesByConfig"},{"$ref":"#/components/schemas/DecreasedByConfig"},{"$ref":"#/components/schemas/IncreasedByConfig"}],"discriminator":{"propertyName":"type","mapping":{"io.ad.catalog.api.model.quality.ChangesByConfig":"#/components/schemas/ChangesByConfig","io.ad.catalog.api.model.quality.DecreasedByConfig":"#/components/schemas/DecreasedByConfig","io.ad.catalog.api.model.quality.IncreasedByConfig":"#/components/schemas/IncreasedByConfig"}}},"LookBackConfig":{"type":"object","title":"LookBackConfig","required":["window","windowType"],"properties":{"window":{"type":"integer"},"windowType":{"type":"string","enum":["RUNS","DAYS","HOURS","MINUTES"]}}},"OperationalConfig":{"type":"object","title":"OperationalConfig","required":["lookBack"],"properties":{"lookBack":{"$ref":"#/components/schemas/LookBackConfig"}}},"RelativeThresholdConfig":{"type":"object","title":"RelativeThresholdConfig","required":["config","operationalConfig","type"],"properties":{"config":{"$ref":"#/components/schemas/RelativeConfig"},"operationalConfig":{"$ref":"#/components/schemas/OperationalConfig"},"success":{"type":"number"},"type":{"type":"string","enum":["ANOMALY","RELATIVE","TIME_BASED","ABSOLUTE"]},"warning":{"type":"number"}}},"TimeBasedConfig":{"type":"object","title":"TimeBasedConfig","required":["lookBackWindowType","successLookBackWindow"],"properties":{"lookBackWindowType":{"type":"string","enum":["RUNS","DAYS","HOURS","MINUTES"]},"successLookBackWindow":{"type":"integer"},"warningLookBackWindow":{"type":"integer"}}},"TimeBasedThresholdConfig":{"type":"object","title":"TimeBasedThresholdConfig","required":["config","type"],"properties":{"config":{"$ref":"#/components/schemas/TimeBasedConfig"},"success":{"type":"number"},"type":{"type":"string","enum":["ANOMALY","RELATIVE","TIME_BASED","ABSOLUTE"]},"warning":{"type":"number"}}},"RuleThresholdConfiguration":{"type":["object","null"],"title":"RuleThresholdConfiguration","oneOf":[{"$ref":"#/components/schemas/AbsoluteThresholdConfig"},{"$ref":"#/components/schemas/AnomalyThresholdConfig"},{"$ref":"#/components/schemas/RelativeThresholdConfig"},{"$ref":"#/components/schemas/TimeBasedThresholdConfig"}],"discriminator":{"propertyName":"type","mapping":{"io.ad.catalog.api.model.quality.AbsoluteThresholdConfig":"#/components/schemas/AbsoluteThresholdConfig","io.ad.catalog.api.model.quality.AnomalyThresholdConfig":"#/components/schemas/AnomalyThresholdConfig","io.ad.catalog.api.model.quality.RelativeThresholdConfig":"#/components/schemas/RelativeThresholdConfig","io.ad.catalog.api.model.quality.TimeBasedThresholdConfig":"#/components/schemas/TimeBasedThresholdConfig"}}},"QualityRule":{"type":"object","title":"QualityRule","required":["additionalPersistedColumns","archived","backingAssets","continueExecutionOnFailure","createdAt","enabled","executionSequence","includeInQualityScore","isCompositeRule","isProtectedResource","markedForDeletion","name","policyScoreStrategy","policyTransformUDFS","rightSparkSQLFilterType","scheduled","sparkSQLFilterType","thresholdLevel","timeZone","treatZeroRowsAsSuccess","type","updatedAt","version"],"properties":{"additionalPersistedColumns":{"type":"array","items":{"type":"string"}},"analyticsPipelineId":{"type":"integer"},"anomalyStrengthThreshold":{"type":["string","null"],"enum":["HIGH","MEDIUM","LOW"]},"archivalReason":{"type":["string","null"]},"archived":{"type":"boolean"},"autoCreated":{"type":"boolean"},"autoRetries":{"type":"integer"},"autoRetryEnabled":{"type":"boolean"},"backingAssets":{"type":"array","items":{"$ref":"#/components/schemas/BackingAsset"}},"continueExecutionOnFailure":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"createdBy":{"type":["string","null"]},"deletionReason":{"type":["string","null"]},"description":{"type":["string","null"]},"enabled":{"type":"boolean"},"engineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"executionSequence":{"type":"integer"},"executionTimeoutInMinutes":{"type":"integer"},"filter":{"type":["string","null"]},"id":{"type":"integer"},"includeInQualityScore":{"type":"boolean"},"isCompositeRule":{"type":"boolean"},"isProtectedResource":{"type":"boolean"},"jobSchedule":{"oneOf":[{"$ref":"#/components/schemas/JobSchedule"},{"type":"null"}]},"labels":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Label"}},"lastUpdatedBy":{"type":["string","null"]},"leftCustomSqlConfig":{"oneOf":[{"$ref":"#/components/schemas/CustomSqlConfig"},{"type":"null"}]},"markedForDeletion":{"type":"boolean"},"markedForDeletionAt":{"type":"integer"},"name":{"type":"string"},"notificationChannels":{"oneOf":[{"$ref":"#/components/schemas/NotificationPayload"},{"type":"null"}]},"parentId":{"type":"integer"},"policyGroups":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PolicyGroup"}},"policyScoreStrategy":{"type":"string","enum":["CUSTOM","WEIGHTAGE","RULES"]},"policyTransformUDFS":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTransformUDF"}},"resourceStrategyType":{"type":["string","null"],"enum":["INVENTORY","CUSTOM"]},"rightCustomSqlConfig":{"oneOf":[{"$ref":"#/components/schemas/CustomSqlConfig"},{"type":"null"}]},"rightEngineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"rightFilter":{"type":["string","null"]},"rightSparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"rightSparkSQLDynamicFilterVariableMapping":{"oneOf":[{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"},{"type":"null"}]},"rightSparkSQLFilterType":{"type":"string","enum":["STATIC","DYNAMIC"]},"ruleSetId":{"type":"integer"},"schedule":{"type":["string","null"]},"scheduled":{"type":"boolean"},"segments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ShortSegment"}},"selectedResourceInventory":{"type":["string","null"]},"sparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"sparkResourceConfig":{"oneOf":[{"$ref":"#/components/schemas/SparkResourceConfig"},{"type":"null"}]},"sparkSQLDynamicFilterVariableMapping":{"oneOf":[{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"},{"type":"null"}]},"sparkSQLFilterType":{"type":"string","enum":["STATIC","DYNAMIC"]},"subType":{"type":["string","null"],"enum":["ASSET","SQL"]},"tags":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RuleTag"}},"tenantId":{"type":["string","null"]},"thresholdLevel":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"timeZone":{"type":"string"},"totalExecutionTimeoutInMinutes":{"type":"integer"},"treatZeroRowsAsSuccess":{"type":"boolean"},"type":{"type":"string","enum":["DATA_QUALITY","RECONCILIATION","EQUALITY","DATA_DRIFT","SCHEMA_DRIFT","DATA_CADENCE","PROFILE_ANOMALY","AUTO_ANOMALY"]},"updatedAt":{"$ref":"#/components/schemas/DateTime"},"version":{"type":"integer"}}},"EnableRuleRequest":{"type":"object","title":"EnableRuleRequest","required":["enable"],"properties":{"enable":{"type":"boolean"}}},"RuleResponse":{"type":"object","title":"RuleResponse","required":["rule"],"properties":{"rule":{"$ref":"#/components/schemas/QualityRule"}}},"RuleTagRequest":{"type":"object","title":"RuleTagRequest","required":["ruleTag"],"properties":{"ruleTag":{"$ref":"#/components/schemas/RuleTag"}}},"ConnectionTestResult":{"type":"object","title":"ConnectionTestResult","required":["isParentAvailable","parentList","status"],"properties":{"isParentAvailable":{"type":"boolean"},"message":{"type":["string","null"]},"parentList":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Any"}},"requestId":{"type":["string","null"]},"status":{"type":"string"}}},"ExecutionCancellationResponse":{"type":"object","title":"ExecutionCancellationResponse","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/ConnectionTestResult"}}},"Item":{"type":"object","title":"Item","required":["aggregateType","executionOrder","isArchived","isDimension","isWarning","measurementType","name","resultThreshold","ruleVersion","weightage"],"properties":{"aggregateType":{"type":"string","enum":["SUM","AVG","MIN","MAX","RULE","CUSTOM","COUNT"]},"associatedDQRecommendationId":{"type":"integer"},"bulkPolicyDqRuleId":{"type":"integer"},"businessExplanation":{"type":["string","null"]},"columnName":{"type":["string","null"]},"executionInputs":{"type":["object","null"],"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]}},"executionOrder":{"type":"integer"},"id":{"type":"integer"},"isArchived":{"type":"boolean"},"isDimension":{"type":"boolean"},"isWarning":{"type":"boolean"},"labels":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Label"}},"measurementType":{"type":"string","enum":["MISSING_VALUES","FRESHNESS_CHECK","DATATYPE_MATCH","REGEX_MATCH","VALUES_IN_LIST","VALUES_IN_LOOKUP","DISTINCTNESS_CHECK","DUPLICATE_ROWS_CHECK","PRECISION_SCALE_CHECK","BUSINESS_MEASURE","TAG_MATCH","RANGE_MATCH","SIZE_CHECK","CUSTOM","UDF_PREDICATE","SQL_METRIC","AGGREGATES","DATA_FRESHNESS","RECORD_COUNT_TOTAL","RECORD_COUNT_DRIFT","DATA_VOLUME_TOTAL","DATA_VOLUME_DRIFT","FILE_COUNT_TOTAL","FILE_COUNT_DRIFT","CHANGE_IN_FILE_SIZE","ABSOLUTE_FILE_SIZE","RAW_ABSOLUTE_SIZE","RAW_DATA_FRESHNESS","MESSAGES_COUNT_TOTAL","MESSAGES_COUNT_DRIFT","CHANGE_IN_TOPIC_SIZE","ABSOLUTE_TOPIC_SIZE"]},"name":{"type":"string"},"resultThreshold":{"type":"number"},"ruleExpression":{"type":["string","null"]},"ruleId":{"type":"integer"},"ruleVersion":{"type":"integer"},"thresholdConfig":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"value":{"type":["object","null"],"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]}},"weightage":{"type":"number"}}},"Rule":{"type":"object","title":"Rule","required":["backingAssetId","continueExecutionOnFailure","executionSequence","isCompositeRule","isSegmented","items","policyScoreStrategy","ruleId","treatZeroRowsAsSuccess"],"properties":{"backingAssetId":{"type":"integer"},"continueExecutionOnFailure":{"type":"boolean"},"customSqlConfig":{"oneOf":[{"$ref":"#/components/schemas/CustomSqlConfig"},{"type":"null"}]},"engineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"executionSequence":{"type":"integer"},"filter":{"type":["string","null"]},"id":{"type":"integer"},"isCompositeRule":{"type":"boolean"},"isSegmented":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"jobSchedule":{"oneOf":[{"$ref":"#/components/schemas/JobSchedule"},{"type":"null"}]},"parentId":{"type":"integer"},"policyScoreStrategy":{"type":"string","enum":["CUSTOM","WEIGHTAGE","RULES"]},"ruleId":{"type":"integer"},"segments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ShortSegment"}},"subType":{"type":["string","null"],"enum":["ASSET","SQL"]},"tenantId":{"type":["string","null"]},"transformUDFs":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PolicyTransformUDF"}},"treatZeroRowsAsSuccess":{"type":"boolean"}}},"Engine":{"type":"object","title":"Engine","required":["type"],"properties":{"config":{"oneOf":[{"$ref":"#/components/schemas/EngineConfig"},{"type":"null"}]},"type":{"type":"string","enum":["SPARK_ASYNC","POD_ASYNC","STANDALONE_ASYNC","PUSHDOWN_ASYNC"]}}},"DataplaneEngine":{"type":"object","title":"DataplaneEngine","required":["current","displayName"],"properties":{"current":{"type":"string","enum":["SPARK","JDBC_SQL","POD"]},"displayName":{"type":"string"},"supported":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Engine"}}}},"DataQualityRule":{"type":"object","title":"DataQualityRule","required":["additionalPersistedColumns","archived","backingAsset","continueExecutionOnFailure","createdAt","enabled","executionSequence","includeInQualityScore","isCompositeRule","isProtectedResource","name","policyScoreStrategy","scheduled","sparkSQLFilterType","thresholdLevel","timeZone","treatZeroRowsAsSuccess","type","updatedAt","version"],"properties":{"additionalPersistedColumns":{"type":"array","items":{"type":"string"}},"archivalReason":{"type":["string","null"]},"archived":{"type":"boolean"},"autoCreated":{"type":"boolean"},"autoRetryEnabled":{"type":"boolean"},"backingAsset":{"$ref":"#/components/schemas/BackingAsset"},"continueExecutionOnFailure":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"createdBy":{"type":["string","null"]},"customSqlConfig":{"oneOf":[{"$ref":"#/components/schemas/CustomSqlConfig"},{"type":"null"}]},"description":{"type":["string","null"]},"enabled":{"type":"boolean"},"engineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"executionSequence":{"type":"integer"},"executionTimeoutInMinutes":{"type":"integer"},"filter":{"type":["string","null"]},"id":{"type":"integer"},"includeInQualityScore":{"type":"boolean"},"isCompositeRule":{"type":"boolean"},"isProtectedResource":{"type":"boolean"},"jobSchedule":{"oneOf":[{"$ref":"#/components/schemas/JobSchedule"},{"type":"null"}]},"labels":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Label"}},"lastUpdatedBy":{"type":["string","null"]},"name":{"type":"string"},"notificationChannels":{"oneOf":[{"$ref":"#/components/schemas/NotificationPayload"},{"type":"null"}]},"parentId":{"type":"integer"},"policyGroups":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PolicyGroup"}},"policyScoreStrategy":{"type":"string","enum":["CUSTOM","WEIGHTAGE","RULES"]},"resourceStrategyType":{"type":["string","null"],"enum":["INVENTORY","CUSTOM"]},"ruleSetId":{"type":"integer"},"schedule":{"type":["string","null"]},"scheduled":{"type":"boolean"},"segments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ShortSegment"}},"selectedResourceInventory":{"type":["string","null"]},"sparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"sparkResourceConfig":{"oneOf":[{"$ref":"#/components/schemas/SparkResourceConfig"},{"type":"null"}]},"sparkSQLDynamicFilterVariableMapping":{"oneOf":[{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"},{"type":"null"}]},"sparkSQLFilterType":{"type":"string","enum":["STATIC","DYNAMIC"]},"subType":{"type":["string","null"],"enum":["ASSET","SQL"]},"tags":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RuleTag"}},"tenantId":{"type":["string","null"]},"thresholdLevel":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"timeZone":{"type":"string"},"totalExecutionTimeoutInMinutes":{"type":"integer"},"treatZeroRowsAsSuccess":{"type":"boolean"},"type":{"type":"string","enum":["DATA_QUALITY","RECONCILIATION","EQUALITY","DATA_DRIFT","SCHEMA_DRIFT","DATA_CADENCE","PROFILE_ANOMALY","AUTO_ANOMALY"]},"updatedAt":{"$ref":"#/components/schemas/DateTime"},"version":{"type":"integer"}}},"DataQuality.RuleResponse":{"type":"object","title":"DataQuality.RuleResponse","required":["rule"],"properties":{"childRules":{"type":["array","null"],"items":{"$ref":"#/components/schemas/DataQuality.RuleResponse"}},"details":{"oneOf":[{"$ref":"#/components/schemas/Rule"},{"type":"null"}]},"engine":{"oneOf":[{"$ref":"#/components/schemas/DataplaneEngine"},{"type":"null"}]},"rule":{"$ref":"#/components/schemas/DataQualityRule"}}},"DataplaneJobStatus":{"type":"object","title":"DataplaneJobStatus","required":["id","isFinished","status"],"properties":{"details":{"type":["string","null"]},"errorMsg":{"type":["string","null"]},"id":{"type":"string"},"isFinished":{"type":"boolean"},"result":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]},"status":{"type":"string"}}},"SparkJobStatus":{"type":"object","title":"SparkJobStatus","required":["id","isFinished","status"],"properties":{"details":{"type":["string","null"]},"errorMsg":{"type":["string","null"]},"id":{"type":"string"},"isFinished":{"type":"boolean"},"result":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]},"status":{"type":"string"}}},"AnalysisJobContext":{"type":"object","title":"AnalysisJobContext","required":["type"],"properties":{"dataplaneJobStatus":{"oneOf":[{"$ref":"#/components/schemas/DataplaneJobStatus"},{"type":"null"}]},"sparkJobStatus":{"oneOf":[{"$ref":"#/components/schemas/SparkJobStatus"},{"type":"null"}]},"statusRetryCount":{"type":"integer"},"type":{"type":"string"}}},"JobSpec":{"type":"object","title":"JobSpec","required":["artifactFacts"],"properties":{"artifactFacts":{"type":"array","items":{"$ref":"#/components/schemas/Artifact"}}}},"EngineConfig":{"type":"object","title":"EngineConfig"},"DataplaneRequest":{"type":"object","title":"DataplaneRequest","required":["engine","method","requestId"],"properties":{"engine":{"$ref":"#/components/schemas/Engine"},"method":{"type":"string","enum":["SUBMIT","CANCEL","STATUS"]},"requestId":{"type":"string"}}},"DataplaneJob":{"type":"object","title":"DataplaneJob","required":["executionStatus","jobType","startedAt"],"properties":{"analysisJobContext":{"oneOf":[{"$ref":"#/components/schemas/AnalysisJobContext"},{"type":"null"}]},"analysisServiceJobId":{"type":"integer"},"analyticsPipelineId":{"type":"integer"},"assetId":{"type":"integer"},"assetUid":{"type":["string","null"]},"autoRetries":{"type":"integer"},"autoRetryEnabled":{"type":"boolean"},"createdAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"dataSourceId":{"type":["string","null"]},"dataSourceType":{"type":["string","null"]},"engineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"errorMessage":{"type":["string","null"]},"executionId":{"type":"integer"},"executionStatus":{"type":"string","enum":["WAITING","SKIPPED","SUBMITTED","QUEUED","IN_PROGRESS","ABORTED","FAILED","POSTPROCESSING","ANOMALY_DETECTION","EXECUTION_RESULT","SUCCESSFUL"]},"finishedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"jobSpec":{"oneOf":[{"$ref":"#/components/schemas/JobSpec"},{"type":"null"}]},"jobState":{"type":["string","null"],"enum":["ACKNOWLEDGED","SUBMITTED","QUEUED","SKIPPED","RUNNING","READ_DATA","REFERENCE_DATA","PROFILE_STAGE_1","PROFILE_STAGE_2","PROFILE_STAGE_3","PROFILE_STAGE_4","DQ_BATCH_RULES","DQ_ROW_RULES","DQ_CUSTOM_RULES","DQ_SEGMENT","DQ_GOOD_RESULT_STORE","DQ_BAD_RESULT_STORE","VALIDATE","PROCESSING","PREPARE_RESULT","SEND_RESULT","SEND_RESULT_FAILED","SUCCESSFUL","FAILED","ABORTED","WAITING","METRICS_REQUEST_SENT","PARTIAL_RESPONSE_PUBLISHED","COMPLETE_RESPONSE_PUBLISHED","METRICS_RESPONSE_RECEIVED","ANOMALY_DETECTION_INITIATED","PARTIAL_ANOMALY_RESULT_RECEIVED","COMPLETE_ANOMALY_RESULT_RECEIVED","POLICY_EXECUTION_SUCCESSFUL","POLICY_EXECUTION_FAILURE","EXECUTION_RESULT"]},"jobType":{"type":"string","enum":["SAMPLE_DATA","FILE_INFO_CRAWLER","SAMPLE_DATA_CRAWLER","UDF_VALIDATION","SQL_VIEW_SAMPLE_DATA","VISUAL_VIEW_SAMPLE_DATA","DATA_VIOLATIONS_SAMPLE_DATA","DATA_VIOLATIONS_SAMPLE_DATA_S3","DATA_VIOLATIONS_SAMPLE_DATA_ADLS","DATA_VIOLATIONS_SAMPLE_DATA_GCS","DATA_VIOLATIONS_SAMPLE_DATA_HDFS","DATA_VIOLATIONS_SAMPLE_DATA_LOCAL","PROFILE","DATA_QUALITY","RECONCILIATION","ROW_COUNT_EQUALITY","FILE_CRAWLER","KAFKA_CRAWLER","PUBSUB_CRAWLER","CRAWLER","ASSET_FILE_MONITORING","ASSET_MONITORING","ASSET_REFERENCE_VALIDATION","AUTO_TAG","EXECUTION_RESULT","CONNECTION_VALIDATION","PARENT_LIST","CADENCE","AUTO_ANOMALY","SQL_VALIDATION","RESULT","DATA_VIOLATIONS","DOWNLOAD_DATA_VIOLATIONS","FRESHNESS","DATA_SOURCE_QUERY"]},"lastHealthUpdateAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"request":{"oneOf":[{"$ref":"#/components/schemas/DataplaneRequest"},{"type":"null"}]},"requestId":{"type":["string","null"]},"resourceStrategyType":{"type":["string","null"],"enum":["INVENTORY","CUSTOM"]},"selectedResourceInventory":{"type":["string","null"]},"sparkClusterContext":{"type":["string","null"],"enum":["LOCAL","LIVY","DATABRICKS","KUBERNETES","DATAPROC"]},"sparkResourceConfig":{"oneOf":[{"$ref":"#/components/schemas/SparkResourceConfig"},{"type":"null"}]},"startedAt":{"$ref":"#/components/schemas/DateTime"},"startedRunningAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"tenantId":{"type":["string","null"]},"updatedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]}}},"Marker":{"type":"object","title":"Marker","required":["type"],"properties":{"type":{"type":"string"}}},"GenericRuleExecution":{"type":"object","title":"GenericRuleExecution","required":["dataPersistenceEnabled","executionMode","executionStatus","executionType","includeInQualityScore","resultStatus","ruleId","ruleSelectionEnabled","ruleVersion","startedAt"],"properties":{"analysisJob":{"oneOf":[{"$ref":"#/components/schemas/DataplaneJob"},{"type":"null"}]},"autoRetries":{"type":"integer"},"autoRetryEnabled":{"type":"boolean"},"dataPersistenceEnabled":{"type":"boolean"},"engineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"executionError":{"type":["string","null"]},"executionMode":{"type":"string","enum":["SCHEDULED","MANUAL","WEBHOOK","API"]},"executionStatus":{"type":"string","enum":["STARTED","RUNNING","ERRORED","WARNING","SUCCESSFUL","ABORTED","SKIPPED","WAITING","ANOMALY_DETECTION","EXECUTION_RESULT"]},"executionType":{"type":"string","enum":["SELECTIVE","FULL","INCREMENTAL"]},"finishedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"id":{"type":"integer"},"includeInQualityScore":{"type":"boolean"},"lastMarker":{"oneOf":[{"$ref":"#/components/schemas/Marker"},{"type":"null"}]},"leftLastMarker":{"oneOf":[{"$ref":"#/components/schemas/Marker"},{"type":"null"}]},"leftMarkerConfig":{"oneOf":[{"$ref":"#/components/schemas/MarkerConfig"},{"type":"null"}]},"markerConfig":{"oneOf":[{"$ref":"#/components/schemas/MarkerConfig"},{"type":"null"}]},"parentId":{"type":"integer"},"persistencePath":{"type":["string","null"]},"resetPoint":{"type":"integer"},"resourceStrategyType":{"type":["string","null"],"enum":["INVENTORY","CUSTOM"]},"resultPersistencePath":{"type":["object","null"],"additionalProperties":{"type":"string"}},"resultStatus":{"type":"string","enum":["STARTED","RUNNING","ERRORED","WARNING","SUCCESSFUL","ABORTED","SKIPPED","WAITING","ANOMALY_DETECTION","EXECUTION_RESULT"]},"rightLastMarker":{"oneOf":[{"$ref":"#/components/schemas/Marker"},{"type":"null"}]},"rightMarkerConfig":{"oneOf":[{"$ref":"#/components/schemas/MarkerConfig"},{"type":"null"}]},"ruleId":{"type":"integer"},"ruleName":{"type":["string","null"]},"ruleSelectionEnabled":{"type":"boolean"},"ruleType":{"type":["string","null"],"enum":["DATA_QUALITY","RECONCILIATION","EQUALITY","DATA_DRIFT","SCHEMA_DRIFT","DATA_CADENCE","PROFILE_ANOMALY","AUTO_ANOMALY"]},"ruleVersion":{"type":"integer"},"selectedResourceInventory":{"type":["string","null"]},"sparkResourceConfig":{"oneOf":[{"$ref":"#/components/schemas/SparkResourceConfig"},{"type":"null"}]},"startedAt":{"$ref":"#/components/schemas/DateTime"},"thresholdLevel":{"$ref":"#/components/schemas/RuleThresholdConfiguration"}}},"RootCauseAnalysis":{"type":"object","title":"RootCauseAnalysis","required":["bad","badFraction","good","goodFraction","key","totalFraction"],"properties":{"bad":{"type":"integer"},"badFraction":{"type":"number"},"good":{"type":"integer"},"goodFraction":{"type":"number"},"key":{"type":"string"},"totalFraction":{"type":"number"}}},"ItemSegment":{"type":"object","title":"ItemSegment","required":["executionId","itemExecutionId","rowsScanned","ruleItemId","segmentHash"],"properties":{"error":{"type":["string","null"]},"executionId":{"type":"integer"},"executionInputs":{"type":["object","null"],"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]}},"id":{"type":"integer"},"itemExecutionId":{"type":"integer"},"result":{"type":"number"},"rowsFailed":{"type":"integer"},"rowsScanned":{"type":"integer"},"ruleItemId":{"type":"integer"},"segmentHash":{"type":"string"},"status":{"type":["string","null"]},"thresholdConfig":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"value":{"type":["string","null"]}}},"ItemExecution":{"type":"object","title":"ItemExecution","required":["executionId","isWarning","ruleItemId","startedAt","threshold","weightage"],"properties":{"businessItemId":{"type":"integer"},"error":{"type":["string","null"]},"executionId":{"type":"integer"},"executionInputs":{"type":["object","null"],"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]}},"finishedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"id":{"type":"integer"},"isWarning":{"type":"boolean"},"item":{"oneOf":[{"$ref":"#/components/schemas/Item"},{"type":"null"}]},"rca":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RootCauseAnalysis"}},"result":{"type":["string","null"]},"resultPercentage":{"type":"number"},"rowsFailed":{"type":"integer"},"rowsScanned":{"type":"integer"},"rowsWarning":{"type":"integer"},"ruleItemId":{"type":"integer"},"segmentHash":{"type":["string","null"]},"segments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ItemSegment"}},"startedAt":{"$ref":"#/components/schemas/DateTime"},"status":{"type":["string","null"]},"threshold":{"type":"number"},"thresholdConfig":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"value":{"type":["string","null"]},"weightage":{"type":"number"}}},"Execution":{"type":"object","title":"Execution","required":["execution","items","policyScoreStrategy","treatZeroRowsAsSuccess"],"properties":{"execution":{"$ref":"#/components/schemas/GenericRuleExecution"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemExecution"}},"policyScoreStrategy":{"type":"string","enum":["CUSTOM","WEIGHTAGE","RULES"]},"treatZeroRowsAsSuccess":{"type":"boolean"}}},"ExecutionsResponse":{"type":"object","title":"ExecutionsResponse","required":["executions","meta"],"properties":{"executions":{"type":"array","items":{"$ref":"#/components/schemas/Execution"}},"meta":{"$ref":"#/components/schemas/MetaData"}}},"PolicyExecutionMarkerConfig":{"type":"object","title":"PolicyExecutionMarkerConfig","required":["assetId","markerConfig"],"properties":{"assetId":{"type":"integer"},"markerConfig":{"$ref":"#/components/schemas/MarkerConfig"}}},"PolicyExecutionRequest":{"type":"object","title":"PolicyExecutionRequest","required":["columnVariables","executionType","includeInQualityScore","resourceStrategyType"],"properties":{"analysisJobRequestId":{"type":["string","null"]},"analyticsPipelineId":{"type":"integer"},"assetDirection":{"type":["string","null"]},"autoRetryEnabled":{"type":"boolean"},"columnVariables":{"type":"array","items":{"$ref":"#/components/schemas/ColumnVariable"}},"engineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"executionType":{"type":"string","enum":["SELECTIVE","FULL","INCREMENTAL"]},"includeInQualityScore":{"type":"boolean"},"markerConfigs":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PolicyExecutionMarkerConfig"}},"monitorExecutionId":{"type":"integer"},"pipelineAutomationExecutionId":{"type":"integer"},"pipelineRunId":{"type":"integer"},"profileId":{"type":"integer"},"resourceStrategyType":{"type":"string","enum":["INVENTORY","CUSTOM"]},"rightEngineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"rightSparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"rightSparkSQLDynamicFilterVariableMapping":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"}},"ruleItemSelections":{"type":["array","null"],"items":{"type":"integer"}},"selectedResourceInventory":{"type":["string","null"]},"sourceExecutionId":{"type":"integer"},"sparkAppName":{"type":["string","null"]},"sparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"sparkResourceConfig":{"oneOf":[{"$ref":"#/components/schemas/SparkResourceConfig"},{"type":"null"}]},"sparkSQLDynamicFilterVariableMapping":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"}}}},"DataQuality":{"type":"object","title":"DataQuality"},"ScheduleRequest":{"type":"object","title":"ScheduleRequest","required":["scheduled"],"properties":{"cronExpression":{"type":["string","null"]},"scheduled":{"type":"boolean"},"timeZone":{"type":["string","null"]}}},"RuleItemResult":{"type":"object","title":"RuleItemResult","required":["dimension","id","includeInQualityScore","ruleItemId","threshold","weightage"],"properties":{"dimension":{"type":"string","enum":["UNIQUENESS","VALIDITY","ACCURACY","CONSISTENCY","COMPLETENESS","TIMELINESS","OTHERS"]},"error":{"type":["string","null"]},"id":{"type":"integer"},"includeInQualityScore":{"type":"boolean"},"isWarning":{"type":"boolean"},"name":{"type":["string","null"]},"resultPercent":{"type":"number"},"ruleItemId":{"type":"integer"},"status":{"type":["string","null"],"enum":["STARTED","RUNNING","ERRORED","WARNING","SUCCESSFUL","ABORTED","SKIPPED","WAITING","ANOMALY_DETECTION","EXECUTION_RESULT"]},"success":{"type":"boolean"},"threshold":{"type":"number"},"weightage":{"type":"number"}}},"RuleExecutionResult":{"type":"object","title":"RuleExecutionResult","required":["ruleExecutionType","status"],"properties":{"ruleExecutionType":{"type":"string","enum":["RECONCILIATION_RULE_TYPE_EXECUTION","DQ_RULE_TYPE_EXECUTION","DATA_DRIFT_EXECUTION","SCHEMA_DRIFT_EXECUTION","DATA_CADENCE_TYPE_EXECUTION","PROFILE_ANOMALY_TYPE_EXECUTION","AUTO_ANOMALY_TYPE_EXECUTION"]},"status":{"type":"string","enum":["STARTED","RUNNING","ERRORED","WARNING","SUCCESSFUL","ABORTED","SKIPPED","WAITING","ANOMALY_DETECTION","EXECUTION_RESULT"]}}},"ExecutionResult":{"type":"object","title":"ExecutionResult","required":["execution","items","meta","result"],"properties":{"childExecutions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ExecutionResult"}},"execution":{"$ref":"#/components/schemas/GenericRuleExecution"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RuleItemResult"}},"meta":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Any"}},"result":{"$ref":"#/components/schemas/RuleExecutionResult"}}},"ColumnMapping":{"type":"object","title":"ColumnMapping","required":["ignoreNullValues","isArchived","isJoinColumnUsedForMeasure","isWarning","leftColumnName","mappingType","name","operation","rightColumnName","ruleVersion","useForJoining","weightage"],"properties":{"businessExplanation":{"type":["string","null"]},"deletedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"id":{"type":"integer"},"ignoreNullValues":{"type":"boolean"},"isArchived":{"type":"boolean"},"isJoinColumnUsedForMeasure":{"type":"boolean"},"isWarning":{"type":"boolean"},"labels":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Label"}},"leftColumnName":{"type":"string"},"mappingType":{"type":"string","enum":["AUTO","MANUAL"]},"name":{"type":"string"},"operation":{"type":"string","enum":["EQ","NOT_EQ","GTE","GT","LTE","LT"]},"reconciliationRuleId":{"type":"integer"},"rightColumnName":{"type":"string"},"ruleVersion":{"type":"integer"},"useForJoining":{"type":"boolean"},"weightage":{"type":"number"}}},"Reconciliation.Item":{"type":"object","title":"Reconciliation.Item","required":["executionOrder","measurementType","version"],"properties":{"executionOrder":{"type":"integer"},"id":{"type":"integer"},"measurementType":{"type":"string","enum":["EQUALITY","COUNT","PROFILE_EQUALITY","HASHED_EQUALITY","TIMELINESS","CUSTOM","ROW_COUNT_EQUALITY"]},"ruleId":{"type":"integer"},"thresholdConfig":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"version":{"type":"integer"}}},"Reconciliation.Rule":{"type":"object","title":"Reconciliation.Rule","required":["columnMappings","continueExecutionOnFailure","isCompositeRule","isSegmented","items","leftBackingAssetId","leftSparkSQLFilterType","rightBackingAssetId","rightSparkSQLFilterType","ruleId","ruleVersion","timeSecondsOffset","treatZeroRowsAsSuccess"],"properties":{"columnMappings":{"type":"array","items":{"$ref":"#/components/schemas/ColumnMapping"}},"continueExecutionOnFailure":{"type":"boolean"},"delayInMinutes":{"type":"integer"},"id":{"type":"integer"},"isCompositeRule":{"type":"boolean"},"isSegmented":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Reconciliation.Item"}},"joinType":{"type":["string","null"],"enum":["INNER","LEFT","RIGHT","FULL","CROSS"]},"leftBackingAssetId":{"type":"integer"},"leftCustomSqlConfig":{"oneOf":[{"$ref":"#/components/schemas/CustomSqlConfig"},{"type":"null"}]},"leftEngineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"leftFilter":{"type":["string","null"]},"leftSparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"leftSparkSQLDynamicFilterVariableMapping":{"oneOf":[{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"},{"type":"null"}]},"leftSparkSQLFilterType":{"type":"string","enum":["STATIC","DYNAMIC"]},"rightBackingAssetId":{"type":"integer"},"rightCustomSqlConfig":{"oneOf":[{"$ref":"#/components/schemas/CustomSqlConfig"},{"type":"null"}]},"rightEngineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"rightFilter":{"type":["string","null"]},"rightSparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"rightSparkSQLDynamicFilterVariableMapping":{"oneOf":[{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"},{"type":"null"}]},"rightSparkSQLFilterType":{"type":"string","enum":["STATIC","DYNAMIC"]},"ruleId":{"type":"integer"},"ruleVersion":{"type":"integer"},"segments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ShortSegment"}},"subType":{"type":["string","null"],"enum":["ASSET","SQL"]},"timeSecondsOffset":{"type":"integer"},"treatZeroRowsAsSuccess":{"type":"boolean"}}},"ReconciliationRule":{"type":"object","title":"ReconciliationRule","required":["archived","createdAt","enabled","includeInQualityScore","isProtectedResource","leftBackingAsset","leftSparkSQLFilterType","name","rightBackingAsset","rightSparkSQLFilterType","scheduled","thresholdLevel","timeSecondsOffset","timeZone","treatZeroRowsAsSuccess","type","updatedAt","version"],"properties":{"analyticsPipelineId":{"type":"integer"},"archivalReason":{"type":["string","null"]},"archived":{"type":"boolean"},"autoCreated":{"type":"boolean"},"autoRetryEnabled":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"createdBy":{"type":["string","null"]},"delayInMinutes":{"type":"integer"},"description":{"type":["string","null"]},"enabled":{"type":"boolean"},"engineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"executionTimeoutInMinutes":{"type":"integer"},"id":{"type":"integer"},"includeInQualityScore":{"type":"boolean"},"isProtectedResource":{"type":"boolean"},"joinType":{"type":["string","null"],"enum":["INNER","LEFT","RIGHT","FULL","CROSS"]},"labels":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Label"}},"lastUpdatedBy":{"type":["string","null"]},"leftBackingAsset":{"$ref":"#/components/schemas/BackingAsset"},"leftCustomSqlConfig":{"oneOf":[{"$ref":"#/components/schemas/CustomSqlConfig"},{"type":"null"}]},"leftFilter":{"type":["string","null"]},"leftSparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"leftSparkSQLDynamicFilterVariableMapping":{"oneOf":[{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"},{"type":"null"}]},"leftSparkSQLFilterType":{"type":"string","enum":["STATIC","DYNAMIC"]},"name":{"type":"string"},"notificationChannels":{"oneOf":[{"$ref":"#/components/schemas/NotificationPayload"},{"type":"null"}]},"policyGroups":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PolicyGroup"}},"resourceStrategyType":{"type":["string","null"],"enum":["INVENTORY","CUSTOM"]},"rightBackingAsset":{"$ref":"#/components/schemas/BackingAsset"},"rightCustomSqlConfig":{"oneOf":[{"$ref":"#/components/schemas/CustomSqlConfig"},{"type":"null"}]},"rightEngineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"rightFilter":{"type":["string","null"]},"rightSparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"rightSparkSQLDynamicFilterVariableMapping":{"oneOf":[{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"},{"type":"null"}]},"rightSparkSQLFilterType":{"type":"string","enum":["STATIC","DYNAMIC"]},"schedule":{"type":["string","null"]},"scheduled":{"type":"boolean"},"selectedResourceInventory":{"type":["string","null"]},"sparkResourceConfig":{"oneOf":[{"$ref":"#/components/schemas/SparkResourceConfig"},{"type":"null"}]},"subType":{"type":["string","null"],"enum":["ASSET","SQL"]},"tags":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RuleTag"}},"tenantId":{"type":["string","null"]},"thresholdLevel":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"timeSecondsOffset":{"type":"integer"},"timeZone":{"type":"string"},"totalExecutionTimeoutInMinutes":{"type":"integer"},"treatZeroRowsAsSuccess":{"type":"boolean"},"type":{"type":"string","enum":["DATA_QUALITY","RECONCILIATION","EQUALITY","DATA_DRIFT","SCHEMA_DRIFT","DATA_CADENCE","PROFILE_ANOMALY","AUTO_ANOMALY"]},"updatedAt":{"$ref":"#/components/schemas/DateTime"},"version":{"type":"integer"}}},"Reconciliation.RuleResponse":{"type":"object","title":"Reconciliation.RuleResponse","required":["rule"],"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/Reconciliation.Rule"},{"type":"null"}]},"rule":{"$ref":"#/components/schemas/ReconciliationRule"}}},"RuleExecution":{"type":"object","title":"RuleExecution","required":["allowRerun","autoRetryEnabled","dataPersistenceEnabled","executionMode","executionStatus","executionType","includeInQualityScore","isProtectedResource","isResourceRequestedAtRunTime","participatingColumns","policyResultStatusStrategy","resultStatus","rightSparkSQLFilterType","ruleId","ruleSelectionEnabled","ruleVersion","sparkSQLFilterType","startedAt","thresholdLevel"],"properties":{"allowRerun":{"type":"boolean"},"analysisJob":{"oneOf":[{"$ref":"#/components/schemas/DataplaneJob"},{"type":"null"}]},"analyticsPipelineId":{"type":"integer"},"autoRetries":{"type":"integer"},"autoRetryEnabled":{"type":"boolean"},"dataPersistenceEnabled":{"type":"boolean"},"driverPodName":{"type":["string","null"]},"engineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"executedBy":{"type":["string","null"]},"executionError":{"type":["string","null"]},"executionMode":{"type":"string","enum":["SCHEDULED","MANUAL","WEBHOOK","API"]},"executionRank":{"type":"integer"},"executionStatus":{"type":"string","enum":["STARTED","RUNNING","ERRORED","WARNING","SUCCESSFUL","ABORTED","SKIPPED","WAITING","ANOMALY_DETECTION","EXECUTION_RESULT"]},"executionType":{"type":"string","enum":["SELECTIVE","FULL","INCREMENTAL"]},"filter":{"type":["string","null"]},"finishedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"id":{"type":"integer"},"includeInQualityScore":{"type":"boolean"},"isProtectedResource":{"type":"boolean"},"isResourceRequestedAtRunTime":{"type":"boolean"},"jobState":{"type":["string","null"],"enum":["ACKNOWLEDGED","SUBMITTED","QUEUED","SKIPPED","RUNNING","READ_DATA","REFERENCE_DATA","PROFILE_STAGE_1","PROFILE_STAGE_2","PROFILE_STAGE_3","PROFILE_STAGE_4","DQ_BATCH_RULES","DQ_ROW_RULES","DQ_CUSTOM_RULES","DQ_SEGMENT","DQ_GOOD_RESULT_STORE","DQ_BAD_RESULT_STORE","VALIDATE","PROCESSING","PREPARE_RESULT","SEND_RESULT","SEND_RESULT_FAILED","SUCCESSFUL","FAILED","ABORTED","WAITING","METRICS_REQUEST_SENT","PARTIAL_RESPONSE_PUBLISHED","COMPLETE_RESPONSE_PUBLISHED","METRICS_RESPONSE_RECEIVED","ANOMALY_DETECTION_INITIATED","PARTIAL_ANOMALY_RESULT_RECEIVED","COMPLETE_ANOMALY_RESULT_RECEIVED","POLICY_EXECUTION_SUCCESSFUL","POLICY_EXECUTION_FAILURE","EXECUTION_RESULT"]},"lastHealthUpdateAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"lastMarker":{"oneOf":[{"$ref":"#/components/schemas/Marker"},{"type":"null"}]},"leftLastMarker":{"oneOf":[{"$ref":"#/components/schemas/Marker"},{"type":"null"}]},"leftMarkerConfig":{"oneOf":[{"$ref":"#/components/schemas/MarkerConfig"},{"type":"null"}]},"markerConfig":{"oneOf":[{"$ref":"#/components/schemas/MarkerConfig"},{"type":"null"}]},"parentId":{"type":"integer"},"participatingColumns":{"type":"array","items":{"type":"string"}},"persistencePath":{"type":["string","null"]},"pipelineAdditionalConfiguration":{"type":["object","null"],"additionalProperties":{"type":"string"}},"policyResultStatusStrategy":{"type":"string","enum":["CUSTOM","WEIGHTAGE","RULES"]},"requestId":{"type":["string","null"]},"resetPoint":{"type":"integer"},"resourceStrategyType":{"type":["string","null"],"enum":["INVENTORY","CUSTOM"]},"resultPersistencePath":{"type":["object","null"],"additionalProperties":{"type":"string"}},"resultStatus":{"type":"string","enum":["STARTED","RUNNING","ERRORED","WARNING","SUCCESSFUL","ABORTED","SKIPPED","WAITING","ANOMALY_DETECTION","EXECUTION_RESULT"]},"rightEngineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"rightFilter":{"type":["string","null"]},"rightLastMarker":{"oneOf":[{"$ref":"#/components/schemas/Marker"},{"type":"null"}]},"rightMarkerConfig":{"oneOf":[{"$ref":"#/components/schemas/MarkerConfig"},{"type":"null"}]},"rightSparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"rightSparkSQLDynamicFilterVariableMapping":{"oneOf":[{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"},{"type":"null"}]},"rightSparkSQLFilterType":{"type":"string","enum":["STATIC","DYNAMIC"]},"ruleId":{"type":"integer"},"ruleName":{"type":["string","null"]},"ruleSelectionEnabled":{"type":"boolean"},"ruleType":{"type":["string","null"],"enum":["DATA_QUALITY","RECONCILIATION","EQUALITY","DATA_DRIFT","SCHEMA_DRIFT","DATA_CADENCE","PROFILE_ANOMALY","AUTO_ANOMALY"]},"ruleVersion":{"type":"integer"},"scheduleInstanceId":{"type":["string","null"]},"selectedResourceInventory":{"type":["string","null"]},"sourceExecutionId":{"type":"integer"},"sparkFilterSelectedColumns":{"type":["array","null"],"items":{"type":"string"}},"sparkResourceConfig":{"oneOf":[{"$ref":"#/components/schemas/SparkResourceConfig"},{"type":"null"}]},"sparkSQLDynamicFilterVariableMapping":{"oneOf":[{"$ref":"#/components/schemas/RuleSparkSQLDynamicFilterVariableMapping"},{"type":"null"}]},"sparkSQLFilterType":{"type":"string","enum":["STATIC","DYNAMIC"]},"startedAt":{"$ref":"#/components/schemas/DateTime"},"thresholdLevel":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"treatZeroRowsAsSuccess":{"type":"boolean"}}},"Reconciliation.ItemExecution":{"type":"object","title":"Reconciliation.ItemExecution","required":["executionId","isError","leftAnalyticsPipelineName","rightAnalyticsPipelineName","ruleItemId","startedAt"],"properties":{"delayedLeftAnalysisJobId":{"type":"integer"},"delayedRightAnalysisJobId":{"type":"integer"},"executionId":{"type":"integer"},"finishedAt":{"oneOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"null"}]},"id":{"type":"integer"},"isError":{"type":"boolean"},"leftAnalyticsPipelineName":{"type":"string"},"leftError":{"type":["string","null"]},"leftResult":{"type":["string","null"]},"leftRowsFailed":{"type":"integer"},"leftRowsScanned":{"type":"integer"},"matchResult":{"type":["string","null"]},"measuresSelection":{"type":["array","null"],"items":{"type":"integer"}},"rightAnalyticsPipelineName":{"type":"string"},"rightError":{"type":["string","null"]},"rightResult":{"type":["string","null"]},"rightRowsFailed":{"type":"integer"},"rightRowsScanned":{"type":"integer"},"ruleItemId":{"type":"integer"},"startedAt":{"$ref":"#/components/schemas/DateTime"}}},"Reconciliation.Execution":{"type":"object","title":"Reconciliation.Execution","required":["execution","items"],"properties":{"execution":{"$ref":"#/components/schemas/RuleExecution"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Reconciliation.ItemExecution"}}}},"Reconciliation.ExecutionsResponse":{"type":"object","title":"Reconciliation.ExecutionsResponse","required":["executions","meta"],"properties":{"executions":{"type":"array","items":{"$ref":"#/components/schemas/Reconciliation.Execution"}},"meta":{"$ref":"#/components/schemas/MetaData"}}},"Reconciliation":{"type":"object","title":"Reconciliation"},"DataCadenceRule.Item":{"type":"object","title":"DataCadenceRule.Item","required":["displayName","executionOrder","measurementType","ruleVersion"],"properties":{"displayName":{"type":"string"},"executionOrder":{"type":"integer"},"id":{"type":"integer"},"measurementType":{"type":"string","enum":["DATA_FRESHNESS","RECORD_COUNT_TOTAL","RECORD_COUNT_DRIFT","DATA_VOLUME_TOTAL","DATA_VOLUME_DRIFT","FILE_COUNT_TOTAL","FILE_COUNT_DRIFT","CHANGE_IN_FILE_SIZE","ABSOLUTE_FILE_SIZE","RAW_ABSOLUTE_SIZE","RAW_DATA_FRESHNESS","MESSAGES_COUNT_TOTAL","MESSAGES_COUNT_DRIFT","CHANGE_IN_TOPIC_SIZE","ABSOLUTE_TOPIC_SIZE"]},"ruleId":{"type":"integer"},"ruleVersion":{"type":"integer"},"thresholdConfig":{"$ref":"#/components/schemas/RuleThresholdConfiguration"}}},"DataCadenceRule.Rule":{"type":"object","title":"DataCadenceRule.Rule","required":["backingAssetId","continueExecutionOnFailure","isCompositeRule","isSegmented","items","ruleId","version"],"properties":{"backingAssetId":{"type":"integer"},"continueExecutionOnFailure":{"type":"boolean"},"id":{"type":"integer"},"isCompositeRule":{"type":"boolean"},"isSegmented":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DataCadenceRule.Item"}},"ruleId":{"type":"integer"},"segments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ShortSegment"}},"version":{"type":"integer"}}},"DataCadenceRule":{"type":"object","title":"DataCadenceRule"},"DataCadenceRule.RuleResponse":{"type":"object","title":"DataCadenceRule.RuleResponse","required":["rule"],"properties":{"details":{"oneOf":[{"$ref":"#/components/schemas/DataCadenceRule.Rule"},{"type":"null"}]},"rule":{"$ref":"#/components/schemas/DataCadenceRule"}}},"ProfileAnomalyRule.Item":{"type":"object","title":"ProfileAnomalyRule.Item","required":["executionOrder","name","ruleVersion"],"properties":{"executionOrder":{"type":"integer"},"id":{"type":"integer"},"monitorColumns":{"type":["array","null"],"items":{"type":"string"}},"name":{"type":"string"},"ruleId":{"type":"integer"},"ruleVersion":{"type":"integer"},"thresholdConfig":{"$ref":"#/components/schemas/RuleThresholdConfiguration"}}},"ProfileAnomalyRule":{"type":"object","title":"ProfileAnomalyRule","required":["archived","backingAsset","createdAt","enabled","includeInQualityScore","name","scheduled","thresholdLevel","type","updatedAt","version"],"properties":{"anomalyStrengthThreshold":{"type":["string","null"],"enum":["HIGH","MEDIUM","LOW"]},"archivalReason":{"type":["string","null"]},"archived":{"type":"boolean"},"autoCreated":{"type":"boolean"},"backingAsset":{"$ref":"#/components/schemas/BackingAsset"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"createdBy":{"type":["string","null"]},"description":{"type":["string","null"]},"enabled":{"type":"boolean"},"engineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"id":{"type":"integer"},"includeInQualityScore":{"type":"boolean"},"jobSchedule":{"oneOf":[{"$ref":"#/components/schemas/JobSchedule"},{"type":"null"}]},"lastUpdatedBy":{"type":["string","null"]},"name":{"type":"string"},"notificationChannels":{"oneOf":[{"$ref":"#/components/schemas/NotificationPayload"},{"type":"null"}]},"policyGroups":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PolicyGroup"}},"schedule":{"type":["string","null"]},"scheduled":{"type":"boolean"},"sparkResourceConfig":{"oneOf":[{"$ref":"#/components/schemas/SparkResourceConfig"},{"type":"null"}]},"tags":{"type":["array","null"],"items":{"$ref":"#/components/schemas/RuleTag"}},"tenantId":{"type":["string","null"]},"thresholdLevel":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"timeZone":{"type":["string","null"]},"type":{"type":"string","enum":["DATA_QUALITY","RECONCILIATION","EQUALITY","DATA_DRIFT","SCHEMA_DRIFT","DATA_CADENCE","PROFILE_ANOMALY","AUTO_ANOMALY"]},"updatedAt":{"$ref":"#/components/schemas/DateTime"},"version":{"type":"integer"}}},"RuleRequest":{"type":"object","title":"RuleRequest","required":["items","rule"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAnomalyRule.Item"}},"rule":{"$ref":"#/components/schemas/ProfileAnomalyRule"}}},"ApplyPolicyDefinitionRequest":{"type":"object","title":"ApplyPolicyDefinitionRequest","required":["assemblyMap","uuid"],"properties":{"assemblyMap":{"type":"object","additionalProperties":{"type":"string"}},"policyOverride":{"type":"boolean"},"sqlViewOverride":{"type":"boolean"},"uuid":{"type":"string"},"visualViewOverride":{"type":"boolean"}}},"ReferenceAssetUDFRequest":{"type":"object","title":"ReferenceAssetUDFRequest","required":["referenceAssetAlias","referenceAssetColumns","referenceAssetUid"],"properties":{"referenceAssetAlias":{"type":"string"},"referenceAssetColumns":{"type":"array","items":{"type":"string"}},"referenceAssetSqlFilter":{"type":["string","null"]},"referenceAssetUid":{"type":"string"}}},"UdfTemplateRequestWithValidation":{"type":"object","title":"UdfTemplateRequestWithValidation","required":["code","description","isLookup","isMetadata","isPackage","isTemplate","language","name","override","udfDataType","udfType","useTestData","variables"],"properties":{"analyticsPipelineId":{"type":"integer"},"assetId":{"type":"integer"},"className":{"type":["string","null"]},"code":{"type":"string"},"description":{"type":"string"},"enableValidation":{"type":"boolean"},"isLookup":{"type":"boolean"},"isMetadata":{"type":"boolean"},"isPackage":{"type":"boolean"},"isTemplate":{"type":"boolean"},"labels":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Label"}},"language":{"type":"string"},"name":{"type":"string"},"override":{"type":"boolean"},"packageId":{"type":"integer"},"referenceAssets":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ReferenceAssetUDFRequest"}},"testData":{"type":["string","null"]},"transformUDFs":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PolicyTransformUDF"}},"udfDataType":{"type":"string"},"udfType":{"type":"string"},"useTestData":{"type":"boolean"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/UdfVariable"}}}},"UdfTemplateValidationRequest":{"type":"object","title":"UdfTemplateValidationRequest","required":["isCustomSql","selectedColumns","transformUDFs","useTestData","variables"],"properties":{"analyticsPipelineId":{"type":"integer"},"assetId":{"type":"integer"},"customSqlConfig":{"oneOf":[{"$ref":"#/components/schemas/CustomSqlConfig"},{"type":"null"}]},"isCustomSql":{"type":"boolean"},"referenceAssets":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ReferenceAssetUDFRequest"}},"selectedColumns":{"type":"array","items":{"type":"string"}},"testData":{"type":["string","null"]},"transformUDFs":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTransformUDF"}},"useTestData":{"type":"boolean"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/UdfVariable"}}}},"GenerateCodeRequest":{"type":"object","title":"GenerateCodeRequest","required":["assetId","variables"],"properties":{"assetId":{"type":"integer"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/UdfVariable"}}}},"GenerateCodeResponse":{"type":"object","title":"GenerateCodeResponse","required":["code"],"properties":{"code":{"type":"string"}}},"UdfTemplateBulkRequestsWithValidation":{"type":"object","title":"UdfTemplateBulkRequestsWithValidation","required":["override","requests"],"properties":{"override":{"type":"boolean"},"requests":{"type":"array","items":{"$ref":"#/components/schemas/UdfTemplateRequestWithValidation"}}}},"UdfVariablesValidationRequest":{"type":"object","title":"UdfVariablesValidationRequest","required":["code","isCustomSql","isLookup","isMetadata","isPackage","language","selectedColumns","transformUDFs","udfDataType","udfType","useTestData","variables"],"properties":{"analyticsPipelineId":{"type":"integer"},"assetId":{"type":"integer"},"className":{"type":["string","null"]},"code":{"type":"string"},"customSqlConfig":{"oneOf":[{"$ref":"#/components/schemas/CustomSqlConfig"},{"type":"null"}]},"engineType":{"type":["string","null"],"enum":["SPARK","JDBC_SQL","POD"]},"isCustomSql":{"type":"boolean"},"isLookup":{"type":"boolean"},"isMetadata":{"type":"boolean"},"isPackage":{"type":"boolean"},"language":{"type":"string"},"referenceAssets":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ReferenceAssetUDFRequest"}},"selectedColumns":{"type":"array","items":{"type":"string"}},"testData":{"type":["string","null"]},"transformUDFs":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTransformUDF"}},"udfDataType":{"type":"string"},"udfType":{"type":"string"},"useTestData":{"type":"boolean"},"variables":{"type":"array","items":{"$ref":"#/components/schemas/UdfVariable"}}}},"SystemAccessPrincipal":{"type":"object","title":"SystemAccessPrincipal","required":["systemUserName","userId","userName","tenantId","tenantName","tenantStatus"],"properties":{"systemUserName":{"type":"string"},"userId":{"type":"string"},"userName":{"type":"string"},"tenantId":{"type":"string"},"tenantName":{"type":"string"},"tenantStatus":{"type":"string","enum":["TRIAL","TRIAL_EXPIRED","PRODUCTION","CHURNED","NON_EXISTENT","DELETED"]}}},"UserAccessPrincipal":{"type":"object","title":"UserAccessPrincipal","required":["userId","userName","tenantId","tenantName","tenantStatus"],"properties":{"userId":{"type":"string"},"userName":{"type":"string"},"tenantId":{"type":"string"},"tenantName":{"type":"string"},"tenantStatus":{"type":"string","enum":["TRIAL","TRIAL_EXPIRED","PRODUCTION","CHURNED","NON_EXISTENT","DELETED"]}}},"Principal":{"type":["object","null"],"title":"Principal","oneOf":[{"$ref":"#/components/schemas/SystemAccessPrincipal"},{"$ref":"#/components/schemas/UserAccessPrincipal"}],"discriminator":{"propertyName":"type","mapping":{"io.ad.catalog.api.security.Principal.SystemAccessPrincipal":"#/components/schemas/SystemAccessPrincipal","io.ad.catalog.api.security.Principal.UserAccessPrincipal":"#/components/schemas/UserAccessPrincipal"}}},"AssetInfo":{"type":"object","title":"AssetInfo","required":["config","queryType","sourceType","uid"],"properties":{"backingAssetUID":{"type":["string","null"]},"config":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]}},"queryType":{"type":"string","enum":["SQL_QUERY","FILTER","AGGREGATION_PIPELINE"]},"sourceType":{"type":"string"},"tableAlias":{"type":["string","null"]},"uid":{"type":"string"},"userPrincipal":{"$ref":"#/components/schemas/Principal"}}},"MarkerRequest":{"type":"object","title":"MarkerRequest","required":["columnNames","type"],"properties":{"columnNames":{"type":"array","items":{"type":"string"}},"type":{"type":"string"}}},"DataMarkerRequest":{"type":"object","title":"DataMarkerRequest","required":["direction"],"properties":{"direction":{"type":"string"},"request":{"oneOf":[{"$ref":"#/components/schemas/MarkerRequest"},{"type":"null"}]}}},"PatternConfiguration":{"type":"object","title":"PatternConfiguration","required":["frequencyType","maxPatterns"],"properties":{"frequencyType":{"type":"string"},"maxPatterns":{"type":"integer"}}},"AIDQConfiguration":{"type":"object","title":"AIDQConfiguration","required":["columnList","executionId","forceRetrain","modelSensitivity","resultPartition","tenantId"],"properties":{"columnList":{"type":"array","items":{"type":"string"}},"executionId":{"type":"integer"},"forceRetrain":{"type":"boolean"},"markerRequest":{"oneOf":[{"$ref":"#/components/schemas/MarkerRequest"},{"type":"null"}]},"modelSensitivity":{"type":"string","enum":["HIGH","MEDIUM","LOW"]},"modelUUID":{"type":["string","null"]},"resultPartition":{"type":"string"},"tenantId":{"type":"string"}}},"AssetMonitorRequest":{"type":"object","title":"AssetMonitorRequest","required":["assetInfo"],"properties":{"assetInfo":{"$ref":"#/components/schemas/AssetInfo"}}},"MeasurementRequest":{"type":"object","title":"MeasurementRequest","required":["inputs","isWarning","name","ruleName","weightage"],"properties":{"businessExplanation":{"type":["string","null"]},"businessRuleId":{"type":"integer"},"businessRuleItemId":{"type":"integer"},"column":{"type":["string","null"]},"dimension":{"type":["string","null"]},"displayName":{"type":["string","null"]},"inputs":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]}},"isWarning":{"type":"boolean"},"labels":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Label"}},"name":{"type":"string"},"ruleItemId":{"type":"integer"},"ruleName":{"type":"string"},"thresholdConfig":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"type":{"type":["string","null"]},"weightage":{"type":"number"}}},"ReferenceAssetConfig":{"type":"object","title":"ReferenceAssetConfig","required":["referenceAssetInfo"],"properties":{"referenceAssetColumns":{"type":["array","null"],"items":{"type":"string"}},"referenceAssetInfo":{"$ref":"#/components/schemas/AssetInfo"},"referenceAssetSqlFilters":{"type":["array","null"],"items":{"type":"string"}}}},"ReferenceAssetConfigs":{"type":"object","title":"ReferenceAssetConfigs","required":["requests"],"properties":{"requests":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceAssetConfig"}}}},"PackageUdfDetailMini":{"type":"object","title":"PackageUdfDetailMini","required":["id","language","name","packagePath","storageType"],"properties":{"description":{"type":["string","null"]},"id":{"type":"integer"},"language":{"type":"string","enum":["SCALA","JAVA","PYTHON","JAVASCRIPT","EXPRESSION"]},"name":{"type":"string"},"packagePath":{"type":"string"},"storageType":{"type":"string"}}},"TransformUDFRequest":{"type":"object","title":"TransformUDFRequest","required":["code","isPackage","language","name","udfDataType","udfType"],"properties":{"className":{"type":["string","null"]},"code":{"type":"string"},"columnNames":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"integer"},"isPackage":{"type":"boolean"},"language":{"type":"string","enum":["SCALA","JAVA","PYTHON","JAVASCRIPT","EXPRESSION"]},"name":{"type":"string"},"packageUdfDetail":{"oneOf":[{"$ref":"#/components/schemas/PackageUdfDetailMini"},{"type":"null"}]},"udfDataType":{"type":"string","enum":["BOOLEAN","STRING","SHORT","INTEGER","LONG","FLOAT","DOUBLE","BIGDECIMAL","DATE","TIMESTAMP"]},"udfType":{"type":"string","enum":["FILTER","TRANSFORM","NUMBER"]},"variables":{"type":["object","null"],"additionalProperties":{"type":"string"}}}},"ChildRuleConfigs":{"type":"object","title":"ChildRuleConfigs","required":["executionId","executionSequence","measurements","referenceAssetConfigs","ruleId","ruleName","ruleVersion","thresholdLevel","transformUDFs","uuid"],"properties":{"executionId":{"type":"integer"},"executionSequence":{"type":"integer"},"filter":{"type":["string","null"]},"labels":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Label"}},"measurements":{"type":"array","items":{"$ref":"#/components/schemas/MeasurementRequest"}},"persistencePathRequest":{"oneOf":[{"$ref":"#/components/schemas/Any"},{"type":"null"}]},"referenceAssetConfigs":{"$ref":"#/components/schemas/ReferenceAssetConfigs"},"ruleId":{"type":"integer"},"ruleName":{"type":"string"},"ruleVersion":{"type":"integer"},"thresholdLevel":{"$ref":"#/components/schemas/RuleThresholdConfiguration"},"transformUDFs":{"$ref":"#/components/schemas/TransformUDFsConfig"},"uuid":{"type":"string"}}},"MarkingColumn":{"type":"object","title":"MarkingColumn","required":["aggregate","columnExpr","name"],"properties":{"aggregate":{"type":"string","enum":["MAX","MIN","FIRST","LAST","NONE"]},"columnExpr":{"type":"string"},"name":{"type":"string"}}},"ProcessDefinition":{"type":"object","title":"ProcessDefinition","required":["config","processorType"],"properties":{"config":{"$ref":"#/components/schemas/ProcessorConfig"},"processorType":{"type":"string","enum":["DQ","EqualityReconcile","DQProfile","MinMaxDQProcessor","HashReconcile","Profile","MiniProfile","AutoTag","SampleData","FileInfo","ConnectionValidator","UdfPredicateValidator","ParentList","AssetReferenceValidator","AssetsMonitor","RowCountEquality","DQResult","AIDQ","RESULT","EXECUTION_RESULT","EXECUTION_RESULT_SCHEMA","CADENCE","Freshness","DatasourceQuery"]}}},"AssetReferenceValidatorConfig":{"type":"object","title":"AssetReferenceValidatorConfig","required":["maxRowCount","timeOutMilliseconds"],"properties":{"maxRowCount":{"type":"integer"},"timeOutMilliseconds":{"type":"integer"}}},"SampleConfig":{"type":"object","title":"SampleConfig","required":["randomSample","sampleData","viewProtectedRecordData"],"properties":{"filesCollectSizeRestrictionInBytes":{"type":"integer"},"filter":{"type":["string","null"]},"fractionPart":{"type":"integer"},"limit":{"type":"integer"},"randomSample":{"type":"boolean"},"sampleData":{"type":"boolean"},"viewProtectedRecordData":{"type":"boolean"}}},"UDTPackageRequest":{"type":"object","title":"UDTPackageRequest","required":["storageType"],"properties":{"files":{"type":["array","null"],"items":{"type":"string"}},"storageType":{"type":"string"}}},"AssetRequest":{"type":"object","title":"AssetRequest","required":["filesEnhancedProcessorEnabled","invalidateCache","process","referenceAssets","sampleConfig","selectedColumns","transformUDFs"],"properties":{"asset":{"oneOf":[{"$ref":"#/components/schemas/AssetInfo"},{"type":"null"}]},"columnLevel":{"type":"integer"},"filesEnhancedProcessorEnabled":{"type":"boolean"},"id":{"type":["string","null"]},"invalidateCache":{"type":"boolean"},"marker":{"type":["array","null"],"items":{"$ref":"#/components/schemas/DataMarkerRequest"}},"noOfColumnsPerBatch":{"type":"integer"},"patternRequest":{"oneOf":[{"$ref":"#/components/schemas/PatternConfiguration"},{"type":"null"}]},"process":{"$ref":"#/components/schemas/ProcessDefinition"},"profileCapabilities":{"type":["array","null"],"items":{"type":"string","enum":["AUTO_TAG","HISTOGRAM","PATTERNS","EXACT_COUNT_DISTINCT_COLUMN_VALUES"]}},"referenceAssets":{"$ref":"#/components/schemas/ReferenceAssetConfigs"},"referenceValidatorConfig":{"oneOf":[{"$ref":"#/components/schemas/AssetReferenceValidatorConfig"},{"type":"null"}]},"runType":{"type":["string","null"],"enum":["FULL_DATA_LOAD","BATCH_DATA_LOAD"]},"sampleConfig":{"$ref":"#/components/schemas/SampleConfig"},"selectedColumns":{"type":"array","items":{"type":"string"}},"sparkFilter":{"type":["string","null"]},"transformUDFs":{"$ref":"#/components/schemas/TransformUDFsConfig"},"udtPackages":{"oneOf":[{"$ref":"#/components/schemas/UDTPackageRequest"},{"type":"null"}]}}},"UdfValidationAnalysisResult":{"type":"object","title":"UdfValidationAnalysisResult","required":["id","isFinished","request","status"],"properties":{"details":{"type":["string","null"]},"errorMsg":{"type":["string","null"]},"id":{"type":"string"},"isFinished":{"type":"boolean"},"request":{"$ref":"#/components/schemas/AssetRequest"},"status":{"type":"string"}}},"UdfVariablesCancellationValidationRequest":{"type":"object","title":"UdfVariablesCancellationValidationRequest","properties":{"analyticsPipelineId":{"type":"integer"},"assetId":{"type":"integer"}}},"PackageStorageConfig":{"type":"object","title":"PackageStorageConfig","required":["type"],"properties":{"config":{"type":["object","null"],"additionalProperties":{"type":"string"}},"type":{"type":"string"}}},"PackageUDfCreateOrUpdateRequestWithUdfDefinitions":{"type":"object","title":"PackageUDfCreateOrUpdateRequestWithUdfDefinitions","required":["description","language","name","override","packageDetail","packagePath","storageConfig","udtDefinitions","version"],"properties":{"description":{"type":"string"},"language":{"type":"string"},"name":{"type":"string"},"override":{"type":"boolean"},"packageDetail":{"type":"object","additionalProperties":{"type":"string"}},"packagePath":{"type":"string"},"storageConfig":{"$ref":"#/components/schemas/PackageStorageConfig"},"udtDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/UdfTemplateRequestWithValidation"}},"version":{"type":"string"}}},"RulesWithUDF":{"type":"object","title":"RulesWithUDF","required":["ruleId","ruleName"],"properties":{"ruleId":{"type":"integer"},"ruleName":{"type":"string"}}},"UDFTemplate":{"type":"object","title":"UDFTemplate","required":["code","createdAt","description","id","isLookup","isMetadata","isPackage","isTemplate","language","name","udfDataType","udfType","updatedAt","usedInPolices","variables"],"properties":{"className":{"type":["string","null"]},"code":{"type":"string"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"createdBy":{"type":["string","null"]},"description":{"type":"string"},"id":{"type":"integer"},"isLookup":{"type":"boolean"},"isMetadata":{"type":"boolean"},"isPackage":{"type":"boolean"},"isTemplate":{"type":"boolean"},"labels":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Label"}},"language":{"type":"string","enum":["SCALA","JAVA","PYTHON","JAVASCRIPT","EXPRESSION"]},"lastUpdatedBy":{"type":["string","null"]},"name":{"type":"string"},"packageId":{"type":"integer"},"packageUdfDetail":{"oneOf":[{"$ref":"#/components/schemas/PackageUdfDetail"},{"type":"null"}]},"referenceAssets":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ReferenceAssetUDFRequest"}},"udfDataType":{"type":"string","enum":["BOOLEAN","STRING","SHORT","INTEGER","LONG","FLOAT","DOUBLE","BIGDECIMAL","DATE","TIMESTAMP"]},"udfType":{"type":"string","enum":["FILTER","TRANSFORM","NUMBER"]},"updatedAt":{"$ref":"#/components/schemas/DateTime"},"usedInPolices":{"type":"array","items":{"$ref":"#/components/schemas/RulesWithUDF"}},"variables":{"type":"array","items":{"type":"string"}}}},"PackageUdfDetail":{"type":"object","title":"PackageUdfDetail","required":["createdAt","createdBy","id","language","name","packagePath","storageType","tenantId","updatedAt","version"],"properties":{"createdAt":{"$ref":"#/components/schemas/DateTime"},"createdBy":{"type":"string"},"description":{"type":["string","null"]},"id":{"type":"integer"},"language":{"type":"string","enum":["SCALA","JAVA","PYTHON","JAVASCRIPT","EXPRESSION"]},"lastUpdatedBy":{"type":["string","null"]},"name":{"type":"string"},"packageDetail":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/Any"}},"packagePath":{"type":"string"},"storageType":{"type":"string"},"tenantId":{"type":"string"},"udtTemplates":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UDFTemplate"}},"updatedAt":{"$ref":"#/components/schemas/DateTime"},"version":{"type":"string"}}},"UDFTemplateResponseWithStatus":{"type":"object","title":"UDFTemplateResponseWithStatus","required":["name","status"],"properties":{"errorMessage":{"type":["string","null"]},"name":{"type":"string"},"status":{"type":"string"},"udfTemplate":{"oneOf":[{"$ref":"#/components/schemas/UDFTemplate"},{"type":"null"}]}}},"PackageCreateOrUpdateResponse":{"type":"object","title":"PackageCreateOrUpdateResponse","properties":{"packageUdfDetail":{"oneOf":[{"$ref":"#/components/schemas/PackageUdfDetail"},{"type":"null"}]},"udfTemplateResponses":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UDFTemplateResponseWithStatus"}}}}}},"tags":[{"name":"Crawler Status","description":"Endpoints for querying crawler and execution status"},{"name":"Crawler Tracking","description":"Endpoints for crawler heartbeat, tracker, and progress updates"},{"name":"Crawler Jobs","description":"Endpoints for submitting and monitoring async crawler jobs"},{"name":"Crawler Operations","description":"Endpoints for starting, restarting, and removing crawlers"},{"name":"Custom Assets","description":"Endpoints for managing SQL view-based custom assets"},{"name":"Persistence Configs","description":"Endpoints for managing persistence storage configurations that control where analytics outputs are stored"},{"name":"Rules","description":"Top-level endpoints for listing, enabling, and managing rules"},{"name":"Data Quality Rules","description":"Endpoints for data quality rule CRUD, scheduling, and execution"},{"name":"Reconciliation Rules","description":"Endpoints for reconciliation rule CRUD, scheduling, and execution"},{"name":"Data Cadence Rules","description":"Endpoints for data cadence rule management and execution"},{"name":"Profile Anomaly Rules","description":"Endpoints for profile anomaly detection rule management"},{"name":"Data Drift Rules","description":"Endpoints for data drift detection execution results"},{"name":"Schema Drift Rules","description":"Endpoints for schema drift detection execution results"},{"name":"Rule Tags","description":"Endpoints for managing tags on rules"},{"name":"Rule Configuration","description":"Endpoints for viewing rule configuration details"},{"name":"Policy Import/Export","description":"Endpoints for importing and exporting policy definitions"},{"name":"Business Rules","description":"Endpoints for managing business rules and their items"},{"name":"UDF Templates","description":"Endpoints for managing User-Defined Function (UDF) templates used in data quality rules and profiling"},{"name":"UDF Validation","description":"Endpoints for validating UDF templates and variables asynchronously"},{"name":"UDT Packages","description":"Endpoints for managing User-Defined Transform (UDT) packages that bundle multiple UDF templates"}],"x-tagGroups":[{"name":"Crawlers","tags":["Crawler Status","Crawler Operations","Crawler Tracking","Crawler Jobs"]},{"name":"Custom Assets","tags":["Custom Assets"]},{"name":"Persistence Configs","tags":["Persistence Configs"]},{"name":"Rules","tags":["Rules","Data Quality Rules","Reconciliation Rules","Data Cadence Rules","Profile Anomaly Rules","Data Drift Rules","Schema Drift Rules","Rule Tags","Rule Configuration","Policy Import/Export","Business Rules"]},{"name":"UDF Templates","tags":["UDF Templates","UDF Validation"]},{"name":"UDT Packages","tags":["UDT Packages"]}]}