CommondataserviceClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'GetOnDeletedItems_V2': {'operation_id': 'GetOnDeletedItems_V2', 'path': '/{connectionId}/v2/datasets/{dataset}/tables/{table}/ondeleteditems', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'ItemsList'}, 'GetOnNewItems_V2': {'operation_id': 'GetOnNewItems_V2', 'path': '/{connectionId}/v2/datasets/{dataset}/tables/{table}/onnewitems', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'ItemsList'}, 'GetOnUpdatedItems_V2': {'operation_id': 'GetOnUpdatedItems_V2', 'path': '/{connectionId}/v2/datasets/{dataset}/tables/{table}/onupdateditems', 'method': 'get', 'required_parameters': ['dataset', 'table'], 'callback_payload_type': 'ItemsList'}}

Classes

DataSetsMetadata dataclass

DataSetsMetadata(*, tabular: Optional[TabularDataSetsMetadata | Mapping[str, Any]] = None, blob: Optional[BlobDataSetsMetadata | Mapping[str, Any]] = None)

Response for GetDataSetsMetadata

AssociateRecordsPatchItemInput dataclass

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

Associates one row to another on the provided relationship

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

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

Item dataclass

Item(*, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)

Response for Associates one row to another on the provided relationship

ItemsList dataclass

ItemsList(*, value: Optional[List[Item | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for Retrieves all collection valued relationship items as an expand would

Attributes

value class-attribute instance-attribute

value: Optional[List[Item | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Items

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

DataSetsList dataclass

DataSetsList(*, value: Optional[List[DataSet | Mapping[str, Any]]] = None)

Response for GetDataSets

Attributes

value class-attribute instance-attribute

value: Optional[List[DataSet | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of datasets

GetItemResponse dataclass

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

Response for Get row (legacy)

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

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

TableMetadata dataclass

TableMetadata(*, name: Optional[str] = None, title: Optional[str] = None, x_ms_permission: Optional[str] = None, x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = None, schema: Optional[ObjectEntity | Mapping[str, Any]] = None, referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = None, web_url: Optional[str] = None)

Response for Get table metadata - Patch

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Table name

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Table title

x_ms_permission class-attribute instance-attribute

x_ms_permission: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'x-ms-permission'})

Table permission

web_url class-attribute instance-attribute

web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'webUrl'})

Url link

ObjectEntity dataclass

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

Response for Retrieves the metadata for multi select column metadata

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

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

TablesList dataclass

TablesList(*, value: Optional[List[Table | Mapping[str, Any]]] = None)

Response for GetTables

Attributes

value class-attribute instance-attribute

value: Optional[List[Table | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Tables

PatchItemInput dataclass

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

Update a row (legacy)

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

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

PatchItemResponse dataclass

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

Response for Update a row (legacy)

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

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

PostItemInput dataclass

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

Add a new row (legacy)

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

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

PostItemResponse dataclass

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

Response for Add a new row (legacy)

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

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

TabularDataSetsMetadata dataclass

TabularDataSetsMetadata(*, source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None, table_display_name: Optional[str] = None, table_plural_name: Optional[str] = None)

Definition: TabularDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = dataclass_field(default=None, kw_only=True)

Dataset source

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'urlEncoding'})

Dataset url encoding

table_display_name class-attribute instance-attribute

table_display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tableDisplayName'})

Table display name

table_plural_name class-attribute instance-attribute

table_plural_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tablePluralName'})

Table plural display name

BlobDataSetsMetadata dataclass

BlobDataSetsMetadata(*, source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)

Definition: BlobDataSetsMetadata

Attributes

source class-attribute instance-attribute

source: Optional[str] = dataclass_field(default=None, kw_only=True)

Blob dataset source

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Blob dataset display name

url_encoding class-attribute instance-attribute

url_encoding: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'urlEncoding'})

Blob dataset url encoding

TableCapabilitiesMetadata dataclass

TableCapabilitiesMetadata(*, sort_restrictions: Optional[TableSortRestrictionsMetadata | Mapping[str, Any]] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata | Mapping[str, Any]] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata | Mapping[str, Any]] = None, is_only_server_pagable: Optional[bool] = None, filter_function_support: Optional[List[str]] = None, server_paging_options: Optional[List[str]] = None)

Definition: TableCapabilitiesMetadata

Attributes

is_only_server_pagable class-attribute instance-attribute

is_only_server_pagable: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

filter_function_support class-attribute instance-attribute

filter_function_support: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'filterFunctionSupport'})

List of supported filter capabilities

server_paging_options class-attribute instance-attribute

server_paging_options: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'serverPagingOptions'})

List of supported server-driven paging capabilities

TableSortRestrictionsMetadata dataclass

TableSortRestrictionsMetadata(*, sortable: Optional[bool] = None, unsortable_properties: Optional[List[str]] = None, ascending_only_properties: Optional[List[str]] = None)

Definition: TableSortRestrictionsMetadata

Attributes

sortable class-attribute instance-attribute

sortable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute

unsortable_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'unsortableProperties'})

List of unsortable properties

ascending_only_properties class-attribute instance-attribute

ascending_only_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ascendingOnlyProperties'})

List of properties which support ascending order only

TableFilterRestrictionsMetadata dataclass

TableFilterRestrictionsMetadata(*, filterable: Optional[bool] = None, non_filterable_properties: Optional[List[str]] = None, required_properties: Optional[List[str]] = None)

Definition: TableFilterRestrictionsMetadata

Attributes

filterable class-attribute instance-attribute

filterable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute

non_filterable_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nonFilterableProperties'})

List of non filterable properties

required_properties class-attribute instance-attribute

required_properties: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'requiredProperties'})

List of required properties

TableSelectRestrictionsMetadata dataclass

TableSelectRestrictionsMetadata(*, selectable: Optional[bool] = None)

Definition: TableSelectRestrictionsMetadata

Attributes

selectable class-attribute instance-attribute

selectable: Optional[bool] = dataclass_field(default=None, kw_only=True)

Indicates whether this table has selectable columns

SubscriptionRequest dataclass

SubscriptionRequest(notification_url: str)

Definition: SubscriptionRequest

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'NotificationUrl'})

Callback url to the flow engine. Expected as part of the request and provided by Flow.

SubscriptionResponse dataclass

SubscriptionResponse(*, id: Optional[str] = None, resource: Optional[str] = None, notification_type: Optional[str] = None, notification_url: Optional[str] = None)

Definition: SubscriptionResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Id of the subscription

resource class-attribute instance-attribute

resource: Optional[str] = dataclass_field(default=None, kw_only=True)

Resource of the subscription request

notification_type class-attribute instance-attribute

notification_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'notificationType'})

Notification Type

notification_url class-attribute instance-attribute

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

Notification Url

UpdateTriggerSubscriptionRequest dataclass

UpdateTriggerSubscriptionRequest(notification_url: str, *, attribute_filters: Optional[List[str]] = None)

Definition: UpdateTriggerSubscriptionRequest

Attributes

attribute_filters class-attribute instance-attribute

attribute_filters: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AttributeFilters'})

Column filters

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'NotificationUrl'})

Callback url to the flow engine. Expected as part of the request and provided by Flow.

DataSet dataclass

DataSet(*, name: Optional[str] = None, display_name: Optional[str] = None, query: Optional[List[PassThroughNativeQuery | Mapping[str, Any]]] = None)

Definition: DataSet

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

Dataset name

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

Dataset display name

query class-attribute instance-attribute

query: Optional[List[PassThroughNativeQuery | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Pass-through Native Queries

Table dataclass

Table(*, name: Optional[str] = None, display_name: Optional[str] = None, dynamic_properties: Optional[Dict[str, str]] = None)

Definition: Table

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the table. The name is used at runtime.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

The display name of the table.

dynamic_properties class-attribute instance-attribute

dynamic_properties: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DynamicProperties'})

Additional table properties provided by the connector to the clients.

Procedure dataclass

Procedure(*, name: Optional[str] = None, display_name: Optional[str] = None)

Definition: Procedure

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

Procedure name

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

Procedure display name

PassThroughNativeQuery dataclass

PassThroughNativeQuery(*, language: Optional[str] = None)

Definition: PassThroughNativeQuery

Attributes

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Language'})

Query language

DisplayCollectionName dataclass

DisplayCollectionName(*, user_localized_label: Optional[UserLocalizedLabel | Mapping[str, Any]] = None)

Definition: DisplayCollectionName

Attributes

user_localized_label class-attribute instance-attribute

user_localized_label: Optional[UserLocalizedLabel | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userLocalizedLabel'})

The user localized display name label object.

EntitiesDynamicValuesList dataclass

EntitiesDynamicValuesList(*, value: Optional[List[EntitiesDynamicValuesListItem | Mapping[str, Any]]] = None)

Definition: EntitiesDynamicValuesList

Attributes

value class-attribute instance-attribute

value: Optional[List[EntitiesDynamicValuesListItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of tables as dynamic values.

EntitiesDynamicValuesListItem dataclass

EntitiesDynamicValuesListItem(*, metadata_id: Optional[str] = None, entity_set_name: Optional[str] = None, logical_name: Optional[str] = None, display_collection_name: Optional[DisplayCollectionName | Mapping[str, Any]] = None)

Definition: EntitiesDynamicValuesListItem

Attributes

metadata_id class-attribute instance-attribute

metadata_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'metadataId'})

The metadata id.

entity_set_name class-attribute instance-attribute

entity_set_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'entitySetName'})

The name of the table.

logical_name class-attribute instance-attribute

logical_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'logicalName'})

The logical name of the table.

display_collection_name class-attribute instance-attribute

display_collection_name: Optional[DisplayCollectionName | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayCollectionName'})

The display name of the table.

OrganizationsDynamicValuesList dataclass

OrganizationsDynamicValuesList(*, value: Optional[List[OrganizationsDynamicValuesListItem | Mapping[str, Any]]] = None)

Definition: OrganizationsDynamicValuesList

Attributes

value class-attribute instance-attribute

value: Optional[List[OrganizationsDynamicValuesListItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of organizations as dynamic values.

OrganizationsDynamicValuesListItem dataclass

OrganizationsDynamicValuesListItem(*, id: Optional[str] = None, friendly_name: Optional[str] = None, url: Optional[str] = None)

Definition: OrganizationsDynamicValuesListItem

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The organization id.

friendly_name class-attribute instance-attribute

friendly_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FriendlyName'})

The name of the organization.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The URL of the organization.

EntityMetadata dataclass

EntityMetadata(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Definition: EntityMetadata

Attributes

schema class-attribute instance-attribute

schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)

Swagger schema

EntityItemList dataclass

EntityItemList(*, value: Optional[List[EntityItem | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Definition: EntityItemList

Attributes

value class-attribute instance-attribute

value: Optional[List[EntityItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Items

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The url to fetch next page data.

EntityItem dataclass

EntityItem(*, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)

Definition: EntityItem

CallbackRegistration dataclass

CallbackRegistration(version: int, url: str, entityname: str, message: int, scope: int, *, name: Optional[str] = None, sdkmessagename: Optional[str] = None, filteringattributes: Optional[str] = None, filterexpression: Optional[str] = None, postponeuntil: Optional[str] = None, runas: Optional[int] = None)

Definition: CallbackRegistration

Attributes

version instance-attribute

version: int

The callback registration table version

url instance-attribute

url: str

Callback url to the flow engine. Expected as part of the request and provided by Flow.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Callback registration name. Value will be replaced with workflow id

entityname instance-attribute

entityname: str

Choose a table

message instance-attribute

message: int

Choose when the flow triggers

sdkmessagename class-attribute instance-attribute

sdkmessagename: Optional[str] = dataclass_field(default=None, kw_only=True)

Choose an option or add your own

scope instance-attribute

scope: int

Choose a scope to limit which rows can trigger the flow

filteringattributes class-attribute instance-attribute

filteringattributes: Optional[str] = dataclass_field(default=None, kw_only=True)

Enter a comma-separated list of column unique names. The flow triggers if any of them are modified

filterexpression class-attribute instance-attribute

filterexpression: Optional[str] = dataclass_field(default=None, kw_only=True)

Enter an OData style filter expression to determine which rows can trigger the flow

postponeuntil class-attribute instance-attribute

postponeuntil: Optional[str] = dataclass_field(default=None, kw_only=True)

Enter a time to delay the trigger evaluation, eg. 2020-01-01T10:10:00Z

runas class-attribute instance-attribute

runas: Optional[int] = dataclass_field(default=None, kw_only=True)

Choose the running user for steps where invoker connections are used

UserLocalizedLabel dataclass

UserLocalizedLabel(*, label: Optional[str] = None)

Definition: UserLocalizedLabel

Attributes

label class-attribute instance-attribute

label: Optional[str] = dataclass_field(default=None, kw_only=True)

The display name label of the table.

WebhookNotificationContent dataclass

WebhookNotificationContent(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Definition: WebhookNotificationContent

Attributes

schema class-attribute instance-attribute

schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)

Swagger schema

EntityRelationshipsDynamicValuesList dataclass

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

Definition: EntityRelationshipsDynamicValuesList

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of table relationships as dynamic values.

AssociateEntityRequest dataclass

AssociateEntityRequest(id: str)

Definition: AssociateEntityRequest

Attributes

id class-attribute instance-attribute

id: str = dataclass_field(metadata={'wire_name': '@odata.id'})

Enter the row URL using OData ID from a previous step or typing the full URL (eg. https://org0.crm.dynamics.com/api/data/v9.0/faxes(3ce6c728-3c8a-4b55-a4ee-a251b253c3ee)

ActionsDynamicValuesList dataclass

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

Definition: ActionsDynamicValuesList

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of actions as dynamic values

SearchRequestBody dataclass

SearchRequestBody(search: str, *, searchtype: Optional[str] = None, searchmode: Optional[str] = None, top: Optional[int] = None, filter: Optional[str] = None, entities: Optional[List[str]] = None, orderby: Optional[List[str]] = None, facets: Optional[List[str]] = None, skip: Optional[int] = None, returntotalrecordcount: Optional[bool] = None)

Definition: SearchRequestBody

Attributes

search instance-attribute

search: str

Enter a search term, eg. Contoso. Searches modifiers like boolean operators, wildcards, fuzzy search, proximity search etc. require the search type full

searchtype class-attribute instance-attribute

searchtype: Optional[str] = dataclass_field(default=None, kw_only=True)

Enter whether simple or full search syntax should be used (default is simple)

searchmode class-attribute instance-attribute

searchmode: Optional[str] = dataclass_field(default=None, kw_only=True)

Enter whether any or all of the search terms must be matched (default is any)

top class-attribute instance-attribute

top: Optional[int] = dataclass_field(default=None, kw_only=True)

Enter the number of search results to be listed (default = 50)

filter class-attribute instance-attribute

filter: Optional[str] = dataclass_field(default=None, kw_only=True)

Enter an OData style filter expression to narrow the search

entities class-attribute instance-attribute

entities: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

Enter a comma-separated list of tables to be searched (default is all tables)

orderby class-attribute instance-attribute

orderby: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

Enter a comma-separated list of column unique names followed by asc or desc

facets class-attribute instance-attribute

facets: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

Enter a comma-separated list of facet queries to narrow the search

skip class-attribute instance-attribute

skip: Optional[int] = dataclass_field(default=None, kw_only=True)

Enter the number of search results to be skipped

returntotalrecordcount class-attribute instance-attribute

returntotalrecordcount: Optional[bool] = dataclass_field(default=None, kw_only=True)

Choose an option

SearchOutput dataclass

SearchOutput(*, value: Optional[List[Dict[str, Any]]] = None, totalrecordcount: Optional[int] = None, facets: Optional[Dict[str, Any]] = None)

Definition: SearchOutput

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of rows

totalrecordcount class-attribute instance-attribute

totalrecordcount: Optional[int] = dataclass_field(default=None, kw_only=True)

Total count of results (-1 if returntotalrecordcount is set to false)

facets class-attribute instance-attribute

facets: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Facet results

WhenAnActionIsPerformedSubscriptionRequest dataclass

WhenAnActionIsPerformedSubscriptionRequest(version: int, url: str, scope: int, entityname: str, sdkmessagename: str, *, name: Optional[str] = None)

Definition: WhenAnActionIsPerformedSubscriptionRequest

Attributes

version instance-attribute

version: int

The callback registration table version.

url instance-attribute

url: str

Callback url to the flow engine. Expected as part of the request and provided by Flow.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Callback registration name. Value will be replaced with workflow id.

scope instance-attribute

scope: int

Choose a scope to limit which rows can trigger the flow.

entityname instance-attribute

entityname: str

Choose a table to filter actions.

sdkmessagename instance-attribute

sdkmessagename: str

Choose an action.

WebhookNotificationContentForWhenAnActionIsPerformed dataclass

WebhookNotificationContentForWhenAnActionIsPerformed(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Definition: WebhookNotificationContentForWhenAnActionIsPerformed

Attributes

schema class-attribute instance-attribute

schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True)

Swagger schema

CommondataserviceClient

CommondataserviceClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for commondataservice connector.

Initialize a CommondataserviceClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

get_data_sets_metadata async

get_data_sets_metadata(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

GetDataSetsMetadata

Swagger operation ID: GetDataSetsMetadata.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_next_page async

get_next_page(next_link: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Follows nextLink to retrieve next page of data

This operation gets the next page of data.

Swagger operation ID: GetNextPage.

Parameters:

Name	Type	Description	Default
next_link	str	OData nextLink.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

associate_records_patch_item async

associate_records_patch_item(input: AssociateRecordsPatchItemInput | Mapping[str, Any], dataset: str, table: str, id: str, relationship: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Associates one row to another on the provided relationship

Associates one row to another on the provided relationship

Swagger operation ID: AssociateRecordsPatchItem_V2.

Parameters:

Name	Type	Description	Default
input	AssociateRecordsPatchItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
dataset	str	Select an Environment.	required
table	str	Name of the table.	required
id	str	Id of the table row.	required
relationship	str	Relationship on which to associate.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_attachment async

create_attachment(input: bytes, dataset: str, table: str, id: str, display_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Creates Note (annotation) for specified table row

Creates Note (annotation) for specified table row.

Swagger operation ID: CreateAttachment_V2.

Parameters:

Name	Type	Description	Default
input	bytes	The binary request body.	required
dataset	str	Select an Environment.	required
table	str	Table on which to create Note (annotation).	required
id	str	Id of the table row on which to create a Note (annotation).	required
display_name	str	Filename.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_attachment async

delete_attachment(dataset: str, table: str, id: str, attachment_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Deletes specified attachment on the Note (annotation)

Deletes specified attachment on the Note (annotation).

Swagger operation ID: DeleteAttachment_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Table on which to delete Note (annotation).	required
id	str	Id of the table row on which to delete a Note (annotation).	required
attachment_id	str	Note (annotation) id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_item async

delete_item(dataset: str, table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a row (legacy)

This operation deletes a row from a table collection

Swagger operation ID: DeleteItem_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Select a table.	required
id	str	Identifier for the row.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

disassociate_records_post_item async

disassociate_records_post_item(dataset: str, table: str, id: str, relationship: str, related_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Disassociates a row from a multi-valued relationship

Disassociates a row from a multi-valued relationship

Swagger operation ID: DisassociateRecordsPostItem_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Name of the table.	required
id	str	Id of the table row.	required
relationship	str	Relationship on which to associate.	required
related_id	str	The item to disassociate.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

disassociate_single_value_record_delete_item async

disassociate_single_value_record_delete_item(dataset: str, table: str, id: str, relationship: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Disassociates a row from a single-valued relationship

Disassociates a row from a single-valued relationship

Swagger operation ID: DisassociateSingleValueRecordDeleteItem_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Name of the table.	required
id	str	Id of the table row.	required
relationship	str	Relationship on which to associate.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_attachment_content async

get_attachment_content(dataset: str, table: str, id: str, attachment_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Retrieves file content for specified Note (annotation)

Retrieves file content for specified Note (annotation).

Swagger operation ID: GetAttachmentContent_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Table for which to get Note (annotation) content.	required
id	str	Id of the table row for which to get Notes (annotations).	required
attachment_id	str	Note (annotation) id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_collection_relationships

list_collection_relationships(dataset: str, table: str, id: str, collection_type: str, relationship: str, target: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Retrieves all collection valued relationship items as an expand would

Retrieves all collection valued relationship items as an expand would

Returns a single-page Azure Core async collection.

Swagger operation ID: GetCollectionRelationships_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Name of the table.	required
id	str	Id of the table row.	required
collection_type	str	many to many or not.	required
relationship	str	Relationship on which to expand.	required
target	str	Target table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_data_sets

list_data_sets(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

GetDataSets

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDataSets_V2.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_item async

get_item(dataset: str, table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get row (legacy)

This operation retrieves the specified row for a table

Swagger operation ID: GetItem_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Select a table.	required
id	str	Identifier for the row.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_item_attachments

list_item_attachments(dataset: str, table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Retrieves all Notes (annotations) for the provided table row Id

Retrieves all Notes (annotations) for the provided table row Id.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetItemAttachments_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Table for which to get Notes (annotations).	required
id	str	Id of the table row for which to get Notes (annotations).	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_items

list_items(dataset: str, table: str, *, apply: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List rows (legacy)

This operation gets rows for a table

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetItems_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Select a table.	required
apply	Optional[str]	A sequence of OData aggregation transformations.	None
filter	Optional[str]	An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).	None
orderby	Optional[str]	An ODATA orderBy query for specifying the order of entries.	None
top	Optional[int]	Total number of entries to retrieve (default = all).	None
expand	Optional[str]	Related entries to include with requested entries (default = none).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_metadata_for_patch_item async

get_metadata_for_patch_item(dataset: str, table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get table metadata - Patch

Gets table metadata for patch operation

Swagger operation ID: GetMetadataForPatchItem_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Select a table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_metadata_for_post_item async

get_metadata_for_post_item(dataset: str, table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get table metadata - Post

Gets table metadata for post operation

Swagger operation ID: GetMetadataForPostItem_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Select a table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_multi_select_metadata async

get_multi_select_metadata(dataset: str, table: str, item: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Retrieves the metadata for multi select column metadata

Retrieves the metadata for multi select column metadata.

Swagger operation ID: GetMultiSelectMetadata_V2.

Parameters:

Name	Type	Description	Default
dataset	str	org name.	required
table	str	table name.	required
item	str	id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_option_set_metadata async

get_option_set_metadata(dataset: str, table: str, item: str, type_: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Retrieves the metadata for choice column metadata

Retrieves the metadata for choice column metadata.

Swagger operation ID: GetOptionSetMetadata_V2.

Parameters:

Name	Type	Description	Default
dataset	str	org name.	required
table	str	table name.	required
item	str	id.	required
type_	str	type of choice.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_table async

get_table(dataset: str, table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get table metadata

Gets table metadata

Swagger operation ID: GetTable_V2.

Parameters:

Name	Type	Description	Default
dataset	str	Select an Environment.	required
table	str	Select atable.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tables

list_tables(dataset: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

GetTables

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTables_V2.

Parameters:

Name	Type	Description	Default
dataset	str	dataset.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

patch_item async

patch_item(input: PatchItemInput | Mapping[str, Any], dataset: str, table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a row (legacy)

This operation updates an existing row for a table

Swagger operation ID: PatchItem_V2.

Parameters:

Name	Type	Description	Default
input	PatchItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
dataset	str	Select an Environment.	required
table	str	Select a table.	required
id	str	Identifier for the row.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

post_item async

post_item(input: PostItemInput | Mapping[str, Any], dataset: str, table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add a new row (legacy)

This operation adds a new row of a table

Swagger operation ID: PostItem_V2.

Parameters:

Name	Type	Description	Default
input	PostItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
dataset	str	Select an Environment.	required
table	str	Select a table.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.