flywheel.api.protocols_api
ProtocolsApi
Bases: object
archive_task_protocol(protocol_id, **kwargs)
Archive
Archive a protocol. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
protocol_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
archive_task_protocol_with_http_info(protocol_id, **kwargs)
Archive
Archive a protocol. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
protocol_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
create_task_protocol(body, **kwargs)
Create
Create a new protocol. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | ProtocolInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
create_task_protocol_with_http_info(body, **kwargs)
Create
Create a new protocol. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | ProtocolInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_task_protocol(protocol_id, **kwargs)
Delete
Delete a protocol This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
protocol_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_task_protocol_with_http_info(protocol_id, **kwargs)
Delete
Delete a protocol This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
protocol_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
find_task_protocols(**kwargs)
Find All
Get a paginated list of protocols. 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 |
find_task_protocols_with_http_info(**kwargs)
Find All
Get a paginated list of protocols. 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_task_protocol(protocol_id, **kwargs)
Get By Id
Get protocol by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
protocol_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_task_protocol_with_http_info(protocol_id, **kwargs)
Get By Id
Get protocol by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
protocol_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_task_protocol(protocol_id, body, **kwargs)
Modify
Modify a protocol. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
protocol_id | str | | required |
body | ProtocolModify | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_task_protocol_with_http_info(protocol_id, body, **kwargs)
Modify
Modify a protocol. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
protocol_id | str | | required |
body | ProtocolModify | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
publish_task_protocol(protocol_id, **kwargs)
Publish
Publish a protocol. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
protocol_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
publish_task_protocol_with_http_info(protocol_id, **kwargs)
Publish
Publish a protocol. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
protocol_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |