Task

List tasks¶

GET/api/v2/databases/{database}/schemas/{schema}/tasks
Lists tasks under the database and schema, with show options as query parameters.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Path Parameters¶

ParameterDescription
database 
Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases.
schema 
Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database.

Query Parameters¶

ParameterDescription
rootOnly boolean
Query parameter to filter the command output to return only root resources (resources with no predecessors).
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWith string
Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimit integer
Query parameter to limit the maximum number of rows returned by a command.
fromName string
Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.

Response¶

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create a task¶

POST/api/v2/databases/{database}/schemas/{schema}/tasks
Create a task, with standard create modifiers as query parameters. See the Task component definition for what is required to be provided in the request body.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
createMode string
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Response¶

CodeDescription
200
Successful request.
202

Fetch a task¶

GET/api/v2/databases/{database}/schemas/{schema}/tasks/{name}
Fetch a task using the describe command output.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Path Parameters¶

ParameterDescription
name 
Identifier (i.e. name) for the resource.

Response¶

CodeDescription
200
successful
202

Create a (or alter an existing) task¶

PUT/api/v2/databases/{database}/schemas/{schema}/tasks/{name}
Create a (or alter an existing) task. Even if the operation is just an alter, the full property set must be provided.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
202

Delete a task¶

DELETE/api/v2/databases/{database}/schemas/{schema}/tasks/{name}
Delete a task with the task name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response¶

CodeDescription
200
202

Execute a task object¶

POST/api/v2/databases/{database}/schemas/{schema}/tasks/{name}:execute
Execute a task -
  • this is equivalent to EXECUTE IMMEDIATE.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
asyncExec boolean
Asynchronous execution enable/disable. Default is disable.
retryLast boolean
Retry the last failed run of the DAG.

Response¶

CodeDescription
200
202

Resume a suspended task¶

POST/api/v2/databases/{database}/schemas/{schema}/tasks/{name}:resume
Resumes a suspended task object. This is equivalento an ALTER TASK ... RESUME.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
202

Suspend a running task¶

POST/api/v2/databases/{database}/schemas/{schema}/tasks/{name}:suspend
Suspends a running task. This is equivalent to an ALTER TASK ... SUSPEND.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Response¶

CodeDescription
200
202

Fetch the dependent tasks of a task¶

GET/api/v2/databases/{database}/schemas/{schema}/tasks/{name}/dependents
This operation returns a list of the dependent tasks of the task with identifier {name}.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
recursive boolean
Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks.

Response¶

CodeDescription
200
successful
202

Get the graph runs that are executing or scheduled for the task for the next 8 days (Deprecated)¶

GET/api/v2/databases/{database}/schemas/{schema}/tasks/{name}/current_graphs
This function returns details for graph runs that are currently executing or are next scheduled to run within the next 8 days.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
resultLimit integer

Response¶

CodeDescription
200
successful
202

Get the graph runs that are executing or scheduled for the task for the next 8 days¶

GET/api/v2/databases/{database}/schemas/{schema}/tasks/{name}/current-graphs
This function returns details for graph runs that are currently executing or are next scheduled to run within the next 8 days.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
resultLimit integer

Response¶

CodeDescription
200
successful
202

Get the graph runs that are completed for the task (Deprecated)¶

GET/api/v2/databases/{database}/schemas/{schema}/tasks/{name}/complete_graphs
This function returns details for graph runs that are completed.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
resultLimit integer
Number of results to return, at most. Default is 1000, valid range is 1 to 10000.
errorOnly boolean
Whether to only return results for tasks runs that have failed. Default is false.

Response¶

CodeDescription
200
successful
202

Get the graph runs that are completed for the task¶

GET/api/v2/databases/{database}/schemas/{schema}/tasks/{name}/complete-graphs
This function returns details for graph runs that are completed.

For more information

Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.

View

Query Parameters¶

ParameterDescription
resultLimit integer
Number of results to return, at most. Default is 1000, valid range is 1 to 10000.
errorOnly boolean
Whether to only return results for tasks runs that have failed. Default is false.

Response¶

CodeDescription
200
successful
202
Language: English