Forms

flowtask.components.NetworkNinja.models.forms

Condition

Bases: BaseModel

Defines a Condition, a condition for a Logic Group. Example: { "condition_id": 1835, "condition_logic": "EQUALS", "condition_comparison_value": "Regular", "condition_question_reference_id": 48, "condition_option_id": 4308 }

Form

Bases: AbstractPayload

Reference to a Form:

on_sync async

on_sync()

Sync the form with the database.

FormData

Bases: AbstractPayload

Defines a Form Data, a collection of responses to a Form.

Example

{ "form_data_id": 1, "formid": 1, "client_id": 59, "orgid": 77, "store_id": 1, "store_name": "Best Buy 4350", "user_id": 1, "user_name": "Arturo", "created_at": "2025-02-01T00:00:00-06:00", "updated_at": "2025-02-01T00:00:00-06:00", "form_responses": [ { "column_name": "8550", "data": "Arturo", "question_shown_to_user": true, "column_id": "150698" } ] }

save async

save(conn, pk=None, **kwargs)

Always do an UPSERT on Form Data:

FormDefinition

Bases: AbstractPayload

Defines a Form (recap) definition.

FormMetadata

Bases: AbstractPayload

Defines a Form Metadata, a single question from a Form.

Example

{ "column_name": "8452", "description": "Please provide a photo of the starting odometer reading", "is_active": true, "data_type": "FIELD_IMAGE_UPLOAD", "formid": 1, "form_name": "Territory Manager Visit Form TEST", "client_id": 59, "client_name": "TRENDMICRO", "orgid": 77 }

insert_record async

insert_record(conn, **kwargs)

Insert Record to Database.

FormResponse

Bases: BaseModel

Defines a Form Response, a response to a Form.

Example

{ "event_id": 10516, "column_name": 8550, "data": "Arturo", "question_shown_to_user": true, "column_id": "150698" }

LogicGroup

Bases: BaseModel

Defines a Logic Group, a group of questions in a Form. Example: { "logic_group_id": 1706, "conditions": [ { "condition_id": 1835, "condition_logic": "EQUALS", "condition_comparison_value": "Regular", "condition_question_reference_id": 48, "condition_option_id": 4308 } ] }

Question

Bases: BaseModel

Defines a Question, a single question in a Form. Example: { "question_id": 48, "question_column_name": "8501", "question_description": "Purpose of Visit", "question_logic_groups": [], "validations": [ { "validation_id": 43, "validation_type": "responseRequired", "validation_logic": null, "validation_comparison_value": null, "validation_question_reference_id": null } ] }

QuestionBlock

Bases: BaseModel

Defines a Question Block, a collection of questions in a Form.

Example

{ "question_block_id": 9, "question_block_type": "simple", "question_block_logic_groups": [], "questions": [] }

Validation

Bases: BaseModel

Defines a Validation, a validation rule for a question. Example: { "validation_id": 43, "validation_type": "responseRequired", "validation_logic": null, "validation_comparison_value": null, "validation_question_reference_id": null }