Skip to main content
POST
/
api
/
dq
/
suggest
Suggest
curl --request POST \
  --url https://aiapi.{client}.nx1cloud.com/api/dq/suggest \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "table": "<string>",
  "dq_request": "<string>"
}
'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rule_name": "<string>",
    "rule_description": "<string>",
    "sql": "<string>",
    "accepted": true,
    "table": "<string>",
    "external_id": "<string>",
    "spark_sql": "<string>",
    "success_value": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
table
string
required

Name of the table to analyze for data quality suggestions.

​
dq_request
string | null

The request in human language for the required data quality suggestions.

Response

Suggest successful.

​
id
string<uuid>
required

Unique ID of the data quality rule.

​
rule_name
string
required

Name of the data quality rule.

​
rule_description
string
required

Brief explanation of what the rule checks.

​
sql
string
required

Trino SQL query used to validate the rule.

​
accepted
boolean
required

Indicates if the rule has been accepted or not.

​
table
string
required

The database table this rule applies to.

​
external_id
string | null

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

​
spark_sql
string | null

Spark SQL query of the rule, if applicable.

​
success_value
string | null

Expected success condition for this rule.