MicrosoftformsClient

Attributes

FormsList module-attribute

FormsList = List[Dict[str, Any]]

NewResponses module-attribute

NewResponses = List[Dict[str, Any]]

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'CreateFormWebhook': {'operation_id': 'CreateFormWebhook', 'path': '/{connectionId}/formapi/api/forms/{form_id}/webhooks', 'method': 'post', 'required_parameters': ['form_id'], 'callback_payload_type': None}}

Classes

GetFormResponseByIdResult dataclass

GetFormResponseByIdResult(additional_properties: Dict[str, Any] = dict())

Response for Get response details

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetFormDetailsByIdResult dataclass

GetFormDetailsByIdResult(title: Optional[str] = None, modified_date: Optional[str] = None, created_date: Optional[str] = None, status: Optional[str] = None, created_by: Optional[str] = None)

Response for Get form details

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

Title of the form.

modified_date class-attribute instance-attribute

modified_date: Optional[str] = field(default=None, metadata={'wire_name': 'modifiedDate'})

Datetime when form was last modified.

created_date class-attribute instance-attribute

created_date: Optional[str] = field(default=None, metadata={'wire_name': 'createdDate'})

Datetime when form was created.

status class-attribute instance-attribute

status: Optional[str] = None

Status of the form.

created_by class-attribute instance-attribute

created_by: Optional[str] = field(default=None, metadata={'wire_name': 'createdBy'})

User who created the form.

WebhookRequestBody dataclass

WebhookRequestBody(event_type: Optional[str] = None, notification_url: Optional[str] = None, source: Optional[str] = None)

Definition: WebhookRequestBody

Attributes

event_type class-attribute instance-attribute

event_type: Optional[str] = field(default=None, metadata={'wire_name': 'eventType'})

Webhook event

notification_url class-attribute instance-attribute

notification_url: Optional[str] = field(default=None, metadata={'wire_name': 'notificationUrl'})

Webhook callback url

source class-attribute instance-attribute

source: Optional[str] = None

Source of webhook registration

WebhookPayload dataclass

WebhookPayload(value: Optional[List[Dict[str, Any]]] = None)

Definition: WebhookPayload

MicrosoftformsClient

MicrosoftformsClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for microsoftforms connector.

Initialize a MicrosoftformsClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

get_form_response_by_id_async async

get_form_response_by_id_async(form_id: str, response_id: int) -> dict[str, Any] | None

Get response details

This action retrieves a form response

get_form_details_by_id_async async

get_form_details_by_id_async(form_id: str) -> dict[str, Any] | None

Get form details

This action retrieves the details of a form

list_forms_async async

list_forms_async() -> dict[str, Any] | None

List forms

This operation returns a list of forms in your account.

get_questions_async async

get_questions_async(form_id: str) -> None

Get questions

Get questions definition in a form.