Microsoft Dynamics 365 Connector 2.6 Reference | MuleSoft Documentation
# Microsoft Dynamics 365 Connector 2.6 Reference
Anypoint Connector for Microsoft Dynamics 365 (Microsoft Dynamics 365 Connector) enables integration with the Microsoft Dynamics 365 Cloud API.
## Configuration
Default Configuration for Microsoft Dynamics 365 Connector.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Name for this configuration. Connectors reference the configuration with this name.  
**Connection** | 
  *   * OAuth Client Credentials
  * OAuth Username Password

|  Connection types for this configuration.  
Body encoding.
  * If no value is specified, set the Mule default encoding.
  * If a value is specified, set the `-M-Dmule.encoding` VM argument to the same value to avoid an encoding mismatch.

  
ID used to reference this configuration.  
**Expiration Policy** |  Expiration Policy |  Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.  
### Connection (OAuth 2.0) Connection Type
Connects to servers that manage authorization and token access.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Version number of the API to connect to.  
**(Deprecated) Scope** |  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.  
Endpoint URL.  
**Response Type** |  Response type must be `query`.  
**Read Timeout** |  How long the consumer waits for a response before it times out, in milliseconds. Default value is `0`, which means infinite.  
**Connection Timeout** |  How long the connector waits before timing out when establishing a connection to the remote service. Default value is `0`, which means infinite.  
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.  
Port of the proxy. If **Host** is set, then this property must be set and cannot be a negative number.  
Username used to authenticate against the proxy. If this property is not set, then authentication is not applied to the proxy.  
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.  
**Consumer Key** |  OAuth consumer key, as registered with the service provider.  
**Consumer Secret** |  OAuth consumer secret, as registered with the service provider.  
**Authorization Url** |  URL of the service provider’s authorization endpoint. |  `https://login.microsoftonline.com/oauth2/authorize`  
**Access Token Url** |  URL of the service provider’s access token endpoint. |  `https://login.microsoftonline.com/oauth2/token`  
OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.  
**Resource Owner Id** |  Resource owner ID to use if the component does not have another reference.  
Name of the flow to execute immediately before starting the OAuth dance.  
Name of the flow to execute immediately after receiving an access token.  
**Listener Config** |  Configuration for the HTTP listener that listens for requests on the access token callback endpoint.  
**Callback Path** |  Path of the access token callback endpoint.  
**Authorize Path** |  Path of the local HTTP endpoint that triggers the OAuth dance.  
**External Callback Url** |  URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.  
**Object Store** |  Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.  
### OAuth Client Credentials Connection Type
Uses a client ID and a client secret to authenticate the connection to the server.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Version number of the API to connect to.  
Location where to send the requests.  
**Read Timeout** |  How long the consumer waits for a response before it times out, in milliseconds. Default value is `0`, which means infinite.  
**Connection Timeout** |  How long the connector waits before timing out when establishing a connection to the remote service. Default value is `0`, which means infinite.  
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.  
Port of the proxy. If **Host** is set, then this property must be set and cannot be a negative number.  
Username used to authenticate against the proxy. If this property is not set, then authentication is not applied to the proxy.  
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.  
OAuth client ID, as registered with the service provider.  
**Client secret** |  OAuth client secret, as registered with the service provider.  
The service provider’s token endpoint URL. |  `https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token`  
OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.  
**Object Store** |  Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.  
### OAuth Username Password Connection Type
Uses a username and a password to authenticate the connection to the server.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Version number of the API to connect to.  
**Read Timeout** |  How long the consumer waits for a response before it times out, in milliseconds. Default value is `0`, which means infinite.  
**Connection Timeout** |  How long the connector waits before timing out when establishing a connection to the remote service. Default value is `0`, which means infinite.  
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.  
Port of the proxy. If **Host** is set, then this property must be set and cannot be a negative number.  
Username used to authenticate against the proxy. If this property is not set, then authentication is not applied to the proxy.  
Password used to authenticate against the proxy.  
Username used to initialize the session.  
Password used to authenticate the user.  
Application ID URI of the web API (secured resource).  
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**.  
**Client Secret** |  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.  
**Token Request Endpoint** |  Token request endpoint.  
**Reconnection** |  |  Configures a reconnection strategy to use when a connector operation fails to connect to an external server.  
## Sources
  * On Deleted Object Listener
  * On Modified Object
  * 

Microsoft Dynamics 365 Connector sources use Object Store to save watermarks. You might experience limitations that are specific to the Object Store implementation you are using (Object Store for CloudHub deployments or Object Store for on-premises deployments), so configure Object Store to suit your needs. For more information, see The Different Types of Object Stores Explained.   
---  
### On Deleted Object Listener
`<dynamics:on-deleted-object>`
Starts your app when an object is deleted.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Entity Type** |  Describes business data. Example values are `account` and `contact`, which are defined in the Microsoft Dynamics 365 instance.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Primary Node Only** |  Determines whether to execute this source on only the primary node when running Mule instances in a cluster.  
**Scheduling Strategy** |  Scheduling Strategy |  Configures the scheduler that triggers the polling.  
**Redelivery Policy** |  Redelivery Policy |  Defines a policy for processing the redelivery of the same message.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
Attributes Type  
---  
#### Associated Configurations
  *
Microsoft Dynamics 365 Connector sources use Object Store to save watermarks. You might experience limitations that are specific to the Object Store implementation you are using (Object Store for CloudHub deployments or Object Store for on-premises deployments), so configure Object Store to suit your needs. For more information, see The Different Types of Object Stores Explained.   
---  
### On Deleted Object Listener
`<dynamics:on-deleted-object>`
Starts your app when an object is deleted.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Entity Type** |  Describes business data. Example values are `account` and `contact`, which are defined in the Microsoft Dynamics 365 instance.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Primary Node Only** |  Determines whether to execute this source on only the primary node when running Mule instances in a cluster.  
**Scheduling Strategy** |  Scheduling Strategy |  Configures the scheduler that triggers the polling.  
**Redelivery Policy** |  Redelivery Policy |  Defines a policy for processing the redelivery of the same message.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
Attributes Type  
---  
#### Associated Configurations
  * 

### On Modified Object
`<dynamics:on-modified-object>`
Starts your app when an object is modified.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
Required date format is `'yyyy-MM-dd’T’HH:mm:ss’Z'`.  
**Entity Type** |  Describes business data. Example values are `account` and `contact`, which are defined in the Microsoft Dynamics 365 instance.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Primary Node Only** |  Determines whether to execute this source on only the primary node when running Mule instances in a cluster.  
**Scheduling Strategy** |  Scheduling Strategy |  Configures the scheduler that triggers the polling.  
**Redelivery Policy** |  Redelivery Policy |  Defines a policy for processing the redelivery of the same message.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
Attributes Type  
---  
#### Associated Configurations
  * 

### On New Object
`<dynamics:on-new-object>`
Starts your app when a new object is created.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
Required date format is `'yyyy-MM-dd’T’HH:mm:ss’Z'`.  
**Entity Type** |  Describes business data. Example values are `account` and `contact`, which are defined in the Microsoft Dynamics 365 instance.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Primary Node Only** |  Determines whether to execute this source on only the primary node when running Mule instances in a cluster.  
**Scheduling Strategy** |  Scheduling Strategy |  Configures the scheduler that triggers the polling.  
**Redelivery Policy** |  Redelivery Policy |  Defines a policy for processing the redelivery of the same message.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
Attributes Type  
---  
#### Associated Configurations
  * 

## Operations
  * Create Multiple
  * Delete Multiple
  *   *   * Retrieve Multiple
  * Retrieve Multiple By Query
  *   * Update Multiple


### Create
`<dynamics:create>`
Creates a new entity.
  * Create New Entity - `https://msdn.microsoft.com/en-us/library/gg328090.aspx`
  * Associate Entity Upon Creation - `https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Logical Name** |  Logical name of the entity. It is always the schema name in lower case.  
**Attributes** |  Attributes of the entity to create as a map.  
Body encoding.
  * If no value is specified, set the Mule default encoding.
  * If a value is specified, set the `-M-Dmule.encoding` VM argument to the same value to avoid an encoding mismatch.

  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Create Multiple
`<dynamics:create-multiple>`
Creates multiple entities.
  * Create New Entity - `https://msdn.microsoft.com/en-us/library/gg328090.aspx`
  * Associate Entity Upon Creation - `https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4`
  * Batch Request - `https://msdn.microsoft.com/en-us/library/mt607719.aspx`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Logical Name** |  Logical name of the entity. It is always the schema name in lower case.  
**Entities Attributes** |  Array of Object |  List of the entities' attributes to create as a list of maps.  
**Use Single Transaction** |  Use a single transaction for creation. If the entity creation fails, the transaction is rolled back.  
**Continue On Error** |  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** : | Use Single Transaction | Continue on Error | Expected result | Successful records | Failed records | Unprocessed records  
---|---|---|---|---|---  
No rollback. Stops processing records after a failed record.  
No rollback. Continues to process records even after a failed record. | 1-4, 6-10  
If the connector fails to create an entity, no records are committed. | Failed records 1-10  
If the connector fails to create an entity, no records are committed. | Failed records 1-10  
Body encoding.
  * If no value is specified, set the Mule default encoding.
  * If a value is specified, set the `-M-Dmule.encoding` VM argument to the same value to avoid an encoding mismatch.

  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
Bulk Operation Result  
---  
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Delete
`<dynamics:delete>`
Deletes an entity.
  * Delete an Entity - `https://msdn.microsoft.com/en-us/library/mt607664.aspx`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Logical Name** |  Logical name of the entity. It is always the schema name in lower case.  
ID of the entity to delete.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Associated Configurations
  *
|  Retry strategy in case of connectivity errors.  
#### Output
Bulk Operation Result  
---  
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Delete
`<dynamics:delete>`
Deletes an entity.
  * Delete an Entity - `https://msdn.microsoft.com/en-us/library/mt607664.aspx`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Logical Name** |  Logical name of the entity. It is always the schema name in lower case.  
ID of the entity to delete.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Delete Multiple
`<dynamics:delete-multiple>`
Deletes multiple entities.
  * Delete an Entity - `https://msdn.microsoft.com/en-us/library/mt607664.aspx`
  * Batch Request - `https://msdn.microsoft.com/en-us/library/mt607719.aspx`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Logical Name** |  Logical name of the entity. It is always the schema name in lower case.  
Array of String |  List of IDs to delete.  
**Use Single Transaction** |  Use a single transaction for deletion. If the deletion fails, the transaction is rolled back.  
**Continue On Error** |  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** : | Use Single Transaction | Continue on Error | Expected result | Successful records | Failed records | Unprocessed records  
---|---|---|---|---|---  
No rollback. Stops processing records after a failed record.  
No rollback. Continues to process records even after a failed record. | 1-4, 6-10  
If the connector fails to delete an entity, no records are committed. | Failed records 1-10  
If the connector fails to delete an entity, no records are committed. | Failed records 1-10  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
Bulk Operation Result  
---  
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Disassociate
`<dynamics:disassociate>`
Removes a reference to an entity.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Logical Name** |  Logical name of the entity. It is always the schema name in lower case.  
**Attributes** |  Disassociates a request’s payload.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Do Action
`<dynamics:do-action>`
Call an action.
  * Use Web API Actions - `https://msdn.microsoft.com/en-us/library/mt607600.aspx`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Action Name** |  Action name to call.  
**Bounded Entity Type** |  Optional bounded entity type. You must provide this value if the action is bounded.  
**Bounded Entity Id** |  Optional bounded entity ID. You must provide this value if the action is bounded.  
**Related Entities** |  Body to send in the request as a map.  
Body encoding.
  * If no value is specified, set the Mule default encoding.
  * If a value is specified, set the `-M-Dmule.encoding` VM argument to the same value to avoid an encoding mismatch.

  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Invoke
`<dynamics:invoke>`
Generic simple invoke.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
URI to invoke.  
**Http Method** |  Enumeration, one of:
  * PATCH
  * DELETE

|  HTTP method to invoke.  
HTTP headers used in the request.  
String placed in the body of the request.  
Body encoding.
  * If no value is specified, set the Mule default encoding.
  * If a value is specified, set the `-M-Dmule.encoding` VM argument to the same value to avoid an encoding mismatch.

  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Retrieve
`<dynamics:retrieve>`
Retrieves an entity.
  * Retrieve an Entity - `https://msdn.microsoft.com/en-us/library/mt607871.aspx`
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Retrieve
`<dynamics:retrieve>`
Retrieves an entity.
  * Retrieve an Entity - `https://msdn.microsoft.com/en-us/library/mt607871.aspx`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Logical Name** |  Logical name of the entity. It is always the schema name in lower case.  
ID of the entity to retrieve.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Retrieve Multiple
`<dynamics:retrieve-multiple>`
Retrieve multiple by URL.
  * Query Data using the Web API - `https://msdn.microsoft.com/en-us/library/gg334767.aspx`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Data Query URL** |  URL to use for data retrieval.  
Number of items in a results page.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Streaming Strategy** | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * Non Repeatable Iterable

|  Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
Array of Object  
---  
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Retrieve Multiple By Query
`<dynamics:retrieve-multiple-by-query>`
Retrieve multiple by DSQL query.
  * Query Data using the Web API - `https://msdn.microsoft.com/en-us/library/gg334767.aspx`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Datasense Query** |  DSQL query used to retrieve. The query is transformed in a retrieve URL internally.  
Number of items in a results page.  
Information about the specified relationship to include in the response.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Streaming Strategy** | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * Non Repeatable Iterable

|  Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
Array of Object  
---  
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Unauthorize
`<dynamics:unauthorize>`
Deletes all the access token information of a given resource owner ID so that it is impossible to execute any operation for that user without doing the authorization dance again.
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Resource Owner Id** |  ID of the resource owner for whom to invalidate access.  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
#### Associated Configurations
  * 

### Update
`<dynamics:update>`
Updates an entity.
  * Create New Entity - `https://msdn.microsoft.com/en-us/library/gg328090.aspx`
  * Associate Entity Upon Creation - `https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4`
  * Batch Request - `https://msdn.microsoft.com/en-us/library/mt607719.aspx`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Logical Name** |  Logical name of the entity. It is always the schema name in lower case.  
**Attributes** |  Attributes of the entity.  
Body encoding.
  * If no value is specified, set the Mule default encoding.
  * If a value is specified, set the `-M-Dmule.encoding` VM argument to the same value to avoid an encoding mismatch.

  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Update Multiple
`<dynamics:update-multiple>`
Updates multiple entities.
  * Update Entity - `https://msdn.microsoft.com/en-us/library/mt607664.aspx`
  * Associate Entities Upon Update - `https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4`
  * Batch Request - `https://msdn.microsoft.com/en-us/library/mt607719.aspx`
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


### Update Multiple
`<dynamics:update-multiple>`
Updates multiple entities.
  * Update Entity - `https://msdn.microsoft.com/en-us/library/mt607664.aspx`
  * Associate Entities Upon Update - `https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4`
  * Batch Request - `https://msdn.microsoft.com/en-us/library/mt607719.aspx`


Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  Name of the configuration to use.  
**Logical Name** |  Logical name of the entity. It is always the schema name in lower case.  
**Entities Attributes** |  Array of Object |  List of the entities' attributes to create as a list of maps.  
**Use Single Transaction** |  Use a single transaction for an update. If the update fails, the transaction is rolled back.  
**Continue On Error** |  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** : | Use Single Transaction | Continue on Error | Expected result | Successful records | Failed records | Unprocessed records  
---|---|---|---|---|---  
No rollback. Stops processing records after a failed record.  
No rollback. Continues to process records even after a failed record. | 1-4, 6-10  
If the connector fails to update an entity, no records are committed. | Failed records 1-10  
If the connector fails to update an entity, no records are committed. | Failed records 1-10  
Body encoding.
  * If no value is specified, set the Mule default encoding.
  * If a value is specified, set the `-M-Dmule.encoding` VM argument to the same value to avoid an encoding mismatch.

  
**Config Ref** |  ConfigurationProvider |  Name of the configuration used to execute this component.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  Expression that evaluates the operation’s output. The outcome of the expression is stored in the **Target Variable** field.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Retry strategy in case of connectivity errors.  
#### Output
Bulk Operation Result  
---  
#### Associated Configurations
  * 

#### Throws
  * DYNAMICS:CONNECTIVITY
  * DYNAMICS:INVALID_PAGE_SIZE
  * DYNAMICS:NOT_FOUND
  * DYNAMICS:OPERATION_FAILED
  * DYNAMICS:PARSE_ERROR
  * DYNAMICS:RETRY_EXHAUSTED
  * DYNAMICS:TIMEOUT
  * DYNAMICS:UNAUTHORIZED
  * DYNAMICS:UNKNOWN


## Object Types
  *   * Bulk Operation Result
  * Expiration Policy
  *   * Reconnect Forever
  *   * Redelivery Policy
  * Repeatable File Store Iterable
  * Repeatable In Memory Iterable


### Bulk Item
Information about a bulk item.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Exception if the item fails.  
Message to add context to this item, such as an error description, a warning, or information related to the operation.  
Actual data the entity represents.  
**Status Code** |  Optional status code.  
**Successful** |  Whether or not the request is successful.  
### Bulk Operation Result
Information about a bulk operation.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Operation ID.  
Array of Bulk Item |  Ordered list of bulk items.  
**Successful** |  Whether or not the operation is successful. Must be `true` if and only if all the child DynamicsBulkItem entities are also successful.  
### Expiration Policy
Configures an expiration policy strategy.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Max Idle Time** field.  
### Reconnect
Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to attempt to reconnect, in milliseconds.  
If `false`, the reconnection strategy runs in a separate, non-blocking thread.  
How many reconnection attempts the Mule app can make.  
### Reconnect Forever
Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to attempt to reconnect, in milliseconds.  
If `false`, the reconnection strategy runs in a separate, non-blocking thread.  
### Reconnection
Configures a reconnection strategy for an operation.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Fails Deployment** |  What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:
  * `true` Allow the deployment to fail.
  * `false` Ignore the results of the connectivity test.

  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  Reconnection strategy to use.  
### Redelivery Policy
Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Redelivery Count** |  Maximum number of times that a redelivered request can be processed unsuccessfully before returning a `REDELIVERY_EXHAUSTED` error.  
**Use Secure Hash** |  If `true`, Mule uses a secure hash algorithm to identify a redelivered message.  
**Message Digest Algorithm** |  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.  
**Id Expression** |  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`.  
**Object Store** |  ObjectStore |  Configures the object store that stores the redelivery counter for each message.  
### Repeatable File Store Iterable
Repeatable file store iterable type.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max In Memory Size** |  Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.  
**Buffer Unit** |  Enumeration, one of: |  Unit for the **Max In Memory Size** field.  
### Repeatable In Memory Iterable
Repeatable in memory iterable type.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Initial Buffer Size** |  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.  
**Buffer Size Increment** |  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.  
**Max Buffer Size** |  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.  
## See Also
  * Introduction to Anypoint Connectors
  * MuleSoft Help Center