Sign in

v2

latestSwagger 2.02026-07-136054211.7 KB
ScheduleScan

Retrieves details of a specific scan under a given schedule within a business domain.

get/business-domains/{businessDomainId}/schedules/{scheduleId}/scans/{scanId}

Path parameters

businessDomainIdstring required

Unique identifier for the business domain containing the data product

scheduleIdstring required

Unique identifier for the scheduled job within the business domain

scanIdstring required

Unique identifier for the scan within the scheduled job

Query parameters

api-versionstring required

The API version to use for this operation.

Response

The request has succeeded.

succeededinteger

Number of successful scan executions

failedinteger

Number of failed scan executions

skippedinteger

Number of skipped scan executions

scheduleStatusstring

Current schedule operational status

scheduleNamestring

Associated schedule name

scheduleIdstring

Associated schedule identifier

scanIdstring

Specific scan execution identifier

startTimestring date-time

Scan execution start time (UTC)

endTimestring date-time

Scan execution end time (UTC)

accountIdstring

Executing account identifier

businessDomainIdstring

Business domain identifier

totalJobCountinteger

Total job count within scan execution

statusstring

Current scan execution status

scheduleRunTypestring

Schedule run type classification

scanTypestring

Scan type classification

startedBystring

Identity of the scan initiating user

cancelledBystring

Identity of the scan cancelling user

cancelRequestTimestring date-time

Cancellation request timestamp (UTC)

partitionKeystring

Storage partition key for data organization

rowKeystring

Storage row key for unique record identification

timestampstring date-time

Record timestamp for temporal tracking

eTagstring

Entity tag for concurrency control