flywheel.api.tasks_api
TasksApi
Bases: object
assign_reader_task(task_id, body, **kwargs)
Assign
Assign a user or staffing pool to reader task. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id | str | | required |
body | TaskAssign | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
assign_reader_task_with_http_info(task_id, body, **kwargs)
Assign
Assign a user or staffing pool to reader task. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id | str | | required |
body | TaskAssign | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
batch_create_adjudication_task_set(body, **kwargs)
Create Adjudication Batch
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | AdjudicationBatchCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
batch_create_adjudication_task_set_with_http_info(body, **kwargs)
Create Adjudication Batch
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | AdjudicationBatchCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
batch_create_reader_task(body, **kwargs)
Create Batch
Create a reader task. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | ReaderBatchCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
batch_create_reader_task_with_http_info(body, **kwargs)
Create Batch
Create a reader task. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | ReaderBatchCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
complete_reader_task(task_id, **kwargs)
Complete
Complete a reader task. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id | str | | required |
body | (TaskSubmission, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
complete_reader_task_with_http_info(task_id, **kwargs)
Complete
Complete a reader task. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id | str | | required |
body | (TaskSubmission, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
create_adjudication_task_set(body, **kwargs)
Create Adjudication
Create an adjudication task set (1 adjudicator + 2 reader tasks) for a single container. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | AdjudicationTaskCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
create_adjudication_task_set_with_http_info(body, **kwargs)
Create Adjudication
Create an adjudication task set (1 adjudicator + 2 reader tasks) for a single container. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | AdjudicationTaskCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
create_reader_task(body, **kwargs)
Create
Create a reader task. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | ReaderTaskCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
create_reader_task_with_http_info(body, **kwargs)
Create
Create a reader task. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | ReaderTaskCreate | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
find_all_api_tasks_reader_get(**kwargs)
Find All
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
limit | (int, optional) | , defaults to 10 | required |
skip | (int, optional) | , defaults to 0 | required |
filter | (str, optional) | | required |
sort | (str, optional) | | required |
columns | (str, optional) | Comma-separated list of columns to include in response | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
find_all_api_tasks_reader_get_with_http_info(**kwargs)
Find All
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
limit | (int, optional) | , defaults to 10 | required |
skip | (int, optional) | , defaults to 0 | required |
filter | (str, optional) | | required |
sort | (str, optional) | | required |
columns | (str, optional) | Comma-separated list of columns to include in response | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_facets_api_tasks_reader_facets_facet_field_get(facet_field, **kwargs)
Get Facets
Get facet counts for a specific field in reader tasks. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
facet_field | TaskFacet | | required |
filter | (str, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_facets_api_tasks_reader_facets_facet_field_get_with_http_info(facet_field, **kwargs)
Get Facets
Get facet counts for a specific field in reader tasks. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
facet_field | TaskFacet | | required |
filter | (str, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_reader_task(task_id, **kwargs)
Get By Id
Get reader task by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_reader_task_with_http_info(task_id, **kwargs)
Get By Id
Get reader task by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_reader_task(task_id, body, **kwargs)
Modify
Modify a reader task. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id | str | | required |
body | ReaderTaskModify | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_reader_task_with_http_info(task_id, body, **kwargs)
Modify
Modify a reader task. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id | str | | required |
body | ReaderTaskModify | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |