web
You’re offline. This is a read only version of the page.
close
Skip to main content

Announcements

No record found.

News and Announcements icon
Community site session details

Community site session details

Session Id :
Customer experience | Sales, Customer Insights,...
Answered

What does the "Client API reference" parameter refer to?

(0) ShareShare
ReportReport
Posted on by 365

As regards Javascript actions to extend CRM application client-side, the following definition of the retrieveMultipleRecords mentions a parameter of type Client API reference, which is passed to the method:

retrieveMultipleRecords (Client API reference)

Retrieves a collection of entity records

Xrm.WebApi.retrieveMultipleRecords(entityLogicalName, options, maxPageSize).then(successCallback, errorCallback);

I'm very new to web Api and CRM so I'd like to have a clear understanding of how things work together.
This is what I figured out by reading the definition above, please correct me if I'm wrong.

I assume that Web Api is a Rest service/library/dll  which is exposed externally and can be called (through url, for example).

I assume that in this scenario the REST service is inside CRM, it's Dynamic itself, is it correct?
I also assume that a "client" is someone who calls a service to access server data, so that the CRM is the server and the service, and Javascript is the client.
Given these assumptions, I figure out that "Client" in the definition above is referred to my JS .dll, is it correct?



I have the same question (0)
  • PabloCRP Profile Picture
    1,088 on at

    Indeed as you mention Xrm.WebApi is a set of operations available in your client side, Like Forms and webresources inside Dynamics365.

    You can perform CRUD(create,read,,update,delete) operation, also you can call special operations called actions and function, with execute method.

  • Verified answer
    Guido Preite Profile Picture
    54,086 Moderator on at

    "Client API reference" is not a parameter, is just an addition to the title, the parameters are the ones in the signature of the method (entityLogicalName, ...)

Under review

Thank you for your reply! To ensure a great experience for everyone, your content is awaiting approval by our Community Managers. Please check back later.

Helpful resources

Quick Links

Introducing the 2026 Season 1 community Super Users

Congratulations to our 2026 Super Stars!

Meet the Microsoft Dynamics 365 Contact Center Champions

We are thrilled to have these Champions in our Community!

Congratulations to the April Top 10 Community Leaders

These are the community rock stars!

Leaderboard > Customer experience | Sales, Customer Insights, CRM

#1
ManoVerse Profile Picture

ManoVerse 127 Super User 2026 Season 1

#2
11manish Profile Picture

11manish 121

#3
Muhammad Shahzad Shafique Profile Picture

Muhammad Shahzad Sh... 69 Most Valuable Professional

Last 30 days Overall leaderboard

Product updates

Dynamics 365 release plans