flywheel-sdk 18.2.1rc0__py2.py3-none-any.whl → 18.3.0__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- flywheel/api/acquisitions_api.py +31 -27
- flywheel/api/analyses_api.py +6 -6
- flywheel/api/batch_api.py +2 -2
- flywheel/api/collections_api.py +12 -12
- flywheel/api/containers_api.py +31 -27
- flywheel/api/dataexplorer_api.py +2 -2
- flywheel/api/dimse_api.py +14 -14
- flywheel/api/download_api.py +2 -2
- flywheel/api/files_api.py +8 -8
- flywheel/api/gears_api.py +2 -2
- flywheel/api/jobs_api.py +6 -1
- flywheel/api/projects_api.py +35 -31
- flywheel/api/resolve_api.py +4 -4
- flywheel/api/sessions_api.py +31 -27
- flywheel/api/subjects_api.py +31 -27
- flywheel/api/tree_api.py +2 -2
- flywheel/api/upload_api.py +10 -10
- flywheel/api_client.py +25 -12
- flywheel/configuration.py +2 -2
- flywheel/file_spec.py +21 -0
- flywheel/flywheel.py +128 -122
- flywheel/models/__init__.py +1 -1
- flywheel/models/access_level.py +3 -0
- flywheel/models/access_type.py +3 -0
- flywheel/models/accumulator.py +3 -0
- flywheel/models/action.py +3 -0
- flywheel/models/audit_trail_report_status.py +3 -0
- flywheel/models/azure_ml_resource_init_status.py +3 -0
- flywheel/models/body_region.py +3 -0
- flywheel/models/change_log_container_type.py +3 -0
- flywheel/models/change_method.py +3 -0
- flywheel/models/cohort.py +3 -0
- flywheel/models/collection_node_level.py +3 -0
- flywheel/models/collection_operation_type.py +3 -0
- flywheel/models/column_type.py +3 -0
- flywheel/models/conflict_types.py +3 -0
- flywheel/models/container_delete_reason.py +3 -0
- flywheel/models/container_type.py +3 -0
- flywheel/models/data_strategy.py +3 -0
- flywheel/models/data_view_execution_state.py +3 -0
- flywheel/models/default_flywheel_role.py +3 -0
- flywheel/models/deid_log_skip_reason.py +3 -0
- flywheel/models/deprecated_action.py +3 -0
- flywheel/models/destination_container_type.py +3 -0
- flywheel/models/device_create.py +1 -2
- flywheel/models/download_format.py +3 -0
- flywheel/models/download_strategy.py +3 -0
- flywheel/models/file_format.py +3 -0
- flywheel/models/file_group.py +3 -0
- flywheel/models/gear_category.py +3 -0
- flywheel/models/gear_permissions_type.py +3 -0
- flywheel/models/gear_rule_condition_type.py +3 -0
- flywheel/models/header_feature.py +3 -0
- flywheel/models/job_log_column.py +3 -0
- flywheel/models/job_priority.py +3 -0
- flywheel/models/job_request_item_type.py +3 -0
- flywheel/models/job_state.py +3 -0
- flywheel/models/join_type.py +3 -0
- flywheel/models/ml_type.py +3 -0
- flywheel/models/optional_input_policy.py +3 -0
- flywheel/models/order.py +3 -0
- flywheel/models/organ_system.py +3 -0
- flywheel/models/origin_type.py +3 -0
- flywheel/models/parent_type.py +3 -0
- flywheel/models/project_copy_status.py +3 -0
- flywheel/models/project_locking_reason.py +3 -0
- flywheel/models/project_share_level.py +3 -0
- flywheel/models/provider_access_type.py +3 -0
- flywheel/models/provider_class.py +3 -0
- flywheel/models/provider_type.py +3 -0
- flywheel/models/report_access_log_entry.py +289 -1
- flywheel/models/role_type.py +3 -0
- flywheel/models/s3_addressing_style.py +3 -0
- flywheel/models/search_return_type.py +3 -0
- flywheel/models/state.py +3 -0
- flywheel/models/status_type.py +3 -0
- flywheel/models/status_value.py +3 -0
- flywheel/models/storage_strategy.py +3 -0
- flywheel/models/subject_state.py +3 -0
- flywheel/models/therapeutic_area.py +3 -0
- flywheel/models/type_str.py +3 -0
- flywheel/models/upsert_result.py +3 -0
- flywheel/models/validation_error.py +3 -3
- flywheel/models/viewer_app_type.py +3 -0
- flywheel/models/virus_scan_state.py +3 -0
- {flywheel_sdk-18.2.1rc0.dist-info → flywheel_sdk-18.3.0.dist-info}/METADATA +6 -6
- {flywheel_sdk-18.2.1rc0.dist-info → flywheel_sdk-18.3.0.dist-info}/RECORD +90 -90
- {flywheel_sdk-18.2.1rc0.dist-info → flywheel_sdk-18.3.0.dist-info}/WHEEL +1 -1
- {flywheel_sdk-18.2.1rc0.dist-info → flywheel_sdk-18.3.0.dist-info}/LICENSE.txt +0 -0
- {flywheel_sdk-18.2.1rc0.dist-info → flywheel_sdk-18.3.0.dist-info}/top_level.txt +0 -0
flywheel/api/acquisitions_api.py
CHANGED
|
@@ -140,12 +140,13 @@ class AcquisitionsApi(object):
|
|
|
140
140
|
def add_acquisition_analysis(self, cid, body, **kwargs): # noqa: E501
|
|
141
141
|
"""Create an analysis and upload files.
|
|
142
142
|
|
|
143
|
-
When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
|
|
143
|
+
When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
|
|
144
144
|
This method makes a synchronous HTTP request by default.
|
|
145
145
|
|
|
146
146
|
:param str cid: (required)
|
|
147
147
|
:param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
|
|
148
148
|
:param bool job: returns job_id instead of analysis.id
|
|
149
|
+
:param bool job: returns job_id instead of analysis.id
|
|
149
150
|
:param bool async_: Perform the request asynchronously
|
|
150
151
|
:return: InsertedId
|
|
151
152
|
"""
|
|
@@ -168,17 +169,18 @@ class AcquisitionsApi(object):
|
|
|
168
169
|
def add_acquisition_analysis_with_http_info(self, cid, body, **kwargs): # noqa: E501
|
|
169
170
|
"""Create an analysis and upload files.
|
|
170
171
|
|
|
171
|
-
When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
|
|
172
|
+
When query param \"job\" is \"true\", send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.
|
|
172
173
|
This method makes a synchronous HTTP request by default.
|
|
173
174
|
|
|
174
175
|
:param str cid: (required)
|
|
175
176
|
:param union[AdhocAnalysisInput,JobAnalysisInput] body: (required)
|
|
176
177
|
:param bool job: returns job_id instead of analysis.id
|
|
178
|
+
:param bool job: returns job_id instead of analysis.id
|
|
177
179
|
:param bool async_: Perform the request asynchronously
|
|
178
180
|
:return: InsertedId
|
|
179
181
|
"""
|
|
180
182
|
|
|
181
|
-
all_params = ['cid','body','job',] # noqa: E501
|
|
183
|
+
all_params = ['cid','body','job','job',] # noqa: E501
|
|
182
184
|
all_params.append('async_')
|
|
183
185
|
all_params.append('_return_http_data_only')
|
|
184
186
|
all_params.append('_preload_content')
|
|
@@ -210,6 +212,8 @@ class AcquisitionsApi(object):
|
|
|
210
212
|
path_params['cid'] = params['cid'] # noqa: E501
|
|
211
213
|
|
|
212
214
|
query_params = []
|
|
215
|
+
if 'job' in params:
|
|
216
|
+
query_params.append(('job', params['job'])) # noqa: E501
|
|
213
217
|
if 'job' in params:
|
|
214
218
|
query_params.append(('job', params['job'])) # noqa: E501
|
|
215
219
|
else:
|
|
@@ -1038,13 +1042,13 @@ class AcquisitionsApi(object):
|
|
|
1038
1042
|
def delete_acquisition_file(self, cid, filename, **kwargs): # noqa: E501
|
|
1039
1043
|
"""Delete a file
|
|
1040
1044
|
|
|
1041
|
-
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
1045
|
+
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
1042
1046
|
This method makes a synchronous HTTP request by default.
|
|
1043
1047
|
|
|
1044
1048
|
:param str cid: (required)
|
|
1045
1049
|
:param str filename: (required)
|
|
1046
1050
|
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
1047
|
-
:param bool force: Force deletion of the file even if some checks fail
|
|
1051
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
1048
1052
|
:param bool async_: Perform the request asynchronously
|
|
1049
1053
|
:return: DeletedResult
|
|
1050
1054
|
"""
|
|
@@ -1067,13 +1071,13 @@ class AcquisitionsApi(object):
|
|
|
1067
1071
|
def delete_acquisition_file_with_http_info(self, cid, filename, **kwargs): # noqa: E501
|
|
1068
1072
|
"""Delete a file
|
|
1069
1073
|
|
|
1070
|
-
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
1074
|
+
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
1071
1075
|
This method makes a synchronous HTTP request by default.
|
|
1072
1076
|
|
|
1073
1077
|
:param str cid: (required)
|
|
1074
1078
|
:param str filename: (required)
|
|
1075
1079
|
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
1076
|
-
:param bool force: Force deletion of the file even if some checks fail
|
|
1080
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
1077
1081
|
:param bool async_: Perform the request asynchronously
|
|
1078
1082
|
:return: DeletedResult
|
|
1079
1083
|
"""
|
|
@@ -1466,7 +1470,7 @@ class AcquisitionsApi(object):
|
|
|
1466
1470
|
def download_file_from_acquisition(self, acquisition_id, file_name, dest_file, **kwargs): # noqa: E501
|
|
1467
1471
|
"""Download a file.
|
|
1468
1472
|
|
|
1469
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1473
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1470
1474
|
This method makes a synchronous HTTP request by default.
|
|
1471
1475
|
|
|
1472
1476
|
:param str acquisition_id: 24-char hex id (required)
|
|
@@ -1500,7 +1504,7 @@ class AcquisitionsApi(object):
|
|
|
1500
1504
|
def download_file_from_acquisition_with_http_info(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
1501
1505
|
"""Download a file.
|
|
1502
1506
|
|
|
1503
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1507
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1504
1508
|
This method makes a synchronous HTTP request by default.
|
|
1505
1509
|
|
|
1506
1510
|
:param str acquisition_id: 24-char hex id (required)
|
|
@@ -1599,7 +1603,7 @@ class AcquisitionsApi(object):
|
|
|
1599
1603
|
def get_acquisition_file_zip_info(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
1600
1604
|
"""Download a file.
|
|
1601
1605
|
|
|
1602
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1606
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1603
1607
|
This method makes a synchronous HTTP request by default.
|
|
1604
1608
|
|
|
1605
1609
|
:param str acquisition_id: 24-char hex id (required)
|
|
@@ -1634,7 +1638,7 @@ class AcquisitionsApi(object):
|
|
|
1634
1638
|
def get_acquisition_file_zip_info_with_http_info(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
1635
1639
|
"""Download a file.
|
|
1636
1640
|
|
|
1637
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1641
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1638
1642
|
This method makes a synchronous HTTP request by default.
|
|
1639
1643
|
|
|
1640
1644
|
:param str acquisition_id: 24-char hex id (required)
|
|
@@ -1738,7 +1742,7 @@ class AcquisitionsApi(object):
|
|
|
1738
1742
|
def get_acquisition_download_ticket(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
1739
1743
|
"""Download a file.
|
|
1740
1744
|
|
|
1741
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1745
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1742
1746
|
This method makes a synchronous HTTP request by default.
|
|
1743
1747
|
|
|
1744
1748
|
:param str acquisition_id: 24-char hex id (required)
|
|
@@ -1773,7 +1777,7 @@ class AcquisitionsApi(object):
|
|
|
1773
1777
|
def get_acquisition_download_ticket_with_http_info(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
1774
1778
|
"""Download a file.
|
|
1775
1779
|
|
|
1776
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1780
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1777
1781
|
This method makes a synchronous HTTP request by default.
|
|
1778
1782
|
|
|
1779
1783
|
:param str acquisition_id: 24-char hex id (required)
|
|
@@ -1875,7 +1879,7 @@ class AcquisitionsApi(object):
|
|
|
1875
1879
|
def download_input_from_acquisition_analysis(self, acquisition_id, analysis_id, filename, dest_file, **kwargs): # noqa: E501
|
|
1876
1880
|
"""Download analysis inputs with filter.
|
|
1877
1881
|
|
|
1878
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
1882
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
1879
1883
|
This method makes a synchronous HTTP request by default.
|
|
1880
1884
|
|
|
1881
1885
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -1908,7 +1912,7 @@ class AcquisitionsApi(object):
|
|
|
1908
1912
|
def download_input_from_acquisition_analysis_with_http_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
1909
1913
|
"""Download analysis inputs with filter.
|
|
1910
1914
|
|
|
1911
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
1915
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
1912
1916
|
This method makes a synchronous HTTP request by default.
|
|
1913
1917
|
|
|
1914
1918
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2008,7 +2012,7 @@ class AcquisitionsApi(object):
|
|
|
2008
2012
|
def get_acquisition_analysis_input_zip_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2009
2013
|
"""Download analysis inputs with filter.
|
|
2010
2014
|
|
|
2011
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2015
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2012
2016
|
This method makes a synchronous HTTP request by default.
|
|
2013
2017
|
|
|
2014
2018
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2042,7 +2046,7 @@ class AcquisitionsApi(object):
|
|
|
2042
2046
|
def get_acquisition_analysis_input_zip_info_with_http_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2043
2047
|
"""Download analysis inputs with filter.
|
|
2044
2048
|
|
|
2045
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2049
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2046
2050
|
This method makes a synchronous HTTP request by default.
|
|
2047
2051
|
|
|
2048
2052
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2147,7 +2151,7 @@ class AcquisitionsApi(object):
|
|
|
2147
2151
|
def get_acquisition_analysis_input_download_ticket(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2148
2152
|
"""Download analysis inputs with filter.
|
|
2149
2153
|
|
|
2150
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2154
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2151
2155
|
This method makes a synchronous HTTP request by default.
|
|
2152
2156
|
|
|
2153
2157
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2181,7 +2185,7 @@ class AcquisitionsApi(object):
|
|
|
2181
2185
|
def get_acquisition_analysis_input_download_ticket_with_http_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2182
2186
|
"""Download analysis inputs with filter.
|
|
2183
2187
|
|
|
2184
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2188
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
2185
2189
|
This method makes a synchronous HTTP request by default.
|
|
2186
2190
|
|
|
2187
2191
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2284,7 +2288,7 @@ class AcquisitionsApi(object):
|
|
|
2284
2288
|
def download_output_from_acquisition_analysis(self, acquisition_id, analysis_id, filename, dest_file, **kwargs): # noqa: E501
|
|
2285
2289
|
"""Download analysis outputs with filter.
|
|
2286
2290
|
|
|
2287
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2291
|
+
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2288
2292
|
This method makes a synchronous HTTP request by default.
|
|
2289
2293
|
|
|
2290
2294
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2317,7 +2321,7 @@ class AcquisitionsApi(object):
|
|
|
2317
2321
|
def download_output_from_acquisition_analysis_with_http_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2318
2322
|
"""Download analysis outputs with filter.
|
|
2319
2323
|
|
|
2320
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2324
|
+
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2321
2325
|
This method makes a synchronous HTTP request by default.
|
|
2322
2326
|
|
|
2323
2327
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2417,7 +2421,7 @@ class AcquisitionsApi(object):
|
|
|
2417
2421
|
def get_acquisition_analysis_output_zip_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2418
2422
|
"""Download analysis outputs with filter.
|
|
2419
2423
|
|
|
2420
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2424
|
+
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2421
2425
|
This method makes a synchronous HTTP request by default.
|
|
2422
2426
|
|
|
2423
2427
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2451,7 +2455,7 @@ class AcquisitionsApi(object):
|
|
|
2451
2455
|
def get_acquisition_analysis_output_zip_info_with_http_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2452
2456
|
"""Download analysis outputs with filter.
|
|
2453
2457
|
|
|
2454
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2458
|
+
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2455
2459
|
This method makes a synchronous HTTP request by default.
|
|
2456
2460
|
|
|
2457
2461
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2556,7 +2560,7 @@ class AcquisitionsApi(object):
|
|
|
2556
2560
|
def get_acquisition_analysis_output_download_ticket(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2557
2561
|
"""Download analysis outputs with filter.
|
|
2558
2562
|
|
|
2559
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2563
|
+
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2560
2564
|
This method makes a synchronous HTTP request by default.
|
|
2561
2565
|
|
|
2562
2566
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2590,7 +2594,7 @@ class AcquisitionsApi(object):
|
|
|
2590
2594
|
def get_acquisition_analysis_output_download_ticket_with_http_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2591
2595
|
"""Download analysis outputs with filter.
|
|
2592
2596
|
|
|
2593
|
-
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2597
|
+
If \"ticket\" query param is included and not empty, download outputs. If \"ticket\" query param is included and empty, create a ticket for matching outputs in the analysis. If no \"ticket\" query param is included, outputs will be downloaded directly.
|
|
2594
2598
|
This method makes a synchronous HTTP request by default.
|
|
2595
2599
|
|
|
2596
2600
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -3738,7 +3742,7 @@ class AcquisitionsApi(object):
|
|
|
3738
3742
|
def modify_acquisition_file(self, cid, filename, body, **kwargs): # noqa: E501
|
|
3739
3743
|
"""Modify a file's attributes
|
|
3740
3744
|
|
|
3741
|
-
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
3745
|
+
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
3742
3746
|
This method makes a synchronous HTTP request by default.
|
|
3743
3747
|
|
|
3744
3748
|
:param str cid: (required)
|
|
@@ -3766,7 +3770,7 @@ class AcquisitionsApi(object):
|
|
|
3766
3770
|
def modify_acquisition_file_with_http_info(self, cid, filename, body, **kwargs): # noqa: E501
|
|
3767
3771
|
"""Modify a file's attributes
|
|
3768
3772
|
|
|
3769
|
-
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
3773
|
+
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
3770
3774
|
This method makes a synchronous HTTP request by default.
|
|
3771
3775
|
|
|
3772
3776
|
:param str cid: (required)
|
flywheel/api/analyses_api.py
CHANGED
|
@@ -571,7 +571,7 @@ class AnalysesApi(object):
|
|
|
571
571
|
def download_input_from_analysis(self, analysis_id, filename, dest_file, **kwargs): # noqa: E501
|
|
572
572
|
"""Download analysis inputs with filter.
|
|
573
573
|
|
|
574
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
574
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
575
575
|
This method makes a synchronous HTTP request by default.
|
|
576
576
|
|
|
577
577
|
:param str analysis_id: 24-character hex ID (required)
|
|
@@ -603,7 +603,7 @@ class AnalysesApi(object):
|
|
|
603
603
|
def download_input_from_analysis_with_http_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
604
604
|
"""Download analysis inputs with filter.
|
|
605
605
|
|
|
606
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
606
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
607
607
|
This method makes a synchronous HTTP request by default.
|
|
608
608
|
|
|
609
609
|
:param str analysis_id: 24-character hex ID (required)
|
|
@@ -696,7 +696,7 @@ class AnalysesApi(object):
|
|
|
696
696
|
def get_analysis_input_zip_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
697
697
|
"""Download analysis inputs with filter.
|
|
698
698
|
|
|
699
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
699
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
700
700
|
This method makes a synchronous HTTP request by default.
|
|
701
701
|
|
|
702
702
|
:param str analysis_id: 24-character hex ID (required)
|
|
@@ -729,7 +729,7 @@ class AnalysesApi(object):
|
|
|
729
729
|
def get_analysis_input_zip_info_with_http_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
730
730
|
"""Download analysis inputs with filter.
|
|
731
731
|
|
|
732
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
732
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
733
733
|
This method makes a synchronous HTTP request by default.
|
|
734
734
|
|
|
735
735
|
:param str analysis_id: 24-character hex ID (required)
|
|
@@ -827,7 +827,7 @@ class AnalysesApi(object):
|
|
|
827
827
|
def get_analysis_input_download_ticket(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
828
828
|
"""Download analysis inputs with filter.
|
|
829
829
|
|
|
830
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
830
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
831
831
|
This method makes a synchronous HTTP request by default.
|
|
832
832
|
|
|
833
833
|
:param str analysis_id: 24-character hex ID (required)
|
|
@@ -860,7 +860,7 @@ class AnalysesApi(object):
|
|
|
860
860
|
def get_analysis_input_download_ticket_with_http_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
861
861
|
"""Download analysis inputs with filter.
|
|
862
862
|
|
|
863
|
-
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
863
|
+
If \"ticket\" query param is included and not empty, download inputs. If \"ticket\" query param is included and empty, create a ticket for matching inputs in the analysis. If no \"ticket\" query param is included, inputs will be downloaded directly.
|
|
864
864
|
This method makes a synchronous HTTP request by default.
|
|
865
865
|
|
|
866
866
|
:param str analysis_id: 24-character hex ID (required)
|
flywheel/api/batch_api.py
CHANGED
|
@@ -33,7 +33,7 @@ class BatchApi(object):
|
|
|
33
33
|
def cancel_batch(self, batch_id, **kwargs): # noqa: E501
|
|
34
34
|
"""Cancel a Job
|
|
35
35
|
|
|
36
|
-
Cancels jobs that are still pending, returns number of jobs cancelled. Moves a 'running' batch job to 'cancelled'.
|
|
36
|
+
Cancels jobs that are still pending, returns number of jobs cancelled. Moves a 'running' batch job to 'cancelled'.
|
|
37
37
|
This method makes a synchronous HTTP request by default.
|
|
38
38
|
|
|
39
39
|
:param str batch_id: (required)
|
|
@@ -59,7 +59,7 @@ class BatchApi(object):
|
|
|
59
59
|
def cancel_batch_with_http_info(self, batch_id, **kwargs): # noqa: E501
|
|
60
60
|
"""Cancel a Job
|
|
61
61
|
|
|
62
|
-
Cancels jobs that are still pending, returns number of jobs cancelled. Moves a 'running' batch job to 'cancelled'.
|
|
62
|
+
Cancels jobs that are still pending, returns number of jobs cancelled. Moves a 'running' batch job to 'cancelled'.
|
|
63
63
|
This method makes a synchronous HTTP request by default.
|
|
64
64
|
|
|
65
65
|
:param str batch_id: (required)
|
flywheel/api/collections_api.py
CHANGED
|
@@ -687,13 +687,13 @@ class CollectionsApi(object):
|
|
|
687
687
|
def delete_collection_file(self, cid, filename, **kwargs): # noqa: E501
|
|
688
688
|
"""Delete a file
|
|
689
689
|
|
|
690
|
-
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
690
|
+
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
691
691
|
This method makes a synchronous HTTP request by default.
|
|
692
692
|
|
|
693
693
|
:param str cid: (required)
|
|
694
694
|
:param str filename: (required)
|
|
695
695
|
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
696
|
-
:param bool force: Force deletion of the file even if some checks fail
|
|
696
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
697
697
|
:param bool async_: Perform the request asynchronously
|
|
698
698
|
:return: DeletedResult
|
|
699
699
|
"""
|
|
@@ -716,13 +716,13 @@ class CollectionsApi(object):
|
|
|
716
716
|
def delete_collection_file_with_http_info(self, cid, filename, **kwargs): # noqa: E501
|
|
717
717
|
"""Delete a file
|
|
718
718
|
|
|
719
|
-
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
719
|
+
A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose `origin.type` is either `job` or `user`.) <br/> A user with admin permissions on the container may delete any file.
|
|
720
720
|
This method makes a synchronous HTTP request by default.
|
|
721
721
|
|
|
722
722
|
:param str cid: (required)
|
|
723
723
|
:param str filename: (required)
|
|
724
724
|
:param ContainerDeleteReason delete_reason: A reason for deletion when audit-trail is enabled
|
|
725
|
-
:param bool force: Force deletion of the file even if some checks fail
|
|
725
|
+
:param bool force: Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
|
|
726
726
|
:param bool async_: Perform the request asynchronously
|
|
727
727
|
:return: DeletedResult
|
|
728
728
|
"""
|
|
@@ -1219,7 +1219,7 @@ class CollectionsApi(object):
|
|
|
1219
1219
|
def download_file_from_collection(self, collection_id, file_name, dest_file, **kwargs): # noqa: E501
|
|
1220
1220
|
"""Download a file.
|
|
1221
1221
|
|
|
1222
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1222
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1223
1223
|
This method makes a synchronous HTTP request by default.
|
|
1224
1224
|
|
|
1225
1225
|
:param str collection_id: 24-char hex id (required)
|
|
@@ -1253,7 +1253,7 @@ class CollectionsApi(object):
|
|
|
1253
1253
|
def download_file_from_collection_with_http_info(self, collection_id, file_name, **kwargs): # noqa: E501
|
|
1254
1254
|
"""Download a file.
|
|
1255
1255
|
|
|
1256
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1256
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1257
1257
|
This method makes a synchronous HTTP request by default.
|
|
1258
1258
|
|
|
1259
1259
|
:param str collection_id: 24-char hex id (required)
|
|
@@ -1352,7 +1352,7 @@ class CollectionsApi(object):
|
|
|
1352
1352
|
def get_collection_file_zip_info(self, collection_id, file_name, **kwargs): # noqa: E501
|
|
1353
1353
|
"""Download a file.
|
|
1354
1354
|
|
|
1355
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1355
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1356
1356
|
This method makes a synchronous HTTP request by default.
|
|
1357
1357
|
|
|
1358
1358
|
:param str collection_id: 24-char hex id (required)
|
|
@@ -1387,7 +1387,7 @@ class CollectionsApi(object):
|
|
|
1387
1387
|
def get_collection_file_zip_info_with_http_info(self, collection_id, file_name, **kwargs): # noqa: E501
|
|
1388
1388
|
"""Download a file.
|
|
1389
1389
|
|
|
1390
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1390
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1391
1391
|
This method makes a synchronous HTTP request by default.
|
|
1392
1392
|
|
|
1393
1393
|
:param str collection_id: 24-char hex id (required)
|
|
@@ -1491,7 +1491,7 @@ class CollectionsApi(object):
|
|
|
1491
1491
|
def get_collection_download_ticket(self, collection_id, file_name, **kwargs): # noqa: E501
|
|
1492
1492
|
"""Download a file.
|
|
1493
1493
|
|
|
1494
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1494
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1495
1495
|
This method makes a synchronous HTTP request by default.
|
|
1496
1496
|
|
|
1497
1497
|
:param str collection_id: 24-char hex id (required)
|
|
@@ -1526,7 +1526,7 @@ class CollectionsApi(object):
|
|
|
1526
1526
|
def get_collection_download_ticket_with_http_info(self, collection_id, file_name, **kwargs): # noqa: E501
|
|
1527
1527
|
"""Download a file.
|
|
1528
1528
|
|
|
1529
|
-
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1529
|
+
Files can be downloaded directly from this endpoint with a valid \"Authorization\" header or via a ticket id. To generate a ticket: - Make a request with an empty \"ticket\" parameter and a valid \"Authorization\" header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the \"ticket\" parameter. A valid \"Authorization\" header is no longer required. When \"view\" is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.
|
|
1530
1530
|
This method makes a synchronous HTTP request by default.
|
|
1531
1531
|
|
|
1532
1532
|
:param str collection_id: 24-char hex id (required)
|
|
@@ -2775,7 +2775,7 @@ class CollectionsApi(object):
|
|
|
2775
2775
|
def modify_collection_file(self, cid, filename, body, **kwargs): # noqa: E501
|
|
2776
2776
|
"""Modify a file's attributes
|
|
2777
2777
|
|
|
2778
|
-
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
2778
|
+
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
2779
2779
|
This method makes a synchronous HTTP request by default.
|
|
2780
2780
|
|
|
2781
2781
|
:param str cid: (required)
|
|
@@ -2803,7 +2803,7 @@ class CollectionsApi(object):
|
|
|
2803
2803
|
def modify_collection_file_with_http_info(self, cid, filename, body, **kwargs): # noqa: E501
|
|
2804
2804
|
"""Modify a file's attributes
|
|
2805
2805
|
|
|
2806
|
-
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
2806
|
+
Note: If modifying a file's modality, the current classification will be cleared (except for items in the \"Custom\" list)
|
|
2807
2807
|
This method makes a synchronous HTTP request by default.
|
|
2808
2808
|
|
|
2809
2809
|
:param str cid: (required)
|