Skip to main content
POST
/
api
/
dq
/
rules
/
{dq_id}
/
report
Run report by rule
curl --request POST \
  --url https://aiapi.{client}.nx1cloud.com/api/dq/rules/{dq_id}/report \
  --header 'Authorization: Bearer <token>'
[
  {
    "rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rule_name": "<string>",
    "status": "<string>",
    "external_id": "<string>",
    "output": "<string>",
    "error": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
rule_id
string<uuid>
required

The unique ID of the rule to run a report on.

Response

Report Completed.

​
rule_id
string<uuid>
required

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

​
rule_name
string
required

Name of the rule corresponding to the rule_id.

​
status
string
required

Result status of the rule run.

​
external_id
string | null

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

​
output
string | null

Output or result details from the rule run.

​
error
string | null

Error message if the rule failed to execute properly.