flywheel.api.staffing_pools_api
StaffingPoolsApi
Bases: object
create_staffing_pool(body, **kwargs)
Create
Create a staffing pool. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | StaffingPoolCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
create_staffing_pool_with_http_info(body, **kwargs)
Create
Create a staffing pool. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | StaffingPoolCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_staffing_pool(pool_id, **kwargs)
Delete
Delete a staffing pool by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pool_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_staffing_pool_with_http_info(pool_id, **kwargs)
Delete
Delete a staffing pool by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pool_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
find_all_api_staffing_pools_get(**kwargs)
Find All
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_all_api_staffing_pools_get_with_http_info(**kwargs)
Find All
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_staffing_pool(pool_id, **kwargs)
Get By Id
Get a staffing pool by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pool_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_staffing_pool_with_http_info(pool_id, **kwargs)
Get By Id
Get a staffing pool by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pool_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_staffing_pool(pool_id, body, **kwargs)
Modify
Modify a staffing pool. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pool_id | str | | required |
body | StaffingPoolModify | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_staffing_pool_with_http_info(pool_id, body, **kwargs)
Modify
Modify a staffing pool. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pool_id | str | | required |
body | StaffingPoolModify | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
set_user_staffing_pools(user_id, body, **kwargs)
Set User Staffing Pools
Add a user to multiple staffing pools. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id | str | | required |
body | StaffingPoolList | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
set_user_staffing_pools_with_http_info(user_id, body, **kwargs)
Set User Staffing Pools
Add a user to multiple staffing pools. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id | str | | required |
body | StaffingPoolList | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |