Release history

 

Updated: February 21, 2017

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

This is the release history page for the Software Development Kit (SDK) for Microsoft Dynamics 365 (online & on-premises).

Current Version 8.2.1, February 2017

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

Choose your development style for Dynamics 365

Updated topic to add information about appropriately choosing between Web API, SDK assemblies, and XRM tooling assemblies to develop applications for Microsoft Dynamics 365.

Important changes coming in future releases of Microsoft Dynamics 365

Added deprecation information for SDK extensions for Microsoft Dynamics 365.

Impersonate another user

Updated topic to include improved security best practices.

Simple Web API quick-start sample (C#)

Added new C# sample for the Web API that focuses on basics of authentication.

Web API Basic Operations Sample

Web API Basic Operations Sample (C#)

Web API Basic Operations Sample (Client-side JavaScript)

Updated samples to include examples showing create and update with data returned. This capability was introduced with December 2016 update for Dynamics 365 (online and on-premises).More information: Create with data returned and Update with data returned

SDK extensions for Microsoft Dynamics 365

Updated topic to add deprecation information for SDK extensions for Microsoft Dynamics 365.

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

SDK\Bin

Updated the assemblies for Microsoft Dynamics 365 (online & on-premises).

All topics

All topics updated to reflect the product name change.

Build web applications using Server-to-Server (S2S) authentication

New set of topics for new feature. Includes the following new topics:
Use Multi-Tenant Server-to-server authentication
Walkthrough: Multi-tenant server-to-server authentication
Use Single-Tenant Server-to-server authentication

Compose HTTP requests and handle errors

HTTP headers and Identify status codes sections for CRM Web API enhancements.

Connected Field Service Developer Guide

New set of topics for new feature. Includes the following new topics:
Connected Field Service architecture
Extend Connected Field Service solutions with 1 reference topic.
IoT Connector Web API Reference with 19 reference topics.

Create an entity using the Web API

Added the Create with data returned section sections for CRM Web API enhancements.

Create and manage product families, products, bundles, and product properties

Added Define product properties section

Customize entity views

Added Add custom icons with tooltip for a column section

Data Export Service

New topic for new feature.

Define access permission for modular business apps in Dynamics 365

New topic for new feature

Get started with the Microsoft Dynamics 365 Web API (client-side JavaScript)

Refactored existing topic to focus on get started scenario.

Get started with the Microsoft Dynamics 365 Web API (C#)

New set of topics to focus on get started scenario. Includes the following new topics:
Start a Dynamics 365 Web API project in Visual Studio (C#)
Use the Microsoft Dynamics 365 Web API Helper Library (C#)
Web API Helper code: Configuration classes
Web API Helper code: Authentication class
Web API Helper code: CrmHttpResponseException class

Important changes coming in future releases of Microsoft Dynamics 365

Added Ribbon parameters referring to entity type codes section.

Microsoft Dynamics 365 Web API Limitations

Updated topic to add Limitations addressed in December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) and Limitations in December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) sections

Model business process flows

Updated topic for Process enhancements.

Retrieve metadata by name or MetadataId

Updated topic for CRM Web API enhancements.

Sample: Android Activity Tracker for Dynamics 365 and Web API

Added topic to represent new sample published at https://github.com/DynamicsCRM/Android-Activity-Tracker-for-Dynamics-CRM-Web-API.

Sample: iOS Activity Tracker for Dynamics 365 and Web API

Added topic to represent new sample published at https://github.com/DynamicsCRM/iOS-Activity-Tracker-for-Dynamics-CRM-Web-API.

Supported types, triggers, entities, and actions for processes

Updated Supported actions for processes for Process enhancements.

Update and delete entities using the Web API

Added Update with data returned section for CRM Web API enhancements

Use editable grids in Dynamics 365

New topic for new feature

Web API Action Reference

The following actions are new in this release:
BulkDelete Action
BulkDetectDuplicates Action
CreateCustomerRelationships Action
ExecuteWorkflow Action
FullTextSearchKnowledgeArticle Action
PropagateByExpression Action
QualifyLead Action
QueryExpressionToFetchXml Action
SendBulkMail Action
SetFeatureStatus Action
UpdateFeatureConfig Action

Web API ComplexType Reference

The following complex types are new in this release:
BulkDeleteResponse ComplexType
BulkDetectDuplicatesResponse ComplexType
BusinessEntityChanges ComplexType
ComplexLookupAttributeMetadata ComplexType
ConditionExpression ComplexType
CreateCustomerRelationshipsResponse ComplexType
FetchXmlToQueryExpressionResponse ComplexType
FilterExpression ComplexType
IChangedItem ComplexType
InputArgument ComplexType
InputArgumentCollection ComplexType
LinkEntity ComplexType
Object ComplexType
OrderExpression ComplexType

Web API EnumType Reference

The following enum types are new in this release:
ConditionOperator EnumType
JoinOperator EnumType
LogicalOperator EnumType
OrderType EnumType
RollupType EnumType

Web API Function Reference

The following functions are new in this release:
FetchXmlToQueryExpression Function
RetrieveActivePath Function
RetrieveByResourcesService Function
RetrieveEntityChanges Function
RetrieveExchangeAppointments Function
RetrieveFilteredForms Function
RetrieveProcessInstances Function
Rollup Function

Web API Samples

Added a set of C# and client-side JavaScript samples for the Web API . Includes the following new topics:
Web API Basic Operations Sample
Web API Query Data Sample
Web API Conditional Operations Sample
Web API Functions and Actions Sample
Web API Samples (C#)
Web API Basic Operations Sample (C#)
Web API Query Data Sample (C#)
Web API Conditional Operations Sample (C#)
Web API Functions and Actions Sample (C#)Web API Samples (Client-side JavaScript)
Web API Basic Operations Sample (Client-side JavaScript)
Web API Query Data Sample (Client-side JavaScript)
Web API Conditional Operations Sample (Client-side JavaScript)
Web API Functions and Actions Sample (Client-side JavaScript)

Write and debug scripts for the interactive service hub

Updated topic for Enhanced client API support in the interactive service hub.

Xrm.Mobile.offline (client-side reference)

New topic for Introducing Client APIs for using native device capabilities in Dynamics 365 mobile clients.

Xrm.Page.data.process (client-side reference)

Updated setActiveProcess description for Process enhancements.

Xrm.Page.ui control (client-side reference)

Updated Notification description for Process enhancements.

Xrm.Utility (client-side reference)

Added new section: Native device capabilities (Dynamics 365 mobile clients).

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

SDK\Bin

Updated the assemblies for Microsoft Dynamics 365 (online & on-premises).

Apply SLAs to entities

New topic containing information about the SLA support for various entities in Dynamics 365.

Azure integration with Microsoft Dynamics 365

Work with Dynamics 365 event data in your Azure Event Hub solution

Write a listener application for a Microsoft Azure solution

Walkthrough: Configure Microsoft Azure (SAS) for integration with Dynamics 365

Walkthrough: Update a service endpoint from ACS to SAS authorization

Walkthrough: Update a service endpoint imported from a solution

New or updated Azure related topics containing information about new features including SAS authorization, support for event hubs, and multiple messaging data formats for cross-platform interoperability.

The restriction to use the Azure SDK version 1.7 or 1.8 has been changed to version 1.7 or later.

Create packages for the Dynamics 365 Package Deployer

Updated the topic to include information about the new capabilities that enable developers to control how the packages will be deployed while creating packages.

Default SiteMap XML

Updated the topic about the inclusion of the interactive service hub in the default Dynamics 365 sitemap.

Dynamics 365 application platform - A platform for building extended Dynamics 365 (xRM) applications

Added a new topic with information and links to videos about building extended Dynamics 365 (xRM) line-of-business applications.

Important changes coming in future releases of Microsoft Dynamics 365

Added a topic to include deprecation announcements for features that will be removed in the future.

Knowledge base search control (client-side reference)

Updated the topic to include information about the new client APIs in this release.

Microsoft Dynamics 365 Web API Limitations

Added the following additional limitations:

Query Data using the Web API

Added the following sections about Dynamics 365 Web API enhancements in this release:

ServiceEndpoint entity messages and methods

The ServiceEndpoint entity has new attributes for SAS configuration. The NamespaceAddress and NamespaceFormat attributes have been added to support full namespace addressing in addition to the existing option of specifying just the namespace name.

Use the Category entity to categorize Dynamics 365 records

Category entity messages and methods

Topics added that contain information about how you can use the new Category entity.

Use the Feedback entity to manage feedback and ratings for Dynamics 365 records

Feedback entity messages and methods

New topics containing information about how you can use the new Feedback entity.

Work with attribute metadata

Updated the topic to include a new section: Create a customer lookup attribute

Write and debug scripts for Dynamics 365 for phones and tablets

Renamed the topic from Write and debug scripts for Dynamics 365 for tablets, and updated the contents to include information about the client API support for Dynamics 365 for phones and tablets.

Write and debug scripts for the interactive service hub

New topic containing information about the client APIs supported in the interactive service hub.

Write code for Microsoft Dynamics 365 forms

Added entities to list of Updated entities that now support the improved form rendering experience in Dynamics 365.

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

SDK\Bin

Updated the assemblies for Microsoft Dynamics 365 (online & on-premises).

Create early bound entity classes with the code generation tool (CrmSvcUtil.exe)

SDK\Bin\CrmSvcUtil.exe

Added two new command line parameters: /interactivelogin, and /connectionstring.

Added support for multi factor authentication when using either the command line or interactive logon.

Trace logging configuration is now provided in the default CrmSvcUtil.exe.config file. There is now more granular control of the logged data.

Microsoft Dynamics 365 Web API Limitations

Updated the topic to include information about limitations removed after update rollup 1 is applied. Added the Limitations addressed in Microsoft Dynamics CRM Online 2016 Update 0.1 and Microsoft Dynamics CRM 2016 Update 0.1 section to call out the changes. Some of the limitations in the initial release remain.

Query Data using the Web API

Updated the Retrieve a count of entities section to show that the count value is limited by the maximum number of entities that can be returned by a query, which is 5000.

Retrieve and execute predefined queries

In the Use custom FetchXML section, there is a new Paging with FetchXML sub-section that describes how to apply paging when using fetchXML queries with the Web API.

Sample: Simplified connection quick start using Microsoft Dynamics 365

Updated the sample to use the CrmServiceClient Class instead of the CrmConnection Class.

Web API ComplexType Reference

The following complex types were added with update rollup 1:

CheckIncomingEmailResponse ComplexType

ComplexAttributeMetadata ComplexType

ComplexEntityKeyMetadata ComplexType

ComplexEntityMetadata ComplexType

ComplexManyToManyRelationshipMetadata ComplexType

ComplexOneToManyRelationshipMetadata ComplexType

FindParentResourceGroupResponse ComplexType

GetQuantityDecimalResponse ComplexType

IsValidStateTransitionResponse ComplexType

QueryMultipleSchedulesResponse ComplexType

RetrieveAllEntitiesResponse ComplexType

RetrieveLocLabelsResponse ComplexType

RetrievePrincipalAccessResponse ComplexType

TimeInfoCollection ComplexType

ValidateRecurrenceRuleResponse ComplexType

Web API EnumType Reference

The following enum types were added with update rollup 1:

AccessRights EnumType

EntityFilters EnumType

TargetFieldType EnumType

Web API Function Reference

The following functions were added with update rollup 1:

CheckIncomingEmail Function

FindParentResourceGroup Function

GetQuantityDecimal Function

IncrementKnowledgeArticleViewCount Function

InitializeFrom Function

IsValidStateTransition Function

QueryMultipleSchedules Function

RetrieveAllEntities Function

RetrieveDuplicates Function

RetrieveLocLabels Function

RetrievePrincipalAccess Function

RetrieveRecordWall Function

RetrieveUnpublishedMultiple Function

SearchByBodyKbArticle Function

SearchByKeywordsKbArticle Function

SearchByTitleKbArticle Function

ValidateRecurrenceRule Function

.

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

SDK\Bin

Updated the assemblies for Microsoft Dynamics 365 (online & on-premises).

.

The following table lists the significant changes made to this version of the SDK.

New and updated topics

Description of changes

Initial version

Start with What's new for developers: Microsoft Dynamics 365.

.

Microsoft Dynamics 365

© 2017 Microsoft. All rights reserved. Copyright

Community Additions

Show: