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

ExecuteProcedureInput dataclass

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

Execute action

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

AxOnlineProcedureResult dataclass

AxOnlineProcedureResult(*, value: Optional[str] = None, output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)

Response for Execute action

Attributes

value class-attribute instance-attribute

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

Output parameter values

output_parameters class-attribute instance-attribute

output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OutputParameters'})

Output parameter values

ItemsList dataclass

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

Response for Lists items present in table

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.

PostItemInput dataclass

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

Create record

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

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

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] = dataclass_field(default_factory=dict, kw_only=True)

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

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

Attributes

value class-attribute instance-attribute

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

List of Tables

DataSetsList dataclass

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

Response for Get instances

Attributes

value class-attribute instance-attribute

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

List of datasets

TriggerFieldDataList dataclass

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

Response for Gets business events categories

Attributes

value class-attribute instance-attribute

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

List of business event categories

BusinessEventsList dataclass

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

Response for Gets business events

Attributes

value class-attribute instance-attribute

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

List of business events

ProceduresList dataclass

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

Response for Get actions

Attributes

value class-attribute instance-attribute

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

List of Procedures

ProcedureMetadata dataclass

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

Response for Get actions metadata

Attributes

name class-attribute instance-attribute

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

Procedure name

title class-attribute instance-attribute

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

Procedure title

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

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

Definition: Object

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

DataSetsMetadata dataclass

DataSetsMetadata(*, tabular: Optional[TabularDataSetsMetadata | Mapping[str, Any]] = None, blob: Optional[BlobDataSetsMetadata | Mapping[str, Any]] = 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] = 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

BusinessEventSubscription dataclass

BusinessEventSubscription(notification_url: str)

Definition: BusinessEventSubscription

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.

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

Business event Id

name class-attribute instance-attribute

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

Business event data name

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

Business event data name

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = 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

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, ObjectEntity | Mapping[str, Any]]] = 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, ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Language'})

Query language

Item dataclass

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

Definition: Item

ExportableItemsList dataclass

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

Definition: ExportableItemsList

Attributes

value class-attribute instance-attribute

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

List of Items.

ExportableItem dataclass

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

Definition: ExportableItem

DynamicsaxClient

DynamicsaxClient(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 dynamicsax connector.

Initialize a DynamicsaxClient.

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:

execute_procedure async

execute_procedure(input: ExecuteProcedureInput | Mapping[str, Any], dataset: str, procedure: 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

Execute action

Execute action

Swagger operation ID: ExecuteProcedure.

Parameters:

Name	Type	Description	Default
input	ExecuteProcedureInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
dataset	str	The Dynamics 365 for Fin & Ops instance.	required
procedure	str	Name of action.	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_items

list_items(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, 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]]

Lists items present in table

Lists items present in table

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

Swagger operation ID: GetItems.

Parameters:

Name	Type	Description	Default
dataset	str	The Dynamics 365 for Fin & Ops instance.	required
table	str	Entity name.	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
skip	Optional[int]	The number of entries to skip (default = 0).	None
select	Optional[str]	Specific fields to retrieve from entries (default = all).	None
cross_company	Optional[bool]	Query across companies (default = no).	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.

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

Create record

Create a new record in an entity

Swagger operation ID: PostItem.

Parameters:

Name	Type	Description	Default
input	PostItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
dataset	str	The Dynamics 365 for Fin & Ops instance.	required
table	str	Entity name.	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_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 a record

Retrieves a single record

Swagger operation ID: GetItem.

Parameters:

Name	Type	Description	Default
dataset	str	The Dynamics 365 for Fin & Ops instance.	required
table	str	Entity name.	required
id	str	Unique identifier of the object to retrieve.	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_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 record

Deletes a single record in an entity

Swagger operation ID: DeleteItem.

Parameters:

Name	Type	Description	Default
dataset	str	The Dynamics 365 for Fin & Ops instance.	required
table	str	Entity name.	required
id	str	Unique identifier of the object to delete.	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.

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 record

Updates a single record in an entity

Swagger operation ID: PatchItem.

Parameters:

Name	Type	Description	Default
input	PatchItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
dataset	str	The Dynamics 365 for Fin & Ops instance.	required
table	str	Entity name.	required
id	str	Unique identifier of the object to update.	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]]

Get list of entities

Retrieves a list of entities

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTables.

Parameters:

Name	Type	Description	Default
dataset	str	The Dynamics 365 for Fin & Ops instance.	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]]

Get instances

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

Returns a single-page Azure Core async collection.

Swagger operation ID: GetDataSets.

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.

list_business_event_categories

list_business_event_categories(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]]

Gets business events categories

Gets business events categories.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetBusinessEventCategories.

Parameters:

Name	Type	Description	Default
dataset	str	Data set.	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_business_events

list_business_events(dataset: str, businesseventcategory: 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]]

Gets business events

Gets business events.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetBusinessEvents.

Parameters:

Name	Type	Description	Default
dataset	str	Data set.	required
businesseventcategory	str	Business event category.	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_legal_entities

list_legal_entities(dataset: str, businesseventcategory: str, businessevent: 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]]

Gets legal entities

Gets legal entities.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetLegalEntities.

Parameters:

Name	Type	Description	Default
dataset	str	Data set.	required
businesseventcategory	str	Business event category.	required
businessevent	str	Business event.	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_procedures

list_procedures(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]]

Get actions

Get actions

Returns a single-page Azure Core async collection.

Swagger operation ID: GetProcedures.

Parameters:

Name	Type	Description	Default
dataset	str	The Dynamics 365 for Fin & Ops instance.	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.

get_procedure async

get_procedure(dataset: str, procedure: 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 actions metadata

Get actions metadata.

Swagger operation ID: GetProcedure.

Parameters:

Name	Type	Description	Default
dataset	str	The Dynamics 365 for Fin & Ops instance.	required
procedure	str	Name of action.	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 entity metadata

Retrieves metadata for an entity

Swagger operation ID: GetTable.

Parameters:

Name	Type	Description	Default
dataset	str	The Dynamics 365 for Fin & Ops instance.	required
table	str	Entity name.	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.