flywheel.api.data_view_executions_api
DataViewExecutionsApi
Bases: object
delete_view_execution(data_view_execution_id, **kwargs)
Delete a data_view_execution
Delete a data view execution. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_view_execution_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_view_execution_with_http_info(data_view_execution_id, **kwargs)
Delete a data_view_execution
Delete a data view execution. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_view_execution_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_data_view_executions(**kwargs)
Get a list of data_view_executions
Get a list of data view executions. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
exhaustive | (bool, optional) | Set to return a complete list regardless of permissions, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_data_view_executions_with_http_info(**kwargs)
Get a list of data_view_executions
Get a list of data view executions. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
exhaustive | (bool, optional) | Set to return a complete list regardless of permissions, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_data_view_execution(data_view_execution_id, **kwargs)
Get a single data_view_execution
Get a single data view execution by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_view_execution_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_data_view_execution_data(data_view_execution_id, **kwargs)
Get the data from a data_view_execution
Get the data from a data view execution. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_view_execution_id | str | | required |
ticket | (str, optional) | download ticket id | required |
file_format | (FileFormat, optional) | | required |
file_name | (str, optional) | download ticket filename, defaults to view-data | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_data_view_execution_data_with_http_info(data_view_execution_id, **kwargs)
Get the data from a data_view_execution
Get the data from a data view execution. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_view_execution_id | str | | required |
ticket | (str, optional) | download ticket id | required |
file_format | (FileFormat, optional) | | required |
file_name | (str, optional) | download ticket filename, defaults to view-data | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_data_view_execution_with_http_info(data_view_execution_id, **kwargs)
Get a single data_view_execution
Get a single data view execution by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_view_execution_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
save_data_view_execution(data_view_execution_id, **kwargs)
Save a data_view_execution to a project
Save a data view execution to a project. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_view_execution_id | str | | required |
file_format | (FileFormat, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
save_data_view_execution_with_http_info(data_view_execution_id, **kwargs)
Save a data_view_execution to a project
Save a data view execution to a project. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_view_execution_id | str | | required |
file_format | (FileFormat, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |