Microsoft Dynamics 365 Connector 2.6 Reference - Mule 4

String

Version number of the API to connect to.

9.0

String

Do not use this parameter. This parameter cannot be used for the authentication request. The authentication fails if both the Scope and Scopes parameters are used, since they both provide the same functionality. This parameter will be removed in a future version.

openid

String

Endpoint URL.

x

String

Response type must be query.

query

Number

How long the consumer waits for a response before it times out, in milliseconds. Default value is 0, which means infinite.

0

Number

How long the connector waits before timing out when establishing a connection to the remote service. Default value is 0, which means infinite.

0

String

Hostname of the proxy. If this property is not set, then no proxy is used; otherwise, a proxy is used, but a proxy host must be specified.

Number

Port of the proxy. If Host is set, then this property must be set and cannot be a negative number.

String

Username used to authenticate against the proxy. If this property is not set, then authentication is not applied to the proxy.

String

Password used to authenticate against the proxy.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

OAuth consumer key, as registered with the service provider.

x

String

OAuth consumer secret, as registered with the service provider.

x

String

URL of the service provider’s authorization endpoint.

https://login.microsoftonline.com/oauth2/authorize

String

URL of the service provider’s access token endpoint.

https://login.microsoftonline.com/oauth2/token

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

String

Resource owner ID to use if the component does not have another reference.

String

Name of the flow to execute immediately before starting the OAuth dance.

String

Name of the flow to execute immediately after receiving an access token.

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

String

Path of the access token callback endpoint.

x

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

String

Version number of the API to connect to.

9.0

String

Location where to send the requests.

x

Number

How long the consumer waits for a response before it times out, in milliseconds. Default value is 0, which means infinite.

0

Number

How long the connector waits before timing out when establishing a connection to the remote service. Default value is 0, which means infinite.

0

String

Hostname of the proxy. If this property is not set, then no proxy is used; otherwise, a proxy is used, but a proxy host must be specified.

Number

Port of the proxy. If Host is set, then this property must be set and cannot be a negative number.

String

Username used to authenticate against the proxy. If this property is not set, then authentication is not applied to the proxy.

String

Password used to authenticate against the proxy.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

OAuth client ID, as registered with the service provider.

x

String

OAuth client secret, as registered with the service provider.

x

String

The service provider’s token endpoint URL.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

String

Version number of the API to connect to.

9.0

Number

How long the consumer waits for a response before it times out, in milliseconds. Default value is 0, which means infinite.

0

Number

How long the connector waits before timing out when establishing a connection to the remote service. Default value is 0, which means infinite.

0

String

Hostname of the proxy. If this property is not set, then no proxy is used; otherwise, a proxy is used, but a proxy host must be specified.

Number

Port of the proxy. If Host is set, then this property must be set and cannot be a negative number.

String

Username used to authenticate against the proxy. If this property is not set, then authentication is not applied to the proxy.

String

Password used to authenticate against the proxy.

String

Username used to initialize the session.

x

String

Password used to authenticate the user.

x

String

Application ID URI of the web API (secured resource).

x

String

Application ID assigned to your application when you register the application with Azure AD. You can find this Client Id in the Azure Portal. Click Active Directory, select the directory, choose the application, and click Configure.

x

String

Application secret that you create in the application registration portal for your application. This Client Secret must not be used in a native app, because client secrets cannot be reliably stored on devices. It is required for web apps and web APIs, which store the client secret securely on the server side.

x

String

Token request endpoint.

x

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

Name of the configuration to use.

x

String

Describes business data. Example values are account and contact, which are defined in the Microsoft Dynamics 365 instance.

x

ConfigurationProvider

Name of the configuration used to execute this component.

x

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Required date format is 'yyyy-MM-dd’T’HH:mm:ss’Z'.

String

Describes business data. Example values are account and contact, which are defined in the Microsoft Dynamics 365 instance.

x

ConfigurationProvider

Name of the configuration used to execute this component.

x

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Required date format is 'yyyy-MM-dd’T’HH:mm:ss’Z'.

String

Describes business data. Example values are account and contact, which are defined in the Microsoft Dynamics 365 instance.

x

ConfigurationProvider

Name of the configuration used to execute this component.

x

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Logical name of the entity. It is always the schema name in lower case.

x

Object

Attributes of the entity to create as a map.

#[payload]

Body encoding.

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Logical name of the entity. It is always the schema name in lower case.

x

Array of Object

List of the entities' attributes to create as a list of maps.

#[payload]

Boolean

Use a single transaction for creation. If the entity creation fails, the transaction is rolled back.

false

Boolean

Continue in case of error. The default value of false stops creating records after one create fails.

You can use Continue On Error in conjunction with Use Single Transaction. Suppose you want to execute an operation with a payload of 10 records. This payload contains one broken record, number 5, that fails. The other 9 records succeed. The following table shows the output, which depends on the values of Continue On Error and Use Single Transaction:

false

Body encoding.

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Logical name of the entity. It is always the schema name in lower case.

x

String

ID of the entity to delete.

#[payload]

ConfigurationProvider

Name of the configuration used to execute this component.

x

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Logical name of the entity. It is always the schema name in lower case.

x

Array of String

List of IDs to delete.

#[payload]

Boolean

Use a single transaction for deletion. If the deletion fails, the transaction is rolled back.

true

Boolean

Continue in case of error. The default value of false stops deleting records after one delete fails.

You can use Continue On Error in conjunction with Use Single Transaction. Suppose you want to execute an operation with a payload of 10 records. This payload contains one broken record, number 5, that fails. The other 9 records succeed. The following table shows the output, which depends on the values of Continue On Error and Use Single Transaction:

false

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Logical name of the entity. It is always the schema name in lower case.

x

Object

Disassociates a request’s payload.

#[payload]

ConfigurationProvider

Name of the configuration used to execute this component.

x

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Action name to call.

x

String

Optional bounded entity type. You must provide this value if the action is bounded.

String

Optional bounded entity ID. You must provide this value if the action is bounded.

Object

Body to send in the request as a map.

#[payload]

Body encoding.

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

URI to invoke.

x

Enumeration, one of:

HTTP method to invoke.

x

Object

HTTP headers used in the request.

String

String placed in the body of the request.

Body encoding.

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Logical name of the entity. It is always the schema name in lower case.

x

String

ID of the entity to retrieve.

#[payload]

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

URL to use for data retrieval.

x

Number

Number of items in a results page.

5000

ConfigurationProvider

Name of the configuration used to execute this component.

x

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

DSQL query used to retrieve. The query is transformed in a retrieve URL internally.

x

Number

Number of items in a results page.

5000

String

Information about the specified relationship to include in the response.

ConfigurationProvider

Name of the configuration used to execute this component.

x

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

ID of the resource owner for whom to invalidate access.

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Name of the configuration to use.

x

String

Logical name of the entity. It is always the schema name in lower case.

x

Object

Attributes of the entity.

#[payload]

Body encoding.

ConfigurationProvider

Name of the configuration used to execute this component.

x

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Logical name of the entity. It is always the schema name in lower case.

x

Array of Object

List of the entities' attributes to create as a list of maps.

#[payload]

Boolean

Use a single transaction for an update. If the update fails, the transaction is rolled back.

false

Boolean

Continue in case of error. The default value of false stops updating records after one update fails.

You can use Continue On Error in conjunction with Use Single Transaction. Suppose you want to execute an operation with a payload of 10 records. This payload contains one broken record, number 5, that fails. The other 9 records succeed. The following table shows the output, which depends on the values of Continue On Error and Use Single Transaction:

false

Body encoding.

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

Any

Exception if the item fails.

Any

Item ID.

String

Message to add context to this item, such as an error description, a warning, or information related to the operation.

Object

Actual data the entity represents.

String

Optional status code.

Boolean

Whether or not the request is successful.

Any

Operation ID.

Array of Bulk Item

Ordered list of bulk items.

Boolean

Whether or not the operation is successful. Must be true if and only if all the child DynamicsBulkItem entities are also successful.

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Enumeration, one of:

Time unit for the Max Idle Time field.

Number

How often to attempt to reconnect, in milliseconds.

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Number

How many reconnection attempts the Mule app can make.

Number

How often to attempt to reconnect, in milliseconds.

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

Reconnection strategy to use.

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

String

One or more expressions that determine if a message is redelivered. This property can be set only if the Use Secure Hash field is false.

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Enumeration, one of:

Unit for the Max In Memory Size field.

Number

Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower means that the buffer must not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.