> ## Documentation Index > Fetch the complete documentation index at: https://ai.easyaf.dev/llms.txt > Use this file to discover all available pages before exploring further. # EdmModel > Represents a complete OData Entity Data Model (EDM). ## Definition **Assembly:** Microsoft.OData.Mcp.Core.dll **Namespace:** Microsoft.OData.Mcp.Core.Models **Inheritance:** System.Object ## Syntax ```csharp theme={null} Microsoft.OData.Mcp.Core.Models.EdmModel ``` ## Summary Represents a complete OData Entity Data Model (EDM). ## Remarks The EDM defines the structure of data exposed by an OData service, including entity types, complex types, entity containers, and their relationships. This class serves as the root model that contains all metadata necessary to understand and interact with an OData service. ## Constructors ### .ctor Initializes a new instance of the [EdmModel](https://ai.easyaf.dev/odata-mcp/api-reference/Microsoft/OData/Mcp/Core/Models/EdmModel.md) class. #### Syntax ```csharp theme={null} public EdmModel() ``` ### .ctor Initializes a new instance of the [EdmModel](https://ai.easyaf.dev/odata-mcp/api-reference/Microsoft/OData/Mcp/Core/Models/EdmModel.md) class with the specified version. #### Syntax ```csharp theme={null} public EdmModel(string version) ``` #### Parameters | Name | Type | Description | | - | - | - | | `version` | `string` | The version of the EDM. | #### Exceptions | Exception | Description | | - | - | | `ArgumentException` | Thrown when *version* is null or whitespace. | ### .ctor Inherited > [!NOTE] > > Inherited from `object` #### Syntax ```csharp theme={null} public Object() ``` ## Properties ### Actions Gets or sets the actions defined in this model. #### Syntax ```csharp theme={null} public System.Collections.Generic.List Actions { get; set; } ``` #### Property Value Type: `System.Collections.Generic.List` A collection of actions that can be invoked on the service. #### Remarks Actions are operations that may have side effects and are used to modify data or perform operations that cannot be expressed through standard CRUD operations. ### AllEntitySets Gets all entity sets from all entity containers. #### Syntax ```csharp theme={null} public System.Collections.Generic.IEnumerable AllEntitySets { get; } ``` #### Property Value Type: `System.Collections.Generic.IEnumerable` A flattened collection of all entity sets in the model. ### AllSingletons Gets all singletons from all entity containers. #### Syntax ```csharp theme={null} public System.Collections.Generic.IEnumerable AllSingletons { get; } ``` #### Property Value Type: `System.Collections.Generic.IEnumerable` A flattened collection of all singletons in the model. ### Annotations Gets or sets the annotations for this model. #### Syntax ```csharp theme={null} public System.Collections.Generic.Dictionary Annotations { get; set; } ``` #### Property Value Type: `System.Collections.Generic.Dictionary` A dictionary of annotations that provide additional metadata about the model. #### Remarks Annotations can be used to specify additional behaviors, constraints, or metadata that are not captured by the standard OData model elements. ### ComplexTypes Gets or sets the complex types defined in this model. #### Syntax ```csharp theme={null} public System.Collections.Generic.List ComplexTypes { get; set; } ``` #### Property Value Type: `System.Collections.Generic.List` A collection of complex types that define reusable structured data elements. #### Remarks Complex types are structured types without keys that can be used as property types in entity types or other complex types. ### EntityContainer Gets the primary entity container for this model (alias for PrimaryContainer). #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmEntityContainer EntityContainer { get; } ``` #### Property Value Type: `Microsoft.OData.Mcp.Core.Models.EdmEntityContainer?` The first entity container, or `null` if no containers are defined. ### EntityContainers Gets or sets the entity containers defined in this model. #### Syntax ```csharp theme={null} public System.Collections.Generic.List EntityContainers { get; set; } ``` #### Property Value Type: `System.Collections.Generic.List` A collection of entity containers that define the service interface. #### Remarks Entity containers define the addressable resources in the OData service. Typically, there is one primary entity container per service. ### EntityTypes Gets or sets the entity types defined in this model. #### Syntax ```csharp theme={null} public System.Collections.Generic.List EntityTypes { get; set; } ``` #### Property Value Type: `System.Collections.Generic.List` A collection of entity types that define the structure of entities in the service. #### Remarks Entity types are the primary structural elements in the EDM, defining the properties and relationships that make up the data model. ### EnumTypes Gets or sets the enumeration types defined in this model. #### Syntax ```csharp theme={null} public System.Collections.Generic.List EnumTypes { get; set; } ``` #### Property Value Type: `System.Collections.Generic.List` A collection of enumeration types whose members appear in type shapes and schemas. #### Remarks Structural properties reference these by [EdmEnumType.FullName](https://ai.easyaf.dev/odata-mcp/api-reference/Microsoft/OData/Mcp/Core/Models/EdmEnumType.md#fullname) in [EdmProperty.Type](https://ai.easyaf.dev/odata-mcp/api-reference/Microsoft/OData/Mcp/Core/Models/EdmProperty.md#type). ### Functions Gets or sets the functions defined in this model. #### Syntax ```csharp theme={null} public System.Collections.Generic.List Functions { get; set; } ``` #### Property Value Type: `System.Collections.Generic.List` A collection of functions that can be called on the service. #### Remarks Functions are operations that can be called to retrieve data or perform calculations. They are side-effect free and can be composed with other query operations. ### HasComplexTypes Gets a value indicating whether this model has any complex types. #### Syntax ```csharp theme={null} public bool HasComplexTypes { get; } ``` #### Property Value Type: `bool` `true` if the model has complex types; otherwise, `false`. ### HasEntityContainers Gets a value indicating whether this model has any entity containers. #### Syntax ```csharp theme={null} public bool HasEntityContainers { get; } ``` #### Property Value Type: `bool` `true` if the model has entity containers; otherwise, `false`. ### HasEntityTypes Gets a value indicating whether this model has any entity types. #### Syntax ```csharp theme={null} public bool HasEntityTypes { get; } ``` #### Property Value Type: `bool` `true` if the model has entity types; otherwise, `false`. ### HasEnumTypes Gets a value indicating whether this model has any enumeration types. #### Syntax ```csharp theme={null} public bool HasEnumTypes { get; } ``` #### Property Value Type: `bool` `true` if the model has enumeration types; otherwise, `false`. ### Namespaces Gets or sets the namespaces used in this model. #### Syntax ```csharp theme={null} public System.Collections.Generic.List Namespaces { get; set; } ``` #### Property Value Type: `System.Collections.Generic.List` A collection of namespace strings that organize the types in the model. #### Remarks Namespaces provide organizational structure and help avoid naming conflicts between types from different sources. ### PrimaryContainer Gets the primary entity container for this model. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmEntityContainer PrimaryContainer { get; } ``` #### Property Value Type: `Microsoft.OData.Mcp.Core.Models.EdmEntityContainer?` The first entity container, or `null` if no containers are defined. #### Remarks Most OData services have a single entity container that serves as the primary interface. This property provides convenient access to that container. ### Version Gets or sets the version of the EDM. #### Syntax ```csharp theme={null} public string Version { get; set; } ``` #### Property Value Type: `string` The version string (e.g., "4.0", "4.01"). #### Remarks This indicates which version of the OData standard the model conforms to. Different versions have different capabilities and syntax. ## Methods ### AddAnnotation Adds an annotation to this model. #### Syntax ```csharp theme={null} public void AddAnnotation(string term, object value) ``` #### Parameters | Name | Type | Description | | - | - | - | | `term` | `string` | The annotation term. | | `value` | `object` | The annotation value. | #### Exceptions | Exception | Description | | - | - | | `ArgumentException` | Thrown when *term* is null or whitespace. | ### AddComplexType Adds a complex type to the model. #### Syntax ```csharp theme={null} public void AddComplexType(Microsoft.OData.Mcp.Core.Models.EdmComplexType complexType) ``` #### Parameters | Name | Type | Description | | - | - | - | | `complexType` | `Microsoft.OData.Mcp.Core.Models.EdmComplexType` | The complex type to add. | #### Exceptions | Exception | Description | | - | - | | `ArgumentNullException` | Thrown when *complexType* is null. | | `InvalidOperationException` | Thrown when a complex type with the same full name already exists. | ### AddEntityContainer Adds an entity container to the model. #### Syntax ```csharp theme={null} public void AddEntityContainer(Microsoft.OData.Mcp.Core.Models.EdmEntityContainer entityContainer) ``` #### Parameters | Name | Type | Description | | - | - | - | | `entityContainer` | `Microsoft.OData.Mcp.Core.Models.EdmEntityContainer` | The entity container to add. | #### Exceptions | Exception | Description | | - | - | | `ArgumentNullException` | Thrown when *entityContainer* is null. | | `InvalidOperationException` | Thrown when an entity container with the same full name already exists. | ### AddEntityType Adds an entity type to the model. #### Syntax ```csharp theme={null} public void AddEntityType(Microsoft.OData.Mcp.Core.Models.EdmEntityType entityType) ``` #### Parameters | Name | Type | Description | | - | - | - | | `entityType` | `Microsoft.OData.Mcp.Core.Models.EdmEntityType` | The entity type to add. | #### Exceptions | Exception | Description | | - | - | | `ArgumentNullException` | Thrown when *entityType* is null. | | `InvalidOperationException` | Thrown when an entity type with the same full name already exists. | ### AddEnumType Adds an enumeration type to the model. #### Syntax ```csharp theme={null} public void AddEnumType(Microsoft.OData.Mcp.Core.Models.EdmEnumType enumType) ``` #### Parameters | Name | Type | Description | | - | - | - | | `enumType` | `Microsoft.OData.Mcp.Core.Models.EdmEnumType` | The enumeration type to add. | #### Exceptions | Exception | Description | | - | - | | `ArgumentNullException` | Thrown when *enumType* is null. | | `InvalidOperationException` | Thrown when an enumeration type with the same full name already exists. | ### Equals Inherited Virtual > [!NOTE] > > Inherited from `object` #### Syntax ```csharp theme={null} public virtual bool Equals(object obj) ``` #### Parameters | Name | Type | Description | | - | - | - | | `obj` | `object?` | - | #### Returns Type: `bool` ### Equals Inherited > [!NOTE] > > Inherited from `object` #### Syntax ```csharp theme={null} public static bool Equals(object objA, object objB) ``` #### Parameters | Name | Type | Description | | - | - | - | | `objA` | `object?` | - | | `objB` | `object?` | - | #### Returns Type: `bool` ### GetAnnotation Gets an annotation value by term. #### Syntax ```csharp theme={null} public T GetAnnotation(string term) ``` #### Parameters | Name | Type | Description | | - | - | - | | `term` | `string` | The annotation term. | #### Returns Type: `T?` The annotation value, or the default value of *T* if not found. #### Type Parameters * `T` - The type of the annotation value. ### GetComplexType Gets a complex type by its fully qualified name. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmComplexType GetComplexType(string fullName) ``` #### Parameters | Name | Type | Description | | - | - | - | | `fullName` | `string` | The fully qualified name of the complex type (namespace.name). | #### Returns Type: `Microsoft.OData.Mcp.Core.Models.EdmComplexType?` The complex type with the specified name, or `null` if not found. ### GetComplexType Gets a complex type by name and namespace. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmComplexType GetComplexType(string name, string namespace) ``` #### Parameters | Name | Type | Description | | - | - | - | | `name` | `string` | The name of the complex type. | | `namespace` | `string` | The namespace of the complex type. | #### Returns Type: `Microsoft.OData.Mcp.Core.Models.EdmComplexType?` The complex type with the specified name and namespace, or `null` if not found. ### GetEntityContainer Gets an entity container by its fully qualified name. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmEntityContainer GetEntityContainer(string fullName) ``` #### Parameters | Name | Type | Description | | - | - | - | | `fullName` | `string` | The fully qualified name of the entity container (namespace.name). | #### Returns Type: `Microsoft.OData.Mcp.Core.Models.EdmEntityContainer?` The entity container with the specified name, or `null` if not found. ### GetEntityContainer Gets an entity container by name and namespace. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmEntityContainer GetEntityContainer(string name, string namespace) ``` #### Parameters | Name | Type | Description | | - | - | - | | `name` | `string` | The name of the entity container. | | `namespace` | `string` | The namespace of the entity container. | #### Returns Type: `Microsoft.OData.Mcp.Core.Models.EdmEntityContainer?` The entity container with the specified name and namespace, or `null` if not found. ### GetEntitySet Gets an entity set by name from any entity container. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmEntitySet GetEntitySet(string entitySetName) ``` #### Parameters | Name | Type | Description | | - | - | - | | `entitySetName` | `string` | The name of the entity set. | #### Returns Type: `Microsoft.OData.Mcp.Core.Models.EdmEntitySet?` The entity set with the specified name, or `null` if not found. ### GetEntityType Gets an entity type by its fully qualified name. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmEntityType GetEntityType(string fullName) ``` #### Parameters | Name | Type | Description | | - | - | - | | `fullName` | `string` | The fully qualified name of the entity type (namespace.name). | #### Returns Type: `Microsoft.OData.Mcp.Core.Models.EdmEntityType?` The entity type with the specified name, or `null` if not found. ### GetEntityType Gets an entity type by name and namespace. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmEntityType GetEntityType(string name, string namespace) ``` #### Parameters | Name | Type | Description | | - | - | - | | `name` | `string` | The name of the entity type. | | `namespace` | `string` | The namespace of the entity type. | #### Returns Type: `Microsoft.OData.Mcp.Core.Models.EdmEntityType?` The entity type with the specified name and namespace, or `null` if not found. ### GetEnumType Gets an enumeration type by its fully qualified name. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmEnumType GetEnumType(string fullName) ``` #### Parameters | Name | Type | Description | | - | - | - | | `fullName` | `string` | The fully qualified name of the enumeration type (namespace.name). | #### Returns Type: `Microsoft.OData.Mcp.Core.Models.EdmEnumType?` The enumeration type with the specified name, or `null` if not found. ### GetEnumType Gets an enumeration type by name and namespace. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmEnumType GetEnumType(string name, string namespace) ``` #### Parameters | Name | Type | Description | | - | - | - | | `name` | `string` | The name of the enumeration type. | | `namespace` | `string` | The namespace of the enumeration type. | #### Returns Type: `Microsoft.OData.Mcp.Core.Models.EdmEnumType?` The enumeration type with the specified name and namespace, or `null` if not found. ### GetHashCode Inherited Virtual > [!NOTE] > > Inherited from `object` #### Syntax ```csharp theme={null} public virtual int GetHashCode() ``` #### Returns Type: `int` ### GetSingleton Gets a singleton by name from any entity container. #### Syntax ```csharp theme={null} public Microsoft.OData.Mcp.Core.Models.EdmSingleton GetSingleton(string singletonName) ``` #### Parameters | Name | Type | Description | | - | - | - | | `singletonName` | `string` | The name of the singleton. | #### Returns Type: `Microsoft.OData.Mcp.Core.Models.EdmSingleton?` The singleton with the specified name, or `null` if not found. ### GetType Inherited > [!NOTE] > > Inherited from `object` #### Syntax ```csharp theme={null} public System.Type GetType() ``` #### Returns Type: `System.Type` ### MemberwiseClone Inherited > [!NOTE] > > Inherited from `object` #### Syntax ```csharp theme={null} protected internal object MemberwiseClone() ``` #### Returns Type: `object` ### ReferenceEquals Inherited > [!NOTE] > > Inherited from `object` #### Syntax ```csharp theme={null} public static bool ReferenceEquals(object objA, object objB) ``` #### Parameters | Name | Type | Description | | - | - | - | | `objA` | `object?` | - | | `objB` | `object?` | - | #### Returns Type: `bool` ### ToString Override Returns a string representation of the model. #### Syntax ```csharp theme={null} public override string ToString() ``` #### Returns Type: `string` A summary of the model contents. ### ToString Inherited Virtual > [!NOTE] > > Inherited from `object` #### Syntax ```csharp theme={null} public virtual string ToString() ``` #### Returns Type: `string?` ### Validate Validates the model for consistency and completeness. #### Syntax ```csharp theme={null} public System.Collections.Generic.IEnumerable Validate() ``` #### Returns Type: `System.Collections.Generic.IEnumerable` A collection of validation errors, or an empty collection if the model is valid. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.