List rules

List the DQ rules in your environment.

Paging is forward-only. The listing is not isolated from concurrent changes: if rules are created or deleted between page requests, some rules might be missing from the results.

get/data-quality/v1/rules

Request

Base URL
https://your-environment.ataccama.one/api
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/docs/data-quality/v1/rules/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response. Starts at the beginning when omitted.

sizeinteger

Number of rules to return per page.

sortstring

Example:name

Comma-separated field names for sorting (for example, name). Prefix with a hyphen (-) for descending order.

Response

Paginated list of rules.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "draftType": "NEW",
      "defaultDqThreshold": {
        "severity": "WARNING",
        "urn": "urn:ata:acme-corp:data-quality:dq-threshold:123e4567-e89b-12d3-a456-426614174000",
        "correlationId": "new_email"
      },
      "stewardship": {
        "groupUrn": "urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000"
      },
      "implementation": {
        "ruleType": "SINGLE_TABLE",
        "dqDimensionUrn": "urn:ata:acme-corp:data-quality:dq-dimension:123e4567-e89b-12d3-a456-426614174000",
        "fallback": {
          "resultUrn": "urn:ata:acme-corp:data-quality:dq-dimension-result:123e4567-e89b-12d3-a456-426614174000"
        }
      },
      "urn": "urn:ata:acme-corp:data-quality:rule:123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.