CA OData IntelliSense

Introduction to Dataverse WebAPI

Dataverse WebAPI is based on the official OData specification, but it is limited to a subset of the full capabilities.

KCA OData IntelliSense is aligned to the Dataverse WebAPI, which means it provides full autocompletion for common functions and domain specific data model identifiers.

KCA provides autocompletion for retrieve operations only.

Build a query

Simple Retrieve

A select statement specifies which attributes should be returned. KCA provides a list of available attributes, based on the entity context.

Xrm.WebApi.retrieveMultipleRecords("account", "?$select=)"

Filter

A filter can use context specific identifiers (attribute, functions or relations) to limit the returned records.

Simple Filter

Xrm.WebApi.retrieveMultipleRecords("account", "?$select=name&$filter=name eq 'Golet Inc.')")

Standard query functions

Xrm.WebApi.retrieveMultipleRecords("account", "?$select=name&$filter=contains((name,'Golet Inc.'))")

MS Functions

$select=name&$filter=Microsoft.Dynamics.CRM.OlderThanXDays(PropertyName='createdon',PropertyValue=7)

Lambda Expressions

Xrm.WebApi.retrieveMultipleRecords("contact", "?$select=fullname&$filter=Contact_Appointments/all(o:o/")

Parameter

Xrm.WebApi.retrieveMultipleRecords("contacts", "?$select=fullname&$filter=Microsoft.Dynamics.CRM.In(PropertyName=@p1,PropertyValues=@p2) &@p1='lastname' &@p2=['OBrian','OBryan','OBrian','OBryan']")

Order

Xrm.WebApi.retrieveMultipleRecords("account", "?$select=name&$orderby=n")

Expand

Xrm.WebApi.retrieveMultipleRecords("account", "?$select=name&$expand=primarycontactid($select=fullname;$expand=owningbusinessunit($select=n))")

Aggregate and grouping

Xrm.WebApi.retrieveMultipleRecords("account", "?$apply=groupby((statuscode),aggregate(revenue with sum as total))")

Configure feature

The feature must be enabled via the options menu.

References

WebAPI Functions: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/reference/queryfunctions?view=dataverse-latest

WebAPI: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/query-data-web-api

Limitations and known issues

  • Attribute types are not checked for simple filter and function arguments

  • Escape characters are not supported

Need help? Contact support