Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

Microsoft Dynamics 365 Connector Reference

Configurations


Dynamics 365

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

Connection Types

Connection

Name Type Description Default Value Required

Scope

String

openid

Resource

String

x

Response Type

String

query

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Host

String

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

Port

Number

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

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Consumer Key

String

The OAuth consumerKey as registered with the service provider

x

Consumer Secret

String

The OAuth consumerSecret as registered with the service provider

x

Authorization Url

String

The service provider’s authorization endpoint URL

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

Access Token Url

String

The service provider’s accessToken endpoint URL

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

Scopes

String

The OAuth scopes to be requested during the dance. If not provided, it will default to those in the annotation

Resource Owner Id

String

The resourceOwnerId which each component should use if it doesn’t reference otherwise.

Before

String

The name of a flow to be executed right before starting the OAuth dance

After

String

The name of a flow to be executed right after an accessToken has been received

Listener Config

String

A reference to a <http:listener-config /> to be used in order to create the listener that will catch the access token callback endpoint.

x

Callback Path

String

The path of the access token callback endpoint

x

Authorize Path

String

The path of the local HTTP endpoint which triggers the OAuth dance

x

External Callback Url

String

If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback

Object Store

String

A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one.

OAuth Username Password

Name Type Description Default Value Required

Username

String

Username used to initialize the session

x

Password

String

Password used to authenticate the user

x

Resource

String

The App ID URI of the web API (secured resource).

x

Client Id

String

The Application Id assigned to your app when you registered it with Azure AD. You can find this in the Azure Portal. Click Active Directory, click the directory, choose the application, and click Configure.

x

Client Secret

String

The Application Secret that you created in the app registration portal for your app. It should 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 have the ability to store the client_secret securely on the server side.

x

Token Request Endpoint

String

x

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Host

String

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

Port

Number

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

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Operations

Create

<dynamics:create>

Creates a new Entity:

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Logical Name

String

The logical name of the entity. It is always the Schema Name in lower case.

x

Attributes

Object

The attributes of the entity to be created as a Map.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

  • DYNAMICS:CONNECTIVITY

Create Multiple

<dynamics:create-multiple>

Creates Multiple Entities:

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Logical Name

String

The logical name of the entities to be created. It is always the Schema Name in lower case.

x

Entities Attributes

Array of Object

A list with the attributes of the entities to be created as a List of Maps.

#[payload]

Use Single Transaction

Boolean

Use a single transaction for creation. If one entity fails to be created the transaction is rolled-back.

false

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

  • DYNAMICS:CONNECTIVITY

Delete

<dynamics:delete>

Delete an Entity:

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Logical Name

String

The logical name of the entity. It is always the Schema Name in lower case.

x

Id

String

The id of the entity that is going to be deleted

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

  • DYNAMICS:CONNECTIVITY

Delete Multiple

<dynamics:delete-multiple>

Delete Multiple Entities:

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Logical Name

String

The logical name of the entity. It is always the Schema Name in lower case.

x

Ids

Array of String

The list of ids that are going to be deleted.

#[payload]

Use Single Transaction

Boolean

Use a single transaction for deletion. If one entity fails to be deleted the transaction is rolled-back.

true

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

  • DYNAMICS:CONNECTIVITY

Disassociate

<dynamics:disassociate>

Removes a reference to an entity.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Logical Name

String

The logical name of the entity. It is always the Schema Name in lower case.

x

Attributes

Object

disasociate request’s payload

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

  • DYNAMICS:CONNECTIVITY

Do Action

<dynamics:do-action>

Call Action:

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Action Name

String

The action name that is going to be called

x

Bounded Entity Type

String

An optional bounded entity type. It must be provided if the action is bounded.

Bounded Entity Id

String

An optional bounded entity id. It must be provided if the action is bounded.

Related Entities

Object

This is the body that will be send in the request as a Map.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

For Configurations

Throws

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

  • DYNAMICS:CONNECTIVITY

Invoke

<dynamics:invoke>

Generic Simple Invoke.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Uri

String

The URI that is going to be invoked.

x

Http Method

Enumeration, one of:

  • GET

  • POST

  • PUT

  • PATCH

  • DELETE

The HTTP Method that is going to be invoked.

x

Headers

Object

The HTTP headers used in the request. There are some default headers that are used; read more in the documentation.

Body

String

The string that will be placed in the body of the request.

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

For Configurations

Throws

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

  • DYNAMICS:CONNECTIVITY

Retrieve

<dynamics:retrieve>

Retrieve an Entity:

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Logical Name

String

The logical name of the entity. It is always the Schema Name in lower case.

x

Id

String

The id of the entity that is going to be retrieved.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

For Configurations

Throws

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

  • DYNAMICS:CONNECTIVITY

Retrieve Multiple

<dynamics:retrieve-multiple>

Retrieve Multiple by URL:

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Data Query URL

String

The URL that is going to be used for retrieve.

x

Page Size

Number

The size of a page

5000

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Retrieve Multiple By Query

<dynamics:retrieve-multiple-by-query>

Retrieve Multiple by DSQL Query:

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Datasense Query

String

The DSQL query that is going to be used for retrieve. The query will be transformed in a retrieve URL internally.

x

Page Size

Number

Number of items in a results page

5000

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

Unauthorize

<dynamics:unauthorize>

Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without doing the authorization dance again.

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The ID of the resource owner which access should be invalidated

For Configurations

Update

<dynamics:update>

Update:

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Logical Name

String

The logical name of the entity. It is always the Schema Name in lower case.

x

Attributes

Object

The attributes of the entity.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

  • DYNAMICS:CONNECTIVITY

Update Multiple

<dynamics:update-multiple>

Update Multiple Entities:

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Logical Name

String

The logical name of the entity. It is always the Schema Name in lower case.

x

Entities Attributes

Array of Object

A list with the attributes of the entities that are going to be updated as a List of Maps.

#[payload]

Use Single Transaction

Boolean

Use a single transaction for update. If one entity fails to be updated the transaction is rolled-back.

false

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • DYNAMICS:RETRY_EXHAUSTED

  • DYNAMICS:CONNECTIVITY

  • DYNAMICS:UNKNOWN

  • DYNAMICS:CONNECTIVITY

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Bulk Operation Result

Field Type Description Default Value Required

Id

Any

Items

Array of Bulk Item

Successful

Boolean

Bulk Item

Field Type Description Default Value Required

Exception

Any

Id

Any

Message

String

Payload

Object

Status Code

String

Successful

Boolean

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed