`flywheel.api.modalities_api`

`ModalitiesApi`

Bases: object

`add_modality(body, **kwargs)`

Create a new modality.

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

Parameters:

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

`add_modality_with_http_info(body, **kwargs)`

Create a new modality.

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

Parameters:

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

`delete_modality(modality_id, **kwargs)`

Delete a modality

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

Parameters:

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

`delete_modality_with_http_info(modality_id, **kwargs)`

Delete a modality

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

Parameters:

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

`get_all_modalities(**kwargs)`

List all modalities.

Requires login. 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
`x_accept_feature`	`(list[str], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_modalities_with_http_info(**kwargs)`

List all modalities.

Requires login. 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
`x_accept_feature`	`(list[str], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_modality(modality_id, **kwargs)`

Get a modality's classification specification

This method makes a synchronous HTTP request by default.

Parameters:

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

`get_modality_with_http_info(modality_id, **kwargs)`

Get a modality's classification specification

This method makes a synchronous HTTP request by default.

Parameters:

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

`replace_modality(modality_id, body, **kwargs)`

Replace modality

Update details for a modality. This method makes a synchronous HTTP request by default.

Parameters:

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

`replace_modality_with_http_info(modality_id, body, **kwargs)`

Replace modality

Update details for a modality. This method makes a synchronous HTTP request by default.

Parameters:

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