`flywheel.api.collections_api`

`CollectionsApi`

Bases: object

`add_collection(body, **kwargs)`

Create a collection

Create a collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`CollectionInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_collection_note(container_id, body, **kwargs)`

Add a note to a(n) collection.

Add a note to a(n) collection. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`container_id`	`str`		required
`body`	`NoteInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_collection_note_with_http_info(container_id, body, **kwargs)`

Add a note to a(n) collection.

Add a note to a(n) collection. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`container_id`	`str`		required
`body`	`NoteInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_collection_permission(collection_id, body, **kwargs)`

Add a permission

Add a permission This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`body`	`AccessPermission`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_collection_permission_with_http_info(collection_id, body, **kwargs)`

Add a permission

Add a permission This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`body`	`AccessPermission`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_collection_tag(cid, body, **kwargs)`

Add a tag to a(n) collection.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`Tag`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_collection_tag_with_http_info(cid, body, **kwargs)`

Add a tag to a(n) collection.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`Tag`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_collection_tags(cid, body, **kwargs)`

Add multiple tags to a(n) collection

Add multiple tags to a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`list[str]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_collection_tags_with_http_info(cid, body, **kwargs)`

Add multiple tags to a(n) collection

Add multiple tags to a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`list[str]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_collection_with_http_info(body, **kwargs)`

Create a collection

Create a collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`CollectionInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection(collection_id, **kwargs)`

Delete a collection

Delete Collections. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_file(cid, filename, **kwargs)`

Delete a file

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.)
A user with admin permissions on the container may delete any file. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`filename`	`str`		required
`delete_reason`	`(ContainerDeleteReason, optional)`	A reason for deletion when audit-trail is enabled	required
`force`	`(bool, optional)`	Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_file_with_http_info(cid, filename, **kwargs)`

Delete a file

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.)
A user with admin permissions on the container may delete any file. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`filename`	`str`		required
`delete_reason`	`(ContainerDeleteReason, optional)`	A reason for deletion when audit-trail is enabled	required
`force`	`(bool, optional)`	Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_note(cid, note_id, **kwargs)`

Remove a note from a(n) collection

Remove a note from a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`note_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_note_with_http_info(cid, note_id, **kwargs)`

Remove a note from a(n) collection

Remove a note from a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`note_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_tag(cid, value, **kwargs)`

Delete a tag

Delete a tag This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_tag_with_http_info(cid, value, **kwargs)`

Delete a tag

Delete a tag This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_tags(cid, body, **kwargs)`

Delete multiple tags from a(n) collection

Delete multiple tags from a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`list[str]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_tags_with_http_info(cid, body, **kwargs)`

Delete multiple tags from a(n) collection

Delete multiple tags from a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`list[str]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_user_permission(collection_id, user_id, **kwargs)`

Delete a permission

Delete a permission This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`user_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_user_permission_with_http_info(collection_id, user_id, **kwargs)`

Delete a permission

Delete a permission This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`user_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collection_with_http_info(collection_id, **kwargs)`

Delete a collection

Delete Collections. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collections_by_ids(body, **kwargs)`

Delete multiple collections by ID list

Delete multiple collections by ID list This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`list[str]`	List of IDs to delete	required
`delete_reason`	`(ContainerDeleteReason, optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_collections_by_ids_with_http_info(body, **kwargs)`

Delete multiple collections by ID list

Delete multiple collections by ID list This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`list[str]`	List of IDs to delete	required
`delete_reason`	`(ContainerDeleteReason, optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`download_file_from_collection(collection_id, file_name, dest_file, **kwargs)`

Download a file.

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 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. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`	24-character hex ID	required
`file_name`	`str`	output file name	required
`info`	`(bool, optional)`	If the file is a zipfile, return a json response of zipfile member information, defaults to false	required
`member`	`(str, optional)`	The filename of a zipfile member to download rather than the entire file	required
`view`	`(bool, optional)`	If true, the proper "Content-Type" header based on the file's mimetype is set on response If false, the "Content-Type" header is set to "application/octet-stream" , defaults to false	required
`version`	`(int, optional)`	version of the file to download	required
`hash`	`(str, optional)`	file hash for comparison	required
`range`	`(str, optional)`	byte ranges to return	required
`x_accept_feature`	`(list[str], optional)`	redirect header, defaults to []	required
`dest_file`	`str`	Destination file path	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`download_file_from_collection_with_http_info(collection_id, file_name, **kwargs)`

Download a file.

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 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. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`	24-character hex ID	required
`file_name`	`str`	output file name	required
`info`	`(bool, optional)`	If the file is a zipfile, return a json response of zipfile member information, defaults to false	required
`member`	`(str, optional)`	The filename of a zipfile member to download rather than the entire file	required
`view`	`(bool, optional)`	If true, the proper "Content-Type" header based on the file's mimetype is set on response If false, the "Content-Type" header is set to "application/octet-stream" , defaults to false	required
`version`	`(int, optional)`	version of the file to download	required
`hash`	`(str, optional)`	file hash for comparison	required
`range`	`(str, optional)`	byte ranges to return	required
`x_accept_feature`	`(list[str], optional)`	redirect header, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_collections(**kwargs)`

List all collections.

List all collections. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`exhaustive`	`(bool, optional)`	, defaults to false	required
`join_avatars`	`(bool, optional)`	add name and avatar to notes, defaults to false	required
`join_files`	`(bool, optional)`	, defaults to true	required
`join`	`(JoinType, optional)`		required
`stats`	`(bool, optional)`	, defaults to false	required
`include_all_info`	`(bool, optional)`	Include all info in returned objects, defaults to false	required
`user_id`	`(str, optional)`		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[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_collections_curators(**kwargs)`

List all curators of collections

List all curators of collections This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`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
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_collections_curators_with_http_info(**kwargs)`

List all curators of collections

List all curators of collections This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`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
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_collections_with_http_info(**kwargs)`

List all collections.

List all collections. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`exhaustive`	`(bool, optional)`	, defaults to false	required
`join_avatars`	`(bool, optional)`	add name and avatar to notes, defaults to false	required
`join_files`	`(bool, optional)`	, defaults to true	required
`join`	`(JoinType, optional)`		required
`stats`	`(bool, optional)`	, defaults to false	required
`include_all_info`	`(bool, optional)`	Include all info in returned objects, defaults to false	required
`user_id`	`(str, optional)`		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[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection(collection_id, **kwargs)`

Retrieve a single collection

Retrieve a single collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`join_avatars`	`(bool, optional)`	add name and avatar to notes, defaults to false	required
`join`	`(JoinType, optional)`		required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_acquisitions(collection_id, **kwargs)`

List acquisitions in a collection

List acquisitions in a collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`session`	`(str, optional)`	The id of a session, to which the acquisitions returned will be restricted	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_collection_acquisitions_with_http_info(collection_id, **kwargs)`

List acquisitions in a collection

List acquisitions in a collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`session`	`(str, optional)`	The id of a session, to which the acquisitions returned will be restricted	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_collection_download_ticket(collection_id, file_name, **kwargs)`

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`	24-character hex ID	required
`file_name`	`str`	output file name	required
`ticket`	`(str, optional)`	The generated ticket id for the download, or present but empty to generate a ticket id	required
`info`	`(bool, optional)`	If the file is a zipfile, return a json response of zipfile member information, defaults to false	required
`member`	`(str, optional)`	The filename of a zipfile member to download rather than the entire file	required
`view`	`(bool, optional)`	If true, the proper "Content-Type" header based on the file's mimetype is set on response If false, the "Content-Type" header is set to "application/octet-stream" , defaults to false	required
`version`	`(int, optional)`	version of the file to download	required
`hash`	`(str, optional)`	file hash for comparison	required
`range`	`(str, optional)`	byte ranges to return	required
`x_accept_feature`	`(list[str], optional)`	redirect header, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_download_ticket_with_http_info(collection_id, file_name, **kwargs)`

Get a signed URL to download a named child file.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`	24-character hex ID	required
`file_name`	`str`	output file name	required
`ticket`	`(str, optional)`	The generated ticket id for the download, or present but empty to generate a ticket id	required
`info`	`(bool, optional)`	If the file is a zipfile, return a json response of zipfile member information, defaults to false	required
`member`	`(str, optional)`	The filename of a zipfile member to download rather than the entire file	required
`view`	`(bool, optional)`	If true, the proper "Content-Type" header based on the file's mimetype is set on response If false, the "Content-Type" header is set to "application/octet-stream" , defaults to false	required
`version`	`(int, optional)`	version of the file to download	required
`hash`	`(str, optional)`	file hash for comparison	required
`range`	`(str, optional)`	byte ranges to return	required
`x_accept_feature`	`(list[str], optional)`	redirect header, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_file_info(cid, filename, **kwargs)`

Get info for a particular file.

Get info for a particular file. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`	Container Id	required
`filename`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_file_info_with_http_info(cid, filename, **kwargs)`

Get info for a particular file.

Get info for a particular file. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`	Container Id	required
`filename`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_file_zip_info(collection_id, file_name, **kwargs)`

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`	24-character hex ID	required
`file_name`	`str`	output file name	required
`ticket`	`(str, optional)`	The generated ticket id for the download, or present but empty to generate a ticket id	required
`info`	`(bool, optional)`	If the file is a zipfile, return a json response of zipfile member information, defaults to false	required
`member`	`(str, optional)`	The filename of a zipfile member to download rather than the entire file	required
`view`	`(bool, optional)`	If true, the proper "Content-Type" header based on the file's mimetype is set on response If false, the "Content-Type" header is set to "application/octet-stream" , defaults to false	required
`version`	`(int, optional)`	version of the file to download	required
`hash`	`(str, optional)`	file hash for comparison	required
`range`	`(str, optional)`	byte ranges to return	required
`x_accept_feature`	`(list[str], optional)`	redirect header, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_file_zip_info_with_http_info(collection_id, file_name, **kwargs)`

Retrieve the zip info of a child file by name.

Does not work on files whose names contain a forward slash. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`	24-character hex ID	required
`file_name`	`str`	output file name	required
`ticket`	`(str, optional)`	The generated ticket id for the download, or present but empty to generate a ticket id	required
`info`	`(bool, optional)`	If the file is a zipfile, return a json response of zipfile member information, defaults to false	required
`member`	`(str, optional)`	The filename of a zipfile member to download rather than the entire file	required
`view`	`(bool, optional)`	If true, the proper "Content-Type" header based on the file's mimetype is set on response If false, the "Content-Type" header is set to "application/octet-stream" , defaults to false	required
`version`	`(int, optional)`	version of the file to download	required
`hash`	`(str, optional)`	file hash for comparison	required
`range`	`(str, optional)`	byte ranges to return	required
`x_accept_feature`	`(list[str], optional)`	redirect header, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_note(cid, note_id, **kwargs)`

Get a note of a(n) collection.

Get a note of a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`note_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_note_with_http_info(cid, note_id, **kwargs)`

Get a note of a(n) collection.

Get a note of a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`note_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_sessions(collection_id, **kwargs)`

List sessions in a collection

List sessions in a collection. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`include_all_info`	`(bool, optional)`	Include all info in returned objects, 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_collection_sessions_with_http_info(collection_id, **kwargs)`

List sessions in a collection

List sessions in a collection. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`include_all_info`	`(bool, optional)`	Include all info in returned objects, 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_collection_tag(cid, value, **kwargs)`

Get the value of a tag, by name.

Get the value of a tag, by name This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_tag_with_http_info(cid, value, **kwargs)`

Get the value of a tag, by name.

Get the value of a tag, by name This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_user_permission(collection_id, user_id, **kwargs)`

List a user's permissions for this group.

List a user's permissions for this group This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`user_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_user_permission_with_http_info(collection_id, user_id, **kwargs)`

List a user's permissions for this group.

List a user's permissions for this group This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`user_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_collection_with_http_info(collection_id, **kwargs)`

Retrieve a single collection

Retrieve a single collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`join_avatars`	`(bool, optional)`	add name and avatar to notes, defaults to false	required
`join`	`(JoinType, optional)`		required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection(collection_id, body, **kwargs)`

Update a collection and its contents

Update a collection and its contents This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`body`	`CollectionInputWithContents`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_file(cid, filename, body, **kwargs)`

Modify a file's attributes

Note: If modifying a file's modality, the current classification will be cleared (except for items in the "Custom" list) This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`filename`	`str`		required
`body`	`FileModifyInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_file_classification(cid, filename, body, **kwargs)`

Update classification for a particular file.

If replacing a file's classification, the modality can optionally be modified as well. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`filename`	`str`		required
`body`	`FileClassificationDelta`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_file_classification_with_http_info(cid, filename, body, **kwargs)`

Update classification for a particular file.

If replacing a file's classification, the modality can optionally be modified as well. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`filename`	`str`		required
`body`	`FileClassificationDelta`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_file_info(cid, filename, body, **kwargs)`

Update info for a particular file.

Modify and return the file 'info' field This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`filename`	`str`		required
`body`	`Info`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_file_info_with_http_info(cid, filename, body, **kwargs)`

Update info for a particular file.

Modify and return the file 'info' field This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`filename`	`str`		required
`body`	`Info`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_file_with_http_info(cid, filename, body, **kwargs)`

Modify a file's attributes

Note: If modifying a file's modality, the current classification will be cleared (except for items in the "Custom" list) This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`filename`	`str`		required
`body`	`FileModifyInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_info(cid, body, **kwargs)`

Update or replace info for a(n) collection.

Update or replace info for a(n) collection. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`Info`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_info_with_http_info(cid, body, **kwargs)`

Update or replace info for a(n) collection.

Update or replace info for a(n) collection. Keys that contain '$' or '.' will be sanitized in the process of being updated on the container. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`Info`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_note(cid, note_id, body, **kwargs)`

Update a note of a(n) collection.

Update a note of a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`note_id`	`str`		required
`body`	`NoteInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_note_with_http_info(cid, note_id, body, **kwargs)`

Update a note of a(n) collection.

Update a note of a(n) collection This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`note_id`	`str`		required
`body`	`NoteInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_user_permission(collection_id, user_id, body, **kwargs)`

Update a user's permission for this group.

Update a users permission for this group This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`user_id`	`str`		required
`body`	`AccessPermissionUpdate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_user_permission_with_http_info(collection_id, user_id, body, **kwargs)`

Update a user's permission for this group.

Update a users permission for this group This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`user_id`	`str`		required
`body`	`AccessPermissionUpdate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_collection_with_http_info(collection_id, body, **kwargs)`

Update a collection and its contents

Update a collection and its contents This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`collection_id`	`str`		required
`body`	`CollectionInputWithContents`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`rename_collection_tag(cid, value, body, **kwargs)`

Rename a tag.

Rename a tag This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`body`	`Tag`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`rename_collection_tag_with_http_info(cid, value, body, **kwargs)`

Rename a tag.

Rename a tag This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`body`	`Tag`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`upload_file_to_collection(container_id, file, **kwargs)`

Upload a file to a(n) collection.

Upload a file to a(n) collection. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`container_id`	`str`		required
`file`	`str`	The file to upload	required
`preserve_metadata`	`(bool, optional)`	, defaults to false	required
`ticket`	`(str, optional)`		required
`id`	`(str, optional)`		required
`level`	`(ContainerType, optional)`		required
`job`	`(str, optional)`		required
`metadata`	`(union[FileCreateInput, list[FileCreateInput]], optional)`	Dictionary of file metadata (type, modality, info, etc.)	required
`x_accept_feature`	`(list[str], optional)`	redirect header, defaults to []	required
`content_type`	`(str, optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`upload_file_to_collection_with_http_info(container_id, file, **kwargs)`

Upload a file to a(n) collection.

Upload a file to a(n) collection. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`container_id`	`str`		required
`file`	`str`	The file to upload	required
`preserve_metadata`	`(bool, optional)`	, defaults to false	required
`ticket`	`(str, optional)`		required
`id`	`(str, optional)`		required
`level`	`(ContainerType, optional)`		required
`job`	`(str, optional)`		required
`metadata`	`(union[FileCreateInput, list[FileCreateInput]], optional)`	Dictionary of file metadata (type, modality, info, etc.)	required
`x_accept_feature`	`(list[str], optional)`	redirect header, defaults to []	required
`content_type`	`(str, optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required