Skip to content

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] = None, blob: Optional[BlobDataSetsMetadata] = 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] = field(default_factory=dict)

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

Item dataclass 

Item(dynamic_properties: Optional[Dict[str, Any]] = None)

Response for Associates one row to another on the provided relationship

ItemsList dataclass 

ItemsList(value: Optional[List[Item]] = 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]] = None

List of Items

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

The URL to retrieve the next page.

DataSetsList dataclass 

DataSetsList(value: Optional[List[DataSet]] = None)

Response for GetDataSets

Attributes

value class-attribute instance-attribute 
value: Optional[List[DataSet]] = None

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] = field(default_factory=dict)

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] = None, schema: Optional[ObjectEntity] = None, referenced_entities: Optional[ObjectEntity] = None, web_url: Optional[str] = None)

Response for Get table metadata - Patch

Attributes

name class-attribute instance-attribute 
name: Optional[str] = None

Table name

title class-attribute instance-attribute 
title: Optional[str] = None

Table title

x_ms_permission class-attribute instance-attribute 
x_ms_permission: Optional[str] = field(default=None, metadata={'wire_name': 'x-ms-permission'})

Table permission

web_url class-attribute instance-attribute 
web_url: Optional[str] = field(default=None, 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] = field(default_factory=dict)

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

TablesList dataclass 

TablesList(value: Optional[List[Table]] = None)

Response for GetTables

Attributes

value class-attribute instance-attribute 
value: Optional[List[Table]] = None

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = field(default_factory=dict)

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] = None

Dataset source

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Dataset display name

url_encoding class-attribute instance-attribute 
url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Dataset url encoding

table_display_name class-attribute instance-attribute 
table_display_name: Optional[str] = field(default=None, metadata={'wire_name': 'tableDisplayName'})

Table display name

table_plural_name class-attribute instance-attribute 
table_plural_name: Optional[str] = field(default=None, 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] = None

Blob dataset source

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Blob dataset display name

url_encoding class-attribute instance-attribute 
url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Blob dataset url encoding

TableCapabilitiesMetadata dataclass 

TableCapabilitiesMetadata(sort_restrictions: Optional[TableSortRestrictionsMetadata] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata] = 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] = field(default=None, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

filter_function_support class-attribute instance-attribute 
filter_function_support: Optional[List[str]] = field(default=None, metadata={'wire_name': 'filterFunctionSupport'})

List of supported filter capabilities

server_paging_options class-attribute instance-attribute 
server_paging_options: Optional[List[str]] = field(default=None, 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] = None

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute 
unsortable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'unsortableProperties'})

List of unsortable properties

ascending_only_properties class-attribute instance-attribute 
ascending_only_properties: Optional[List[str]] = field(default=None, 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] = None

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute 
non_filterable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'nonFilterableProperties'})

List of non filterable properties

required_properties class-attribute instance-attribute 
required_properties: Optional[List[str]] = field(default=None, 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] = None

Indicates whether this table has selectable columns

SubscriptionRequest dataclass 

SubscriptionRequest(notification_url: Optional[str] = None)

Definition: SubscriptionRequest

Attributes

notification_url class-attribute instance-attribute 
notification_url: Optional[str] = field(default=None, 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] = None

Id of the subscription

resource class-attribute instance-attribute 
resource: Optional[str] = None

Resource of the subscription request

notification_type class-attribute instance-attribute 
notification_type: Optional[str] = field(default=None, metadata={'wire_name': 'notificationType'})

Notification Type

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

Notification Url

UpdateTriggerSubscriptionRequest dataclass 

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

Definition: UpdateTriggerSubscriptionRequest

Attributes

attribute_filters class-attribute instance-attribute 
attribute_filters: Optional[List[str]] = field(default=None, metadata={'wire_name': 'AttributeFilters'})

Column filters

notification_url class-attribute instance-attribute 
notification_url: Optional[str] = field(default=None, 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]] = None)

Definition: DataSet

Attributes

name class-attribute instance-attribute 
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Dataset name

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Dataset display name

query class-attribute instance-attribute 
query: Optional[List[PassThroughNativeQuery]] = None

Pass-through Native Queries

Table dataclass 

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

Definition: Table

Attributes

name class-attribute instance-attribute 
name: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the table.

dynamic_properties class-attribute instance-attribute 
dynamic_properties: Optional[Dict[str, Any]] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'Name'})

Procedure name

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, 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] = field(default=None, metadata={'wire_name': 'Language'})

Query language

DisplayCollectionName dataclass 

DisplayCollectionName(user_localized_label: Optional[UserLocalizedLabel] = None)

Definition: DisplayCollectionName

Attributes

user_localized_label class-attribute instance-attribute 
user_localized_label: Optional[UserLocalizedLabel] = field(default=None, metadata={'wire_name': 'userLocalizedLabel'})

The user localized display name label object.

EntitiesDynamicValuesList dataclass 

EntitiesDynamicValuesList(value: Optional[List[EntitiesDynamicValuesListItem]] = None)

Definition: EntitiesDynamicValuesList

Attributes

value class-attribute instance-attribute 
value: Optional[List[EntitiesDynamicValuesListItem]] = None

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] = None)

Definition: EntitiesDynamicValuesListItem

Attributes

metadata_id class-attribute instance-attribute 
metadata_id: Optional[str] = field(default=None, metadata={'wire_name': 'metadataId'})

The metadata id.

entity_set_name class-attribute instance-attribute 
entity_set_name: Optional[str] = field(default=None, metadata={'wire_name': 'entitySetName'})

The name of the table.

logical_name class-attribute instance-attribute 
logical_name: Optional[str] = field(default=None, metadata={'wire_name': 'logicalName'})

The logical name of the table.

display_collection_name class-attribute instance-attribute 
display_collection_name: Optional[DisplayCollectionName] = field(default=None, metadata={'wire_name': 'displayCollectionName'})

The display name of the table.

OrganizationsDynamicValuesList dataclass 

OrganizationsDynamicValuesList(value: Optional[List[OrganizationsDynamicValuesListItem]] = None)

Definition: OrganizationsDynamicValuesList

Attributes

value class-attribute instance-attribute 
value: Optional[List[OrganizationsDynamicValuesListItem]] = None

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] = field(default=None, metadata={'wire_name': 'Id'})

The organization id.

friendly_name class-attribute instance-attribute 
friendly_name: Optional[str] = field(default=None, metadata={'wire_name': 'FriendlyName'})

The name of the organization.

url class-attribute instance-attribute 
url: Optional[str] = field(default=None, metadata={'wire_name': 'Url'})

The URL of the organization.

EntityMetadata dataclass 

EntityMetadata(schema: Optional[ObjectEntity] = None)

Definition: EntityMetadata

Attributes

schema class-attribute instance-attribute 
schema: Optional[ObjectEntity] = None

Swagger schema

EntityItemList dataclass 

EntityItemList(value: Optional[List[EntityItem]] = None, next_link: Optional[str] = None)

Definition: EntityItemList

Attributes

value class-attribute instance-attribute 
value: Optional[List[EntityItem]] = None

List of Items

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

The url to fetch next page data.

EntityItem dataclass 

EntityItem(dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: EntityItem

CallbackRegistration dataclass 

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

Definition: CallbackRegistration

Attributes

version class-attribute instance-attribute 
version: Optional[int] = None

The callback registration table version

url class-attribute instance-attribute 
url: Optional[str] = None

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

name class-attribute instance-attribute 
name: Optional[str] = None

Callback registration name. Value will be replaced with workflow id

entityname class-attribute instance-attribute 
entityname: Optional[str] = None

Choose a table

message class-attribute instance-attribute 
message: Optional[int] = None

Choose when the flow triggers

sdkmessagename class-attribute instance-attribute 
sdkmessagename: Optional[str] = None

Choose an option or add your own

scope class-attribute instance-attribute 
scope: Optional[int] = None

Choose a scope to limit which rows can trigger the flow

filteringattributes class-attribute instance-attribute 
filteringattributes: Optional[str] = None

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] = None

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

postponeuntil class-attribute instance-attribute 
postponeuntil: Optional[str] = None

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

runas class-attribute instance-attribute 
runas: Optional[int] = None

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] = None

The display name label of the table.

WebhookNotificationContent dataclass 

WebhookNotificationContent(schema: Optional[ObjectEntity] = None)

Definition: WebhookNotificationContent

Attributes

schema class-attribute instance-attribute 
schema: Optional[ObjectEntity] = None

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]]] = None

List of table relationships as dynamic values.

AssociateEntityRequest dataclass 

AssociateEntityRequest(id: Optional[str] = None)

Definition: AssociateEntityRequest

Attributes

id class-attribute instance-attribute 
id: Optional[str] = field(default=None, 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]]] = None

List of actions as dynamic values

SearchRequestBody dataclass 

SearchRequestBody(search: Optional[str] = None, 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 class-attribute instance-attribute 
search: Optional[str] = None

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] = None

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

searchmode class-attribute instance-attribute 
searchmode: Optional[str] = None

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

top class-attribute instance-attribute 
top: Optional[int] = None

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

filter class-attribute instance-attribute 
filter: Optional[str] = None

Enter an OData style filter expression to narrow the search

entities class-attribute instance-attribute 
entities: Optional[List[str]] = None

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

orderby class-attribute instance-attribute 
orderby: Optional[List[str]] = None

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

facets class-attribute instance-attribute 
facets: Optional[List[str]] = None

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

skip class-attribute instance-attribute 
skip: Optional[int] = None

Enter the number of search results to be skipped

returntotalrecordcount class-attribute instance-attribute 
returntotalrecordcount: Optional[bool] = None

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]]] = None

List of rows

totalrecordcount class-attribute instance-attribute 
totalrecordcount: Optional[int] = None

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

facets class-attribute instance-attribute 
facets: Optional[Dict[str, Any]] = None

Facet results

WhenAnActionIsPerformedSubscriptionRequest dataclass 

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

Definition: WhenAnActionIsPerformedSubscriptionRequest

Attributes

version class-attribute instance-attribute 
version: Optional[int] = None

The callback registration table version.

url class-attribute instance-attribute 
url: Optional[str] = None

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

name class-attribute instance-attribute 
name: Optional[str] = None

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

scope class-attribute instance-attribute 
scope: Optional[int] = None

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

entityname class-attribute instance-attribute 
entityname: Optional[str] = None

Choose a table to filter actions.

sdkmessagename class-attribute instance-attribute 
sdkmessagename: Optional[str] = None

Choose an action.

WebhookNotificationContentForWhenAnActionIsPerformed dataclass 

WebhookNotificationContentForWhenAnActionIsPerformed(schema: Optional[ObjectEntity] = None)

Definition: WebhookNotificationContentForWhenAnActionIsPerformed

Attributes

schema class-attribute instance-attribute 
schema: Optional[ObjectEntity] = None

Swagger schema

CommondataserviceClient 

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

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
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

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

GetDataSetsMetadata

get_next_page_async async 
get_next_page_async(next_link: str) -> dict[str, Any] | None

Follows nextLink to retrieve next page of data

This operation gets the next page of data.

associate_records_patch_item_async async 
associate_records_patch_item_async(input: AssociateRecordsPatchItemInput, dataset: str, table: str, id: str, relationship: str) -> dict[str, Any] | None

Associates one row to another on the provided relationship

Associates one row to another on the provided relationship

create_attachment_async async 
create_attachment_async(input: bytes, dataset: str, table: str, id: str, display_name: str) -> dict[str, Any] | None

Creates Note (annotation) for specified table row

Creates Note (annotation) for specified table row.

delete_attachment_async async 
delete_attachment_async(dataset: str, table: str, id: str, attachment_id: str) -> None

Deletes specified attachment on the Note (annotation)

Deletes specified attachment on the Note (annotation).

delete_item_async async 
delete_item_async(dataset: str, table: str, id: str) -> None

Delete a row (legacy)

This operation deletes a row from a table collection

disassociate_records_post_item_async async 
disassociate_records_post_item_async(dataset: str, table: str, id: str, relationship: str, related_id: str) -> dict[str, Any] | None

Disassociates a row from a multi-valued relationship

Disassociates a row from a multi-valued relationship

disassociate_single_value_record_delete_item_async async 
disassociate_single_value_record_delete_item_async(dataset: str, table: str, id: str, relationship: str) -> dict[str, Any] | None

Disassociates a row from a single-valued relationship

Disassociates a row from a single-valued relationship

get_attachment_content_async async 
get_attachment_content_async(dataset: str, table: str, id: str, attachment_id: str) -> bytes

Retrieves file content for specified Note (annotation)

Retrieves file content for specified Note (annotation).

get_collection_relationships_async async 
get_collection_relationships_async(dataset: str, table: str, id: str, collection_type: str, relationship: str, target: str) -> dict[str, Any] | None

Retrieves all collection valued relationship items as an expand would

Retrieves all collection valued relationship items as an expand would

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

GetDataSets

get_item_async async 
get_item_async(dataset: str, table: str, id: str) -> dict[str, Any] | None

Get row (legacy)

This operation retrieves the specified row for a table

get_item_attachments_async async 
get_item_attachments_async(dataset: str, table: str, id: str) -> dict[str, Any] | None

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

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

get_items_async async 
get_items_async(dataset: str, table: str, apply: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, expand: Optional[str] = None) -> AsyncIterator[dict[str, Any]]

List rows (legacy)

This operation gets rows for a table

Yields items from every response page and automatically follows the connector continuation URL.

get_metadata_for_patch_item_async async 
get_metadata_for_patch_item_async(dataset: str, table: str) -> dict[str, Any] | None

Get table metadata - Patch

Gets table metadata for patch operation

get_metadata_for_post_item_async async 
get_metadata_for_post_item_async(dataset: str, table: str) -> dict[str, Any] | None

Get table metadata - Post

Gets table metadata for post operation

get_multi_select_metadata_async async 
get_multi_select_metadata_async(dataset: str, table: str, item: str) -> dict[str, Any] | None

Retrieves the metadata for multi select column metadata

Retrieves the metadata for multi select column metadata.

get_option_set_metadata_async async 
get_option_set_metadata_async(dataset: str, table: str, item: str, type_: str) -> dict[str, Any] | None

Retrieves the metadata for choice column metadata

Retrieves the metadata for choice column metadata.

get_table_async async 
get_table_async(dataset: str, table: str) -> dict[str, Any] | None

Get table metadata

Gets table metadata

get_tables_async async 
get_tables_async(dataset: str) -> dict[str, Any] | None

GetTables

patch_item_async async 
patch_item_async(input: PatchItemInput, dataset: str, table: str, id: str) -> dict[str, Any] | None

Update a row (legacy)

This operation updates an existing row for a table

post_item_async async 
post_item_async(input: PostItemInput, dataset: str, table: str) -> dict[str, Any] | None

Add a new row (legacy)

This operation adds a new row of a table