When a Data Reliability policy runs (Data Quality, Reconciliation, Drift, Freshness, Anomaly, etc.), ADOC writes detailed execution results and roll-up summaries to storage. Policy persistence paths let you control where those results land (for GOOD/BAD records, samples, and derived outputs) so you can plug them into downstream platforms, archives, or analytics.
Use these APIs when you want to:
Route policy outputs to a specific storage prefix (for example, a cloud bucket folder per domain or per policy type).
Turn result persistence on/off for GOOD/BAD rows or sample-only outputs without editing the policy definition itself.
Manage persistence centrally by policy ID or policy name, depending on how your team references policies.
Available Endpoints
| Action | Endpoint | Description |
|---|---|---|
| Get Persistence Configuration by ID | GET /catalog-server/api/rules/persistence/:assetId | Fetch persistence configuration for a specific policy by its numeric ID. |
| Create or Update Persistence Configuration | PUT /catalog-server/api/rules/persistence/:assetId | Create or update persistence configuration for a policy by ID. |
| Get Persistence Configuration by Name | GET /catalog-server/api/rules/byName/:name/configuration | Fetch persistence configuration by policy name (useful when IDs vary by environment but names stay consistent). |
| Create or Update Persistence Configuration by Name | PUT /catalog-server/api/rules/byName/:name/configuration | Create or update persistence configuration for a policy by name. |
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Unique identifier of the policy whose persistence configuration you want to fetch or update. |
name | string | Yes | Human-readable policy name (for example, customers_dq_latency_policy) used to locate the policy when ID is not known. |
Sample Requests
Fetch persistence configuration by Policy ID
Use this when you know the internal policy ID (for example, from the Policies listing or another API).
curl --location --request GET 'https://{{HOST}}/catalog-server/api/rules/14706/configuration' \ --header 'accessKey: {{ACCESS_KEY}}' \ --header 'secretKey: {{SECRET_KEY}}' \ --header 'Accept: application/json'Create / update persistence configuration by Policy ID
Use this to turn on/off result persistence for GOOD/BAD rows and control the storage prefix for that policy.
curl --location --request PUT 'https://{{HOST}}/catalog-server/api/rules/14706/configuration' \ --header 'accessKey: {{ACCESS_KEY}}' \ --header 'secretKey: {{SECRET_KEY}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "persistentPathConfig": { "GOOD": { "storeResult": true, "sampleOnly": false }, "BAD": { "storeResult": true, "sampleOnly": true }, "persistenceFolderPrefix": "s3://my-bucket/data-reliability/policies/14706/" } }'Key fields in the request body:
persistentPathConfig.GOOD.storeResult– Whether to persist successful (GOOD) records.persistentPathConfig.GOOD.sampleOnly– Iftrue, only a sample of GOOD records is persisted.persistentPathConfig.BAD.storeResult– Whether to persist failing (BAD) records.persistentPathConfig.BAD.sampleOnly– Iftrue, only a sample of BAD records is persisted.persistentPathConfig.persistenceFolderPrefix– Prefix/path under your configured storage where all outputs for this policy will be written.
Fetch persistence configuration by Policy Name
Use this when your automation knows the policy by name instead of ID (for example, across dev/stage/prod where IDs differ).
curl --location --request GET 'https://{{HOST}}/catalog-server/api/rules/byName/customers_dq_latency_policy/configuration' \ --header 'accessKey: {{ACCESS_KEY}}' \ --header 'secretKey: {{SECRET_KEY}}' \ --header 'Accept: application/json'This returns the current persistence configuration for the named policy.
Create / update persistence configuration by Policy Name
curl --location --request PUT 'https://{{HOST}}/catalog-server/api/rules/byName/customers_dq_latency_policy/configuration' \ --header 'accessKey: {{ACCESS_KEY}}' \ --header 'secretKey: {{SECRET_KEY}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "persistentPathConfig": { "GOOD": { "storeResult": true, "sampleOnly": false }, "BAD": { "storeResult": false, "sampleOnly": false }, "persistenceFolderPrefix": "abfss://dq-results@myaccount.dfs.core.windows.net/latency/" } }'Using the name-based endpoints is especially handy in CI/CD pipelines, where policy names are stable but numeric IDs may differ across tenants or environments.