Azure.Analaytics.Purview.DataQuality (preview:2025-09-01)

2025/11/18 • 35 new methods

GetBulkAssetMetadata (new)
Description :  Retrieves metadata for all assets in an account with pagination support. Returns up to 10 assets per request.
Reference :  Link ¶

⚼ Request

GET:  /bulk-asset-metadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
continuationToken:
{
Description: Continuation token for pagination. Use this to get all results until continuationToken from the response becomes null. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
continuationToken:
{
Description: Continuation token for pagination. Null when no more results are available. ,
Required: False ,
}
string ,
metadata:
{
Description: Array of metadata entries (up to 10 per response) ,
Required: True ,
}
[
{
assetMetadata:
{
Description: Asset metadata information ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the asset metadata observer ,
Required: True ,
}
string ,
name:
{
Description: Display name of the asset metadata observer ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the associated business domain ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated data product ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated data asset ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
isDeleted:
{
Description: Soft deletion flag ,
Required: False ,
}
boolean ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
type:
{
Description: Data source type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Common metadata properties across all asset types ,
Required: False ,
}
{
inputDatasets:
{
Description: Input dataset definitions and schemas ,
Required: False ,
}
[
string ,
]
,
projection:
{
Description: Data projection and mapping configuration ,
Required: False ,
}
string ,
}
,
location:
{
Description: Physical storage locations for file-based assets ,
Required: False ,
}
[
{
type:
{
Description: Storage type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Storage-specific configuration properties ,
Required: True ,
}
{
fileSystem:
{
Description: File system or container name ,
Required: False ,
}
string ,
folderPath:
{
Description: Hierarchical path within the storage location ,
Required: False ,
}
string ,
accountName:
{
Description: Storage account name or endpoint identifier ,
Required: False ,
}
string ,
region:
{
Description: Geographic region or environment location ,
Required: False ,
}
string ,
}
,
}
,
]
,
format:
{
Description: Data format specification for structured assets ,
Required: False ,
}
string ,
schemaName:
{
Description: Database schema name for SQL-based assets ,
Required: False ,
}
string ,
tableName:
{
Description: Table name for SQL-based data assets ,
Required: False ,
}
string ,
hostName:
{
Description: Host server name for on-premises database connections ,
Required: False ,
}
string ,
testConnectionDatasetName:
{
Description: Connection Dataset name for Google Big Quey type of data asset ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Connection Schema name for Google Big Query type of data asset ,
Required: False ,
}
string ,
projectId:
{
Description: Project ID for Google Big Query type of data asset ,
Required: False ,
}
string ,
isDQAsset:
{
Description: Flag indicating if the asset is a Data Quality asset ,
Required: False ,
}
boolean ,
}
,
assetScopedMetadata:
{
Description: Asset scoped metadata information ,
Required: True ,
}
{
id:
{
Description: Unique identifier for the scoped asset metadata entity. ,
Required: False ,
}
string ,
description:
{
Description: Descriptive text providing details about the scoped asset metadata. ,
Required: True ,
}
string ,
businessDomain:
{
Description: Reference to the associated Business Domain. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated Data Product. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated Data Asset. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
runtime:
{
Description: Runtime configuration parameters defining error row behavior and output format. ,
Required: False ,
}
{
isErrorRowRequired:
{
Description: Indicates whether error row details should be captured. ,
Required: True ,
}
boolean ,
errorRowWriteFormat:
{
Description: Specifies the format in which error rows are written (e.g., CSV, Parquet). ,
Required: False ,
}
string ,
}
,
favouriteColumnPaths:
{
Description: List of favorite column paths selected for quick access or monitoring. ,
Required: True ,
}
[
string ,
]
,
createdAt:
{
Description: Timestamp when this metadata was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this metadata was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier of the user who created this metadata. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier of the user who last modified this metadata. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag used for concurrency control and version validation. ,
Required: False ,
}
string ,
}
,
scoreSnapshot:
{
Description: Snapshot Details ,
Required: True ,
}
{
businessDomainId:
{
Description: Business domain identifier ,
Required: True ,
}
string ,
dataProductId:
{
Description: Data product identifier ,
Required: True ,
}
string ,
assetId:
{
Description: Asset identifier ,
Required: True ,
}
string ,
assetScore:
{
Description: Overall score for the asset ,
Format: double ,
Required: True ,
}
number ,
originAssetId:
{
Description: Origin asset identifier ,
Required: True ,
}
string ,
isStandaloneAsset:
{
Description: Is the asset standalone ,
Required: True ,
}
boolean ,
rules:
{
Description: Rules with their scores and validation results ,
Required: True ,
}
[
{
id:
{
Description: Rule identifier ,
Required: False ,
}
string ,
score:
{
Description: Score for the rule ,
Format: double ,
Required: False ,
}
number ,
name:
{
Description: Name of the rule ,
Required: False ,
}
string ,
description:
{
Description: Description of the rule ,
Required: False ,
}
string ,
type:
{
Description: Type of the rule ,
Required: False ,
}
string ,
status:
{
Description: Status of the rule ,
Required: False ,
}
string ,
columns:
{
Description: Columns associated with the rule ,
Required: False ,
}
[
string ,
]
,
totalRows:
{
Description: Total number of rows processed ,
Format: int64 ,
Required: False ,
}
integer ,
failedRows:
{
Description: Number of failed rows ,
Format: int64 ,
Required: False ,
}
integer ,
passedRows:
{
Description: Number of passed rows ,
Format: int64 ,
Required: False ,
}
integer ,
emptyRows:
{
Description: Number of empty rows ,
Format: int64 ,
Required: False ,
}
integer ,
miscastRows:
{
Description: Number of miscast rows ,
Format: int64 ,
Required: False ,
}
integer ,
queryExecuted:
{
Description: The query which has been executed ,
Required: False ,
}
string ,
dimension:
{
Description: Dimension of the rule ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the business domain ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the data product ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the data asset ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
typeProperties:
{
Description: Properties related to the data asset ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
lastModifiedAt:
{
Description: Last modification timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modifier user ID ,
Required: False ,
}
string ,
createdBy:
{
Description: Creator user ID ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
job:
{
Description: Job information for the snapshot ,
Required: True ,
}
{
jobId:
{
Description: Job identifier ,
Required: False ,
}
string ,
businessDomainId:
{
Description: Business domain identifier ,
Required: False ,
}
string ,
}
,
}
,
globalRules:
{
Description: Global rules applied to the asset ,
Required: True ,
}
[
{
name:
{
Description: Descriptive name of the rule ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of rule validation and business purpose ,
Required: False ,
}
string ,
type:
{
Description: Rule type classification ,
Required: True ,
}
string ,
status:
{
Description: Current execution status ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific configuration properties ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Unique rule identifier ,
Required: True ,
}
string ,
businessDomain:
{
Description: Business domain reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Data product reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
score:
{
Description: Quality score (0.0 to 1.0) ,
Format: double ,
Required: False ,
}
number ,
dimension:
{
Description: Optional business dimension or classification ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp when this rule was created ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this rule was last modified ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: User identifier for the creator of the rule ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: User identifier for the last modifier of the rule ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateBulkAssetMetadata (new)
Description :  Inserts metadata for multiple assets into a new account ID.
Reference :  Link ¶

⚼ Request

PUT:  /bulk-asset-metadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
request:
{
Description: Bulk asset metadata to insert ,
Required: True ,
}
{
continuationToken:
{
Description: Continuation token for pagination. Null when no more results are available. ,
Required: False ,
}
string ,
metadata:
{
Description: Array of metadata entries (up to 10 per response) ,
Required: True ,
}
[
{
assetMetadata:
{
Description: Asset metadata information ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the asset metadata observer ,
Required: True ,
}
string ,
name:
{
Description: Display name of the asset metadata observer ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the associated business domain ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated data product ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated data asset ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
isDeleted:
{
Description: Soft deletion flag ,
Required: False ,
}
boolean ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
type:
{
Description: Data source type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Common metadata properties across all asset types ,
Required: False ,
}
{
inputDatasets:
{
Description: Input dataset definitions and schemas ,
Required: False ,
}
[
string ,
]
,
projection:
{
Description: Data projection and mapping configuration ,
Required: False ,
}
string ,
}
,
location:
{
Description: Physical storage locations for file-based assets ,
Required: False ,
}
[
{
type:
{
Description: Storage type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Storage-specific configuration properties ,
Required: True ,
}
{
fileSystem:
{
Description: File system or container name ,
Required: False ,
}
string ,
folderPath:
{
Description: Hierarchical path within the storage location ,
Required: False ,
}
string ,
accountName:
{
Description: Storage account name or endpoint identifier ,
Required: False ,
}
string ,
region:
{
Description: Geographic region or environment location ,
Required: False ,
}
string ,
}
,
}
,
]
,
format:
{
Description: Data format specification for structured assets ,
Required: False ,
}
string ,
schemaName:
{
Description: Database schema name for SQL-based assets ,
Required: False ,
}
string ,
tableName:
{
Description: Table name for SQL-based data assets ,
Required: False ,
}
string ,
hostName:
{
Description: Host server name for on-premises database connections ,
Required: False ,
}
string ,
testConnectionDatasetName:
{
Description: Connection Dataset name for Google Big Quey type of data asset ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Connection Schema name for Google Big Query type of data asset ,
Required: False ,
}
string ,
projectId:
{
Description: Project ID for Google Big Query type of data asset ,
Required: False ,
}
string ,
isDQAsset:
{
Description: Flag indicating if the asset is a Data Quality asset ,
Required: False ,
}
boolean ,
}
,
assetScopedMetadata:
{
Description: Asset scoped metadata information ,
Required: True ,
}
{
id:
{
Description: Unique identifier for the scoped asset metadata entity. ,
Required: False ,
}
string ,
description:
{
Description: Descriptive text providing details about the scoped asset metadata. ,
Required: True ,
}
string ,
businessDomain:
{
Description: Reference to the associated Business Domain. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated Data Product. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated Data Asset. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
runtime:
{
Description: Runtime configuration parameters defining error row behavior and output format. ,
Required: False ,
}
{
isErrorRowRequired:
{
Description: Indicates whether error row details should be captured. ,
Required: True ,
}
boolean ,
errorRowWriteFormat:
{
Description: Specifies the format in which error rows are written (e.g., CSV, Parquet). ,
Required: False ,
}
string ,
}
,
favouriteColumnPaths:
{
Description: List of favorite column paths selected for quick access or monitoring. ,
Required: True ,
}
[
string ,
]
,
createdAt:
{
Description: Timestamp when this metadata was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this metadata was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier of the user who created this metadata. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier of the user who last modified this metadata. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag used for concurrency control and version validation. ,
Required: False ,
}
string ,
}
,
scoreSnapshot:
{
Description: Snapshot Details ,
Required: True ,
}
{
businessDomainId:
{
Description: Business domain identifier ,
Required: True ,
}
string ,
dataProductId:
{
Description: Data product identifier ,
Required: True ,
}
string ,
assetId:
{
Description: Asset identifier ,
Required: True ,
}
string ,
assetScore:
{
Description: Overall score for the asset ,
Format: double ,
Required: True ,
}
number ,
originAssetId:
{
Description: Origin asset identifier ,
Required: True ,
}
string ,
isStandaloneAsset:
{
Description: Is the asset standalone ,
Required: True ,
}
boolean ,
rules:
{
Description: Rules with their scores and validation results ,
Required: True ,
}
[
{
id:
{
Description: Rule identifier ,
Required: False ,
}
string ,
score:
{
Description: Score for the rule ,
Format: double ,
Required: False ,
}
number ,
name:
{
Description: Name of the rule ,
Required: False ,
}
string ,
description:
{
Description: Description of the rule ,
Required: False ,
}
string ,
type:
{
Description: Type of the rule ,
Required: False ,
}
string ,
status:
{
Description: Status of the rule ,
Required: False ,
}
string ,
columns:
{
Description: Columns associated with the rule ,
Required: False ,
}
[
string ,
]
,
totalRows:
{
Description: Total number of rows processed ,
Format: int64 ,
Required: False ,
}
integer ,
failedRows:
{
Description: Number of failed rows ,
Format: int64 ,
Required: False ,
}
integer ,
passedRows:
{
Description: Number of passed rows ,
Format: int64 ,
Required: False ,
}
integer ,
emptyRows:
{
Description: Number of empty rows ,
Format: int64 ,
Required: False ,
}
integer ,
miscastRows:
{
Description: Number of miscast rows ,
Format: int64 ,
Required: False ,
}
integer ,
queryExecuted:
{
Description: The query which has been executed ,
Required: False ,
}
string ,
dimension:
{
Description: Dimension of the rule ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the business domain ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the data product ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the data asset ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
typeProperties:
{
Description: Properties related to the data asset ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
lastModifiedAt:
{
Description: Last modification timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modifier user ID ,
Required: False ,
}
string ,
createdBy:
{
Description: Creator user ID ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
job:
{
Description: Job information for the snapshot ,
Required: True ,
}
{
jobId:
{
Description: Job identifier ,
Required: False ,
}
string ,
businessDomainId:
{
Description: Business domain identifier ,
Required: False ,
}
string ,
}
,
}
,
globalRules:
{
Description: Global rules applied to the asset ,
Required: True ,
}
[
{
name:
{
Description: Descriptive name of the rule ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of rule validation and business purpose ,
Required: False ,
}
string ,
type:
{
Description: Rule type classification ,
Required: True ,
}
string ,
status:
{
Description: Current execution status ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific configuration properties ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Unique rule identifier ,
Required: True ,
}
string ,
businessDomain:
{
Description: Business domain reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Data product reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
score:
{
Description: Quality score (0.0 to 1.0) ,
Format: double ,
Required: False ,
}
number ,
dimension:
{
Description: Optional business dimension or classification ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp when this rule was created ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this rule was last modified ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: User identifier for the creator of the rule ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: User identifier for the last modifier of the rule ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (201)

{
continuationToken:
{
Description: Continuation token for pagination. Null when no more results are available. ,
Required: False ,
}
string ,
metadata:
{
Description: Array of metadata entries (up to 10 per response) ,
Required: True ,
}
[
{
assetMetadata:
{
Description: Asset metadata information ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the asset metadata observer ,
Required: True ,
}
string ,
name:
{
Description: Display name of the asset metadata observer ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the associated business domain ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated data product ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated data asset ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
isDeleted:
{
Description: Soft deletion flag ,
Required: False ,
}
boolean ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
type:
{
Description: Data source type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Common metadata properties across all asset types ,
Required: False ,
}
{
inputDatasets:
{
Description: Input dataset definitions and schemas ,
Required: False ,
}
[
string ,
]
,
projection:
{
Description: Data projection and mapping configuration ,
Required: False ,
}
string ,
}
,
location:
{
Description: Physical storage locations for file-based assets ,
Required: False ,
}
[
{
type:
{
Description: Storage type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Storage-specific configuration properties ,
Required: True ,
}
{
fileSystem:
{
Description: File system or container name ,
Required: False ,
}
string ,
folderPath:
{
Description: Hierarchical path within the storage location ,
Required: False ,
}
string ,
accountName:
{
Description: Storage account name or endpoint identifier ,
Required: False ,
}
string ,
region:
{
Description: Geographic region or environment location ,
Required: False ,
}
string ,
}
,
}
,
]
,
format:
{
Description: Data format specification for structured assets ,
Required: False ,
}
string ,
schemaName:
{
Description: Database schema name for SQL-based assets ,
Required: False ,
}
string ,
tableName:
{
Description: Table name for SQL-based data assets ,
Required: False ,
}
string ,
hostName:
{
Description: Host server name for on-premises database connections ,
Required: False ,
}
string ,
testConnectionDatasetName:
{
Description: Connection Dataset name for Google Big Quey type of data asset ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Connection Schema name for Google Big Query type of data asset ,
Required: False ,
}
string ,
projectId:
{
Description: Project ID for Google Big Query type of data asset ,
Required: False ,
}
string ,
isDQAsset:
{
Description: Flag indicating if the asset is a Data Quality asset ,
Required: False ,
}
boolean ,
}
,
assetScopedMetadata:
{
Description: Asset scoped metadata information ,
Required: True ,
}
{
id:
{
Description: Unique identifier for the scoped asset metadata entity. ,
Required: False ,
}
string ,
description:
{
Description: Descriptive text providing details about the scoped asset metadata. ,
Required: True ,
}
string ,
businessDomain:
{
Description: Reference to the associated Business Domain. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated Data Product. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated Data Asset. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
runtime:
{
Description: Runtime configuration parameters defining error row behavior and output format. ,
Required: False ,
}
{
isErrorRowRequired:
{
Description: Indicates whether error row details should be captured. ,
Required: True ,
}
boolean ,
errorRowWriteFormat:
{
Description: Specifies the format in which error rows are written (e.g., CSV, Parquet). ,
Required: False ,
}
string ,
}
,
favouriteColumnPaths:
{
Description: List of favorite column paths selected for quick access or monitoring. ,
Required: True ,
}
[
string ,
]
,
createdAt:
{
Description: Timestamp when this metadata was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this metadata was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier of the user who created this metadata. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier of the user who last modified this metadata. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag used for concurrency control and version validation. ,
Required: False ,
}
string ,
}
,
scoreSnapshot:
{
Description: Snapshot Details ,
Required: True ,
}
{
businessDomainId:
{
Description: Business domain identifier ,
Required: True ,
}
string ,
dataProductId:
{
Description: Data product identifier ,
Required: True ,
}
string ,
assetId:
{
Description: Asset identifier ,
Required: True ,
}
string ,
assetScore:
{
Description: Overall score for the asset ,
Format: double ,
Required: True ,
}
number ,
originAssetId:
{
Description: Origin asset identifier ,
Required: True ,
}
string ,
isStandaloneAsset:
{
Description: Is the asset standalone ,
Required: True ,
}
boolean ,
rules:
{
Description: Rules with their scores and validation results ,
Required: True ,
}
[
{
id:
{
Description: Rule identifier ,
Required: False ,
}
string ,
score:
{
Description: Score for the rule ,
Format: double ,
Required: False ,
}
number ,
name:
{
Description: Name of the rule ,
Required: False ,
}
string ,
description:
{
Description: Description of the rule ,
Required: False ,
}
string ,
type:
{
Description: Type of the rule ,
Required: False ,
}
string ,
status:
{
Description: Status of the rule ,
Required: False ,
}
string ,
columns:
{
Description: Columns associated with the rule ,
Required: False ,
}
[
string ,
]
,
totalRows:
{
Description: Total number of rows processed ,
Format: int64 ,
Required: False ,
}
integer ,
failedRows:
{
Description: Number of failed rows ,
Format: int64 ,
Required: False ,
}
integer ,
passedRows:
{
Description: Number of passed rows ,
Format: int64 ,
Required: False ,
}
integer ,
emptyRows:
{
Description: Number of empty rows ,
Format: int64 ,
Required: False ,
}
integer ,
miscastRows:
{
Description: Number of miscast rows ,
Format: int64 ,
Required: False ,
}
integer ,
queryExecuted:
{
Description: The query which has been executed ,
Required: False ,
}
string ,
dimension:
{
Description: Dimension of the rule ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the business domain ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the data product ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the data asset ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
typeProperties:
{
Description: Properties related to the data asset ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
lastModifiedAt:
{
Description: Last modification timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modifier user ID ,
Required: False ,
}
string ,
createdBy:
{
Description: Creator user ID ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
job:
{
Description: Job information for the snapshot ,
Required: True ,
}
{
jobId:
{
Description: Job identifier ,
Required: False ,
}
string ,
businessDomainId:
{
Description: Business domain identifier ,
Required: False ,
}
string ,
}
,
}
,
globalRules:
{
Description: Global rules applied to the asset ,
Required: True ,
}
[
{
name:
{
Description: Descriptive name of the rule ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of rule validation and business purpose ,
Required: False ,
}
string ,
type:
{
Description: Rule type classification ,
Required: True ,
}
string ,
status:
{
Description: Current execution status ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific configuration properties ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Unique rule identifier ,
Required: True ,
}
string ,
businessDomain:
{
Description: Business domain reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Data product reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
score:
{
Description: Quality score (0.0 to 1.0) ,
Format: double ,
Required: False ,
}
number ,
dimension:
{
Description: Optional business dimension or classification ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp when this rule was created ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this rule was last modified ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: User identifier for the creator of the rule ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: User identifier for the last modifier of the rule ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Observations (new)
Description :  Triggers a long-running observation job for a specific data asset.
Reference :  Link ¶

⚼ Request

POST:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}:observations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product containing the data asset ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset ,
Required: True ,
}
string ,
request:
{
Description: Job configuration request payload ,
Required: True ,
}
{
redundancyCheck:
{
Description: Flag for redundancy validation checks ,
Required: False ,
}
boolean ,
datasetToDatasourceMappings:
{
Description: Dataset to data source mapping configurations ,
Required: False ,
}
[
{
datasetAliasName:
{
Description: Logical dataset alias name ,
Required: False ,
}
string ,
datasourceId:
{
Description: Physical data source identifier ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
id:
{
Description: Unique identifier of the monitored operation ,
Required: True ,
}
string ,
status:
{
Description: Current status of the operation ,
Enum:
{
InProgress: Operation in progress ,
Succeeded: Operation completed successfully ,
Failed: Operation failed with errors ,
}
,
Required: True ,
}
enum ,
kind:
{
Description: Kind of operation being monitored ,
Enum:
{
Unknown: Operation type is unknown ,
Create: Create operation ,
Update: Update operation ,
Delete: Delete operation ,
Retrieve: Retrieve operation ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Last status update timestamp (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
statusMessage:
{
Description: Status description message ,
Required: False ,
}
string ,
progressPercentage:
{
Description: Completion percentage (0–100) ,
Format: int32 ,
Required: False ,
}
integer ,
errorDetails:
{
Description: Error details for failed operations ,
Required: False ,
}
{
code:
{
Description: Standardized error code ,
Required: False ,
}
string ,
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
details:
{
Description: Additional error context as key-value pairs ,
Required: False ,
}
object ,
}
,
result:
{
Description: Result payload for successful operations ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Profile (new)
Description :  Creates or updates the profile for a given data asset within a business domain. Supports polling as a long-running operation.
Reference :  Link ¶

⚼ Request

POST:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}:profile
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product containing the data asset ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset ,
Required: True ,
}
string ,
request:
{
Description: Profile entity request payload ,
Required: True ,
}
{
type:
{
Description: Profile type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific profiling configuration properties ,
Required: True ,
}
{
location:
{
Description: Collection of data location definitions specifying where profiling should be performed ,
Required: True ,
}
[
{
type:
{
Description: Location type classification (AdlsGen2FileLocation, BlobStorageLocation, etc.) ,
Required: True ,
}
string ,
typeProperties:
{
Description: Location-specific properties defining file system and path details ,
Required: True ,
}
{
fileSystem:
{
Description: File system or container name where data resides ,
Required: True ,
}
string ,
folderPath:
{
Description: Folder path within the file system containing target data ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
dataSourceId:
{
Description: Data source identifier for profiling target ,
Required: True ,
}
string ,
configuration:
{
Description: Profiling configuration with key columns and parameters ,
Required: True ,
}
{
keyColumns:
{
Description: Collection of key columns that serve as primary identifiers for profiling analysis ,
Required: True ,
}
[
{
name:
{
Description: Name of the key column used for data identification and grouping ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
id:
{
Description: Unique identifier of the monitored operation ,
Required: True ,
}
string ,
status:
{
Description: Current status of the operation ,
Enum:
{
InProgress: Operation in progress ,
Succeeded: Operation completed successfully ,
Failed: Operation failed with errors ,
}
,
Required: True ,
}
enum ,
kind:
{
Description: Kind of operation being monitored ,
Enum:
{
Unknown: Operation type is unknown ,
Create: Create operation ,
Update: Update operation ,
Delete: Delete operation ,
Retrieve: Retrieve operation ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Last status update timestamp (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
statusMessage:
{
Description: Status description message ,
Required: False ,
}
string ,
progressPercentage:
{
Description: Completion percentage (0–100) ,
Format: int32 ,
Required: False ,
}
integer ,
errorDetails:
{
Description: Error details for failed operations ,
Required: False ,
}
{
code:
{
Description: Standardized error code ,
Required: False ,
}
string ,
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
details:
{
Description: Additional error context as key-value pairs ,
Required: False ,
}
object ,
}
,
result:
{
Description: Result payload for successful operations ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteObservation (new)
Description :  Deletes a specific observation associated with a data asset.
Reference :  Link ¶

⚼ Request

DELETE:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/observations/{observationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset ,
Required: True ,
}
string ,
observationId:
{
Description: Unique identifier for the observation metadata ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteProfileRun (new)
Description :  Deletes a specific profile run for a given data asset within a business domain.
Reference :  Link ¶

⚼ Request

DELETE:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/profiles/{profileRunId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset ,
Required: True ,
}
string ,
profileRunId:
{
Description: Unique identifier for the profile run execution ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
OpinionTrend (new)
Description :  Retrieves the opinion trend for a specific profile rule under a given data asset.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/rule-opinions/{ruleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product containing the data asset ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset whose rule opinion trend is being retrieved ,
Required: True ,
}
string ,
ruleId:
{
Description: Unique identifier of the rule for opinion trend retrieval ,
Required: True ,
}
string ,
startTime:
{
Description: Start time for the opinion trend query. If specified, endTime must also be provided. Maximum time window is 90 days. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time for the opinion trend query. Can only be used with startTime. Maximum time window is 90 days. ,
Format: date-time ,
Required: False ,
}
string ,
maxRecordsToReturn:
{
Description: Maximum number of records to return in a single request. Must be between 1 and 100. Default is 10. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
businessDomainId:
{
Description: Business domain identifier for opinion context ,
Required: True ,
}
string ,
dataProductId:
{
Description: Data product identifier for opinion scope ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Data asset identifier for opinion target ,
Required: True ,
}
string ,
controlId:
{
Description: Data quality control identifier ,
Required: False ,
}
string ,
opinionId:
{
Description: Opinion record unique identifier ,
Required: True ,
}
string ,
value:
{
Description: Opinion assessment value or result ,
Required: False ,
}
string ,
resultedAt:
{
Description: Opinion completion timestamp (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
outcomeId:
{
Description: Assessment outcome identifier ,
Required: True ,
}
string ,
queryExecuted:
{
Description: Supporting query execution identifier ,
Required: False ,
}
string ,
totalRows:
{
Description: Total number of rows evaluated during the opinion assessment ,
Format: int64 ,
Required: True ,
}
integer ,
emptyRows:
{
Description: Number of empty rows identified during the opinion assessment ,
Format: int64 ,
Required: True ,
}
integer ,
failedRows:
{
Description: Number of failed rows identified during the opinion assessment ,
Format: int64 ,
Required: True ,
}
integer ,
passedRows:
{
Description: Number of passed rows identified during the opinion assessment ,
Format: int64 ,
Required: True ,
}
integer ,
miscastRows:
{
Description: Number of miscast rows identified during the opinion assessment ,
Format: int64 ,
Required: True ,
}
integer ,
isClonedOpinion:
{
Description: Indicates if the opinion is a cloned instance ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetRules (new)
Description :  Retrieves all rules associated with data assets.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/rules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product containing the data asset ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Descriptive name of the rule ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of rule validation and business purpose ,
Required: False ,
}
string ,
type:
{
Description: Rule type classification ,
Required: True ,
}
string ,
status:
{
Description: Current execution status ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific configuration properties ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Unique rule identifier ,
Required: True ,
}
string ,
businessDomain:
{
Description: Business domain reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Data product reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
score:
{
Description: Quality score (0.0 to 1.0) ,
Format: double ,
Required: False ,
}
number ,
dimension:
{
Description: Optional business dimension or classification ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp when this rule was created ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this rule was last modified ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: User identifier for the creator of the rule ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: User identifier for the last modifier of the rule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetRule (new)
Description :  Retrieves a specific rule associated with a data asset.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/rules/{ruleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product containing the data asset ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset ,
Required: True ,
}
string ,
ruleId:
{
Description: Unique identifier for the data quality rule ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Descriptive name of the rule ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of rule validation and business purpose ,
Required: False ,
}
string ,
type:
{
Description: Rule type classification ,
Required: True ,
}
string ,
status:
{
Description: Current execution status ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific configuration properties ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Unique rule identifier ,
Required: True ,
}
string ,
businessDomain:
{
Description: Business domain reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Data product reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
score:
{
Description: Quality score (0.0 to 1.0) ,
Format: double ,
Required: False ,
}
number ,
dimension:
{
Description: Optional business dimension or classification ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp when this rule was created ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this rule was last modified ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: User identifier for the creator of the rule ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: User identifier for the last modifier of the rule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateRules (new)
Description :  Creates rules for a specific data asset within a data product and business domain.
Reference :  Link ¶

⚼ Request

PUT:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/rules/{ruleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product containing the data asset ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset ,
Required: True ,
}
string ,
ruleId:
{
Description: Unique identifier for the rule ,
Required: True ,
}
string ,
request:
{
Description: Rule creation request ,
Required: True ,
}
{
name:
{
Description: Descriptive name of the rule ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of rule validation and business purpose ,
Required: False ,
}
string ,
type:
{
Description: Rule type classification ,
Required: True ,
}
string ,
status:
{
Description: Current execution status ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific configuration properties ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Unique rule identifier ,
Required: True ,
}
string ,
businessDomain:
{
Description: Business domain reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Data product reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
score:
{
Description: Quality score (0.0 to 1.0) ,
Format: double ,
Required: False ,
}
number ,
dimension:
{
Description: Optional business dimension or classification ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp when this rule was created ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this rule was last modified ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: User identifier for the creator of the rule ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: User identifier for the last modifier of the rule ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
name:
{
Description: Descriptive name of the rule ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of rule validation and business purpose ,
Required: False ,
}
string ,
type:
{
Description: Rule type classification ,
Required: True ,
}
string ,
status:
{
Description: Current execution status ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific configuration properties ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Unique rule identifier ,
Required: True ,
}
string ,
businessDomain:
{
Description: Business domain reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Data product reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
score:
{
Description: Quality score (0.0 to 1.0) ,
Format: double ,
Required: False ,
}
number ,
dimension:
{
Description: Optional business dimension or classification ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp when this rule was created ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this rule was last modified ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: User identifier for the creator of the rule ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: User identifier for the last modifier of the rule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateRule (new)
Description :  Updates an existing rule associated with a data asset.
Reference :  Link ¶

⚼ Request

PATCH:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/rules/{ruleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product containing the data asset ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset ,
Required: True ,
}
string ,
ruleId:
{
Description: Unique identifier for the rule to update ,
Required: True ,
}
string ,
request:
{
Description: Rule update request ,
Required: True ,
}
{
name:
{
Description: Descriptive name of the rule ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of rule validation and business purpose ,
Required: False ,
}
string ,
type:
{
Description: Rule type classification ,
Required: False ,
}
string ,
status:
{
Description: Current execution status ,
Required: False ,
}
string ,
typeProperties:
{
Description: Type-specific configuration properties ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Unique rule identifier ,
Required: False ,
}
string ,
businessDomain:
{
Description: Business domain reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Data product reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
score:
{
Description: Quality score (0.0 to 1.0) ,
Format: double ,
Required: False ,
}
number ,
dimension:
{
Description: Optional business dimension or classification ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp when this rule was created ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this rule was last modified ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: User identifier for the creator of the rule ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: User identifier for the last modifier of the rule ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: Descriptive name of the rule ,
Required: True ,
}
string ,
description:
{
Description: Detailed description of rule validation and business purpose ,
Required: False ,
}
string ,
type:
{
Description: Rule type classification ,
Required: True ,
}
string ,
status:
{
Description: Current execution status ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific configuration properties ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Unique rule identifier ,
Required: True ,
}
string ,
businessDomain:
{
Description: Business domain reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Data product reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
score:
{
Description: Quality score (0.0 to 1.0) ,
Format: double ,
Required: False ,
}
number ,
dimension:
{
Description: Optional business dimension or classification ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp when this rule was created ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this rule was last modified ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: User identifier for the creator of the rule ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: User identifier for the last modifier of the rule ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteRule (new)
Description :  Deletes a specific rule associated with a data asset.
Reference :  Link ¶

⚼ Request

DELETE:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/rules/{ruleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset ,
Required: True ,
}
string ,
ruleId:
{
Description: Unique identifier for the data quality rule ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetRunsForAsset (new)
Description :  Retrieves all runs associated with a specific data asset, optionally filtered by run type.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: The unique identifier for the business domain. ,
Required: True ,
}
string ,
dataProductId:
{
Description: The unique identifier for the data product. ,
Required: True ,
}
string ,
dataAssetId:
{
Description: The unique identifier for the data asset. ,
Required: True ,
}
string ,
runType:
{
Description: Specifies the type of run to filter results by (e.g., 'Scan' or 'Validation'). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of job history execution records ,
Required: True ,
}
[
{
dataAssetId:
{
Description: Processed data asset identifier ,
Required: True ,
}
string ,
runId:
{
Description: Job execution run identifier ,
Required: True ,
}
string ,
dataProductId:
{
Description: Parent data product identifier ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Governing business domain identifier ,
Required: True ,
}
string ,
startTime:
{
Description: Job execution start timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job execution end timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
submissionTime:
{
Description: Job submission timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Final job execution status ,
Required: False ,
}
string ,
jobType:
{
Description: Job type classification ,
Required: False ,
}
string ,
accountId:
{
Description: Job execution account identifier ,
Required: False ,
}
string ,
isDQAsset:
{
Description: Flag indicating if the asset is a Data Quality asset ,
Required: False ,
}
boolean ,
qualifiedPath:
{
Description: Fully qualified data resource path ,
Required: False ,
}
string ,
scanId:
{
Description: Associated scan operation identifier ,
Required: False ,
}
string ,
dataProductName:
{
Description: Which data product the scan belongs to ,
Required: False ,
}
string ,
dataAssetName:
{
Description: Which dataasset the scan belongs to ,
Required: False ,
}
string ,
triggerType:
{
Description: Trigger type classification ,
Required: False ,
}
string ,
scheduleId:
{
Description: Triggering schedule identifier ,
Required: False ,
}
string ,
scheduleName:
{
Description: Scheduled triggered name ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetScopedAssetMetaData (new)
Description :  Retrieves the scoped asset metadata for a given data asset within a business domain.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/scoped-asset-metadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product containing the data asset ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset whose scoped metadata is being retrieved ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier for the scoped asset metadata entity. ,
Required: False ,
}
string ,
description:
{
Description: Descriptive text providing details about the scoped asset metadata. ,
Required: True ,
}
string ,
businessDomain:
{
Description: Reference to the associated Business Domain. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated Data Product. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated Data Asset. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
runtime:
{
Description: Runtime configuration parameters defining error row behavior and output format. ,
Required: False ,
}
{
isErrorRowRequired:
{
Description: Indicates whether error row details should be captured. ,
Required: True ,
}
boolean ,
errorRowWriteFormat:
{
Description: Specifies the format in which error rows are written (e.g., CSV, Parquet). ,
Required: False ,
}
string ,
}
,
favouriteColumnPaths:
{
Description: List of favorite column paths selected for quick access or monitoring. ,
Required: True ,
}
[
string ,
]
,
createdAt:
{
Description: Timestamp when this metadata was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this metadata was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier of the user who created this metadata. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier of the user who last modified this metadata. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag used for concurrency control and version validation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateScopedAssetMetaData (new)
Description :  Create or update the scoped asset metadata for a given data asset within a business domain.
Reference :  Link ¶

⚼ Request

PATCH:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/scoped-asset-metadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product containing the data asset ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset whose scoped metadata is being updated ,
Required: True ,
}
string ,
request:
{
Description: Updated scoped asset metadata with partial modifications ,
Required: True ,
}
{
id:
{
Description: Unique identifier for the scoped asset metadata entity. ,
Required: False ,
}
string ,
description:
{
Description: Descriptive text providing details about the scoped asset metadata. ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the associated Business Domain. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated Data Product. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated Data Asset. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
runtime:
{
Description: Runtime configuration parameters defining error row behavior and output format. ,
Required: False ,
}
{
isErrorRowRequired:
{
Description: Indicates whether error row details should be captured. ,
Required: False ,
}
boolean ,
errorRowWriteFormat:
{
Description: Specifies the format in which error rows are written (e.g., CSV, Parquet). ,
Required: False ,
}
string ,
}
,
favouriteColumnPaths:
{
Description: List of favorite column paths selected for quick access or monitoring. ,
Required: False ,
}
[
string ,
]
,
createdAt:
{
Description: Timestamp when this metadata was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this metadata was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier of the user who created this metadata. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier of the user who last modified this metadata. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag used for concurrency control and version validation. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier for the scoped asset metadata entity. ,
Required: False ,
}
string ,
description:
{
Description: Descriptive text providing details about the scoped asset metadata. ,
Required: True ,
}
string ,
businessDomain:
{
Description: Reference to the associated Business Domain. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated Data Product. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated Data Asset. ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
runtime:
{
Description: Runtime configuration parameters defining error row behavior and output format. ,
Required: False ,
}
{
isErrorRowRequired:
{
Description: Indicates whether error row details should be captured. ,
Required: True ,
}
boolean ,
errorRowWriteFormat:
{
Description: Specifies the format in which error rows are written (e.g., CSV, Parquet). ,
Required: False ,
}
string ,
}
,
favouriteColumnPaths:
{
Description: List of favorite column paths selected for quick access or monitoring. ,
Required: True ,
}
[
string ,
]
,
createdAt:
{
Description: Timestamp when this metadata was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Timestamp when this metadata was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier of the user who created this metadata. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier of the user who last modified this metadata. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag used for concurrency control and version validation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteScopedAssetMetaData (new)
Description :  Deletes the scoped asset metadata for a given data asset within a business domain.
Reference :  Link ¶

⚼ Request

DELETE:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/scoped-asset-metadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique identifier for the data product containing the data asset ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset whose scoped metadata is being deleted ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetLatestSnapshot (new)
Description :  Retrieves the latest data quality snapshot report for a given business domain.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{assetId}/snapshots
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain ,
Required: True ,
}
string ,
dataProductId:
{
Description: Unique Data Product Identifier ,
Required: True ,
}
string ,
assetId:
{
Description: Unique Data Asset Identifier ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
businessDomainId:
{
Description: Business domain identifier ,
Required: True ,
}
string ,
dataProductId:
{
Description: Data product identifier ,
Required: True ,
}
string ,
assetId:
{
Description: Asset identifier ,
Required: True ,
}
string ,
assetScore:
{
Description: Overall score for the asset ,
Format: double ,
Required: True ,
}
number ,
originAssetId:
{
Description: Origin asset identifier ,
Required: True ,
}
string ,
isStandaloneAsset:
{
Description: Is the asset standalone ,
Required: True ,
}
boolean ,
rules:
{
Description: Rules with their scores and validation results ,
Required: True ,
}
[
{
id:
{
Description: Rule identifier ,
Required: False ,
}
string ,
score:
{
Description: Score for the rule ,
Format: double ,
Required: False ,
}
number ,
name:
{
Description: Name of the rule ,
Required: False ,
}
string ,
description:
{
Description: Description of the rule ,
Required: False ,
}
string ,
type:
{
Description: Type of the rule ,
Required: False ,
}
string ,
status:
{
Description: Status of the rule ,
Required: False ,
}
string ,
columns:
{
Description: Columns associated with the rule ,
Required: False ,
}
[
string ,
]
,
totalRows:
{
Description: Total number of rows processed ,
Format: int64 ,
Required: False ,
}
integer ,
failedRows:
{
Description: Number of failed rows ,
Format: int64 ,
Required: False ,
}
integer ,
passedRows:
{
Description: Number of passed rows ,
Format: int64 ,
Required: False ,
}
integer ,
emptyRows:
{
Description: Number of empty rows ,
Format: int64 ,
Required: False ,
}
integer ,
miscastRows:
{
Description: Number of miscast rows ,
Format: int64 ,
Required: False ,
}
integer ,
queryExecuted:
{
Description: The query which has been executed ,
Required: False ,
}
string ,
dimension:
{
Description: Dimension of the rule ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the business domain ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the data product ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the data asset ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
typeProperties:
{
Description: Properties related to the data asset ,
Required: False ,
}
{
column:
{
Description: Column specification for column-specific rules. ,
Required: False ,
}
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
columns:
{
Description: List of columns for multi-column or relational rules (e.g., Duplicate, CustomTruth). ,
Required: False ,
}
[
{
type:
{
Description: Column data type or classification ,
Required: False ,
}
string ,
value:
{
Description: Column name or identifier ,
Required: False ,
}
string ,
}
,
]
,
pattern:
{
Description: Regex or pattern-based validation logic for format rules. ,
Required: False ,
}
string ,
condition:
{
Description: Main logical condition or expression defining validation criteria. ,
Required: False ,
}
string ,
filterCriteria:
{
Description: Optional filter condition to limit rows that are validated by this rule. ,
Required: False ,
}
string ,
emptyCriteria:
{
Description: Optional condition defining when a field or column is considered empty. ,
Required: False ,
}
string ,
}
,
lastModifiedAt:
{
Description: Last modification timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modifier user ID ,
Required: False ,
}
string ,
createdBy:
{
Description: Creator user ID ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation timestamp ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
job:
{
Description: Job information for the snapshot ,
Required: True ,
}
{
jobId:
{
Description: Job identifier ,
Required: False ,
}
string ,
businessDomainId:
{
Description: Business domain identifier ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetDataSources (new)
Description :  Retrieves all data source connections for a given business domain, with optional name filtering and pagination.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/data-sources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier of the business domain whose data sources are being retrieved. ,
Required: True ,
}
string ,
skipToken:
{
Description: Continuation token used for pagination of data source results. ,
Required: False ,
}
string ,
name:
{
Description: Optional name filter to match data sources by partial or full name. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of data source entities ,
Required: True ,
}
[
{
id:
{
Description: Unique system identifier for the data source entity. ,
Required: False ,
}
string ,
name:
{
Description: Human-readable display name identifying the data source connection. ,
Required: False ,
}
string ,
isVNetEnabled:
{
Description: Virtual Network connectivity flag. ,
Required: False ,
}
boolean ,
targetResourceId:
{
Description: Azure resource identifier for target platform (if applicable). ,
Required: False ,
}
string ,
businessDomain:
{
Description: Business domain governance reference for this data source. ,
Required: False ,
}
{
type:
{
Description: Business domain reference type classification. ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique business domain identifier associated with this data source. ,
Required: True ,
}
string ,
}
,
lastModifiedAt:
{
Description: ISO 8601 timestamp representing the last modification time. ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier or name of the user who created the data source configuration. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier or name of the last modifying user. ,
Required: False ,
}
string ,
type:
{
Description: Platform type of the data source (e.g., AzureSqlDatabase, Snowflake, OneLake, etc.). ,
Required: False ,
}
string ,
credential:
{
Description: Authentication credential configuration for data source access. ,
Required: False ,
}
{
type:
{
Description: Credential type for authentication. ,
Required: True ,
}
string ,
referenceName:
{
Description: Reference identifier for the credential resource. ,
Required: False ,
}
string ,
typeProperties:
{
Description: Type-specific credential parameters. ,
Required: False ,
}
object ,
}
,
typeProperties:
{
Description: Combined configuration properties for all supported data source platforms. ,
Required: False ,
}
{
server:
{
Description: Azure SQL server name (for AzureSqlDatabase). ,
Required: False ,
}
string ,
database:
{
Description: Database name (for AzureSqlDatabase, Snowflake, Synapse). ,
Required: False ,
}
string ,
host:
{
Description: Oracle host IP or DNS (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
port:
{
Description: Oracle database port (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
username:
{
Description: Oracle username (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
schema:
{
Description: Schema name (for Oracle, Snowflake, or Databricks). ,
Required: False ,
}
string ,
service:
{
Description: Oracle service name (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
dataIntegrationRuntimeId:
{
Description: Integration runtime ID (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
url:
{
Description: Snowflake account URL. ,
Required: False ,
}
string ,
warehouse:
{
Description: Snowflake warehouse name. ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Schema name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
testConnectionTableName:
{
Description: Table name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
endpoint:
{
Description: Primary DFS endpoint for ADLS Gen2. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: Databricks workspace URL. ,
Required: False ,
}
string ,
httpPath:
{
Description: HTTP path for Databricks SQL warehouse. ,
Required: False ,
}
string ,
catalog:
{
Description: Unity Catalog name. ,
Required: False ,
}
string ,
metastoreId:
{
Description: Metastore identifier for Unity Catalog. ,
Required: False ,
}
string ,
workspaceName:
{
Description: Synapse workspace name. ,
Required: False ,
}
string ,
dedicatedEndpoint:
{
Description: Dedicated SQL endpoint for Synapse. ,
Required: False ,
}
string ,
serverlessEndpoint:
{
Description: Serverless SQL endpoint for Synapse. ,
Required: False ,
}
string ,
endpointType:
{
Description: Endpoint type classification (e.g., sql). ,
Required: False ,
}
string ,
tenantId:
{
Description: Microsoft Entra tenant ID (for OneLake). ,
Required: False ,
}
string ,
workspaceId:
{
Description: Fabric workspace ID (for OneLake). ,
Required: False ,
}
string ,
lakehouseId:
{
Description: Lakehouse ID (for OneLake). ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the user who created this data source. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name associated with the data source. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier associated with the data source. ,
Required: False ,
}
string ,
}
,
computeId:
{
Description: Compute resource identifier associated with the credential. ,
Required: False ,
}
string ,
region:
{
Description: Region associated with the credential. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Type of data source platform (e.g., AzureSqlDatabase, OnPremiseOracleDatabase, Snowflake, etc.). ,
Required: False ,
}
string ,
managePrivateEndPointId:
{
Description: Managed Private Endpoint identifier for secure connectivity. ,
Required: False ,
}
string ,
managePrivateEndpointStatus:
{
Description: Manage Private Endpoint status information. ,
Required: False ,
}
string ,
scopes:
{
Description: Access scope definitions controlling which data objects are included or excluded from operations. ,
Required: False ,
}
[
{
scope:
{
Description: Scope configuration defining inclusion and exclusion boundaries. ,
Required: True ,
}
{
type:
{
Description: Scope type classification (SQL, NoSQL, File, etc.). ,
Required: True ,
}
string ,
includes:
{
Description: List of included data object names or patterns within this scope. ,
Required: True ,
}
[
string ,
]
,
}
,
id:
{
Description: Unique identifier for this scope definition. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetDataSource (new)
Description :  Retrieves a specific data source connection by its ID within a given business domain, with optional query parameters.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/data-sources/{dataSourceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data source ,
Required: True ,
}
string ,
dataSourceId:
{
Description: Unique identifier for the data source connection within the business domain ,
Required: True ,
}
string ,
skipToken:
{
Description: Continuation token for paginated results. ,
Required: False ,
}
string ,
name:
{
Description: Optional name filter for data sources. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique system identifier for the data source entity. ,
Required: False ,
}
string ,
name:
{
Description: Human-readable display name identifying the data source connection. ,
Required: False ,
}
string ,
isVNetEnabled:
{
Description: Virtual Network connectivity flag. ,
Required: False ,
}
boolean ,
targetResourceId:
{
Description: Azure resource identifier for target platform (if applicable). ,
Required: False ,
}
string ,
businessDomain:
{
Description: Business domain governance reference for this data source. ,
Required: False ,
}
{
type:
{
Description: Business domain reference type classification. ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique business domain identifier associated with this data source. ,
Required: True ,
}
string ,
}
,
lastModifiedAt:
{
Description: ISO 8601 timestamp representing the last modification time. ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier or name of the user who created the data source configuration. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier or name of the last modifying user. ,
Required: False ,
}
string ,
type:
{
Description: Platform type of the data source (e.g., AzureSqlDatabase, Snowflake, OneLake, etc.). ,
Required: False ,
}
string ,
credential:
{
Description: Authentication credential configuration for data source access. ,
Required: False ,
}
{
type:
{
Description: Credential type for authentication. ,
Required: True ,
}
string ,
referenceName:
{
Description: Reference identifier for the credential resource. ,
Required: False ,
}
string ,
typeProperties:
{
Description: Type-specific credential parameters. ,
Required: False ,
}
object ,
}
,
typeProperties:
{
Description: Combined configuration properties for all supported data source platforms. ,
Required: False ,
}
{
server:
{
Description: Azure SQL server name (for AzureSqlDatabase). ,
Required: False ,
}
string ,
database:
{
Description: Database name (for AzureSqlDatabase, Snowflake, Synapse). ,
Required: False ,
}
string ,
host:
{
Description: Oracle host IP or DNS (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
port:
{
Description: Oracle database port (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
username:
{
Description: Oracle username (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
schema:
{
Description: Schema name (for Oracle, Snowflake, or Databricks). ,
Required: False ,
}
string ,
service:
{
Description: Oracle service name (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
dataIntegrationRuntimeId:
{
Description: Integration runtime ID (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
url:
{
Description: Snowflake account URL. ,
Required: False ,
}
string ,
warehouse:
{
Description: Snowflake warehouse name. ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Schema name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
testConnectionTableName:
{
Description: Table name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
endpoint:
{
Description: Primary DFS endpoint for ADLS Gen2. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: Databricks workspace URL. ,
Required: False ,
}
string ,
httpPath:
{
Description: HTTP path for Databricks SQL warehouse. ,
Required: False ,
}
string ,
catalog:
{
Description: Unity Catalog name. ,
Required: False ,
}
string ,
metastoreId:
{
Description: Metastore identifier for Unity Catalog. ,
Required: False ,
}
string ,
workspaceName:
{
Description: Synapse workspace name. ,
Required: False ,
}
string ,
dedicatedEndpoint:
{
Description: Dedicated SQL endpoint for Synapse. ,
Required: False ,
}
string ,
serverlessEndpoint:
{
Description: Serverless SQL endpoint for Synapse. ,
Required: False ,
}
string ,
endpointType:
{
Description: Endpoint type classification (e.g., sql). ,
Required: False ,
}
string ,
tenantId:
{
Description: Microsoft Entra tenant ID (for OneLake). ,
Required: False ,
}
string ,
workspaceId:
{
Description: Fabric workspace ID (for OneLake). ,
Required: False ,
}
string ,
lakehouseId:
{
Description: Lakehouse ID (for OneLake). ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the user who created this data source. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name associated with the data source. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier associated with the data source. ,
Required: False ,
}
string ,
}
,
computeId:
{
Description: Compute resource identifier associated with the credential. ,
Required: False ,
}
string ,
region:
{
Description: Region associated with the credential. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Type of data source platform (e.g., AzureSqlDatabase, OnPremiseOracleDatabase, Snowflake, etc.). ,
Required: False ,
}
string ,
managePrivateEndPointId:
{
Description: Managed Private Endpoint identifier for secure connectivity. ,
Required: False ,
}
string ,
managePrivateEndpointStatus:
{
Description: Manage Private Endpoint status information. ,
Required: False ,
}
string ,
scopes:
{
Description: Access scope definitions controlling which data objects are included or excluded from operations. ,
Required: False ,
}
[
{
scope:
{
Description: Scope configuration defining inclusion and exclusion boundaries. ,
Required: True ,
}
{
type:
{
Description: Scope type classification (SQL, NoSQL, File, etc.). ,
Required: True ,
}
string ,
includes:
{
Description: List of included data object names or patterns within this scope. ,
Required: True ,
}
[
string ,
]
,
}
,
id:
{
Description: Unique identifier for this scope definition. ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateDataSource (new)
Description :  Creates a new data source connection under a given business domain.
Reference :  Link ¶

⚼ Request

PUT:  /business-domains/{businessDomainId}/data-sources/{dataSourceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain that will contain the new data source ,
Required: True ,
}
string ,
dataSourceId:
{
Description: Unique identifier for the data source connection to be created ,
Required: True ,
}
string ,
request:
{
Description: Data source entity with configuration for the new data source ,
Required: True ,
}
{
id:
{
Description: Unique system identifier for the data source entity. ,
Required: False ,
}
string ,
name:
{
Description: Human-readable display name identifying the data source connection. ,
Required: False ,
}
string ,
isVNetEnabled:
{
Description: Virtual Network connectivity flag. ,
Required: False ,
}
boolean ,
targetResourceId:
{
Description: Azure resource identifier for target platform (if applicable). ,
Required: False ,
}
string ,
businessDomain:
{
Description: Business domain governance reference for this data source. ,
Required: False ,
}
{
type:
{
Description: Business domain reference type classification. ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique business domain identifier associated with this data source. ,
Required: True ,
}
string ,
}
,
lastModifiedAt:
{
Description: ISO 8601 timestamp representing the last modification time. ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier or name of the user who created the data source configuration. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier or name of the last modifying user. ,
Required: False ,
}
string ,
type:
{
Description: Platform type of the data source (e.g., AzureSqlDatabase, Snowflake, OneLake, etc.). ,
Required: False ,
}
string ,
credential:
{
Description: Authentication credential configuration for data source access. ,
Required: False ,
}
{
type:
{
Description: Credential type for authentication. ,
Required: True ,
}
string ,
referenceName:
{
Description: Reference identifier for the credential resource. ,
Required: False ,
}
string ,
typeProperties:
{
Description: Type-specific credential parameters. ,
Required: False ,
}
object ,
}
,
typeProperties:
{
Description: Combined configuration properties for all supported data source platforms. ,
Required: False ,
}
{
server:
{
Description: Azure SQL server name (for AzureSqlDatabase). ,
Required: False ,
}
string ,
database:
{
Description: Database name (for AzureSqlDatabase, Snowflake, Synapse). ,
Required: False ,
}
string ,
host:
{
Description: Oracle host IP or DNS (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
port:
{
Description: Oracle database port (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
username:
{
Description: Oracle username (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
schema:
{
Description: Schema name (for Oracle, Snowflake, or Databricks). ,
Required: False ,
}
string ,
service:
{
Description: Oracle service name (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
dataIntegrationRuntimeId:
{
Description: Integration runtime ID (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
url:
{
Description: Snowflake account URL. ,
Required: False ,
}
string ,
warehouse:
{
Description: Snowflake warehouse name. ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Schema name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
testConnectionTableName:
{
Description: Table name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
endpoint:
{
Description: Primary DFS endpoint for ADLS Gen2. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: Databricks workspace URL. ,
Required: False ,
}
string ,
httpPath:
{
Description: HTTP path for Databricks SQL warehouse. ,
Required: False ,
}
string ,
catalog:
{
Description: Unity Catalog name. ,
Required: False ,
}
string ,
metastoreId:
{
Description: Metastore identifier for Unity Catalog. ,
Required: False ,
}
string ,
workspaceName:
{
Description: Synapse workspace name. ,
Required: False ,
}
string ,
dedicatedEndpoint:
{
Description: Dedicated SQL endpoint for Synapse. ,
Required: False ,
}
string ,
serverlessEndpoint:
{
Description: Serverless SQL endpoint for Synapse. ,
Required: False ,
}
string ,
endpointType:
{
Description: Endpoint type classification (e.g., sql). ,
Required: False ,
}
string ,
tenantId:
{
Description: Microsoft Entra tenant ID (for OneLake). ,
Required: False ,
}
string ,
workspaceId:
{
Description: Fabric workspace ID (for OneLake). ,
Required: False ,
}
string ,
lakehouseId:
{
Description: Lakehouse ID (for OneLake). ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the user who created this data source. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name associated with the data source. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier associated with the data source. ,
Required: False ,
}
string ,
}
,
computeId:
{
Description: Compute resource identifier associated with the credential. ,
Required: False ,
}
string ,
region:
{
Description: Region associated with the credential. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Type of data source platform (e.g., AzureSqlDatabase, OnPremiseOracleDatabase, Snowflake, etc.). ,
Required: False ,
}
string ,
managePrivateEndPointId:
{
Description: Managed Private Endpoint identifier for secure connectivity. ,
Required: False ,
}
string ,
managePrivateEndpointStatus:
{
Description: Manage Private Endpoint status information. ,
Required: False ,
}
string ,
scopes:
{
Description: Access scope definitions controlling which data objects are included or excluded from operations. ,
Required: False ,
}
[
{
scope:
{
Description: Scope configuration defining inclusion and exclusion boundaries. ,
Required: True ,
}
{
type:
{
Description: Scope type classification (SQL, NoSQL, File, etc.). ,
Required: True ,
}
string ,
includes:
{
Description: List of included data object names or patterns within this scope. ,
Required: True ,
}
[
string ,
]
,
}
,
id:
{
Description: Unique identifier for this scope definition. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Unique system identifier for the data source entity. ,
Required: False ,
}
string ,
name:
{
Description: Human-readable display name identifying the data source connection. ,
Required: False ,
}
string ,
isVNetEnabled:
{
Description: Virtual Network connectivity flag. ,
Required: False ,
}
boolean ,
targetResourceId:
{
Description: Azure resource identifier for target platform (if applicable). ,
Required: False ,
}
string ,
businessDomain:
{
Description: Business domain governance reference for this data source. ,
Required: False ,
}
{
type:
{
Description: Business domain reference type classification. ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique business domain identifier associated with this data source. ,
Required: True ,
}
string ,
}
,
lastModifiedAt:
{
Description: ISO 8601 timestamp representing the last modification time. ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier or name of the user who created the data source configuration. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier or name of the last modifying user. ,
Required: False ,
}
string ,
type:
{
Description: Platform type of the data source (e.g., AzureSqlDatabase, Snowflake, OneLake, etc.). ,
Required: False ,
}
string ,
credential:
{
Description: Authentication credential configuration for data source access. ,
Required: False ,
}
{
type:
{
Description: Credential type for authentication. ,
Required: True ,
}
string ,
referenceName:
{
Description: Reference identifier for the credential resource. ,
Required: False ,
}
string ,
typeProperties:
{
Description: Type-specific credential parameters. ,
Required: False ,
}
object ,
}
,
typeProperties:
{
Description: Combined configuration properties for all supported data source platforms. ,
Required: False ,
}
{
server:
{
Description: Azure SQL server name (for AzureSqlDatabase). ,
Required: False ,
}
string ,
database:
{
Description: Database name (for AzureSqlDatabase, Snowflake, Synapse). ,
Required: False ,
}
string ,
host:
{
Description: Oracle host IP or DNS (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
port:
{
Description: Oracle database port (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
username:
{
Description: Oracle username (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
schema:
{
Description: Schema name (for Oracle, Snowflake, or Databricks). ,
Required: False ,
}
string ,
service:
{
Description: Oracle service name (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
dataIntegrationRuntimeId:
{
Description: Integration runtime ID (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
url:
{
Description: Snowflake account URL. ,
Required: False ,
}
string ,
warehouse:
{
Description: Snowflake warehouse name. ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Schema name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
testConnectionTableName:
{
Description: Table name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
endpoint:
{
Description: Primary DFS endpoint for ADLS Gen2. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: Databricks workspace URL. ,
Required: False ,
}
string ,
httpPath:
{
Description: HTTP path for Databricks SQL warehouse. ,
Required: False ,
}
string ,
catalog:
{
Description: Unity Catalog name. ,
Required: False ,
}
string ,
metastoreId:
{
Description: Metastore identifier for Unity Catalog. ,
Required: False ,
}
string ,
workspaceName:
{
Description: Synapse workspace name. ,
Required: False ,
}
string ,
dedicatedEndpoint:
{
Description: Dedicated SQL endpoint for Synapse. ,
Required: False ,
}
string ,
serverlessEndpoint:
{
Description: Serverless SQL endpoint for Synapse. ,
Required: False ,
}
string ,
endpointType:
{
Description: Endpoint type classification (e.g., sql). ,
Required: False ,
}
string ,
tenantId:
{
Description: Microsoft Entra tenant ID (for OneLake). ,
Required: False ,
}
string ,
workspaceId:
{
Description: Fabric workspace ID (for OneLake). ,
Required: False ,
}
string ,
lakehouseId:
{
Description: Lakehouse ID (for OneLake). ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the user who created this data source. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name associated with the data source. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier associated with the data source. ,
Required: False ,
}
string ,
}
,
computeId:
{
Description: Compute resource identifier associated with the credential. ,
Required: False ,
}
string ,
region:
{
Description: Region associated with the credential. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Type of data source platform (e.g., AzureSqlDatabase, OnPremiseOracleDatabase, Snowflake, etc.). ,
Required: False ,
}
string ,
managePrivateEndPointId:
{
Description: Managed Private Endpoint identifier for secure connectivity. ,
Required: False ,
}
string ,
managePrivateEndpointStatus:
{
Description: Manage Private Endpoint status information. ,
Required: False ,
}
string ,
scopes:
{
Description: Access scope definitions controlling which data objects are included or excluded from operations. ,
Required: False ,
}
[
{
scope:
{
Description: Scope configuration defining inclusion and exclusion boundaries. ,
Required: True ,
}
{
type:
{
Description: Scope type classification (SQL, NoSQL, File, etc.). ,
Required: True ,
}
string ,
includes:
{
Description: List of included data object names or patterns within this scope. ,
Required: True ,
}
[
string ,
]
,
}
,
id:
{
Description: Unique identifier for this scope definition. ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateDataSource (new)
Description :  Updates an existing data source within a given business domain.
Reference :  Link ¶

⚼ Request

PATCH:  /business-domains/{businessDomainId}/data-sources/{dataSourceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data source ,
Required: True ,
}
string ,
dataSourceId:
{
Description: Unique identifier for the data source connection to be updated ,
Required: True ,
}
string ,
request:
{
Description: Updated data source entity with partial modifications ,
Required: True ,
}
{
id:
{
Description: Unique system identifier for the data source entity. ,
Required: False ,
}
string ,
name:
{
Description: Human-readable display name identifying the data source connection. ,
Required: False ,
}
string ,
isVNetEnabled:
{
Description: Virtual Network connectivity flag. ,
Required: False ,
}
boolean ,
targetResourceId:
{
Description: Azure resource identifier for target platform (if applicable). ,
Required: False ,
}
string ,
businessDomain:
{
Description: Business domain governance reference for this data source. ,
Required: False ,
}
{
type:
{
Description: Business domain reference type classification. ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique business domain identifier associated with this data source. ,
Required: False ,
}
string ,
}
,
lastModifiedAt:
{
Description: ISO 8601 timestamp representing the last modification time. ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier or name of the user who created the data source configuration. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier or name of the last modifying user. ,
Required: False ,
}
string ,
type:
{
Description: Platform type of the data source (e.g., AzureSqlDatabase, Snowflake, OneLake, etc.). ,
Required: False ,
}
string ,
credential:
{
Description: Authentication credential configuration for data source access. ,
Required: False ,
}
{
type:
{
Description: Credential type for authentication. ,
Required: False ,
}
string ,
referenceName:
{
Description: Reference identifier for the credential resource. ,
Required: False ,
}
string ,
typeProperties:
{
Description: Type-specific credential parameters. ,
Required: False ,
}
object ,
}
,
typeProperties:
{
Description: Combined configuration properties for all supported data source platforms. ,
Required: False ,
}
{
server:
{
Description: Azure SQL server name (for AzureSqlDatabase). ,
Required: False ,
}
string ,
database:
{
Description: Database name (for AzureSqlDatabase, Snowflake, Synapse). ,
Required: False ,
}
string ,
host:
{
Description: Oracle host IP or DNS (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
port:
{
Description: Oracle database port (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
username:
{
Description: Oracle username (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
schema:
{
Description: Schema name (for Oracle, Snowflake, or Databricks). ,
Required: False ,
}
string ,
service:
{
Description: Oracle service name (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
dataIntegrationRuntimeId:
{
Description: Integration runtime ID (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
url:
{
Description: Snowflake account URL. ,
Required: False ,
}
string ,
warehouse:
{
Description: Snowflake warehouse name. ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Schema name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
testConnectionTableName:
{
Description: Table name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
endpoint:
{
Description: Primary DFS endpoint for ADLS Gen2. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: Databricks workspace URL. ,
Required: False ,
}
string ,
httpPath:
{
Description: HTTP path for Databricks SQL warehouse. ,
Required: False ,
}
string ,
catalog:
{
Description: Unity Catalog name. ,
Required: False ,
}
string ,
metastoreId:
{
Description: Metastore identifier for Unity Catalog. ,
Required: False ,
}
string ,
workspaceName:
{
Description: Synapse workspace name. ,
Required: False ,
}
string ,
dedicatedEndpoint:
{
Description: Dedicated SQL endpoint for Synapse. ,
Required: False ,
}
string ,
serverlessEndpoint:
{
Description: Serverless SQL endpoint for Synapse. ,
Required: False ,
}
string ,
endpointType:
{
Description: Endpoint type classification (e.g., sql). ,
Required: False ,
}
string ,
tenantId:
{
Description: Microsoft Entra tenant ID (for OneLake). ,
Required: False ,
}
string ,
workspaceId:
{
Description: Fabric workspace ID (for OneLake). ,
Required: False ,
}
string ,
lakehouseId:
{
Description: Lakehouse ID (for OneLake). ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the user who created this data source. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name associated with the data source. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier associated with the data source. ,
Required: False ,
}
string ,
}
,
computeId:
{
Description: Compute resource identifier associated with the credential. ,
Required: False ,
}
string ,
region:
{
Description: Region associated with the credential. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Type of data source platform (e.g., AzureSqlDatabase, OnPremiseOracleDatabase, Snowflake, etc.). ,
Required: False ,
}
string ,
managePrivateEndPointId:
{
Description: Managed Private Endpoint identifier for secure connectivity. ,
Required: False ,
}
string ,
managePrivateEndpointStatus:
{
Description: Manage Private Endpoint status information. ,
Required: False ,
}
string ,
scopes:
{
Description: Access scope definitions controlling which data objects are included or excluded from operations. ,
Required: False ,
}
[
{
scope:
{
Description: Scope configuration defining inclusion and exclusion boundaries. ,
Required: True ,
}
{
type:
{
Description: Scope type classification (SQL, NoSQL, File, etc.). ,
Required: True ,
}
string ,
includes:
{
Description: List of included data object names or patterns within this scope. ,
Required: True ,
}
[
string ,
]
,
}
,
id:
{
Description: Unique identifier for this scope definition. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique system identifier for the data source entity. ,
Required: False ,
}
string ,
name:
{
Description: Human-readable display name identifying the data source connection. ,
Required: False ,
}
string ,
isVNetEnabled:
{
Description: Virtual Network connectivity flag. ,
Required: False ,
}
boolean ,
targetResourceId:
{
Description: Azure resource identifier for target platform (if applicable). ,
Required: False ,
}
string ,
businessDomain:
{
Description: Business domain governance reference for this data source. ,
Required: False ,
}
{
type:
{
Description: Business domain reference type classification. ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique business domain identifier associated with this data source. ,
Required: True ,
}
string ,
}
,
lastModifiedAt:
{
Description: ISO 8601 timestamp representing the last modification time. ,
Required: False ,
}
string ,
createdBy:
{
Description: Identifier or name of the user who created the data source configuration. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identifier or name of the last modifying user. ,
Required: False ,
}
string ,
type:
{
Description: Platform type of the data source (e.g., AzureSqlDatabase, Snowflake, OneLake, etc.). ,
Required: False ,
}
string ,
credential:
{
Description: Authentication credential configuration for data source access. ,
Required: False ,
}
{
type:
{
Description: Credential type for authentication. ,
Required: True ,
}
string ,
referenceName:
{
Description: Reference identifier for the credential resource. ,
Required: False ,
}
string ,
typeProperties:
{
Description: Type-specific credential parameters. ,
Required: False ,
}
object ,
}
,
typeProperties:
{
Description: Combined configuration properties for all supported data source platforms. ,
Required: False ,
}
{
server:
{
Description: Azure SQL server name (for AzureSqlDatabase). ,
Required: False ,
}
string ,
database:
{
Description: Database name (for AzureSqlDatabase, Snowflake, Synapse). ,
Required: False ,
}
string ,
host:
{
Description: Oracle host IP or DNS (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
port:
{
Description: Oracle database port (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
username:
{
Description: Oracle username (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
schema:
{
Description: Schema name (for Oracle, Snowflake, or Databricks). ,
Required: False ,
}
string ,
service:
{
Description: Oracle service name (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
dataIntegrationRuntimeId:
{
Description: Integration runtime ID (for OnPremiseOracleDatabase). ,
Required: False ,
}
string ,
url:
{
Description: Snowflake account URL. ,
Required: False ,
}
string ,
warehouse:
{
Description: Snowflake warehouse name. ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Schema name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
testConnectionTableName:
{
Description: Table name used for test connection (for Snowflake). ,
Required: False ,
}
string ,
endpoint:
{
Description: Primary DFS endpoint for ADLS Gen2. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: Databricks workspace URL. ,
Required: False ,
}
string ,
httpPath:
{
Description: HTTP path for Databricks SQL warehouse. ,
Required: False ,
}
string ,
catalog:
{
Description: Unity Catalog name. ,
Required: False ,
}
string ,
metastoreId:
{
Description: Metastore identifier for Unity Catalog. ,
Required: False ,
}
string ,
workspaceName:
{
Description: Synapse workspace name. ,
Required: False ,
}
string ,
dedicatedEndpoint:
{
Description: Dedicated SQL endpoint for Synapse. ,
Required: False ,
}
string ,
serverlessEndpoint:
{
Description: Serverless SQL endpoint for Synapse. ,
Required: False ,
}
string ,
endpointType:
{
Description: Endpoint type classification (e.g., sql). ,
Required: False ,
}
string ,
tenantId:
{
Description: Microsoft Entra tenant ID (for OneLake). ,
Required: False ,
}
string ,
workspaceId:
{
Description: Fabric workspace ID (for OneLake). ,
Required: False ,
}
string ,
lakehouseId:
{
Description: Lakehouse ID (for OneLake). ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the user who created this data source. ,
Required: False ,
}
string ,
createdAt:
{
Description: ISO 8601 timestamp representing the creation time. ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control and change detection. ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource name associated with the data source. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier associated with the data source. ,
Required: False ,
}
string ,
}
,
computeId:
{
Description: Compute resource identifier associated with the credential. ,
Required: False ,
}
string ,
region:
{
Description: Region associated with the credential. ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Type of data source platform (e.g., AzureSqlDatabase, OnPremiseOracleDatabase, Snowflake, etc.). ,
Required: False ,
}
string ,
managePrivateEndPointId:
{
Description: Managed Private Endpoint identifier for secure connectivity. ,
Required: False ,
}
string ,
managePrivateEndpointStatus:
{
Description: Manage Private Endpoint status information. ,
Required: False ,
}
string ,
scopes:
{
Description: Access scope definitions controlling which data objects are included or excluded from operations. ,
Required: False ,
}
[
{
scope:
{
Description: Scope configuration defining inclusion and exclusion boundaries. ,
Required: True ,
}
{
type:
{
Description: Scope type classification (SQL, NoSQL, File, etc.). ,
Required: True ,
}
string ,
includes:
{
Description: List of included data object names or patterns within this scope. ,
Required: True ,
}
[
string ,
]
,
}
,
id:
{
Description: Unique identifier for this scope definition. ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteDataSource (new)
Description :  Deletes a specific data source connection within a given business domain.
Reference :  Link ¶

⚼ Request

DELETE:  /business-domains/{businessDomainId}/data-sources/{dataSourceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain ,
Required: True ,
}
string ,
dataSourceId:
{
Description: Unique identifier for the data source ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetRunStatus (new)
Description :  Retrieves execution metadata and status for a specific schedule run within a business domain.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/runs/{runId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
runId:
{
Description: Unique identifier for the run within the business domain ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
runId:
{
Description: Unique execution run identifier ,
Required: False ,
}
string ,
dataProductId:
{
Description: Data product identifier containing target assets ,
Required: False ,
}
string ,
redundancyCheck:
{
Description: Flag for redundancy validation checks ,
Required: False ,
}
boolean ,
accountId:
{
Description: Executing account identifier ,
Required: False ,
}
string ,
businessDomainId:
{
Description: Governing business domain identifier ,
Required: False ,
}
string ,
submissionTime:
{
Description: Job submission timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Job execution start timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job execution end timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
cancelRequestTime:
{
Description: Job cancellation request timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Current job execution status ,
Required: False ,
}
string ,
pfsJobId:
{
Description: Platform-specific external job identifier ,
Required: False ,
}
string ,
message:
{
Description: Job execution message with status or error details ,
Required: False ,
}
string ,
duration:
{
Description: Job execution duration in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
startedBy:
{
Description: Identity of the job initiating user ,
Required: False ,
}
string ,
cancelledBy:
{
Description: Identity of the job cancelling user ,
Required: False ,
}
string ,
jobType:
{
Description: Job type classification ,
Required: False ,
}
string ,
jobExecutionRegion:
{
Description: Job execution geographic region ,
Required: False ,
}
string ,
dataAssetId:
{
Description: Primary data asset identifier ,
Required: False ,
}
string ,
dataAssetName:
{
Description: Primary data asset name ,
Required: False ,
}
string ,
scheduleId:
{
Description: Triggering schedule identifier ,
Required: False ,
}
string ,
scheduleName:
{
Description: Triggering schedule name ,
Required: False ,
}
string ,
qualifiedPath:
{
Description: Fully qualified data resource path ,
Required: False ,
}
string ,
scanId:
{
Description: Associated scan operation identifier ,
Required: False ,
}
string ,
scheduleScanType:
{
Description: Schedule scan type classification ,
Required: False ,
}
string ,
jobBillingSparkSku:
{
Description: Spark compute SKU for billing and resource allocation ,
Required: False ,
}
string ,
dataSourceType:
{
Description: Data source type classification ,
Required: False ,
}
string ,
primaryDataSourceID:
{
Description: Primary data source identifier ,
Required: False ,
}
string ,
puDetail:
{
Description: Additional Purview-specific governance details ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CancelScanByRunId (new)
Description :  Cancels a specific scan run within a business domain.
Reference :  Link ¶

⚼ Request

POST:  /business-domains/{businessDomainId}/runs/{runId}:cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
runId:
{
Description: Unique identifier for the run within the business domain ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
id:
{
Description: Unique identifier of the monitored operation ,
Required: True ,
}
string ,
status:
{
Description: Current status of the operation ,
Enum:
{
InProgress: Operation in progress ,
Succeeded: Operation completed successfully ,
Failed: Operation failed with errors ,
}
,
Required: True ,
}
enum ,
kind:
{
Description: Kind of operation being monitored ,
Enum:
{
Unknown: Operation type is unknown ,
Create: Create operation ,
Update: Update operation ,
Delete: Delete operation ,
Retrieve: Retrieve operation ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Last status update timestamp (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
statusMessage:
{
Description: Status description message ,
Required: False ,
}
string ,
progressPercentage:
{
Description: Completion percentage (0–100) ,
Format: int32 ,
Required: False ,
}
integer ,
errorDetails:
{
Description: Error details for failed operations ,
Required: False ,
}
{
code:
{
Description: Standardized error code ,
Required: False ,
}
string ,
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
details:
{
Description: Additional error context as key-value pairs ,
Required: False ,
}
object ,
}
,
result:
{
Description: Result payload for successful operations ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetSchedules (new)
Description :  Retrieves all scheduled jobs defined under a given business domain, optionally supporting pagination with `skipToken`.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/schedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ScheduleEntity items on this page ,
Required: True ,
}
[
{
id:
{
Description: Unique identifier of the schedule ,
Required: True ,
}
string ,
name:
{
Description: Human-readable schedule display name ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of schedule purpose and strategy ,
Required: False ,
}
string ,
trigger:
{
Description: Trigger configuration for execution timing and scheduling ,
Required: False ,
}
{
type:
{
Description: Trigger type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific trigger configuration properties ,
Required: True ,
}
{
timezone:
{
Description: Time zone identifier for schedule evaluation ,
Required: False ,
}
string ,
isScheduled:
{
Description: Flag for automatic execution activation ,
Required: False ,
}
boolean ,
triggerTime:
{
Description: Next scheduled execution time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
scope:
{
Description: Execution scope for data quality scanning ,
Required: False ,
}
{
items:
{
Description: Collection of target data products and assets ,
Required: True ,
}
[
{
dataProduct:
{
Description: Data product reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data product unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data product reference type ,
Required: True ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data asset unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data asset reference type ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
businessDomain:
{
Description: Reference to the governing business domain ,
Required: False ,
}
{
type:
{
Description: Business domain reference type ,
Required: True ,
}
string ,
referenceId:
{
Description: Business domain unique identifier ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetSchedule (new)
Description :  Retrieves a specific scheduled job by its unique identifier under a business domain.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/schedules/{scheduleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
scheduleId:
{
Description: Unique identifier for the scheduled job within the business domain ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier of the schedule ,
Required: False ,
}
string ,
name:
{
Description: Human-readable schedule display name ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of schedule purpose and strategy ,
Required: False ,
}
string ,
trigger:
{
Description: Trigger configuration for execution timing and scheduling ,
Required: False ,
}
{
type:
{
Description: Trigger type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific trigger configuration properties ,
Required: True ,
}
{
timezone:
{
Description: Time zone identifier for schedule evaluation ,
Required: False ,
}
string ,
isScheduled:
{
Description: Flag for automatic execution activation ,
Required: False ,
}
boolean ,
triggerTime:
{
Description: Next scheduled execution time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
scope:
{
Description: Execution scope for data quality scanning ,
Required: False ,
}
{
items:
{
Description: Collection of target data products and assets ,
Required: True ,
}
[
{
dataProduct:
{
Description: Data product reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data product unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data product reference type ,
Required: True ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data asset unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data asset reference type ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
businessDomain:
{
Description: Reference to the governing business domain ,
Required: False ,
}
{
type:
{
Description: Business domain reference type ,
Required: True ,
}
string ,
referenceId:
{
Description: Business domain unique identifier ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CreateSchedule (new)
Description :  Creates a new scheduled job under a business domain for selected data assets.
Reference :  Link ¶

⚼ Request

PUT:  /business-domains/{businessDomainId}/schedules/{scheduleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
scheduleId:
{
Description: Unique identifier for the scheduled job within the business domain ,
Required: True ,
}
string ,
request:
{
Description: The payload for creating scheduled job ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the schedule ,
Required: False ,
}
string ,
name:
{
Description: Human-readable schedule display name ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of schedule purpose and strategy ,
Required: False ,
}
string ,
trigger:
{
Description: Trigger configuration for execution timing and scheduling ,
Required: False ,
}
{
type:
{
Description: Trigger type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific trigger configuration properties ,
Required: True ,
}
{
timezone:
{
Description: Time zone identifier for schedule evaluation ,
Required: False ,
}
string ,
isScheduled:
{
Description: Flag for automatic execution activation ,
Required: False ,
}
boolean ,
triggerTime:
{
Description: Next scheduled execution time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
scope:
{
Description: Execution scope for data quality scanning ,
Required: False ,
}
{
items:
{
Description: Collection of target data products and assets ,
Required: True ,
}
[
{
dataProduct:
{
Description: Data product reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data product unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data product reference type ,
Required: True ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data asset unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data asset reference type ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
businessDomain:
{
Description: Reference to the governing business domain ,
Required: False ,
}
{
type:
{
Description: Business domain reference type ,
Required: True ,
}
string ,
referenceId:
{
Description: Business domain unique identifier ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Unique identifier of the schedule ,
Required: False ,
}
string ,
name:
{
Description: Human-readable schedule display name ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of schedule purpose and strategy ,
Required: False ,
}
string ,
trigger:
{
Description: Trigger configuration for execution timing and scheduling ,
Required: False ,
}
{
type:
{
Description: Trigger type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific trigger configuration properties ,
Required: True ,
}
{
timezone:
{
Description: Time zone identifier for schedule evaluation ,
Required: False ,
}
string ,
isScheduled:
{
Description: Flag for automatic execution activation ,
Required: False ,
}
boolean ,
triggerTime:
{
Description: Next scheduled execution time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
scope:
{
Description: Execution scope for data quality scanning ,
Required: False ,
}
{
items:
{
Description: Collection of target data products and assets ,
Required: True ,
}
[
{
dataProduct:
{
Description: Data product reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data product unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data product reference type ,
Required: True ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data asset unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data asset reference type ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
businessDomain:
{
Description: Reference to the governing business domain ,
Required: False ,
}
{
type:
{
Description: Business domain reference type ,
Required: True ,
}
string ,
referenceId:
{
Description: Business domain unique identifier ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateSchedule (new)
Description :  Updates the details of an existing schedule under a specific business domain.
Reference :  Link ¶

⚼ Request

PATCH:  /business-domains/{businessDomainId}/schedules/{scheduleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
scheduleId:
{
Description: Unique identifier for the schedule within the business domain ,
Required: True ,
}
string ,
request:
{
Description: The payload for creating schedule ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the schedule ,
Required: False ,
}
string ,
name:
{
Description: Human-readable schedule display name ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of schedule purpose and strategy ,
Required: False ,
}
string ,
trigger:
{
Description: Trigger configuration for execution timing and scheduling ,
Required: False ,
}
{
type:
{
Description: Trigger type classification ,
Required: False ,
}
string ,
typeProperties:
{
Description: Type-specific trigger configuration properties ,
Required: False ,
}
{
timezone:
{
Description: Time zone identifier for schedule evaluation ,
Required: False ,
}
string ,
isScheduled:
{
Description: Flag for automatic execution activation ,
Required: False ,
}
boolean ,
triggerTime:
{
Description: Next scheduled execution time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
scope:
{
Description: Execution scope for data quality scanning ,
Required: False ,
}
{
items:
{
Description: Collection of target data products and assets ,
Required: False ,
}
[
{
dataProduct:
{
Description: Data product reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data product unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data product reference type ,
Required: True ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data asset unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data asset reference type ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
businessDomain:
{
Description: Reference to the governing business domain ,
Required: False ,
}
{
type:
{
Description: Business domain reference type ,
Required: False ,
}
string ,
referenceId:
{
Description: Business domain unique identifier ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier of the schedule ,
Required: False ,
}
string ,
name:
{
Description: Human-readable schedule display name ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of schedule purpose and strategy ,
Required: False ,
}
string ,
trigger:
{
Description: Trigger configuration for execution timing and scheduling ,
Required: False ,
}
{
type:
{
Description: Trigger type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Type-specific trigger configuration properties ,
Required: True ,
}
{
timezone:
{
Description: Time zone identifier for schedule evaluation ,
Required: False ,
}
string ,
isScheduled:
{
Description: Flag for automatic execution activation ,
Required: False ,
}
boolean ,
triggerTime:
{
Description: Next scheduled execution time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
scope:
{
Description: Execution scope for data quality scanning ,
Required: False ,
}
{
items:
{
Description: Collection of target data products and assets ,
Required: True ,
}
[
{
dataProduct:
{
Description: Data product reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data product unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data product reference type ,
Required: True ,
}
string ,
}
,
dataAsset:
{
Description: Data asset reference within scope ,
Required: True ,
}
{
referenceId:
{
Description: Data asset unique identifier ,
Required: True ,
}
string ,
type:
{
Description: Data asset reference type ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
businessDomain:
{
Description: Reference to the governing business domain ,
Required: False ,
}
{
type:
{
Description: Business domain reference type ,
Required: True ,
}
string ,
referenceId:
{
Description: Business domain unique identifier ,
Required: True ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DeleteSchedule (new)
Description :  Deletes a specific schedule under a given business domain.
Reference :  Link ¶

⚼ Request

DELETE:  /business-domains/{businessDomainId}/schedules/{scheduleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain ,
Required: True ,
}
string ,
scheduleId:
{
Description: Unique identifier of the schedule ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Scans (new)
Description :  Creates a scan under a specific business domain and schedule.
Reference :  Link ¶

⚼ Request

POST:  /business-domains/{businessDomainId}/schedules/{scheduleId}:scans
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain ,
Required: True ,
}
string ,
scheduleId:
{
Description: Unique identifier of the schedule ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
scanType:
{
Description: Scan type classification ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
id:
{
Description: Unique identifier of the monitored operation ,
Required: True ,
}
string ,
status:
{
Description: Current status of the operation ,
Enum:
{
InProgress: Operation in progress ,
Succeeded: Operation completed successfully ,
Failed: Operation failed with errors ,
}
,
Required: True ,
}
enum ,
kind:
{
Description: Kind of operation being monitored ,
Enum:
{
Unknown: Operation type is unknown ,
Create: Create operation ,
Update: Update operation ,
Delete: Delete operation ,
Retrieve: Retrieve operation ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Last status update timestamp (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
statusMessage:
{
Description: Status description message ,
Required: False ,
}
string ,
progressPercentage:
{
Description: Completion percentage (0–100) ,
Format: int32 ,
Required: False ,
}
integer ,
errorDetails:
{
Description: Error details for failed operations ,
Required: False ,
}
{
code:
{
Description: Standardized error code ,
Required: False ,
}
string ,
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
details:
{
Description: Additional error context as key-value pairs ,
Required: False ,
}
object ,
}
,
result:
{
Description: Result payload for successful operations ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
CancelScan (new)
Description :  Cancels a specific scan under a given schedule within a business domain.
Reference :  Link ¶

⚼ Request

POST:  /business-domains/{businessDomainId}/schedules/{scheduleId}/scans/{scanId}:cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
scheduleId:
{
Description: Unique identifier for the scheduled job within the business domain ,
Required: True ,
}
string ,
scanId:
{
Description: Unique identifier for the scan within the scheduled job ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
id:
{
Description: Unique identifier of the monitored operation ,
Required: True ,
}
string ,
status:
{
Description: Current status of the operation ,
Enum:
{
InProgress: Operation in progress ,
Succeeded: Operation completed successfully ,
Failed: Operation failed with errors ,
}
,
Required: True ,
}
enum ,
kind:
{
Description: Kind of operation being monitored ,
Enum:
{
Unknown: Operation type is unknown ,
Create: Create operation ,
Update: Update operation ,
Delete: Delete operation ,
Retrieve: Retrieve operation ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Last status update timestamp (UTC) ,
Format: date-time ,
Required: True ,
}
string ,
statusMessage:
{
Description: Status description message ,
Required: False ,
}
string ,
progressPercentage:
{
Description: Completion percentage (0–100) ,
Format: int32 ,
Required: False ,
}
integer ,
errorDetails:
{
Description: Error details for failed operations ,
Required: False ,
}
{
code:
{
Description: Standardized error code ,
Required: False ,
}
string ,
message:
{
Description: Human-readable error message ,
Required: False ,
}
string ,
details:
{
Description: Additional error context as key-value pairs ,
Required: False ,
}
object ,
}
,
result:
{
Description: Result payload for successful operations ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ScanByScanId (new)
Description :  Retrieves details of a specific scan under a given schedule within a business domain.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/schedules/{scheduleId}/scans/{scanId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
scheduleId:
{
Description: Unique identifier for the scheduled job within the business domain ,
Required: True ,
}
string ,
scanId:
{
Description: Unique identifier for the scan within the scheduled job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
succeeded:
{
Description: Number of successful scan executions ,
Format: int64 ,
Required: False ,
}
integer ,
failed:
{
Description: Number of failed scan executions ,
Format: int64 ,
Required: False ,
}
integer ,
skipped:
{
Description: Number of skipped scan executions ,
Format: int64 ,
Required: False ,
}
integer ,
scheduleStatus:
{
Description: Current schedule operational status ,
Required: False ,
}
string ,
scheduleName:
{
Description: Associated schedule name ,
Required: False ,
}
string ,
scheduleId:
{
Description: Associated schedule identifier ,
Required: False ,
}
string ,
scanId:
{
Description: Specific scan execution identifier ,
Required: False ,
}
string ,
startTime:
{
Description: Scan execution start time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Scan execution end time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
accountId:
{
Description: Executing account identifier ,
Required: False ,
}
string ,
businessDomainId:
{
Description: Business domain identifier ,
Required: False ,
}
string ,
totalJobCount:
{
Description: Total job count within scan execution ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Current scan execution status ,
Required: False ,
}
string ,
scheduleRunType:
{
Description: Schedule run type classification ,
Required: False ,
}
string ,
scanType:
{
Description: Scan type classification ,
Required: False ,
}
string ,
startedBy:
{
Description: Identity of the scan initiating user ,
Required: False ,
}
string ,
cancelledBy:
{
Description: Identity of the scan cancelling user ,
Required: False ,
}
string ,
cancelRequestTime:
{
Description: Cancellation request timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
partitionKey:
{
Description: Storage partition key for data organization ,
Required: False ,
}
string ,
rowKey:
{
Description: Storage row key for unique record identification ,
Required: False ,
}
string ,
timestamp:
{
Description: Record timestamp for temporal tracking ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetRuns (new)
Description :  Retrieves all runs associated with a specific scan under a given schedule.
Reference :  Link ¶

⚼ Request

GET:  /business-domains/{businessDomainId}/schedules/{scheduleId}/scans/{scanId}/runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
businessDomainId:
{
Description: Unique identifier for the business domain containing the data product ,
Required: True ,
}
string ,
scheduleId:
{
Description: Unique identifier for the scheduled job within the business domain ,
Required: True ,
}
string ,
scanId:
{
Description: Unique identifier for the scan within the scheduled job ,
Required: True ,
}
string ,
offset:
{
Description: Offset value for pagination or incremental retrieval of runs. ,
Format: int64 ,
Required: True ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: Collection of schedule scan monitoring entities ,
Required: True ,
}
[
{
succeeded:
{
Description: Number of successful scan executions ,
Format: int64 ,
Required: False ,
}
integer ,
failed:
{
Description: Number of failed scan executions ,
Format: int64 ,
Required: False ,
}
integer ,
skipped:
{
Description: Number of skipped scan executions ,
Format: int64 ,
Required: False ,
}
integer ,
scheduleStatus:
{
Description: Current schedule operational status ,
Required: False ,
}
string ,
scheduleName:
{
Description: Associated schedule name ,
Required: False ,
}
string ,
scheduleId:
{
Description: Associated schedule identifier ,
Required: False ,
}
string ,
scanId:
{
Description: Specific scan execution identifier ,
Required: False ,
}
string ,
startTime:
{
Description: Scan execution start time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Scan execution end time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
accountId:
{
Description: Executing account identifier ,
Required: False ,
}
string ,
businessDomainId:
{
Description: Business domain identifier ,
Required: False ,
}
string ,
totalJobCount:
{
Description: Total job count within scan execution ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: Current scan execution status ,
Required: False ,
}
string ,
scheduleRunType:
{
Description: Schedule run type classification ,
Required: False ,
}
string ,
scanType:
{
Description: Scan type classification ,
Required: False ,
}
string ,
startedBy:
{
Description: Identity of the scan initiating user ,
Required: False ,
}
string ,
cancelledBy:
{
Description: Identity of the scan cancelling user ,
Required: False ,
}
string ,
cancelRequestTime:
{
Description: Cancellation request timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
partitionKey:
{
Description: Storage partition key for data organization ,
Required: False ,
}
string ,
rowKey:
{
Description: Storage row key for unique record identification ,
Required: False ,
}
string ,
timestamp:
{
Description: Record timestamp for temporal tracking ,
Format: date-time ,
Required: False ,
}
string ,
eTag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetObserver (new)
Description :  Retrieves the asset metadata associated with a Data Asset.
Reference :  Link ¶

⚼ Request

GET:  /data-assets/{dataAssetId}/asset-metadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset whose metadata observer is being retrieved ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique identifier of the asset metadata observer ,
Required: True ,
}
string ,
name:
{
Description: Display name of the asset metadata observer ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the associated business domain ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated data product ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated data asset ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
isDeleted:
{
Description: Soft deletion flag ,
Required: False ,
}
boolean ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
type:
{
Description: Data source type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Common metadata properties across all asset types ,
Required: False ,
}
{
inputDatasets:
{
Description: Input dataset definitions and schemas ,
Required: False ,
}
[
string ,
]
,
projection:
{
Description: Data projection and mapping configuration ,
Required: False ,
}
string ,
}
,
location:
{
Description: Physical storage locations for file-based assets ,
Required: False ,
}
[
{
type:
{
Description: Storage type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Storage-specific configuration properties ,
Required: True ,
}
{
fileSystem:
{
Description: File system or container name ,
Required: False ,
}
string ,
folderPath:
{
Description: Hierarchical path within the storage location ,
Required: False ,
}
string ,
accountName:
{
Description: Storage account name or endpoint identifier ,
Required: False ,
}
string ,
region:
{
Description: Geographic region or environment location ,
Required: False ,
}
string ,
}
,
}
,
]
,
format:
{
Description: Data format specification for structured assets ,
Required: False ,
}
string ,
schemaName:
{
Description: Database schema name for SQL-based assets ,
Required: False ,
}
string ,
tableName:
{
Description: Table name for SQL-based data assets ,
Required: False ,
}
string ,
hostName:
{
Description: Host server name for on-premises database connections ,
Required: False ,
}
string ,
testConnectionDatasetName:
{
Description: Connection Dataset name for Google Big Quey type of data asset ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Connection Schema name for Google Big Query type of data asset ,
Required: False ,
}
string ,
projectId:
{
Description: Project ID for Google Big Query type of data asset ,
Required: False ,
}
string ,
isDQAsset:
{
Description: Flag indicating if the asset is a Data Quality asset ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
UpdateObserver (new)
Description :  Updates the asset metadata associated with a Data Asset.
Reference :  Link ¶

⚼ Request

PATCH:  /data-assets/{dataAssetId}/asset-metadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dataAssetId:
{
Description: Unique identifier for the data asset whose metadata observer is being updated ,
Required: True ,
}
string ,
request:
{
Description: Asset metadata update request ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the asset metadata observer ,
Required: False ,
}
string ,
name:
{
Description: Display name of the asset metadata observer ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the associated business domain ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated data product ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated data asset ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
isDeleted:
{
Description: Soft deletion flag ,
Required: False ,
}
boolean ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
type:
{
Description: Data source type classification ,
Required: False ,
}
string ,
typeProperties:
{
Description: Common metadata properties across all asset types ,
Required: False ,
}
{
inputDatasets:
{
Description: Input dataset definitions and schemas ,
Required: False ,
}
[
string ,
]
,
projection:
{
Description: Data projection and mapping configuration ,
Required: False ,
}
string ,
}
,
location:
{
Description: Physical storage locations for file-based assets ,
Required: False ,
}
[
{
type:
{
Description: Storage type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Storage-specific configuration properties ,
Required: True ,
}
{
fileSystem:
{
Description: File system or container name ,
Required: False ,
}
string ,
folderPath:
{
Description: Hierarchical path within the storage location ,
Required: False ,
}
string ,
accountName:
{
Description: Storage account name or endpoint identifier ,
Required: False ,
}
string ,
region:
{
Description: Geographic region or environment location ,
Required: False ,
}
string ,
}
,
}
,
]
,
format:
{
Description: Data format specification for structured assets ,
Required: False ,
}
string ,
schemaName:
{
Description: Database schema name for SQL-based assets ,
Required: False ,
}
string ,
tableName:
{
Description: Table name for SQL-based data assets ,
Required: False ,
}
string ,
hostName:
{
Description: Host server name for on-premises database connections ,
Required: False ,
}
string ,
testConnectionDatasetName:
{
Description: Connection Dataset name for Google Big Quey type of data asset ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Connection Schema name for Google Big Query type of data asset ,
Required: False ,
}
string ,
projectId:
{
Description: Project ID for Google Big Query type of data asset ,
Required: False ,
}
string ,
isDQAsset:
{
Description: Flag indicating if the asset is a Data Quality asset ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Unique identifier of the asset metadata observer ,
Required: True ,
}
string ,
name:
{
Description: Display name of the asset metadata observer ,
Required: False ,
}
string ,
businessDomain:
{
Description: Reference to the associated business domain ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataProduct:
{
Description: Reference to the associated data product ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
dataAsset:
{
Description: Reference to the associated data asset ,
Required: False ,
}
{
type:
{
Description: Type classification of the referenced entity ,
Required: False ,
}
string ,
referenceId:
{
Description: Unique identifier of the referenced entity ,
Required: False ,
}
string ,
}
,
createdAt:
{
Description: Creation timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Identity of the creating user ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last modification timestamp (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Identity of the last modifying user ,
Required: False ,
}
string ,
isDeleted:
{
Description: Soft deletion flag ,
Required: False ,
}
boolean ,
ETag:
{
Description: Entity tag for concurrency control ,
Required: False ,
}
string ,
type:
{
Description: Data source type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Common metadata properties across all asset types ,
Required: False ,
}
{
inputDatasets:
{
Description: Input dataset definitions and schemas ,
Required: False ,
}
[
string ,
]
,
projection:
{
Description: Data projection and mapping configuration ,
Required: False ,
}
string ,
}
,
location:
{
Description: Physical storage locations for file-based assets ,
Required: False ,
}
[
{
type:
{
Description: Storage type classification ,
Required: True ,
}
string ,
typeProperties:
{
Description: Storage-specific configuration properties ,
Required: True ,
}
{
fileSystem:
{
Description: File system or container name ,
Required: False ,
}
string ,
folderPath:
{
Description: Hierarchical path within the storage location ,
Required: False ,
}
string ,
accountName:
{
Description: Storage account name or endpoint identifier ,
Required: False ,
}
string ,
region:
{
Description: Geographic region or environment location ,
Required: False ,
}
string ,
}
,
}
,
]
,
format:
{
Description: Data format specification for structured assets ,
Required: False ,
}
string ,
schemaName:
{
Description: Database schema name for SQL-based assets ,
Required: False ,
}
string ,
tableName:
{
Description: Table name for SQL-based data assets ,
Required: False ,
}
string ,
hostName:
{
Description: Host server name for on-premises database connections ,
Required: False ,
}
string ,
testConnectionDatasetName:
{
Description: Connection Dataset name for Google Big Quey type of data asset ,
Required: False ,
}
string ,
testConnectionSchemaName:
{
Description: Connection Schema name for Google Big Query type of data asset ,
Required: False ,
}
string ,
projectId:
{
Description: Project ID for Google Big Query type of data asset ,
Required: False ,
}
string ,
isDQAsset:
{
Description: Flag indicating if the asset is a Data Quality asset ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}