Web API Reference

This section contains reference documentation of the types, functions, and actions that constitute the Web API for Dynamics 365 Customer Engagement.

In This Section

Web API EntityType Reference

An EntityType represents an entity type in the OData v4 entity model.

Web API Action Reference

Actions represent operations that may have observable side effects, such as creating or updating records. An action may require parameters and may return a value. Actions may be bound to entity types.

Web API Function Reference

A function is an operation that doesn’t have observable side effects. Functions typically retrieve data. They may have parameters and they may return values. Functions may be bound to entity types.

Web API Query Function Reference

Query functions are functions that can be used as a filter criteria in a query. They accept parameters and return a Boolean value.

Web API ComplexType Reference

A ComplexType represents structured data that doesn't have a key. Complex types are frequently returned as a response from using an action or function or passed as a parameter to a function..

Web API EnumType Reference

An EnumType represents an enumeration type in an OData v4 entity model.

Web API Metadata EntityType Reference

Metadata EntityTypes represent the types used in the Dynamics 365 customer engagement metadata model. For information about using these entity types, see Use the Web API with Dynamics 365 metadata.

Web API Solution Reference

Solutions include components that are available in the Web API. Solutions can include custom entities, attributes, entity relationships, and custom actions which change the objects available to use in the Web API.

Reference

OData - the best way to REST
OData Version 4.0 Part 1: Protocol
OData Version 4.0 Part 2: URL Conventions
OData Version 4.0 Part 3: Common Schema Definition Language (CSDL)

Use the Microsoft Dynamics 365 Customer Engagement Web API
Web API types and operations
Perform operations using the Web API