DynamicsaxClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'SubscribeOnABusinessEvent': {'operation_id': 'SubscribeOnABusinessEvent', 'path': '/{connectionId}/datasets/{dataset}/subscribebusinessevent/{businessevent}', 'method': 'post', 'required_parameters': ['dataset', 'businesseventcategory', 'businessevent'], 'callback_payload_type': 'BusinessEventSubscriptionResponse'}}

Classes

BusinessEventSubscriptionResponse dataclass

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

Response for When a Business Event occurs

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

ExecuteProcedureInput dataclass

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

Execute action

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

AxOnlineProcedureResult dataclass

AxOnlineProcedureResult(value: Optional[str] = None, output_parameters: Optional[Dict[str, Any]] = None)

Response for Execute action

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Output parameter values

output_parameters class-attribute instance-attribute

output_parameters: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'OutputParameters'})

Output parameter values

ItemsList dataclass

ItemsList(value: Optional[List[Item]] = None)

Response for Lists items present in table

Attributes

value class-attribute instance-attribute

value: Optional[List[Item]] = None

List of Items

PostItemInput dataclass

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

Create record

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 Create record

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

GetItemResponse dataclass

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

Response for Get a record

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

PatchItemInput dataclass

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

Update a record

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 record

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 Get list of entities

Attributes

value class-attribute instance-attribute

value: Optional[List[Table]] = None

List of Tables

DataSetsList dataclass

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

Response for Get instances

Attributes

value class-attribute instance-attribute

value: Optional[List[DataSet]] = None

List of datasets

TriggerFieldDataList dataclass

TriggerFieldDataList(value: Optional[List[TriggerFieldData]] = None)

Response for Gets business events categories

Attributes

value class-attribute instance-attribute

value: Optional[List[TriggerFieldData]] = None

List of business event categories

BusinessEventsList dataclass

BusinessEventsList(value: Optional[List[BusinessEventData]] = None)

Response for Gets business events

Attributes

value class-attribute instance-attribute

value: Optional[List[BusinessEventData]] = None

List of business events

ProceduresList dataclass

ProceduresList(value: Optional[List[Procedure]] = None)

Response for Get actions

Attributes

value class-attribute instance-attribute

value: Optional[List[Procedure]] = None

List of Procedures

ProcedureMetadata dataclass

ProcedureMetadata(name: Optional[str] = None, title: Optional[str] = None, schema: Optional[ObjectEntity] = None)

Response for Get actions metadata

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Procedure name

title class-attribute instance-attribute

title: Optional[str] = None

Procedure title

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 entity metadata

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())

Definition: Object

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

DataSetsMetadata dataclass

DataSetsMetadata(tabular: Optional[TabularDataSetsMetadata] = None, blob: Optional[BlobDataSetsMetadata] = None)

Definition: DataSetsMetadata

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

BusinessEventSubscription dataclass

BusinessEventSubscription(notification_url: Optional[str] = None)

Definition: BusinessEventSubscription

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.

BusinessEventData dataclass

BusinessEventData(id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None)

Definition: BusinessEventData

Attributes

id class-attribute instance-attribute

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

Business event Id

name class-attribute instance-attribute

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

Business event data name

display_name class-attribute instance-attribute

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

Business event data display name

TriggerFieldData dataclass

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

Definition: TriggerFieldData

Attributes

name class-attribute instance-attribute

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

Business event data name

display_name class-attribute instance-attribute

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

Business event data display name

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

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.

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

Item dataclass

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

Definition: Item

ExportableItemsList dataclass

ExportableItemsList(value: Optional[List[ExportableItem]] = None)

Definition: ExportableItemsList

Attributes

value class-attribute instance-attribute

value: Optional[List[ExportableItem]] = None

List of Items.

ExportableItem dataclass

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

Definition: ExportableItem

DynamicsaxClient

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

Bases: ConnectorClientBase

Typed client for dynamicsax connector.

Initialize a DynamicsaxClient.

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:

execute_procedure_async async

execute_procedure_async(input: ExecuteProcedureInput, dataset: str, procedure: str) -> dict[str, Any] | None

Execute action

Execute action

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, skip: Optional[int] = None, select: Optional[str] = None, cross_company: Optional[bool] = None) -> dict[str, Any] | None

Lists items present in table

Lists items present in table

post_item_async async

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

Create record

Create a new record in an entity

get_item_async async

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

Get a record

Retrieves a single record

delete_item_async async

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

Delete record

Deletes a single record in an entity

patch_item_async async

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

Update a record

Updates a single record in an entity

get_tables_async async

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

Get list of entities

Retrieves a list of entities

get_data_sets_async async

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

Get instances

Retrieves a list of accessable Dynamics 365 for Fin & Ops instances

get_business_event_categories_async async

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

Gets business events categories

Gets business events categories.

get_business_events_async async

get_business_events_async(dataset: str, businesseventcategory: str) -> dict[str, Any] | None

Gets business events

Gets business events.

get_legal_entities_async async

get_legal_entities_async(dataset: str, businesseventcategory: str, businessevent: str) -> dict[str, Any] | None

Gets legal entities

Gets legal entities.

get_procedures_async async

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

Get actions

Get actions

get_procedure_async async

get_procedure_async(dataset: str, procedure: str) -> dict[str, Any] | None

Get actions metadata

Get actions metadata.

get_table_async async

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

Get entity metadata

Retrieves metadata for an entity