Type Alias DataContractsAPI

Index
clearCache: typeof dataContracts.clearCache

Clears the cache for data-contracts api requests.

createDataContractsDatasets: typeof createDataContractsDatasets

Creates a data contract for each listed dataset ID, notably to apply a contract to every dataset of a data product at once. The caller's "Compute data quality" write privilege is checked once for the whole request, before any dataset is processed: it does not depend on any single dataset, so a caller lacking it is rejected upfront with HTTP 403, rather than failing every dataset entry individually. Each dataset is then processed independently and concurrently: a failure on one dataset (no write permission on its space, dataset not found, or a contract already existing for that dataset) does not block the others. An existing contract is never overwritten. The request is capped at 100 datasets; a larger batch is rejected upfront with HTTP 400, before any contract is created.

an object with the body content

CreateDataContractsDatasetsHttpError

deleteDataContractsDataset: typeof deleteDataContractsDataset

Permanently deletes the data contract for the given dataset, along with every expectation and evaluation belonging to it. This is a hard delete: unlike deactivation, nothing is preserved and the operation cannot be undone.

deleteDataContractsDataset(
"66a3aa9800358457159ecd12"
)

DeleteDataContractsDatasetHttpError

getDataContractsDatasetExpectations: typeof getDataContractsDatasetExpectations

Returns every expectation for the dataset — the Trust Score dimension expectations and the data volume expectation — with their current activation status, configured thresholds or bounds, latest actual value, and last evaluation result. If the dataset has no data contract, the operation still returns 200 with the default, non-activated expectations. For non-activated expectations, the actual value (Trust Score) or row count (volume) is fetched live while the response is built and is omitted if it cannot be retrieved.

getDataContractsDatasetExpectations(
"66a3aa9800358457159ecd12"
)

GetDataContractsDatasetExpectationsHttpError

patchDataContractsDatasetExpectations: typeof patchDataContractsDatasetExpectations

Updates, activates, or deactivates the dataset's expectations in a single call. Trust Score and data volume expectations are supplied in their respective arrays, and each item is processed independently: some items may succeed while others fail, and the per-item outcome is reported in the response with HTTP 200. When the dataset has no data contract yet, activating at least one expectation creates the contract; a request that would create a contract without activating any expectation is rejected with HTTP 400. For Trust Score items, threshold and warning must be within 0-100 and warning, when set, must be strictly greater than threshold.

an object with the body content

PatchDataContractsDatasetExpectationsHttpError