PL 400 : interact with data and processes by using the Dataverse Web API or the Organization Service (Use platform APIs)

API is not a new concept, but in the modern computer world, it is the popular way of communication between applications. An API is a component that allows different platforms, applications, and systems to connect and share information with each other. Developers use this component to improve their products/software by accessing other business data, software, services or code. Most of the benefits of an API are that it is easy to use in code and allows access to resources with control manners.


Web API is basically an Open-Source framework that is used to write HTTP APIs.

In the Dataverse, Microsoft provides different mechanisms to work with data, tables and column definition. Those are below:

  • Web API
  • Organization Service

Microsoft first introduced this feature in Dynamics CRM 2016 and it uses similarly in the Dataverse  with different programming languages, multiple platforms, and devices. The Web API in Dataverse uses the Open Data Protocol (OData), known as OData version 4.0. OData (Open Data Protocol) is an ISO/IEC approved, OASIS standard that defines a set of best practices for building and consuming RESTful APIs.  OData helps to focus on business logic while building RESTFUL APIs without having to worry about the various approaches to define:

  • Request & Response header
  • Status Codes
  • HTTP Methods
  • URL 
  • Media Types
  • Payload format
  • Query options
OData RESTFUL APIs are easy to consume.
Because Web API is based on REST, we can use it with HTTP in JavaScript or C# with .NET or any other platform or programming language. It can be called and accessed using JavaScript. We can use Web API with HTML web resources, form scripts, and ribbon commands to perform various  operations on data. Web API is very convenient to use with JavaScript as it returns in the form of JSON objects that can be easily converted to JavaScript objects.

Following are the features of Web API: 
  • It implements OData version 4.0 for creating and consuming RESTful APIs on rich data sources like DOC, HTML and PDF. 
  • It supports a variety of programming languages such as .NET, C++, Java, Python. , device and platform
  •  requests and responses have JSON format
Some of the CRUD operations that Web API provides are:
  • Create
  • Update
  • Delete
  • Retrieve
  • Retrievemultiple (Using  OData and Fetch)
  • Execute Web API functions
  • Execute Web API Actions
  • Execute Web API Query functions
Limitation of Web API :
  • A maximum of 5000 records will be returned for each request.
  • If there are more records that match the query filter criteria a @odata.nextlink property with returned with the results
  • Web API is not enabled for MS dynamics outlook with offline access while user is offline.
  • Can't retrieve unpublished metadata.
  • Error when querying self referential Many to Many relationships.
  • Null Valued properties may not be returned in expanded navigation property results.
Dataverse Organization Service:

Dataverse Organization service is another option to interact and process the data. The organization service is optimized for use with the .NET Framework and the SDK assemblies in the Microsoft.CRMSdk.CoreAssemblies NuGet package provide the classes for the IOrganizationService interface necessary work with data, and table and column definition using this service. The organization service defines the supported operations as messages. Each message has a name. These messages correspond to the events that are emitted by the event framework. The .NET assemblies for the organization service currently use a SOAP endpoint. The assemblies were designed to closely model the underlying platform services based on IOrganizationService interface. However they are not the same components and should not be confused with one another. The SOAP endpoint for the organization service was introduced in 2011 and we have announced that it is deprecated.

Key features:
  • For use of Organization service, we should implement the IOrganizationService interface.
  • It is also known as SOAP endpoint.
  • It is the primary web service for accessing data and metadata from Microsoft Dynamics CRM organization.
  • Organization service request and response is in SOAP format.
  • The Microsoft Dynamics CRM SDK provides assemblies and tools to generate strongly typed classes and proxies to simplify development in Microsoft Visual Studio.
  • Up to 5000 records can be returned in a single query.

Comments

Post a Comment

Popular posts from this blog

PCF vs. Web Resources: Choosing the Right Extensibility Tool for Dataverse

Image
Extensibility refers to the ability to be extended or augmented beyond the default capabilities of the platform. This involves customization but also includes more advanced techniques, such as coding, integration with external services, and the use of custom components. In the context of Power Platform and Dynamics CRM, the term "extend behavior" refers to the ability to customize and extend the functionality of the platform to meet specific business needs. Extensibility often requires technical skills, such as coding in JavaScript, C#, or using tools like Azure Logic Apps and Power Automate for complex integrations. Customization  is a subset of extensibility. Customization involves configuring and modifying existing elements within the platform to suit specific business needs. Extensibility, on the other hand, covers a wide range of functions and techniques, including customization and more advanced development and integration tasks, to extend the capabilities of the Power
Read more

Is Debt Prosperity or Trap?

 “What can be added to the happiness of a man who is in health, out of debt, and has a clear conscience?”  Adam Smith Grandfather Bhishma lay on the bed of arrows and was preaching the future king of Hastinapur about political science, economics and the duties of the king. He took a deep breath and told Yudhishthira " Fire, debt and enemies must be dealt with quickly and completely. If there is any balance left, they can continue to grow. " The future king was listening with curiosity and was eager to learn about the complete knowledge from his grandsire. Each moment was important as the sun was moving from south to north. Either we read the quote of the father of modern economics or both ancient great scholars are advising to avoid debt. But the whole of modern economics is based on the debt that advises the public to borrow money. The aggressive campaign of banks and financial institutions has been luring more and more loans. Even democratic governments and public banks con
Read more

Exam PL-400: Microsoft Power Platform Developer

 Create a technical design (10-15%) Validate requirements and design technical architecture design and validate the technical architecture for a solution design authentication and authorization strategy determine whether you can meet requirements with out-of-the-box functionality determine when to use Logic Apps versus Power Automate flows determine when to use serverless computing, plug-ins, or Power Automate determine when to build a virtual entity data source provider and when to use connectors Design solution components design a data model design Power Apps reusable components design custom connectors design server-side components Describe Microsoft Power Platform extensibility points describe Power Virtual Agents extensibility points including Bot Framework skills and Power Automate flows describe Power BI extensibility points including Power BI APIs, custom visuals, and embedding Power BI apps in websites and other applications describe Power Apps portal extensibility points incl
Read more