Task
List tasks¶
GET/api/v2/databases/{database}/schemas/{schema}/tasks
Lists tasks under the database and schema, with show options as query parameters.
Path Parameters¶
Parameter | Description |
---|---|
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¶
Parameter | Description |
---|---|
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¶
Code | Description |
---|---|
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.
Query Parameters¶
Parameter | Description |
---|---|
createMode string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
Response¶
Code | Description |
---|---|
200 | Successful request. |
202 |
Fetch a task¶
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.
Response¶
Code | Description |
---|---|
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.
Query Parameters¶
Parameter | Description |
---|---|
ifExists boolean | Query parameter that specifies how to handle the request for a resource that does not exist:
|
Response¶
Code | Description |
---|---|
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.
Query Parameters¶
Parameter | Description |
---|---|
asyncExec boolean | Asynchronous execution enable/disable. Default is disable. |
retryLast boolean | Retry the last failed run of the DAG. |
Response¶
Code | Description |
---|---|
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.
Response¶
Code | Description |
---|---|
200 | |
202 |
Suspends 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.
Response¶
Code | Description |
---|---|
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}.
Query Parameters¶
Parameter | Description |
---|---|
recursive boolean | Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks. |
Response¶
Code | Description |
---|---|
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.
Query Parameters¶
Parameter | Description |
---|---|
resultLimit integer |
Response¶
Code | Description |
---|---|
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.
Query Parameters¶
Parameter | Description |
---|---|
resultLimit integer |
Response¶
Code | Description |
---|---|
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.
Query Parameters¶
Parameter | Description |
---|---|
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¶
Code | Description |
---|---|
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.
Query Parameters¶
Parameter | Description |
---|---|
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¶
Code | Description |
---|---|
200 | successful |
202 |