flywheel-sdk 19.3.0rc1__py2.py3-none-any.whl → 19.4.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/__init__.py +1 -0
- flywheel/api/acquisitions_api.py +134 -28
- flywheel/api/analyses_api.py +125 -21
- flywheel/api/collections_api.py +122 -12
- flywheel/api/containers_api.py +25 -27
- flywheel/api/files_api.py +212 -4
- flywheel/api/groups_api.py +109 -1
- flywheel/api/jobs_api.py +5 -1
- flywheel/api/projects_api.py +149 -31
- flywheel/api/sessions_api.py +144 -30
- flywheel/api/subjects_api.py +139 -29
- flywheel/api/tree_api.py +5 -1
- flywheel/api/users_api.py +15 -3
- flywheel/api_client.py +1 -1
- flywheel/configuration.py +2 -2
- flywheel/flywheel.py +207 -187
- flywheel/models/__init__.py +2 -1
- flywheel/models/daily_report_usage.py +62 -4
- flywheel/models/features.py +16 -16
- flywheel/models/filter.py +217 -0
- flywheel/models/mixins.py +33 -2
- flywheel/models/report_usage.py +88 -1
- {flywheel_sdk-19.3.0rc1.dist-info → flywheel_sdk-19.4.0.dist-info}/METADATA +6 -6
- {flywheel_sdk-19.3.0rc1.dist-info → flywheel_sdk-19.4.0.dist-info}/RECORD +27 -26
- {flywheel_sdk-19.3.0rc1.dist-info → flywheel_sdk-19.4.0.dist-info}/WHEEL +1 -1
- {flywheel_sdk-19.3.0rc1.dist-info → flywheel_sdk-19.4.0.dist-info}/LICENSE.txt +0 -0
- {flywheel_sdk-19.3.0rc1.dist-info → flywheel_sdk-19.4.0.dist-info}/top_level.txt +0 -0
flywheel/__init__.py
CHANGED
|
@@ -289,6 +289,7 @@ from flywheel.models.file_version_output import FileVersionOutput
|
|
|
289
289
|
from flywheel.models.file_via import FileVia
|
|
290
290
|
from flywheel.models.file_zip_entry import FileZipEntry
|
|
291
291
|
from flywheel.models.file_zip_info import FileZipInfo
|
|
292
|
+
from flywheel.models.filter import Filter
|
|
292
293
|
from flywheel.models.filter_values import FilterValues
|
|
293
294
|
from flywheel.models.fixed_file_version_input import FixedFileVersionInput
|
|
294
295
|
from flywheel.models.fixed_input import FixedInput
|
flywheel/api/acquisitions_api.py
CHANGED
|
@@ -1575,6 +1575,110 @@ class AcquisitionsApi(object):
|
|
|
1575
1575
|
_request_out=params.get('_request_out'),
|
|
1576
1576
|
collection_formats=collection_formats)
|
|
1577
1577
|
|
|
1578
|
+
def delete_acquisitions_by_query(self, body, **kwargs): # noqa: E501
|
|
1579
|
+
"""Delete multiple acquisitions by query
|
|
1580
|
+
|
|
1581
|
+
Delete multiple acquisitions by query
|
|
1582
|
+
This method makes a synchronous HTTP request by default.
|
|
1583
|
+
|
|
1584
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
1585
|
+
:param ContainerDeleteReason delete_reason:
|
|
1586
|
+
:param bool async_: Perform the request asynchronously
|
|
1587
|
+
:return: DeletedResult
|
|
1588
|
+
"""
|
|
1589
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
1590
|
+
kwargs['_return_http_data_only'] = True
|
|
1591
|
+
|
|
1592
|
+
if kwargs.get('async_'):
|
|
1593
|
+
return self.delete_acquisitions_by_query_with_http_info(body, **kwargs) # noqa: E501
|
|
1594
|
+
else:
|
|
1595
|
+
(data) = self.delete_acquisitions_by_query_with_http_info(body, **kwargs) # noqa: E501
|
|
1596
|
+
if (
|
|
1597
|
+
data
|
|
1598
|
+
and hasattr(data, 'return_value')
|
|
1599
|
+
and not ignore_simplified_return_value
|
|
1600
|
+
):
|
|
1601
|
+
return data.return_value()
|
|
1602
|
+
return data
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
def delete_acquisitions_by_query_with_http_info(self, body, **kwargs): # noqa: E501
|
|
1606
|
+
"""Delete multiple acquisitions by query
|
|
1607
|
+
|
|
1608
|
+
Delete multiple acquisitions by query
|
|
1609
|
+
This method makes a synchronous HTTP request by default.
|
|
1610
|
+
|
|
1611
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
1612
|
+
:param ContainerDeleteReason delete_reason:
|
|
1613
|
+
:param bool async_: Perform the request asynchronously
|
|
1614
|
+
:return: DeletedResult
|
|
1615
|
+
"""
|
|
1616
|
+
|
|
1617
|
+
all_params = ['body','delete_reason',] # noqa: E501
|
|
1618
|
+
all_params.append('async_')
|
|
1619
|
+
all_params.append('_return_http_data_only')
|
|
1620
|
+
all_params.append('_preload_content')
|
|
1621
|
+
all_params.append('_request_timeout')
|
|
1622
|
+
all_params.append('_request_out')
|
|
1623
|
+
|
|
1624
|
+
params = locals()
|
|
1625
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1626
|
+
if key not in all_params:
|
|
1627
|
+
raise TypeError(
|
|
1628
|
+
"Got an unexpected keyword argument '%s'"
|
|
1629
|
+
" to method delete_acquisitions_by_query" % key
|
|
1630
|
+
)
|
|
1631
|
+
params[key] = val
|
|
1632
|
+
del params['kwargs']
|
|
1633
|
+
# verify the required parameter 'body' is set
|
|
1634
|
+
if ('body' not in params or
|
|
1635
|
+
params['body'] is None):
|
|
1636
|
+
raise ValueError("Missing the required parameter `body` when calling `delete_acquisitions_by_query`") # noqa: E501
|
|
1637
|
+
|
|
1638
|
+
collection_formats = {}
|
|
1639
|
+
|
|
1640
|
+
path_params = {}
|
|
1641
|
+
|
|
1642
|
+
query_params = []
|
|
1643
|
+
if 'delete_reason' in params:
|
|
1644
|
+
query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
|
|
1645
|
+
|
|
1646
|
+
header_params = {}
|
|
1647
|
+
|
|
1648
|
+
form_params = []
|
|
1649
|
+
local_var_files = {}
|
|
1650
|
+
|
|
1651
|
+
body_params = None
|
|
1652
|
+
if 'body' in params:
|
|
1653
|
+
body_params = params['body']
|
|
1654
|
+
# HTTP header `Accept`
|
|
1655
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1656
|
+
['application/json']) # noqa: E501
|
|
1657
|
+
|
|
1658
|
+
# HTTP header `Content-Type`
|
|
1659
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
1660
|
+
['application/json']) # noqa: E501
|
|
1661
|
+
|
|
1662
|
+
# Authentication setting
|
|
1663
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
1664
|
+
|
|
1665
|
+
return self.api_client.call_api(
|
|
1666
|
+
'/acquisitions/delete_by_query', 'DELETE',
|
|
1667
|
+
path_params,
|
|
1668
|
+
query_params,
|
|
1669
|
+
header_params,
|
|
1670
|
+
body=body_params,
|
|
1671
|
+
post_params=form_params,
|
|
1672
|
+
files=local_var_files,
|
|
1673
|
+
response_type='DeletedResult', # noqa: E501
|
|
1674
|
+
auth_settings=auth_settings,
|
|
1675
|
+
async_=params.get('async_'),
|
|
1676
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1677
|
+
_preload_content=params.get('_preload_content', True),
|
|
1678
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1679
|
+
_request_out=params.get('_request_out'),
|
|
1680
|
+
collection_formats=collection_formats)
|
|
1681
|
+
|
|
1578
1682
|
def download_file_from_acquisition(self, acquisition_id, file_name, dest_file, **kwargs): # noqa: E501
|
|
1579
1683
|
"""Download a file.
|
|
1580
1684
|
|
|
@@ -1709,9 +1813,9 @@ class AcquisitionsApi(object):
|
|
|
1709
1813
|
collection_formats=collection_formats)
|
|
1710
1814
|
|
|
1711
1815
|
def get_acquisition_file_zip_info(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
1712
|
-
"""
|
|
1816
|
+
"""Retrieve the zip info of a child file by name.
|
|
1713
1817
|
|
|
1714
|
-
|
|
1818
|
+
Does not work on files whose names contain a forward slash.
|
|
1715
1819
|
This method makes a synchronous HTTP request by default.
|
|
1716
1820
|
|
|
1717
1821
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -1744,9 +1848,9 @@ class AcquisitionsApi(object):
|
|
|
1744
1848
|
|
|
1745
1849
|
|
|
1746
1850
|
def get_acquisition_file_zip_info_with_http_info(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
1747
|
-
"""
|
|
1851
|
+
"""Retrieve the zip info of a child file by name.
|
|
1748
1852
|
|
|
1749
|
-
|
|
1853
|
+
Does not work on files whose names contain a forward slash.
|
|
1750
1854
|
This method makes a synchronous HTTP request by default.
|
|
1751
1855
|
|
|
1752
1856
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -1848,9 +1952,8 @@ class AcquisitionsApi(object):
|
|
|
1848
1952
|
collection_formats=collection_formats)
|
|
1849
1953
|
|
|
1850
1954
|
def get_acquisition_download_ticket(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
1851
|
-
"""
|
|
1955
|
+
"""Get a signed URL to download a named child file.
|
|
1852
1956
|
|
|
1853
|
-
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.
|
|
1854
1957
|
This method makes a synchronous HTTP request by default.
|
|
1855
1958
|
|
|
1856
1959
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -1883,9 +1986,8 @@ class AcquisitionsApi(object):
|
|
|
1883
1986
|
|
|
1884
1987
|
|
|
1885
1988
|
def get_acquisition_download_ticket_with_http_info(self, acquisition_id, file_name, **kwargs): # noqa: E501
|
|
1886
|
-
"""
|
|
1989
|
+
"""Get a signed URL to download a named child file.
|
|
1887
1990
|
|
|
1888
|
-
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.
|
|
1889
1991
|
This method makes a synchronous HTTP request by default.
|
|
1890
1992
|
|
|
1891
1993
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2118,9 +2220,9 @@ class AcquisitionsApi(object):
|
|
|
2118
2220
|
collection_formats=collection_formats)
|
|
2119
2221
|
|
|
2120
2222
|
def get_acquisition_analysis_input_zip_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2121
|
-
"""
|
|
2223
|
+
"""Retrieve the zip info of a child file by name.
|
|
2122
2224
|
|
|
2123
|
-
|
|
2225
|
+
Does not work on files whose names contain a forward slash.
|
|
2124
2226
|
This method makes a synchronous HTTP request by default.
|
|
2125
2227
|
|
|
2126
2228
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2152,9 +2254,9 @@ class AcquisitionsApi(object):
|
|
|
2152
2254
|
|
|
2153
2255
|
|
|
2154
2256
|
def get_acquisition_analysis_input_zip_info_with_http_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2155
|
-
"""
|
|
2257
|
+
"""Retrieve the zip info of a child file by name.
|
|
2156
2258
|
|
|
2157
|
-
|
|
2259
|
+
Does not work on files whose names contain a forward slash.
|
|
2158
2260
|
This method makes a synchronous HTTP request by default.
|
|
2159
2261
|
|
|
2160
2262
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2257,9 +2359,8 @@ class AcquisitionsApi(object):
|
|
|
2257
2359
|
collection_formats=collection_formats)
|
|
2258
2360
|
|
|
2259
2361
|
def get_acquisition_analysis_input_download_ticket(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2260
|
-
"""
|
|
2362
|
+
"""Get a signed URL to download a named child file.
|
|
2261
2363
|
|
|
2262
|
-
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.
|
|
2263
2364
|
This method makes a synchronous HTTP request by default.
|
|
2264
2365
|
|
|
2265
2366
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2291,9 +2392,8 @@ class AcquisitionsApi(object):
|
|
|
2291
2392
|
|
|
2292
2393
|
|
|
2293
2394
|
def get_acquisition_analysis_input_download_ticket_with_http_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2294
|
-
"""
|
|
2395
|
+
"""Get a signed URL to download a named child file.
|
|
2295
2396
|
|
|
2296
|
-
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.
|
|
2297
2397
|
This method makes a synchronous HTTP request by default.
|
|
2298
2398
|
|
|
2299
2399
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2527,9 +2627,9 @@ class AcquisitionsApi(object):
|
|
|
2527
2627
|
collection_formats=collection_formats)
|
|
2528
2628
|
|
|
2529
2629
|
def get_acquisition_analysis_output_zip_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2530
|
-
"""
|
|
2630
|
+
"""Retrieve the zip info of a child file by name.
|
|
2531
2631
|
|
|
2532
|
-
|
|
2632
|
+
Does not work on files whose names contain a forward slash.
|
|
2533
2633
|
This method makes a synchronous HTTP request by default.
|
|
2534
2634
|
|
|
2535
2635
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2561,9 +2661,9 @@ class AcquisitionsApi(object):
|
|
|
2561
2661
|
|
|
2562
2662
|
|
|
2563
2663
|
def get_acquisition_analysis_output_zip_info_with_http_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2564
|
-
"""
|
|
2664
|
+
"""Retrieve the zip info of a child file by name.
|
|
2565
2665
|
|
|
2566
|
-
|
|
2666
|
+
Does not work on files whose names contain a forward slash.
|
|
2567
2667
|
This method makes a synchronous HTTP request by default.
|
|
2568
2668
|
|
|
2569
2669
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2666,9 +2766,8 @@ class AcquisitionsApi(object):
|
|
|
2666
2766
|
collection_formats=collection_formats)
|
|
2667
2767
|
|
|
2668
2768
|
def get_acquisition_analysis_output_download_ticket(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2669
|
-
"""
|
|
2769
|
+
"""Get a signed URL to download a named child file.
|
|
2670
2770
|
|
|
2671
|
-
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.
|
|
2672
2771
|
This method makes a synchronous HTTP request by default.
|
|
2673
2772
|
|
|
2674
2773
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2700,9 +2799,8 @@ class AcquisitionsApi(object):
|
|
|
2700
2799
|
|
|
2701
2800
|
|
|
2702
2801
|
def get_acquisition_analysis_output_download_ticket_with_http_info(self, acquisition_id, analysis_id, filename, **kwargs): # noqa: E501
|
|
2703
|
-
"""
|
|
2802
|
+
"""Get a signed URL to download a named child file.
|
|
2704
2803
|
|
|
2705
|
-
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.
|
|
2706
2804
|
This method makes a synchronous HTTP request by default.
|
|
2707
2805
|
|
|
2708
2806
|
:param str acquisition_id: 24-character hex ID (required)
|
|
@@ -2927,6 +3025,7 @@ class AcquisitionsApi(object):
|
|
|
2927
3025
|
:param bool inflate_job:
|
|
2928
3026
|
:param bool join_avatars:
|
|
2929
3027
|
:param JoinType join:
|
|
3028
|
+
:param bool include_all_info: Include all info in returned objects
|
|
2930
3029
|
:param list[str] x_accept_feature:
|
|
2931
3030
|
:param bool async_: Perform the request asynchronously
|
|
2932
3031
|
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
@@ -2963,12 +3062,13 @@ class AcquisitionsApi(object):
|
|
|
2963
3062
|
:param bool inflate_job:
|
|
2964
3063
|
:param bool join_avatars:
|
|
2965
3064
|
:param JoinType join:
|
|
3065
|
+
:param bool include_all_info: Include all info in returned objects
|
|
2966
3066
|
:param list[str] x_accept_feature:
|
|
2967
3067
|
:param bool async_: Perform the request asynchronously
|
|
2968
3068
|
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
2969
3069
|
"""
|
|
2970
3070
|
|
|
2971
|
-
all_params = ['cid','filter','sort','limit','skip','page','after_id','inflate_job','join_avatars','join','x_accept_feature',] # noqa: E501
|
|
3071
|
+
all_params = ['cid','filter','sort','limit','skip','page','after_id','inflate_job','join_avatars','join','include_all_info','x_accept_feature',] # noqa: E501
|
|
2972
3072
|
all_params.append('async_')
|
|
2973
3073
|
all_params.append('_return_http_data_only')
|
|
2974
3074
|
all_params.append('_preload_content')
|
|
@@ -3014,6 +3114,8 @@ class AcquisitionsApi(object):
|
|
|
3014
3114
|
query_params.append(('join_avatars', params['join_avatars'])) # noqa: E501
|
|
3015
3115
|
if 'join' in params:
|
|
3016
3116
|
query_params.append(('join', params['join'])) # noqa: E501
|
|
3117
|
+
if 'include_all_info' in params:
|
|
3118
|
+
query_params.append(('include_all_info', params['include_all_info'])) # noqa: E501
|
|
3017
3119
|
|
|
3018
3120
|
header_params = {}
|
|
3019
3121
|
if 'x_accept_feature' in params:
|
|
@@ -3486,6 +3588,7 @@ class AcquisitionsApi(object):
|
|
|
3486
3588
|
:param JoinType join:
|
|
3487
3589
|
:param bool join_avatars: add name and avatar to notes
|
|
3488
3590
|
:param str collection_id:
|
|
3591
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3489
3592
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
3490
3593
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3491
3594
|
:param int limit: The maximum number of entries to return.
|
|
@@ -3522,6 +3625,7 @@ class AcquisitionsApi(object):
|
|
|
3522
3625
|
:param JoinType join:
|
|
3523
3626
|
:param bool join_avatars: add name and avatar to notes
|
|
3524
3627
|
:param str collection_id:
|
|
3628
|
+
:param bool include_all_info: Include all info in returned objects
|
|
3525
3629
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
3526
3630
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
3527
3631
|
:param int limit: The maximum number of entries to return.
|
|
@@ -3533,7 +3637,7 @@ class AcquisitionsApi(object):
|
|
|
3533
3637
|
:return: union[list[AcquisitionListOutput],Page]
|
|
3534
3638
|
"""
|
|
3535
3639
|
|
|
3536
|
-
all_params = ['exhaustive','join','join_avatars','collection_id','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
3640
|
+
all_params = ['exhaustive','join','join_avatars','collection_id','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
3537
3641
|
all_params.append('async_')
|
|
3538
3642
|
all_params.append('_return_http_data_only')
|
|
3539
3643
|
all_params.append('_preload_content')
|
|
@@ -3563,6 +3667,8 @@ class AcquisitionsApi(object):
|
|
|
3563
3667
|
query_params.append(('join_avatars', params['join_avatars'])) # noqa: E501
|
|
3564
3668
|
if 'collection_id' in params:
|
|
3565
3669
|
query_params.append(('collection_id', params['collection_id'])) # noqa: E501
|
|
3670
|
+
if 'include_all_info' in params:
|
|
3671
|
+
query_params.append(('include_all_info', params['include_all_info'])) # noqa: E501
|
|
3566
3672
|
if 'filter' in params:
|
|
3567
3673
|
query_params.append(('filter', params['filter'])) # noqa: E501
|
|
3568
3674
|
if 'sort' in params:
|
|
@@ -4219,7 +4325,7 @@ class AcquisitionsApi(object):
|
|
|
4219
4325
|
def modify_acquisition_info(self, cid, body, **kwargs): # noqa: E501
|
|
4220
4326
|
"""Update or replace info for a(n) acquisition.
|
|
4221
4327
|
|
|
4222
|
-
Update or replace info for a(n) acquisition.
|
|
4328
|
+
Update or replace info for a(n) acquisition. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
4223
4329
|
This method makes a synchronous HTTP request by default.
|
|
4224
4330
|
|
|
4225
4331
|
:param str cid: (required)
|
|
@@ -4246,7 +4352,7 @@ class AcquisitionsApi(object):
|
|
|
4246
4352
|
def modify_acquisition_info_with_http_info(self, cid, body, **kwargs): # noqa: E501
|
|
4247
4353
|
"""Update or replace info for a(n) acquisition.
|
|
4248
4354
|
|
|
4249
|
-
Update or replace info for a(n) acquisition.
|
|
4355
|
+
Update or replace info for a(n) acquisition. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
4250
4356
|
This method makes a synchronous HTTP request by default.
|
|
4251
4357
|
|
|
4252
4358
|
:param str cid: (required)
|
flywheel/api/analyses_api.py
CHANGED
|
@@ -263,7 +263,7 @@ class AnalysesApi(object):
|
|
|
263
263
|
def delete_analyses_by_ids(self, body, **kwargs): # noqa: E501
|
|
264
264
|
"""Delete multiple analyses by ID list
|
|
265
265
|
|
|
266
|
-
Delete analyses by
|
|
266
|
+
Delete multiple analyses by ID list
|
|
267
267
|
This method makes a synchronous HTTP request by default.
|
|
268
268
|
|
|
269
269
|
:param list[str] body: List of IDs to delete (required)
|
|
@@ -290,7 +290,7 @@ class AnalysesApi(object):
|
|
|
290
290
|
def delete_analyses_by_ids_with_http_info(self, body, **kwargs): # noqa: E501
|
|
291
291
|
"""Delete multiple analyses by ID list
|
|
292
292
|
|
|
293
|
-
Delete analyses by
|
|
293
|
+
Delete multiple analyses by ID list
|
|
294
294
|
This method makes a synchronous HTTP request by default.
|
|
295
295
|
|
|
296
296
|
:param list[str] body: List of IDs to delete (required)
|
|
@@ -364,6 +364,110 @@ class AnalysesApi(object):
|
|
|
364
364
|
_request_out=params.get('_request_out'),
|
|
365
365
|
collection_formats=collection_formats)
|
|
366
366
|
|
|
367
|
+
def delete_analyses_by_query(self, body, **kwargs): # noqa: E501
|
|
368
|
+
"""Delete multiple analyses by query
|
|
369
|
+
|
|
370
|
+
Delete multiple analyses by query
|
|
371
|
+
This method makes a synchronous HTTP request by default.
|
|
372
|
+
|
|
373
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
374
|
+
:param ContainerDeleteReason delete_reason:
|
|
375
|
+
:param bool async_: Perform the request asynchronously
|
|
376
|
+
:return: DeletedResult
|
|
377
|
+
"""
|
|
378
|
+
ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
|
|
379
|
+
kwargs['_return_http_data_only'] = True
|
|
380
|
+
|
|
381
|
+
if kwargs.get('async_'):
|
|
382
|
+
return self.delete_analyses_by_query_with_http_info(body, **kwargs) # noqa: E501
|
|
383
|
+
else:
|
|
384
|
+
(data) = self.delete_analyses_by_query_with_http_info(body, **kwargs) # noqa: E501
|
|
385
|
+
if (
|
|
386
|
+
data
|
|
387
|
+
and hasattr(data, 'return_value')
|
|
388
|
+
and not ignore_simplified_return_value
|
|
389
|
+
):
|
|
390
|
+
return data.return_value()
|
|
391
|
+
return data
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
def delete_analyses_by_query_with_http_info(self, body, **kwargs): # noqa: E501
|
|
395
|
+
"""Delete multiple analyses by query
|
|
396
|
+
|
|
397
|
+
Delete multiple analyses by query
|
|
398
|
+
This method makes a synchronous HTTP request by default.
|
|
399
|
+
|
|
400
|
+
:param list[Filter] body: Query for containers to delete (required)
|
|
401
|
+
:param ContainerDeleteReason delete_reason:
|
|
402
|
+
:param bool async_: Perform the request asynchronously
|
|
403
|
+
:return: DeletedResult
|
|
404
|
+
"""
|
|
405
|
+
|
|
406
|
+
all_params = ['body','delete_reason',] # noqa: E501
|
|
407
|
+
all_params.append('async_')
|
|
408
|
+
all_params.append('_return_http_data_only')
|
|
409
|
+
all_params.append('_preload_content')
|
|
410
|
+
all_params.append('_request_timeout')
|
|
411
|
+
all_params.append('_request_out')
|
|
412
|
+
|
|
413
|
+
params = locals()
|
|
414
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
415
|
+
if key not in all_params:
|
|
416
|
+
raise TypeError(
|
|
417
|
+
"Got an unexpected keyword argument '%s'"
|
|
418
|
+
" to method delete_analyses_by_query" % key
|
|
419
|
+
)
|
|
420
|
+
params[key] = val
|
|
421
|
+
del params['kwargs']
|
|
422
|
+
# verify the required parameter 'body' is set
|
|
423
|
+
if ('body' not in params or
|
|
424
|
+
params['body'] is None):
|
|
425
|
+
raise ValueError("Missing the required parameter `body` when calling `delete_analyses_by_query`") # noqa: E501
|
|
426
|
+
|
|
427
|
+
collection_formats = {}
|
|
428
|
+
|
|
429
|
+
path_params = {}
|
|
430
|
+
|
|
431
|
+
query_params = []
|
|
432
|
+
if 'delete_reason' in params:
|
|
433
|
+
query_params.append(('delete_reason', params['delete_reason'])) # noqa: E501
|
|
434
|
+
|
|
435
|
+
header_params = {}
|
|
436
|
+
|
|
437
|
+
form_params = []
|
|
438
|
+
local_var_files = {}
|
|
439
|
+
|
|
440
|
+
body_params = None
|
|
441
|
+
if 'body' in params:
|
|
442
|
+
body_params = params['body']
|
|
443
|
+
# HTTP header `Accept`
|
|
444
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
445
|
+
['application/json']) # noqa: E501
|
|
446
|
+
|
|
447
|
+
# HTTP header `Content-Type`
|
|
448
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
449
|
+
['application/json']) # noqa: E501
|
|
450
|
+
|
|
451
|
+
# Authentication setting
|
|
452
|
+
auth_settings = ['ApiKey'] # noqa: E501
|
|
453
|
+
|
|
454
|
+
return self.api_client.call_api(
|
|
455
|
+
'/analyses/delete_by_query', 'DELETE',
|
|
456
|
+
path_params,
|
|
457
|
+
query_params,
|
|
458
|
+
header_params,
|
|
459
|
+
body=body_params,
|
|
460
|
+
post_params=form_params,
|
|
461
|
+
files=local_var_files,
|
|
462
|
+
response_type='DeletedResult', # noqa: E501
|
|
463
|
+
auth_settings=auth_settings,
|
|
464
|
+
async_=params.get('async_'),
|
|
465
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
466
|
+
_preload_content=params.get('_preload_content', True),
|
|
467
|
+
_request_timeout=params.get('_request_timeout'),
|
|
468
|
+
_request_out=params.get('_request_out'),
|
|
469
|
+
collection_formats=collection_formats)
|
|
470
|
+
|
|
367
471
|
def delete_analysis(self, analysis_id, **kwargs): # noqa: E501
|
|
368
472
|
"""Delete an analysis
|
|
369
473
|
|
|
@@ -798,9 +902,9 @@ class AnalysesApi(object):
|
|
|
798
902
|
collection_formats=collection_formats)
|
|
799
903
|
|
|
800
904
|
def get_analysis_input_zip_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
801
|
-
"""
|
|
905
|
+
"""Retrieve the zip info of a child file by name.
|
|
802
906
|
|
|
803
|
-
|
|
907
|
+
Does not work on files whose names contain a forward slash.
|
|
804
908
|
This method makes a synchronous HTTP request by default.
|
|
805
909
|
|
|
806
910
|
:param str analysis_id: 24-character hex ID (required)
|
|
@@ -831,9 +935,9 @@ class AnalysesApi(object):
|
|
|
831
935
|
|
|
832
936
|
|
|
833
937
|
def get_analysis_input_zip_info_with_http_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
834
|
-
"""
|
|
938
|
+
"""Retrieve the zip info of a child file by name.
|
|
835
939
|
|
|
836
|
-
|
|
940
|
+
Does not work on files whose names contain a forward slash.
|
|
837
941
|
This method makes a synchronous HTTP request by default.
|
|
838
942
|
|
|
839
943
|
:param str analysis_id: 24-character hex ID (required)
|
|
@@ -929,9 +1033,8 @@ class AnalysesApi(object):
|
|
|
929
1033
|
collection_formats=collection_formats)
|
|
930
1034
|
|
|
931
1035
|
def get_analysis_input_download_ticket(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
932
|
-
"""
|
|
1036
|
+
"""Get a signed URL to download a named child file.
|
|
933
1037
|
|
|
934
|
-
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.
|
|
935
1038
|
This method makes a synchronous HTTP request by default.
|
|
936
1039
|
|
|
937
1040
|
:param str analysis_id: 24-character hex ID (required)
|
|
@@ -962,9 +1065,8 @@ class AnalysesApi(object):
|
|
|
962
1065
|
|
|
963
1066
|
|
|
964
1067
|
def get_analysis_input_download_ticket_with_http_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
965
|
-
"""
|
|
1068
|
+
"""Get a signed URL to download a named child file.
|
|
966
1069
|
|
|
967
|
-
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.
|
|
968
1070
|
This method makes a synchronous HTTP request by default.
|
|
969
1071
|
|
|
970
1072
|
:param str analysis_id: 24-character hex ID (required)
|
|
@@ -1183,9 +1285,9 @@ class AnalysesApi(object):
|
|
|
1183
1285
|
collection_formats=collection_formats)
|
|
1184
1286
|
|
|
1185
1287
|
def get_analysis_output_zip_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
1186
|
-
"""
|
|
1288
|
+
"""Retrieve the zip info of a child file by name.
|
|
1187
1289
|
|
|
1188
|
-
|
|
1290
|
+
Does not work on files whose names contain a forward slash.
|
|
1189
1291
|
This method makes a synchronous HTTP request by default.
|
|
1190
1292
|
|
|
1191
1293
|
:param str analysis_id: Container ID (required)
|
|
@@ -1216,9 +1318,9 @@ class AnalysesApi(object):
|
|
|
1216
1318
|
|
|
1217
1319
|
|
|
1218
1320
|
def get_analysis_output_zip_info_with_http_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
1219
|
-
"""
|
|
1321
|
+
"""Retrieve the zip info of a child file by name.
|
|
1220
1322
|
|
|
1221
|
-
|
|
1323
|
+
Does not work on files whose names contain a forward slash.
|
|
1222
1324
|
This method makes a synchronous HTTP request by default.
|
|
1223
1325
|
|
|
1224
1326
|
:param str analysis_id: Container ID (required)
|
|
@@ -1314,9 +1416,8 @@ class AnalysesApi(object):
|
|
|
1314
1416
|
collection_formats=collection_formats)
|
|
1315
1417
|
|
|
1316
1418
|
def get_analysis_output_download_ticket(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
1317
|
-
"""Get
|
|
1419
|
+
"""Get a signed URL to download a named child file.
|
|
1318
1420
|
|
|
1319
|
-
Get Output File
|
|
1320
1421
|
This method makes a synchronous HTTP request by default.
|
|
1321
1422
|
|
|
1322
1423
|
:param str analysis_id: Container ID (required)
|
|
@@ -1347,9 +1448,8 @@ class AnalysesApi(object):
|
|
|
1347
1448
|
|
|
1348
1449
|
|
|
1349
1450
|
def get_analysis_output_download_ticket_with_http_info(self, analysis_id, filename, **kwargs): # noqa: E501
|
|
1350
|
-
"""Get
|
|
1451
|
+
"""Get a signed URL to download a named child file.
|
|
1351
1452
|
|
|
1352
|
-
Get Output File
|
|
1353
1453
|
This method makes a synchronous HTTP request by default.
|
|
1354
1454
|
|
|
1355
1455
|
:param str analysis_id: Container ID (required)
|
|
@@ -1449,6 +1549,7 @@ class AnalysesApi(object):
|
|
|
1449
1549
|
This method makes a synchronous HTTP request by default.
|
|
1450
1550
|
|
|
1451
1551
|
:param bool inflate_job: Return job as an object instead of an id
|
|
1552
|
+
:param bool include_all_info: Include all info in returned objects
|
|
1452
1553
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
1453
1554
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
1454
1555
|
:param int limit: The maximum number of entries to return.
|
|
@@ -1482,6 +1583,7 @@ class AnalysesApi(object):
|
|
|
1482
1583
|
This method makes a synchronous HTTP request by default.
|
|
1483
1584
|
|
|
1484
1585
|
:param bool inflate_job: Return job as an object instead of an id
|
|
1586
|
+
:param bool include_all_info: Include all info in returned objects
|
|
1485
1587
|
:param str filter: The filter to apply. (e.g. label=my-label,created>2018-09-22)
|
|
1486
1588
|
:param str sort: The sort fields and order. (e.g. label:asc,created:desc)
|
|
1487
1589
|
:param int limit: The maximum number of entries to return.
|
|
@@ -1493,7 +1595,7 @@ class AnalysesApi(object):
|
|
|
1493
1595
|
:return: union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]
|
|
1494
1596
|
"""
|
|
1495
1597
|
|
|
1496
|
-
all_params = ['inflate_job','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
1598
|
+
all_params = ['inflate_job','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',] # noqa: E501
|
|
1497
1599
|
all_params.append('async_')
|
|
1498
1600
|
all_params.append('_return_http_data_only')
|
|
1499
1601
|
all_params.append('_preload_content')
|
|
@@ -1517,6 +1619,8 @@ class AnalysesApi(object):
|
|
|
1517
1619
|
query_params = []
|
|
1518
1620
|
if 'inflate_job' in params:
|
|
1519
1621
|
query_params.append(('inflate_job', params['inflate_job'])) # noqa: E501
|
|
1622
|
+
if 'include_all_info' in params:
|
|
1623
|
+
query_params.append(('include_all_info', params['include_all_info'])) # noqa: E501
|
|
1520
1624
|
if 'filter' in params:
|
|
1521
1625
|
query_params.append(('filter', params['filter'])) # noqa: E501
|
|
1522
1626
|
if 'sort' in params:
|
|
@@ -2215,7 +2319,7 @@ class AnalysesApi(object):
|
|
|
2215
2319
|
def modify_analysis_info(self, container_id, body, **kwargs): # noqa: E501
|
|
2216
2320
|
"""Update or replace info for a(n) analysis.
|
|
2217
2321
|
|
|
2218
|
-
Update or replace info for a(n) analysis.
|
|
2322
|
+
Update or replace info for a(n) analysis. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
2219
2323
|
This method makes a synchronous HTTP request by default.
|
|
2220
2324
|
|
|
2221
2325
|
:param str container_id: (required)
|
|
@@ -2242,7 +2346,7 @@ class AnalysesApi(object):
|
|
|
2242
2346
|
def modify_analysis_info_with_http_info(self, container_id, body, **kwargs): # noqa: E501
|
|
2243
2347
|
"""Update or replace info for a(n) analysis.
|
|
2244
2348
|
|
|
2245
|
-
Update or replace info for a(n) analysis.
|
|
2349
|
+
Update or replace info for a(n) analysis. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container.
|
|
2246
2350
|
This method makes a synchronous HTTP request by default.
|
|
2247
2351
|
|
|
2248
2352
|
:param str container_id: (required)
|