Edit

Dynamics 365 Customer Engagement Web API Versions

  • Article

Beginning with the Dynamics 365 for Customer Engagement apps version 9.0 (v9.x) release, the Microsoft Dynamics 365 for Customer Engagement (on-premises) Web API supports version specific differences in the same environment.

This support is different from the behavior for the v8.x releases. In the previous releases, new capabilities were available to any version of the service depending on the update applied to the environment. After an upgrade to v8.2, the v8.0, and v8.1 services were all identical. This commonality was possible because all the changes were additive. Nothing was removed or introduced breaking changes. As a result, the specific version referenced in the service URL for the v8.x wasn't important.

Going forward, the capabilities of the service can change, including potentially breaking changes such as removing specific operations. This flexibility will allow for improvements to be applied on an on-going basis. This topic will record any version specific differences and any limitations where the Web API hasn't yet achieved parity with the organization service.

Web API Limitations

The Microsoft Dynamics 365 for Customer Engagement (on-premises) Web API provides complete parity with the capabilities of the organization service. For Dynamics 365 for Customer Engagement apps version 9.0, this topic describes the limitations carried forward from the December 2016 Update for Dynamics 365 (online) release. For earlier releases, see Dynamics CRM 2016 Web API Limitations.

Limitations addressed in Dynamics 365 for Customer Engagement apps version 9.0

In version 8.2, some custom actions were not available in Web API.

Note

This issue is addressed in Dynamics 365 for Customer Engagement apps version 9.0.

If you defined a custom action, which includeed a complex return value and a simple return value, a corresponding Action was not available in the Web API but was available using the Organization service. A complex return value is an EntityReference, Entity, or EntityCollection. You can have any combination of simple return values or a single complex return value. More information: Create your own actions

New operations added

The following operations have been added to the Web API for Dynamics 365 for Customer Engagement apps version 9.0.

See also

Use the Dynamics 365 Customer Engagement Web API
Authenticate to Dynamics 365 Customer Engagement (on-premises) with the Web API