Report assertion runs

curl --request POST \
  --url https://aiapi.{client}.nx1cloud.com/api/dq/rules/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "report_items": [
    {
      "rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rule_name": "<string>",
      "status": "<string>",
      "external_id": "<string>",
      "output": "<string>",
      "error": "<string>"
    }
  ]
}
'

true

POST

api

rules

report

Report assertion runs

curl --request POST \
  --url https://aiapi.{client}.nx1cloud.com/api/dq/rules/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "report_items": [
    {
      "rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rule_name": "<string>",
      "status": "<string>",
      "external_id": "<string>",
      "output": "<string>",
      "error": "<string>"
    }
  ]
}
'

true

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

report_items

DQRuleReportItem · object[]

required

List of data quality rules.

Show child attributes

report_items.rule_id

string<uuid>

required

Unique ID of the data quality rule that generated this report entry.

report_items.rule_name

string

required

Name of the rule corresponding to the rule_id.

report_items.status

string

required

Result status of the rule run.

report_items.external_id

string | null

Uniform Resource Name (URN) of the assertion in DataHub.

report_items.output

string | null

Output or result details from the rule run.

report_items.error

string | null

Error message if the rule failed to execute properly.

Response

Report Completed.

The response is of type boolean.

Run report by rule Create

⌘I

Using the APIs

Endpoints

Report assertion runs

Authorizations

Body

Response