`flywheel.api.form_responses_api`

`FormResponsesApi`

Bases: object

`create_or_replace_task_response(task_id, body, **kwargs)`

Create or replace a response for a task (409 if submitted)

Create or replace a response for a task using its protocol's form schema. If no response exists, a new one is created. If a response exists and is NOT submitted, it is replaced. If a response exists and IS submitted, returns 409 Conflict. Only the task assignee can create/replace responses. Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task. This method makes a synchronous HTTP request by default.

Parameters:

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

`create_or_replace_task_response_with_http_info(task_id, body, **kwargs)`

Create or replace a response for a task (409 if submitted)

Create or replace a response for a task using its protocol's form schema. If no response exists, a new one is created. If a response exists and is NOT submitted, it is replaced. If a response exists and IS submitted, returns 409 Conflict. Only the task assignee can create/replace responses. Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task. This method makes a synchronous HTTP request by default.

Parameters:

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

`get_response(response_id, **kwargs)`

Retrieve a specific response

Retrieve a specific response. This method makes a synchronous HTTP request by default.

Parameters:

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

`get_response_with_http_info(response_id, **kwargs)`

Retrieve a specific response

Retrieve a specific response. This method makes a synchronous HTTP request by default.

Parameters:

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

`list_task_responses(task_id, **kwargs)`

List all responses for a given task

List all responses for a given task. This method makes a synchronous HTTP request by default.

Parameters:

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

`list_task_responses_with_http_info(task_id, **kwargs)`

List all responses for a given task

List all responses for a given task. This method makes a synchronous HTTP request by default.

Parameters:

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

`put_task_response(task_id, response_id, body, **kwargs)`

Create or replace a response for a task (409 if submitted)

Create or replace a response for a task using its protocol's form schema. If no response exists, a new one is created. If a response exists and is NOT submitted, it is replaced. If a response exists and IS submitted, returns 409 Conflict. Only the task assignee can create/replace responses. Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`task_id`	`str`		required
`response_id`	`str`		required
`body`	`FormResponseCreate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`put_task_response_with_http_info(task_id, response_id, body, **kwargs)`

Create or replace a response for a task (409 if submitted)

Create or replace a response for a task using its protocol's form schema. If no response exists, a new one is created. If a response exists and is NOT submitted, it is replaced. If a response exists and IS submitted, returns 409 Conflict. Only the task assignee can create/replace responses. Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`task_id`	`str`		required
`response_id`	`str`		required
`body`	`FormResponseCreate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`submit_response(response_id, **kwargs)`

Submit a response. Validate against form schema and lock it

Submit a response. Validate against form schema and lock it. Once submitted: - submitted flag is set to true - submitted_at timestamp is recorded - origin is set to the submitting user - further edits are disabled This method makes a synchronous HTTP request by default.

Parameters:

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

`submit_response_with_http_info(response_id, **kwargs)`

Submit a response. Validate against form schema and lock it

Submit a response. Validate against form schema and lock it. Once submitted: - submitted flag is set to true - submitted_at timestamp is recorded - origin is set to the submitting user - further edits are disabled This method makes a synchronous HTTP request by default.

Parameters:

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

`update_response(response_id, body, **kwargs)`

Update a response only if not submitted

Update a response only if not submitted. Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task. Once submitted, further edits are disabled. This method makes a synchronous HTTP request by default.

Parameters:

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

`update_response_with_http_info(response_id, body, **kwargs)`

Update a response only if not submitted

Update a response only if not submitted. Responses can be saved multiple times as drafts before submission without validation. Validation is enforced only when submitting or completing the task. Once submitted, further edits are disabled. This method makes a synchronous HTTP request by default.

Parameters:

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