Skip to main content
POST
/
api
/
dataeng
/
schedule
Schedule query
curl --request POST \
  --url https://aiapi.{client}.nx1cloud.com/api/dataeng/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "<string>",
  "table": "<string>",
  "schema_name": "<string>",
  "query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merge_columns": "<string>",
  "schedule": "<string>",
  "owner_id": "<string>",
  "domain": "<string>",
  "tags": [
    "<string>"
  ]
}
'
{
  "flow_url": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
mode
string
required

Defines how the query output is written to the target table. Valid values: append, overwrite, merge.

​
table
string
required

The target table where the user wants the results to be stored.

​
schema_name
string
required

The schema containing the target table.

​
query_id
string<uuid> | null

A unique ID of the already generated query.

​
merge_columns
string | null

Columns used to match and merge data. Specify only if mode is merge.

​
schedule
string | null

A cron expression specifying when or how often the query runs.

​
owner_id
string | null

The logged in user's email ID.

​
domain
string | null

Domain to be set for the dataset in DataHub.

​
tags
string[] | null

List of tags to be set for the dataset in DataHub.

Response

Schedule query successful.

​
flow_url
string
required

Airflow URL to access the scheduled query flow.

​
id
string<uuid> | null

A unique ID for the scheduled query flow.

​
error
string | null

Error message if scheduling fails due to any issue.