Microsoft.Xrm.Sdk Notification event that a failover has completed and the organization’s current endpoint has been switched to an alternate endpoint. Disaster recovery in Microsoft Dynamics 365 (online) Notification event that a failover has occurred and a switch from the organization’s current endpoint to an alternate endpoint is required. This event is fired during execution of a web service call and only if an alternate endpoint exists. Disaster recovery in Microsoft Dynamics 365 (online) Occurs when a service channel transitions into the closed state. Occurs when a service channel transitions into the faulted state. Occurs when a service channel transitions into the opened state. Occurs when a failover recovery has completed and the organization’s current endpoint has been switched to an alternate endpoint. public event EventHandler<EndpointSwitchEventArgs> EndpointSwitched Public Event EndpointSwitched As EventHandler<EndpointSwitchEventArgs> Disaster recovery in Microsoft Dynamics 365 (online) Occurs when a failover has occurred and a switch from the organization’s current endpoint to an alternate endpoint is required. This event is fired during execution of a web service call and only if an alternate endpoint exists. Disaster recovery in Microsoft Dynamics 365 (online) Occurs when a channel factory is closed. Occurs when a channel factory is faulted. Occurs when a channel factory is opened. An entity logical name claim. Value = http://schemas.microsoft.com/xrm/2011/Claims/EntityLogicalName An initiating user claim. Value = http://schemas.microsoft.com/xrm/2011/Claims/InitiatingUser An organization claim. Value = http://schemas.microsoft.com/xrm/2011/Claims/Organization A plug-in assembly claim. Value = http://schemas.microsoft.com/xrm/2011/Claims/PluginAssembly A plug-in publisher claim. Value = http://schemas.microsoft.com/xrm/2011/Claims/PluginPublisher A request name claim. Value = http://schemas.microsoft.com/xrm/2011/Claims/RequestName A security token claim. Value = http://schemas.microsoft.com/xrm/2011/Claims/SecurityToken A user claim. Value = http://schemas.microsoft.com/xrm/2011/Claims/User Converts UTC value to a DateOnly value that the user who created the record would see in the UI. Converts UTC value to a DateOnly value that the user who last updated the record would see in the UI. Converts UTC value to a DateOnly value that the user who owns the record would see in the UI. Converts UTC value to a DateOnly value as per the time zone code specified in the . parameter. The action is allowed. Value = 4. The action is not allowed. Value = 0. An attribute type that stores a value. An attribute type that stores a value. An attribute type that stores an or value An attribute type that stores an to either an Account or Contact. An attribute type that stores a value. An attribute type that stores a value. An attribute type that stores a value. An attribute type that stores a reference to a logical entity name value. An attribute type that enables access to a specific image for an entity instance. An attribute type that stores an value. An attribute type that stores an value. An attribute type that stores a value. An attribute type that stores a value formatted for multiple lines of text. An attribute type that stores a value. An attribute type that stores an value to a Team or SystemUser record. An attribute type that stores an or value. An attribute type that stores an . An attribute type that stores an representing the valid statecode values for an entity. An attribute type that stores an representing the valid statuscode values for an entity. An attribute type that stores a String value. An attribute type that stores a value. An attribute type that represents a value not included within records. The maximum supported value for this attribute is 9223372036854775807. The minimum supported value for this attribute is -9223372036854775808. Stores the date value with the time value as 12:00 AM (00:00:00) without the time zone information. Value = 2. Stores the date and time values without the time zone information. Value = 3. Stores the date and time value with current user local time zone information. Value = 1. The maximum supported value for Precision is 10. The maximum supported value is 100 Billion. The minimum supported value for Precision is 0. The minimum supported value is -100 Billion. The maximum supported value for Precision is 5. The maximum supported value is 100 billion. The minimum supported value for Precision is 0. The minimum supported value is -100 billion. The maximum supported value is 2147483647. The minimum supported value is -2147483648. For internal use only. The maximum supported length is 1048576. The minimum supported length is 1. The maximum supported precision for this attribute is 4. The maximum supported value for this attribute is 922337000000000. The minimum supported precision for this attribute is 0. The minimum supported value for this attribute is -922337000000000. The maximum supported length is 4000 characters. The minimum supported length is 1 character. Specifies to display the as an email address. Specifies to display the as an phone number. Specifies to display the as an phonetic guide. Specifies to display the as text. Specifies to display the as a text area. Specifies to display the as a ticker symbol. Specifies to display the as a URL. Specifies to display the as a version number. Initializes a new instance of the class. Initializes a new instance of the class. Type: String. The name of the entity the attribute belongs to. Type: String. The attribute on which the aggregate, group by, or select operation was performed. Type: Object. The value returned by the query. Initializes a new instance of the class. Initializes a new instance of the class Type: String. The logical name of an attribute. Initializes a new instance of the class. Initializes a new instance of the class setting the attribute Id, and whether it is valid to create, read and update the attribute value. Type: Guid. The attribute ID. Type: Int32. Whether the attribute value can be specified on create. Type: Int32. Whether the attribute value can be read. Type: Int32. Whether the attribute value can be updated. Initializes a new instance of the class. Initializes a new instance of the class, setting the list property. Type: IList<>. The list of attribute privileges. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class Type: Boolean. true if the value is true; otherwise, false. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Specifies the collection of entity changes. Initializes a new instance of the class. Type: . Specifies an organization service object. Type: Guid. Specifies the ID of the user that owns any data changes made by a call to the service. Disposes the object. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class using a message. Type: String. The message describing the event. Initializes a new instance of the class using an exception. Type: Exception. An exception or . Initializes a new instance of the class using message and an exception. Type: String. A message describing the event. Type: Exception. An exception or . Initializes a new instance of the class. Initializes a new instance of the class using a service configuration and a security token response. Type: . A service configuration. Type: . A security token response. Initializes a new instance of the class using a service configuration and client credentials. Type: . A service configuration. Type: ClientCredentials. The logon credentials of the client. ClientCredentials Classhttp://msdn.microsoft.com/en-us/library/system.servicemodel.description.clientcredentials.aspx Initializes a new instance of the class using a service management and a security token response. Type: . A service management. Type: . A security token response. Initializes a new instance of the class using a service management and client credentials. Type: . A service management. Type: ClientCredentials. The logon credentials of the client. ClientCredentials Classhttp://msdn.microsoft.com/en-us/library/system.servicemodel.description.clientcredentials.aspx Initializes a new instance of the class using a discovery service URI, home realm URI, and client and device credentials. Type: URI. The URI of the discovery service. Type: URI. This parameter is set to a non-null value when a second ADFS instance is configured as an identity provider to the ADFS instance that Microsoft Dynamics CRM 2011 has been configured with for claims authentication. The parameter value is the URI of the WS-Trust metadata endpoint of the second ADFS instance. Type: ClientCredentials. The logon credentials of the client. Type: ClientCredentials. The Microsoft account device credentials. ClientCredentials Classhttp://msdn.microsoft.com/en-us/library/system.servicemodel.description.clientcredentials.aspxHelper code: DeviceIdManager class See . Type: . A discovery service request. Type: The response from executing the discovery service request. For more information about the exceptions that can be thrown when calling the Execute method, see Handle exceptions in your code. Initializes a new instance of the class. Type: String. The logical name of the entity Initializes a new instance of the class. Initializes an instance of the class. Initializes a new instance of the class. Checks if the specified endpoint URI is different from the organization’s alternate endpoint URI. Type: URI. Specifies an endpoint URI. Type: Boolean if the two URIs are different and an endpoint switch can be attempted, otherwise . Fires the event, then if is , switches the organization’s endpoints by calling . Type: Boolean if the endpoint switch was successful, otherwise . Switches the organization’s current endpoint to an alternate endpoint. When an organization is provisioned for disaster recovery failover, that organization has a primary endpoint and an alternate endpoint. If the current endpoint in use for the organization is the primary endpoint, calling switches the current endpoint to the alternate endpoint. Conversely, if the current endpoint for the organization is the alternate endpoint, calling switches the current endpoint to the primary endpoint. Authenticates against the trusted Microsoft Dynamics 365 Secure Token Service using a security token. Type: SecurityToken. A security token retrieved from an identity provider other than the trusted Microsoft Dynamics 365 Secure Token Service (when in federation mode). Type: The security token response. Authenticates against the trusted Microsoft Dynamics 365 Secure Token Service using client credentials. Type: ClientCredentials. Specifies a client credential instance containing either Windows credentials or UserName credentials. Type: The security token response. Returns when the service is in Active Directory mode. A non-null value is returned when in federated mode. Authenticates against Microsoft account using client credentials and a security token response. Type: ClientCredentials. Specifies a client credential instance containing UserName credentials where the UserName and Password properties are set. Type: . A security token response received from authenticating the user's device with Microsoft account. Type: The security token response. Authenticates against a remote Secure Token Service (STS) using a security token retrieved from an identity provider (when in federation mode). Type: SecurityToken. Specifies a security token issued from an identity provider. Type: String. Specifies the identifier of the STS to authenticate on behalf of. Type: URI. Specifies the URI of the cross realm STS metadata endpoint. Type: The security token response. Authenticates against a remote Secure Token Service (STS) using client credentials. Type: ClientCredentials. Specifies a client credentials instance with the credentials or the ( and ) set. Type: String. Specifies the identifier of the STS to authenticate on behalf of. Type: URI. Specifies the URI of the cross realm STS metadata endpoint. Type: The security token response. Authenticates a registered device against Microsoft account. Type: ClientCredentials. Specifies a client credential instance. Type: The security token response. The UserName. and UserName. properties of the credential must be populated with a device name and password. Helper code: DeviceIdManager class Creates a client factory that uses the default Kerberos credentials. Type: ChannelFactory<TService>The channel factory. Creates a WCF channel factory with a specified type of authentication. Type: . Specifies the type of authentication. Type: ChannelFactory<TService>The channel factory. When is specified, you can later call the following method when creating a channel. channelFactory.CreateChannelWithIssuedToken(SecurityToken) For internal use only. Type: . Creates a WCF channel factory that supports passing the client credentials, regardless of whether in federation authentication mode or not. Type: ClientCredentials. Specifies client authentication credentials. Type: ChannelFactory< TService>The channel factory. Windows and UserName credentials are currently supported. Returns the identity provider used for a specified user when accessing a service. Type: String. Specifies a user principal name (UPN). Type: The identity provider. Authenticates the logged on user with the service. Type: . Specifies the user’s logon credentials. Type: The user’s authentication credentials, including the final security token. Creates a WCF channel factory that uses the default Kerberos credentials. Type: ChannelFactory<TService> where TService: or The WCF channel factory. Creates a WCF channel factory with a specified type of authentication. Type: . Specifies the type of authentication. Type: ChannelFactory<TService> where TService: or The WCF channel factory. When is specified, you can later call the following method when creating a channel. channelFactory.CreateChannelWithIssuedToken(SecurityToken) For internal use only. Type: . Creates a WCF channel factory using specified client credentials. Type: ClientCredentials. Specifies the client credentials to use. Type: ChannelFactory<TService> where TService: or The WCF channel factory. Returns the identity provider used for a specified user when accessing a service. Type: String. Specifies a user principal name (UPN). Type: The identity provider used for a specified user when accessing a service. Initializes a new instance of the class. Initializes a new instance of the class. Obtains the issuer endpoint from a Secure Token Service. Type: . Specifies the credential type used by the issuer endpoint. Type: The issuer endpoint from a Secure Token Service. Initializes a new instance of the class. Initializes a new instance of the class. Creates a new instance of the class. Type: . The service that provides access to organization data. Adds the specified link to the set of objects the is tracking. Type: . The source entity for the new link. Type: . The navigation property or attribute on the source object that returns the related object. Type: . The entity related to the source entity by the new link. Notifies the that a new link exists between the related source and target objects and that the link is represented by the specified entity attribute or navigation property. The adds this link to the set of newly created links that are sent to the Web service on the next call to method.Links are one-way relationships. Because associations are bi-directional, in a one-to-one association you must call again to create the reverse link. Adds the specified entity to the set of entities that the is tracking. Type: . The entity to be tracked by the . The entity is put into the tracking set of the in the state. The will attempt to insert the entity into the CRM on the next call to the . This method does not add entities related to the specified entity to the . Each object must be added through a separate call to . The method does not validate that the entity set specified is in the Web service associated with the or that the added entity has the required attributes needed to be added to the specified entity set. Adds a related entity to the and creates the link that defines the relationship between the two entities in a single request. Type: . The parent entity that is being tracked by the context. Type: . The name of the attribute or navigation property that returns the related object based on an association between the two entities. Type: . The related object that is being added. This method essentially works by calling and . Notifies the to start tracking the specified entity. Type: . The entity to be tracked. If the entity is part of an object graph, this operation does not traverse the graph to add related objects. It is a shallow operation.The method does not validate whether the specified entity set occurs in the Web service associated with the . Notifies the to start tracking the specified link that defines a relationship between entity objects. Type: . The source entity in the new link. Type: . The name of the attribute or navigation property on the source object that represents the link between the source and target object. Type: . The target entity in the link that is bound to the source entity specified in this call. Clears all tracking of entities by the . Creates a web service .NET Language-Integrated Query (LINQ) query for the specified entity. Type: String. The logical name of the entity to be queried. Type: IQueryable<>.The query of the specified entity. Creates a Web service .NET Language-Integrated Query (LINQ) query for the specified entity. Type: . The entity to be queried. Type: IQueryable<>The query of the specified entity. Creates a web service .NET Language-Integrated Query (LINQ) query for the specified entity. Type: IQueryProvider. The provider of the Web service. Type: String. The logical name of the entity to be queried. Type: . The entity to be queried. Type: IQueryable<>The query of the specified entity type.. Changes the state of the link to deleted in the list of links being tracked by the . Type: . The source entity in the link to be marked for deletion. Type: . The name of the attribute or navigation property on the source entity that is used to access the target entity. Type: . The target entity involved in the link that is bound to the source entity. Changes the state of the specified entity to be deleted in the . Type: . The tracked entity to be changed to the deleted state. All links to the specified entity are also marked deleted. Changes the state of the specified entity to be deleted in the . Type: . The tracked entity to be changed to the deleted state. Type: Boolean. to specify entities to be deleted recursively, otherwise . All links to the specified entity are also marked deleted. Removes the entity from the set of entities that the is tracking. Type: . The entity to be removed from the set of entities that the is tracking. Type: Boolean. if the specified entity was detached; otherwise . Once an object is detached, it is no longer tracked by the . The Detach method can be called to detach any object, regardless of its state in the context.After detaching the specified entity, this method also detaches any links related to the entity. Removes the entity from the set of entities that the is tracking. Type: . The entity to be removed from the set of entities that the is tracking. Type: Boolean. to specify entities to be detached recursively, otherwise . Type: Boolean. Returns if the specified entity was detached; otherwise . Once an object is detached, it is no longer tracked by the . The Detach method can be called to detach any object, regardless of its state in the context. After detaching the specified entity, this method also detaches any links related to the entity. Removes the specified link from the list of links being tracked by the . Type: . The source entity participating in the link to be marked for deletion. Type: . The name of the attribute or navigation property on the source entity that represents the source in the link between the source and the target. Type: . The target entity involved in the link that is bound to the source object. Type: Boolean. if the specified entity was detached; otherwise . Any link being tracked by the , regardless of its current state, can be detached. Disposes of the service context. IDisposable.Dispose Methodhttp://msdn.microsoft.com/en-us/library/system.idisposable.dispose(VS.100).aspx Disposes of the service context. Type: Boolean. IDisposable.Dispose Methodhttp://msdn.microsoft.com/en-us/library/system.idisposable.dispose(VS.100).aspx Executes a message in the form of a request, and returns a response. Type: . The request to be sent. Type: . The response returned from processing the organization request. For more information see the method. Use messages (request and response classes) with the Execute method Destructor for the class. Refer to the .NET method. Object.Finalize Methodhttp://msdn.microsoft.com/en-us/library/system.object.finalize.aspx Gets an enumerable collection of the entities attached to the . Type: IEnumerable<>. Determines whether an entity is attached and therefore being tracked by the . Type: . The entity to be determined if it is attached. Type: Boolean. if the specified entity is attached to the ; otherwise, . Determines whether an entity relationship is attached and therefore being tracked by the . Type: . The source entity in the link. Type: . The name of the attribute or navigation property on the source entity that represents the link between the source and target entity. Type: . The target entity in the link. Type: Boolean. if the specified entity is attached to the ; otherwise, . Determines whether an entity has been deleted. Type: . The entity to be determined if it is deleted. Type: Boolean. if the specified entity is deleted; otherwise, . Determines whether a relationship has been deleted. Type: . The source entity in the link. Type: . The name of the attribute or navigation property on the source entity that represents the link between the source and target entity. Type: . The target entity in the link. Type: Boolean. if the specified entity is deleted; otherwise, . Loads the related entity collection for the specified relationshp. Type: . The entity with the relationship to be loaded. Type: . The name of the attribute or navigation property on the entity that represents the relationship to be retrieved. Calling this method invokes a network operation to retrieve the property value. The property specified may be any one of the properties on the entity, including properties that represent associations or links.If the property represents an association, link or deferred property, calling this method provides the client a way to lazily load related resources. If the entity is in the unchanged or modified state, the property value loads the related entities and marks them unchanged with unchanged links. If the property is already loaded, calling this method lets you refresh the value of the property. Loads deferred content for a specified property from the Web service. Type: . The entity that contains the property to load. Type: String. The name of the property of the specified entity to load. Calling this method invokes a network operation to retrieve the property value. The property specified may be any one of the properties on the entity, including properties that represent associations or links.If the property represents an association, link or deferred property, calling this method provides the client a way to lazily load related resources. If the entity is in the unchanged or modified state, the property value loads the related entities and marks them unchanged with unchanged links. If the property is already loaded, calling this method lets you refresh the value of the property. Virtual (Overridable) method called when entity tracking begins. Type: . The entity to be tracked by the . Virtual (Overridable) method called when link tracking begins. Type: . The navigation property or attribute on the source object that returns the related object. Type: . The name of the attribute or navigation property on the source object that represents the link between the source and target object. Type: . The target entity in the link that is bound to the source entity specified in this call. Virtual (Overridable) method called after entity tracking ends. Type: . The entity to be tracked by the . Virtual (Overridable) method called after link tracking ends. Type: . The navigation property or attribute on the source object that returns the related object. Type: . The name of the attribute or navigation property on the source object that represents the link between the source and target object. Type: . The target entity in the link that is bound to the source entity specified in this call. Virtual (Overridable) method called after is called and before a response is returned. Type: . The request being processed. Type: . The response that is to be returned from processing the request. is called by . Virtual (Overridable) method called after is called and before an exception is re-thrown. Type: . The request being processed. Type: Exception. The exception thrown from processing the request. is called by . Virtual (Overridable) method called before is called. Type: . The request being processed. is called by . Virtual (Overridable) method called after an attempt to save data changes. Type: . The results of the save changes operation. If saving of changes fails, this method is called before an exception is thrown. Virtual (Overridable) method called before an attempt to save changes is performed. Type: . Save changes options. Saves the changes that the is tracking to Microsoft Dynamics 365. Type: A that contains status, headers, and errors that result from the call to . Saves the changes that the is tracking to Microsoft Dynamics 365. Type: . Indicates how changes are saved. Type: A that contains status, headers, and errors that result from the call to . Changes the state of the specified entity in the to . Type: . The tracked entity to be assigned to the state. Changes the state of the specified entity in the to . Type: . The tracked entity to be assigned to the state. Type: Boolean. if operation should be recursive; otherwise . Initializes a new instance of the class using a service configuration and a security token response. Type: <>. A service configuration. Type: . A security token response. Initializes a new instance of the class using a service configuration and client credentials. Type: <>. A service configuration. Type: ClientCredentials. The logon credentials of the client. Initializes a new instance of the class using a service management and a security token response. Type: <>. A service management. Type: . A security token response. Initializes a new instance of the class using a service configuration and client credentials. Type: <>. A service management. Type: ClientCredentials. The logon credentials of the client. Initializes a new instance of the class using a organization service URI, home realm URI, and client and device credentials. Type: URI. The URI of the organization service. Type: URI. This parameter is set to a non-null value when a second ADFS instance is configured as an identity provider to the ADFS instance that Microsoft Dynamics CRM 2011 has been configured with for claims authentication. The parameter value is the URI of the WS-Trust metadata endpoint of the second ADFS instance. Type: ClientCredentials. The logon credentials of the client. Type: ClientCredentials. The Windows Live ID device credentials. Helper code: DeviceIdManager class Creates a link between records. Type: String. The logical name of the entity specified in the parameter. Type: Guid. The ID of the record to which the related records will be associated. Type: . The name of the relationship to be used to create the link. Type: . A collection of entity references (references to records) to be associated. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadataEntity metadataCustomize entity relationship metadata For internal use only. Creates a record. Type: . An entity instance that contains the properties to set in the newly created record. Type: GuidThe ID of the created entity. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadata For internal use only. Type: GuidThe ID of the created entity. Deletes a record. Type: String. The logical name of the entity specified in the parameter. Type: Guid. The ID of the record of the record to delete. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadata For internal use only. Deletes a link between records. Type: String. The logical name of the entity specified in the parameter. Type: Guid. The ID of the record from which the related records will be disassociated. Type: . The name of the relationship to be used to remove the link. Type: . A collection of entity references (references to records) to be disassociated. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadata For internal use only. Enables support for the early-bound entity types. Enables support for the early-bound entity types exposed in a specified assembly. Type: Assembly. An assembly containing early-bound entity types. Executes a message in the form of a request, and returns a response. Type: . An instance of a request class that defines the action to be performed. Type: . You must cast the return value of this method to the specific instance of the response that corresponds to the parameter. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadataUse messages (request and response classes) with the Execute method For internal use only. Type: . Retrieves a record. Type: String. The logical name of the entity specified in the parameter. Type: Guid. The ID of the record you want to retrieve. Type: . A query that specifies the set of columns, or attributes, to retrieve. Type: .The requested entity. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadata For internal use only. Type: . Retrieves a collection of records. Type: . A query that determines the set of records to retrieve. Type: .A collection of entity records. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadataRetrieve data with queries using SDK assemblies For internal use only. Type: . Updates an existing record. Type: . An entity instance that has one or more properties set to be updated in the record. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadata For internal use only. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class using an assembly containing proxy types generated by the CrmSvcUtil utility. Type: Assembly. An assembly containing proxy types. Create early bound entity classes with the code generation tool (CrmSvcUtil.exe) Refer to the IEndpointBehavior Interface. Type: ServiceEndpoint. A service endpoint. Type: BindingParameterCollection. A collection of binding parameters that store information used by binding elements to build factories. Refer to the IEndpointBehavior Interface. Type: ServiceEndpoint. A service endpoint. Type: ClientRuntime. The insertion point for classes that extend the functionality of Windows Communication Foundation (WCF) client objects. Refer to the IEndpointBehavior Interface. Type: ServiceEndpoint. A service endpoint. Type: EndpointDispatcher. The run-time object that exposes properties that enable the insertion of run-time extensions or modifications for messages in service applications. Refer to the IEndpointBehavior Interface. Type: ServiceEndpoint. A service endpoint. For internal use only. Initializes a new instance of the class. Type: String. Specifies the name of the message request. Initializes a new instance of the class. Type: String. Specifies the name of the message response. Initializes a new instance of the class. Initializes a new instance of the class using a channel factory. For internal use only. Type: ChannelFactory. A channel factory. Causes a service channel to transition immediately from its current state into the closing state. Causes a service channel to transition from its current state into the closed state. Creates a new WCF channel. Type: IOutputChannel or IRequestChannelThe new WCF channel associated with the service channel. The new channel is in the created state. Disposes the service channel. Finalizes the service channel. Inserts processing on a service channel after it transitions to the closing state due to the invocation of a synchronous close operation. Type: . Channel event arguments. Inserts processing on a service channel after it transitions to the faulted state due to the invocation of a synchronous operation. Type: . Channel faulted event arguments. Inserts processing on a service channel after it transitions into the opening state which must complete within a specified interval of time. Type: . Channel event arguments. Causes a service channel to transition from the created state into the opened state. Creates a service configuration. Specifies the service’s URI. Specifies a Microsoft Dynamics 365 service type: or . Type: A service configuration object. Creates a service configuration Specifies the web service’s URI. True to enable proxy types; otherwise, False. An assembly containing proxy types. Specifies a Microsoft Dynamics 365 service type: or . Type: A service configuration object. Create early bound entity classes with the code generation tool (CrmSvcUtil.exe) Creates a service management. Specifies the service’s URI. Specifies a Microsoft Dynamics 365 service type: or . Type: A service management object. Creates a service management. Specifies the service’s URI. True to enable proxy types; otherwise, False. An assembly containing proxy types. Specifies a Microsoft Dynamics 365 service type: or . Type: A service management object. Create early bound entity classes with the code generation tool (CrmSvcUtil.exe) Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class using a service configuration and security token response. Type: . A service configuration. Type: . A security token response. Use this constructor when the service configuration and security token have been acquired externally and only when claims-based authentication is configured. Do not call the method after instantiating a derived object using this constructor. Initializes a new instance of the class using a service configuration and client logon credentials. Type: . A service configuration. Type: ClientCredentials. The logon credentials of the client. Use this constructor when the service configuration has been acquired externally, and Windows-based authentication is in use. Do not call the method after instantiating a derived object using this constructor. Initializes a new instance of the class using a service management and security token response. Type: . A service management. Type: . A security token response. Initializes a new instance of the class using a service management and client logon credentials. Type: . A service management. Type: ClientCredentials. The logon credentials of the client. Initializes a new instance of the class using a service URI, a home realm URI, client logon credentials, and Windows Live device credentials. Type: URI. The URI of the service. Type: URI. The URI of the WS-Trust metadata endpoint of a second ADFS instance. Type: ClientCredentials. The client’s logon credentials. Type: ClientCredentials. The credentials of a device registered with Windows Live. Only required when authenticating with Microsoft Dynamics 365 (online), otherwise use . The home realm parameter is set to a non-null value when a second ADFS instance is configured as an identity provider to the ADFS instance that Microsoft Dynamics CRM 2011 has been configured with for claims authentication. Helper code: DeviceIdManager class Closes the service channel and channel factory if they are open, and then invokes . Authenticates the client with a service. When using claims-based authentication, a new security token is requested by this method invocation. The must be set prior to calling this method. Invokes . Type: A security token response. Authenticates a user in a realm other than the realm that the Microsoft Dynamics 365 server is located in. Type: A security token response. This method will attempt to authenticate the home realm, then use the corresponding security token to authenticate to the Microsoft Dynamics 365 realm STS (Security Token Service). In addition to the normal client credential requirements, the constructor parameter is expected to be set in the call to the constructor. The returned should be the security token that can be used to authenticate against the Microsoft Dynamics 365 server realm STS. This method may be overridden in the case that home realm authentication requires multiple hops, which is not supported by this call. and must be set prior to calling this method. Invokes . Type: A security token response. Authenticates a device with Windows Live. Type: A security token response. The must be set prior to this method being called. Closes a validated service channel. Type: Boolean. true if the service channel should be forced to close; otherwise, false. Custom implementation of that disposes the service channel and channel factory. IDisposable.Dispose Methodhttp://msdn.microsoft.com/en-us/library/system.idisposable.dispose.aspx Custom implementation of that disposes the service channel and channel factory. Type: Boolean. IDisposable.Dispose Methodhttp://msdn.microsoft.com/en-us/library/system.idisposable.dispose.aspx Implicitly frees allocated service channel and service factory resources. Object.Finalize Methodhttp://msdn.microsoft.com/en-us/library/system.object.finalize.aspx For internal use only. For internal use only. Event handler virtual method for a channel factory that is in a closed state. Type: . Channel events arguments. Event handler virtual method for a channel factory that is in a faulted state. Type: . Faulted channel event arguments. Event handler virtual method for a channel factory that is in an opened state. Type: . Channel event arguments. The maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding. Type: Binding. The target channel binding. Type: TimeSpan.A send operation timespan. Type: TimeSpan. An open operation timespan. Type: TimeSpan.A close operation timespan. Checks a message security exception to determine if a service call should be attempted again. Type: MessageSecurityException. The exception to check. Type: Nullable<Boolean>. null if this is the first time the check is performed; otherwise, this is the second time and a retry should not be performed. Type: Nullable<Boolean>true if the service call should be tried again; otherwise, false or null. This particular type of exception occurs in Active Directory environments or sometimes when Internet Information Services (IIS) is reset. Switches the organization’s current endpoint to an alternate endpoint, if one is available. Type: Booleantrue if the switch was successful; otherwise, false. When an organization is provisioned for disaster recovery failover, that organization has a primary endpoint and an alternate endpoint. If the current endpoint in use for the organization is the primary endpoint, calling switches the current endpoint to the alternate endpoint. Conversely, if the current endpoint for the organization is the alternate endpoint, calling switches the current endpoint to the primary endpoint. Disaster recovery in Microsoft Dynamics 365 (online) Authenticates the client and creates a new service channel. If the property is set to false, the method is invoked. If the property is set to null, a new service channel is created. Initializes a new instance of the class. Adds the elements of the specified collection to the end of the . Type: T[]. The array whose elements should be added to the end of the . The array itself cannot be null, but it can contain elements that are null, if type is a reference type. This method extends the base Collection class to add List. functionality. Adds the elements of the specified collection to the end of the . Type: IEnumerable<T>. The collection whose elements should be added to the end of the . The collection itself cannot be null, but it can contain elements that are null, if type is a reference type. This method extends the base Collection class to add List. functionality. Copies the elements of the to a new array. Type: Type[] An array containing copies of the elements of the . This method extends the base Collection class to add List. functionality. Initializes a new instance of the class. Adds the specified key and value to the dictionary. Type: TKey. The key of the element to add. Type: TValue. The value of the element to add. Adds the specified key and value to the dictionary. Type: KeyValuePair<TKey, TValue>. The key and value to add. Adds the elements of the specified collection to the end of the . Type: IEnumerable<KeyValuePair<TKey, TValue>>. The collection whose elements should be added to the end of the . The collection itself cannot be null, but it can contain elements that are null, if type is a reference type. Adds the elements of the specified collection to the end of the . Type: KeyValuePair<TKey, TValue>[]. The array whose elements should be added to the end of the . The array itself cannot be null, but it can contain elements that are null, if type is a reference type. Removes all items from the . Determines whether the contains a specific value. Type: TKey. The key to locate in the collection. Type: Booleantrue if item is found in the ; otherwise, false. Determines whether the contains a specific value. Type: KeyValuePair<TKey, TValue>. The key value pair to locate in the collection. Type: Booleantrue if item is found in the ; otherwise, false. Determines whether the contains a specific key value. Type: TKey. The key to locate in the collection. Type: Booleantrue if item is found in the ; otherwise, false. Type: KeyValuePair<TKey, TValue>[]. The Type: Int32. Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array. Returns an enumerator that iterates through a collection. Type: IEnumerator<KeyValuePair<TKey, TValue>> An IEnumerator object that can be used to iterate through the collection. Removes the first occurrence of a specific object from the . Type: TKey. The object to remove from the . Type: Booleantrue if the object was found and removed; otherwise, false. Removes the first occurrence of a specific object from the . Type: KeyValuePair<TKey, TValue>. The object to remove from the . Type: Booleantrue if the object was found and removed; otherwise, false. Returns an enumerator that iterates through the collection. Type: IEnumerator An IEnumerator object that can be used to iterate through the collection. Gets the value associated with the specified key. Type: TKey. The key of the value to get. Type: TValue%. When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized. Type: Booleantrue if the contains an element with the specified key; otherwise, false. Initializes a new instance of the class. Determines whether the specified instance of is equal to the current instance. The instance to compare with the current instance. Returns Boolean if the specified instance of is equal to the current instance. Otherwise, . Returns a hash code for this instance. Returns Int32The hash code for this instance. Indicates whether two instances are equal. Type: . Specifies a . Type: . Specifies a . Returns Boolean if the values of conversionRuleA and conversionRuleB are equal; otherwise, . Converts a string into a Type String. Specifies a . Returns A that represents the converted String. Indicates whether two instances are not equal. Type . Specifies a . Type . Specifies a . Returns if the values of conversionRuleA and conversionRuleB are not equal; otherwise, . Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Executes a discovery service message in the form of a request, and returns a response. Type: . A request instance that defines the action to be performed. Type: . The response from processing the request. You must cast the return value of this method to the specific instance of the response that corresponds to the Request parameter. Privileges and Access Rights To execute a message, the caller must have a system user account on the Microsoft Dynamics 365 server. Method Availability This method works only when connected to the server. Discovery service messages (request and response classes)Sample: Access the Discovery serviceHandle exceptions in your code Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class setting the entity name. Type: String. The name of the entity. Initializes a new instance of the class. This was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Specifies the entity name. Specifies the key attributes. This was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Initializes a new instance of the class. This was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Specifies the entity name. Specifies the ID of the record. This was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Initializes a new instance of the class. This was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Specifies the entity name. Specifies the key name. Specifies the key value. This was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Checks to see if there is a value present for the specified attribute. Type: String. The logical name of the attribute. Type: Booleantrue if the contains an attribute with the specified name; otherwise, false. Gets the value of the attribute. Type: String. The logical name of the attribute. Type: Type. The type of the attribute. Type: Type The value of the attribute. When an entity instance does not include the attribute specified using the attributeLogicalName parameter this method will return null rather than throw an exception. You should not assume that the entity includes the attribute. It may not be included if the code that retrieved the attribute didn’t request it. You can use . to check whether the entity instance includes the attribute. GetAttributeValue<EntityReference>("regardingobjectid") Blog Post: Entity.GetAttributeValue<T> Explainedhttp://crmentropy.blogspot.com/2013/08/entitygetattributevalue-explained.html Gets the formatted value of the attribute. Type: String. The logical name of the attribute. Type: String The formatted value of the attribute. Gets the collection of related entity instances for the specified relationship. Type: String. The schema name of the relationship. The role of the primary entity in the relationship (referenced or referencing). Type: . The type of the entity. Type: IEnumerableThe collection of related entity instances for the specified relationship. GetRelatedEntities<CampaignResponse>("activity_pointer_campaignresponse", null); Gets the related entity instance for the specified relationship. Type: String. The name of the relationship. Type: . The role of the primary entity in the relationship (referenced or referencing). Type: . The type of the entity. Type: The collection of related entity instances for the specified relationship. GetRelatedEntity<Account>("account_primary_contact", null); Sets the value of an attribute. Type: String. The logical name of the attribute. Type: Object. The value to set. record.SetAttributeValue("new_recipename", "Chocolate Tart"); Sets the collection of related entity instances for the specified relationship. Type: String. The schema name of the relationship. Type: . The role of the primary entity in the relationship (referenced or referencing). Type: IEnumerable. The collection of entity instances to set. Type: . The type of the entity. SetRelatedEntities<ActivityPointer>("Account_ActivityPointers", null, value); Sets the related entity instance for the specified relationship. Type: String. The schema name of the relationship. Type: . The role of the primary entity in the relationship (referenced or referencing). Type: . The entity instance to set. Type: . The type of the entity. SetRelatedEntity<mbs_project>("mbs_project_workiem", null, value); Gets the entity as the specified type. Type: . The entity type to return. Type: The entity as the specified type. Account retrievedAccount = service.Retrieve(account.LogicalName, account.Id, new ColumnSet("primarycontactid")).ToEntity<Account>(); Gets an entity reference for this entity instance. Type: The entity reference for the entity. RetrieveRequest request = new RetrieveRequest { Target = account.ToEntityReference(), ColumnSet = new ColumnSet(), RelatedEntitiesQuery = new RelationshipQueryCollection() }; Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class setting the list of entities. Type: IList<>. A list of entities. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Specifies the logical name. Initializes a new instance of the class. This constructor was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Specifies the entity logical name. Specifies the key attributes collection. This constructor was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Initializes a new instance of the class setting the logical name and entity ID. This constructor was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Type: String. The logical name of the entity. Type: Guid. The ID of the record. This constructor was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Initializes a new instance of the class. This constructor was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Specifies the entity logical name. Specifies the key name. Specifies the key value. This constructor was introduced with Microsoft Dynamics CRM Online 2015 Update 1 and cannot be used with earlier versions. Determines whether two instances are equal. Type: Object. The to compare with the current . Type: Boolean true if the specified is equal to the object; otherwise, false. Serves as a hash function for this type. Type: Int32 The hash code for the current . Initializes a new instance of the class. Initializes a new instance of the class setting the list of entity references. Type: IList<>. A list of entity references. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Validates the field permission value. Type: Int32. The value to validate. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class with an operation status. Type: . The status of the operation. Initializes a new instance of the class with an operation status, an error code, and an error message. Type: . The status of the operation. Type: Int32. The error code that identifies the specific error. Type: String. The error message that explains the reason for the exception. See the ErrorCodes.cs file in the SampleCode\CS\HelperCode folder of the SDK download for a list of Microsoft Dynamics 365 specific error codes. Web service error codes Initializes a new instance of the class with an operation status and an error message. Type: . The status of the operation. Type: String. The error message that explains the reason for the exception. Initializes a new instance of the class with an error message. Type: String. The error message that explains the reason for the exception. Initializes a new instance of the class with a reference to the inner exception that is the cause of this exception. Type: String. The error message that explains the reason for the exception. Type: Exception. The inner exception that is the cause of this exception. Sets the SerializationInfo with information about the exception. Type: SerializationInfo. The serialized object data about the exception being thrown. Type: StreamingContext. The contextual information about the source or destination. Creates a link between records. Type: String. The logical name of the entity that is specified in the parameter. Type: Guid. The ID of the record to which the related records are associated. Type: . The name of the relationship to be used to create the link. Type: . A collection of entity references (references to records) to be associated. Message Availability This message works regardless whether the caller is connected to the server or offline. Privileges and Access Rights To perform this action, the caller must have privileges on the entity that is specified in the parameter and access rights on the record that is specified in the parameter. For a list of the required privileges, see Delete message privileges. Notes for Callers This method creates multiple associations in one transaction between the record that is specified by the parameter and each record in the parameter for the specified relationship in the parameter. For a one-to-many relationship, this method sets the in the related record to the value of the . For a many-to-many relationship, this method creates a record in the intersect table for the relationship, which contains the ID of both the referenced and referencing records. The intersect table name is defined in the property for the relationship. You need this when you query for the records. However, you need the relationship name to set the property. This name is defined in the property for the relationship. For more information about the exceptions that can be thrown when this method is called, see Handle exceptions in your code. Supported Entities You can use this method to associate any records that participate in a relationship, including records for custom entities. The following example shows how to use the method to create an association or link between records. For this sample to work correctly, you must be connected to the server to get an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\LateBound\AssociateDisassociateDE.cs. // The account ID would typically be passed in as an argument or determined by a query. // The contact ID would typically be passed in as an argument or determined by a query. // Associate the accounts to the contact record. //Create a collection of the entity ids that will be associated to the contact. EntityReferenceCollection relatedEntities = new EntityReferenceCollection(); relatedEntities.Add(new EntityReference("account", _account1Id)); relatedEntities.Add(new EntityReference("account", _account2Id)); relatedEntities.Add(new EntityReference("account", _account3Id)); // Create an object that defines the relationship between the contact and account. Relationship relationship = new Relationship("account_primary_contact"); //Associate the contact with the 3 accounts. _service.Associate("contact", _contactId, relationship, relatedEntities); Console.WriteLine("The entities have been associated."); //Disassociate the records. _service.Disassociate("contact", _contactId, relationship, relatedEntities); Entity metadataCustomize entity relationship metadataSample: Associate records (early bound)Handle exceptions in your codeTroubleshooting and error handlingAssign Creates a record. Type: . An entity instance that contains the properties to set in the newly created record. Type:Guid The ID of the newly created record. Message Availability This message works regardless whether the caller is connected to the server or offline. Not all entity types support this message offline. See Supported Entities later in this topic. Privileges and Access Rights To perform this action, the caller must have privileges on the entity that is specified in the parameter. For a list of the required privileges, see Create message privileges. Notes for Callers This method creates one record in a transaction. To create a record that has related records in a transaction, use . By default the caller becomes the owner for the new record. However, for the caller to own the new record, it must have both Create and Read privileges for the entity. For more information, see Privileges by entity. Alternatively, you can set the property to the ID of another user. The entity instance that is specified as a parameter must contain values for all the attributes where the is set to . You can see this in the metadata topic for the entity. If the entity instance includes properties where is false, the values are ignored. You can find this information in the metadata for your organization. See the preceding metadata browser information. For more information about the exceptions that can be thrown when this method is called, see Handle exceptions in your code. Supported Entities You can use this method to create any record of an entity that supports the message, including custom entities. The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) ActivityMimeAttachment 2 (Both) Annotation 2 (Both) AnnualFiscalCalendar 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) AttributeMap 2 (Both) BusinessUnit 2 (Both) BusinessUnitNewsArticle 2 (Both) Calendar 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) ColumnMapping 2 (Both) Competitor 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) ConnectionRoleObjectTypeCode 2 (Both) ConstraintBasedGroup 2 (Both) Contact 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ContractTemplate 2 (Both) ConvertRule 2 (Both) ConvertRuleItem 2 (Both) CustomerAddress 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) Discount 2 (Both) DiscountType 2 (Both) DuplicateRule 2 (Both) DuplicateRuleCondition 2 (Both) DynamicProperty 2 (Both) DynamicPropertyAssociation 2 (Both) DynamicPropertyInstance 2 (Both) DynamicPropertyOptionSetItem 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) EntitlementChannel 2 (Both) EntitlementTemplate 2 (Both) EntitlementTemplateChannel 2 (Both) Equipment 2 (Both) ExchangeSyncIdMapping 2 (Both) Fax 2 (Both) FieldPermission 2 (Both) FieldSecurityProfile 2 (Both) FixedMonthlyFiscalCalendar 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) HierarchyRule 2 (Both) HierarchySecurityConfiguration 2 (Both) Import 2 (Both) ImportEntityMapping 2 (Both) ImportFile 2 (Both) ImportJob 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) Invoice 2 (Both) InvoiceDetail 2 (Both) IsvConfig 2 (Both) KbArticle 2 (Both) KbArticleComment 2 (Both) KbArticleTemplate 2 (Both) Lead 2 (Both) Letter 2 (Both) List 2 (Both) LookUpMapping 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) MonthlyFiscalCalendar 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OpportunityProduct 2 (Both) OrderClose 2 (Both) OrganizationUI 2 (Both) OwnerMapping 2 (Both) PhoneCall 2 (Both) PickListMapping 2 (Both) PluginAssembly 2 (Both) PluginType 2 (Both) Position 2 (Both) Post 2 (Both) PostComment 2 (Both) PostFollow 2 (Both) PostLike 2 (Both) PriceLevel 2 (Both) PrincipalObjectAttributeAccess 2 (Both) ProcessSession 2 (Both) ProcessTrigger 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) ProductPriceLevel 2 (Both) ProductSubstitute 2 (Both) Publisher 2 (Both) PublisherAddress 2 (Both) QuarterlyFiscalCalendar 2 (Both) Queue 2 (Both) QueueItem 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) QuoteDetail 2 (Both) RecurrenceRule 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RelationshipRoleMap 2 (Both) Report 2 (Both) ReportCategory 2 (Both) ReportEntity 2 (Both) ReportVisibility 2 (Both) ResourceSpec 2 (Both) Role 2 (Both) RollupField 2 (Both) RoutingRule 2 (Both) RoutingRuleItem 2 (Both) SalesLiterature 2 (Both) SalesLiteratureItem 2 (Both) SalesOrder 2 (Both) SalesOrderDetail 2 (Both) SavedQuery 2 (Both) SavedQueryVisualization 2 (Both) SdkMessageProcessingStep 2 (Both) SdkMessageProcessingStepImage 2 (Both) SdkMessageProcessingStepSecureConfig 2 (Both) SemiAnnualFiscalCalendar 2 (Both) Service 2 (Both) ServiceAppointment 2 (Both) ServiceEndpoint 2 (Both) SharePointDocument 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) Site 2 (Both) SLA 2 (Both) SLAItem 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialInsightsConfiguration 2 (Both) SocialProfile 2 (Both) Solution 2 (Both) Subject 2 (Both) SystemForm 2 (Both) SystemUser 2 (Both) Task 2 (Both) Team 2 (Both) TeamTemplate 2 (Both) Template 2 (Both) Territory 2 (Both) TraceLog 2 (Both) TransactionCurrency 2 (Both) TransformationMapping 2 (Both) TransformationParameterMapping 2 (Both) UoM 2 (Both) UoMSchedule 2 (Both) UserEntityInstanceData 2 (Both) UserEntityUISettings 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) WebResource 2 (Both) Workflow 2 (Both) WorkflowDependency 2 (Both) WorkflowLog 2 (Both) The following example shows how to use the method to create an account record (early bound). For this sample to work correctly, you must be connected to the server to instantiate an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\EarlyBound\CRUDOperations.cs. StrongTypes#CRUDOperations1 StrongTypesVB#CRUDOperations1 The following example shows how to use the method to create an account record (late bound). For this sample to work correctly, you must be connected to the server to instantiate an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\LateBound\CRUDOperationsDE.cs. DynamicEntity#CRUDOperationsDE1 DynamicEntityVB#CRUDOperationsDE1 Sample: Create, retrieve, update, and delete records (early bound)Sample: Create, retrieve, update, and delete a dashboardHandle exceptions in your codeTroubleshooting and error handlingCreate Deletes a record. Type: String. The logical name of the entity that is specified in the parameter. Type: Guid. The ID of the record that you want to delete. Message Availability This message works regardless whether the caller is connected to the server or offline. Not all entity types support this message offline. See Supported Entities later in this topic. Privileges and Access Rights To perform this action, the caller must have privileges on the entity that is specified in the parameter and access rights on the record that is specified in the parameter. For a list of the required privileges, see Delete message privileges. When a record is deleted, all child records are also deleted. The entire deletion fails if the caller does not have the delete privilege or access rights for any of these records. Notes for Callers This method may cascade to related records according to the cascade configuration for each entity relationship. For a description of how actions on a parent record affect related records, see Cascading behavior. Typically, you should only delete records that you entered by mistake. For some record types, you can deactivate or close the record instead. You can use this method to delete any record of an entity that supports the message, including records from custom entities. For more information about the exceptions that can be thrown when you call this method, see Handle exceptions in your code. Supported Entities The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) ActivityMimeAttachment 2 (Both) Annotation 2 (Both) AnnualFiscalCalendar 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) AttributeMap 2 (Both) BulkDeleteOperation 2 (Both) BulkOperation 2 (Both) BusinessUnit 2 (Both) BusinessUnitNewsArticle 2 (Both) Calendar 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) ColumnMapping 2 (Both) Competitor 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) ConnectionRoleObjectTypeCode 2 (Both) ConstraintBasedGroup 2 (Both) Contact 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ContractTemplate 2 (Both) ConvertRule 2 (Both) ConvertRuleItem 2 (Both) CustomerAddress 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) Discount 2 (Both) DiscountType 2 (Both) DuplicateRule 2 (Both) DuplicateRuleCondition 2 (Both) DynamicProperty 2 (Both) DynamicPropertyAssociation 2 (Both) DynamicPropertyInstance 2 (Both) DynamicPropertyOptionSetItem 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) EntitlementChannel 2 (Both) EntitlementTemplate 2 (Both) EntitlementTemplateChannel 2 (Both) Equipment 2 (Both) ExchangeSyncIdMapping 2 (Both) Fax 2 (Both) FieldPermission 2 (Both) FieldSecurityProfile 2 (Both) FixedMonthlyFiscalCalendar 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) HierarchyRule 2 (Both) HierarchySecurityConfiguration 2 (Both) Import 2 (Both) ImportEntityMapping 2 (Both) ImportFile 2 (Both) ImportJob 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) Invoice 2 (Both) InvoiceDetail 2 (Both) IsvConfig 2 (Both) KbArticle 2 (Both) KbArticleComment 2 (Both) KbArticleTemplate 2 (Both) Lead 2 (Both) Letter 2 (Both) List 2 (Both) LookUpMapping 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) MonthlyFiscalCalendar 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OpportunityProduct 2 (Both) OrderClose 2 (Both) OwnerMapping 2 (Both) PhoneCall 2 (Both) PickListMapping 2 (Both) PluginAssembly 2 (Both) PluginType 2 (Both) Position 2 (Both) Post 2 (Both) PostComment 2 (Both) PostFollow 2 (Both) PostLike 2 (Both) PriceLevel 2 (Both) PrincipalObjectAttributeAccess 2 (Both) ProcessSession 2 (Both) ProcessTrigger 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) ProductPriceLevel 2 (Both) ProductSubstitute 2 (Both) Publisher 2 (Both) PublisherAddress 2 (Both) QuarterlyFiscalCalendar 2 (Both) Queue 2 (Both) QueueItem 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) QuoteDetail 2 (Both) RecurrenceRule 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RelationshipRoleMap 2 (Both) Report 2 (Both) ReportCategory 2 (Both) ReportEntity 2 (Both) ReportVisibility 2 (Both) ResourceSpec 2 (Both) Role 2 (Both) RollupField 2 (Both) RoutingRule 2 (Both) RoutingRuleItem 2 (Both) SalesLiterature 2 (Both) SalesLiteratureItem 2 (Both) SalesOrder 2 (Both) SalesOrderDetail 2 (Both) SavedQuery 2 (Both) SavedQueryVisualization 2 (Both) SdkMessageProcessingStep 2 (Both) SdkMessageProcessingStepImage 2 (Both) SdkMessageProcessingStepSecureConfig 2 (Both) SemiAnnualFiscalCalendar 2 (Both) Service 2 (Both) ServiceAppointment 2 (Both) ServiceEndpoint 2 (Both) SharePointDocument 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) Site 2 (Both) SLA 2 (Both) SLAItem 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialInsightsConfiguration 2 (Both) SocialProfile 2 (Both) Solution 2 (Both) Subject 2 (Both) SystemForm 2 (Both) Task 2 (Both) Team 2 (Both) TeamTemplate 2 (Both) Template 2 (Both) Territory 2 (Both) TraceLog 2 (Both) TransactionCurrency 2 (Both) TransformationMapping 2 (Both) TransformationParameterMapping 2 (Both) UoM 2 (Both) UoMSchedule 2 (Both) UserEntityInstanceData 2 (Both) UserEntityUISettings 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) WebResource 2 (Both) Workflow 2 (Both) WorkflowDependency 2 (Both) WorkflowLog 2 (Both) The following example shows how to use the method to delete an account record (early bound). For this sample to work correctly, you must be connected to the server to get an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\EarlyBound\CRUDOperations.cs. StrongTypes#CRUDOperations1 StrongTypesVB#CRUDOperations1 The following example shows how to use the method to delete an account record (late bound). For this sample to work correctly, you must be connected to the server to get an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\LateBound\CRUDOperationsDE.cs. DynamicEntity#CRUDOperationsDE1 DynamicEntityVB#CRUDOperationsDE1 Handle exceptions in your codeTroubleshooting and error handlingDelete Deletes a link between records. Type: String. The logical name of the entity that is specified in the parameter. Type: Guid. The ID of the record from which the related records are disassociated. Type: . The name of the relationship to be used to remove the link. Type: . A collection of entity references (references to records) to be disassociated. Message Availability This message works regardless whether the caller is connected to the server or offline. Privileges and Access Rights To perform this action, the caller must have privileges on the entity that is specified in the parameter and access rights on the records that are specified in the and parameters. For a list of the required privileges, see Delete message privileges. Notes for Callers This method removes multiple associations in one transaction between the record that is specified by the parameter and each record in the parameter for the relationship that is specified in the parameter. For a one-to-many relationship, this method clears the in the related record to the value of . For a many-to-many relationship, this method deletes a record in the intersect table for the relationship. The intersect table name is defined in the property for the relationship. You need this when you query for the records. However, you need the relationship name to set the property. This name is defined in the property for the relationship. For more information about the exceptions that can be thrown when this method is called, see Handle exceptions in your code. Supported Entities You can use this method to disassociate any records that participate in a relationship, including records for custom entities. The following example demonstrates how to use the method to remove an association or link between records (early bound). StrongTypes#AssociateDisassociate1 StrongTypesVB#AssociateDisassociate1 The following example demonstrates how to use the method to remove an association or link between records (late bound). DynamicEntity#AssociateDisassociateDE1 DynamicEntityVB#AssociateDisassociateDE1 Sample: Associate records (early bound)Entity metadataCustomize entity relationship metadataHandle exceptions in your codeTroubleshooting and error handlingDisassociate Executes a message in the form of a request, and returns a response. Type: . A request instance that defines the action to be performed. Type: The response from the request. You must cast the return value of this method to the specific instance of the response that corresponds to the parameter. Privileges and Access Rights To execute the message, the caller must have the necessary privileges to the entity type that is specified in the request class. The caller must also have access rights on the specified records in the request class. For more information, see the class for the action you want to execute. For example, see . Notes for Callers For more information about the exceptions that can be thrown when this method is called, see Handle exceptions in your code. Method Availability This method works regardless whether the caller is connected to the server or offline. The following example shows how to use the method to assign an account to a team (early bound). For this sample to work correctly, you must be connected to the server to get an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\EarlyBound\AssignRecordToTeam.cs. // Assign the account to a team. AssignRequest assignRequest = new AssignRequest() { Assignee = new EntityReference { LogicalName = Team.EntityLogicalName, Id = _teamId }, Target = new EntityReference(Account.EntityLogicalName, _accountId) }; _service.Execute(assignRequest); The following example shows how to use the method to assign a queue to a team (late bound). For this sample to work correctly, you must be connected to the server to get an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\LateBound\AssignQueueToTeamDE.cs. DynamicEntity#AssignQueueToTeamDE1 Use messages (request and response classes) with the Execute methodThe security model of Microsoft Dynamics 365Privileges by messagePrivileges by entityHandle exceptions in your codeTroubleshooting and error handling Retrieves a record. Type: String. The logical name of the entity that is specified in the parameter. Type: Guid. The ID of the record that you want to retrieve. Type: . A query that specifies the set of columns, or attributes, to retrieve. Type: The requested entity. Message Availability This message works regardless whether the caller is connected to the server or offline. Not all entity types support this message offline. See Supported Entities later in this topic. Privileges and Access Rights To perform this action, the caller must have privileges on the entity that is specified in the parameter and access rights on the record that is specified in the parameter. For a list of the required privileges, see Retrieve message privileges. Notes for Callers The returned record contains values for the specified properties in the parameter for which the calling user has access rights. Any other property values are not returned. For more information, see The security model of Microsoft Dynamics 365. Pass null for the parameter to retrieve only the primary key. If the includes attributes where is false, they are ignored. You can find this information in the metadata for your organization. See the preceding metadata browser information. To retrieve a record and its related records in a single transaction, use the class. You can use this method to retrieve any record of an entity that supports the message, including custom entities. For more information about the exceptions that can be thrown when this method is called, see Handle exceptions in your code. Supported Entities The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) ActivityMimeAttachment 2 (Both) ActivityPointer 2 (Both) Annotation 2 (Both) AnnualFiscalCalendar 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) AttributeMap 2 (Both) Audit 2 (Both) BulkDeleteFailure 2 (Both) BulkDeleteOperation 2 (Both) BulkOperation 2 (Both) BulkOperationLog 2 (Both) BusinessUnit 2 (Both) BusinessUnitNewsArticle 2 (Both) Calendar 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) ColumnMapping 2 (Both) Competitor 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) ConnectionRoleObjectTypeCode 2 (Both) ConstraintBasedGroup 2 (Both) Contact 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ContractTemplate 2 (Both) ConvertRule 2 (Both) ConvertRuleItem 2 (Both) CustomerAddress 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) Dependency 2 (Both) Discount 2 (Both) DiscountType 2 (Both) DisplayString 2 (Both) DuplicateRecord 2 (Both) DuplicateRule 2 (Both) DuplicateRuleCondition 2 (Both) DynamicProperty 2 (Both) DynamicPropertyAssociation 2 (Both) DynamicPropertyInstance 2 (Both) DynamicPropertyOptionSetItem 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) EntitlementChannel 2 (Both) EntitlementTemplate 2 (Both) EntitlementTemplateChannel 2 (Both) EntityMap 2 (Both) Equipment 2 (Both) ExchangeSyncIdMapping 2 (Both) Fax 2 (Both) FieldPermission 2 (Both) FieldSecurityProfile 2 (Both) FixedMonthlyFiscalCalendar 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) HierarchyRule 2 (Both) Import 2 (Both) ImportEntityMapping 2 (Both) ImportFile 2 (Both) ImportJob 2 (Both) ImportLog 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) InvalidDependency 2 (Both) Invoice 2 (Both) InvoiceDetail 2 (Both) IsvConfig 2 (Both) KbArticle 2 (Both) KbArticleComment 2 (Both) KbArticleTemplate 2 (Both) Lead 2 (Both) LeadAddress 2 (Both) Letter 2 (Both) List 2 (Both) LookUpMapping 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) MonthlyFiscalCalendar 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OpportunityProduct 2 (Both) OrderClose 2 (Both) Organization 2 (Both) OrganizationUI 2 (Both) OwnerMapping 2 (Both) PhoneCall 2 (Both) PickListMapping 2 (Both) PluginAssembly 2 (Both) PluginType 2 (Both) PluginTypeStatistic 2 (Both) Position 2 (Both) Post 2 (Both) PostComment 2 (Both) PostFollow 2 (Both) PostLike 2 (Both) PriceLevel 2 (Both) PrincipalObjectAttributeAccess 2 (Both) Privilege 2 (Both) ProcessSession 2 (Both) ProcessStage 2 (Both) ProcessTrigger 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) ProductPriceLevel 2 (Both) ProductSubstitute 2 (Both) Publisher 2 (Both) PublisherAddress 2 (Both) QuarterlyFiscalCalendar 2 (Both) Queue 2 (Both) QueueItem 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) QuoteDetail 2 (Both) RecurrenceRule 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RelationshipRoleMap 2 (Both) Report 2 (Both) ReportCategory 2 (Both) ReportEntity 2 (Both) ReportLink 2 (Both) ReportVisibility 2 (Both) Resource 2 (Both) ResourceGroup 2 (Both) ResourceSpec 2 (Both) Role 2 (Both) RollupField 2 (Both) RoutingRule 2 (Both) RoutingRuleItem 2 (Both) SalesLiterature 2 (Both) SalesLiteratureItem 2 (Both) SalesOrder 2 (Both) SalesOrderDetail 2 (Both) SavedQuery 2 (Both) SavedQueryVisualization 2 (Both) SdkMessage 2 (Both) SdkMessageFilter 2 (Both) SdkMessagePair 2 (Both) SdkMessageProcessingStep 2 (Both) SdkMessageProcessingStepImage 2 (Both) SdkMessageProcessingStepSecureConfig 2 (Both) SdkMessageRequest 2 (Both) SdkMessageRequestField 2 (Both) SdkMessageResponse 2 (Both) SdkMessageResponseField 2 (Both) SemiAnnualFiscalCalendar 2 (Both) Service 2 (Both) ServiceAppointment 2 (Both) ServiceEndpoint 2 (Both) SharePointData 2 (Both) SharePointDocument 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) Site 2 (Both) SiteMap 2 (Both) SLA 2 (Both) SLAItem 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialInsightsConfiguration 2 (Both) SocialProfile 2 (Both) Solution 2 (Both) SolutionComponent 2 (Both) Subject 2 (Both) SystemForm 2 (Both) SystemUser 2 (Both) Task 2 (Both) Team 2 (Both) TeamTemplate 2 (Both) Template 2 (Both) Territory 2 (Both) TimeZoneDefinition 2 (Both) TimeZoneLocalizedName 2 (Both) TimeZoneRule 2 (Both) TraceLog 2 (Both) TransactionCurrency 2 (Both) TransformationMapping 2 (Both) TransformationParameterMapping 2 (Both) UoM 2 (Both) UoMSchedule 2 (Both) UserEntityInstanceData 2 (Both) UserEntityUISettings 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) UserSettings 2 (Both) WebResource 2 (Both) Workflow 2 (Both) WorkflowDependency 2 (Both) WorkflowLog 2 (Both) The following example shows how to use the method to retrieve an account record (early bound). For this sample to work correctly, you must be connected to the server to instantiate an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\EarlyBound\CRUDOperations.cs. StrongTypes#CRUDOperations1 The following example shows how to use the method to retrieve an account record (late bound). For this sample to work correctly, you must be connected to the server to instantiate an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\LateBound\CRUDOperationsDE.cs. DynamicEntity#CRUDOperationsDE1 Handle exceptions in your codeTroubleshooting and error handlingRetrieve Retrieves a collection of records. Type: . A query that determines the set of records to retrieve. Type: The collection of entities returned from the query. Message Availability This message works regardless whether the caller is connected to the server or offline. Not all entity types support this message offline. See Supported Entities later in this topic. Privileges and Access Rights To perform this action, the caller must have privileges on the entity that is specified in the parameter. For a list of the required privileges, see RetrieveMultiple message privileges. This method only returns the records for which the calling user has access rights. Notes for Callers The collection of returned records contains the values for the properties that are specified in the parameter for which the calling user has access rights. Any other property values are not returned. Pass null for the parameter to retrieve only the primary key. If the includes attributes that are not valid for retrieval, they are ignored. This is where is false. You can find this information in the metadata for your organization. See the preceding metadata browser information. You can use this method to retrieve records of an entity that supports the message, including records from custom entities. For more information about the exceptions that can be thrown when this method is called, see Handle exceptions in your code. Supported Entities The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) AccountLeads 2 (Both) ActivityMimeAttachment 2 (Both) ActivityParty 2 (Both) ActivityPointer 2 (Both) Annotation 2 (Both) AnnualFiscalCalendar 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) AttributeMap 2 (Both) Audit 2 (Both) BulkDeleteFailure 2 (Both) BulkDeleteOperation 2 (Both) BulkOperation 2 (Both) BulkOperationLog 2 (Both) BusinessUnit 2 (Both) BusinessUnitNewsArticle 2 (Both) Calendar 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignActivityItem 2 (Both) CampaignItem 2 (Both) CampaignResponse 2 (Both) ColumnMapping 2 (Both) Competitor 2 (Both) CompetitorProduct 2 (Both) CompetitorSalesLiterature 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) ConnectionRoleAssociation 2 (Both) ConnectionRoleObjectTypeCode 2 (Both) ConstraintBasedGroup 2 (Both) Contact 2 (Both) ContactInvoices 2 (Both) ContactLeads 2 (Both) ContactOrders 2 (Both) ContactQuotes 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ContractTemplate 2 (Both) ConvertRule 2 (Both) ConvertRuleItem 2 (Both) CustomerAddress 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) Dependency 2 (Both) Discount 2 (Both) DiscountType 2 (Both) DisplayString 2 (Both) DuplicateRecord 2 (Both) DuplicateRule 2 (Both) DuplicateRuleCondition 2 (Both) DynamicProperty 2 (Both) DynamicPropertyAssociation 2 (Both) DynamicPropertyInstance 2 (Both) DynamicPropertyOptionSetItem 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) EntitlementChannel 2 (Both) EntitlementContacts 2 (Both) EntitlementProducts 2 (Both) EntitlementTemplate 2 (Both) EntitlementTemplateChannel 2 (Both) EntitlementTemplateProducts 2 (Both) EntityMap 2 (Both) Equipment 2 (Both) ExchangeSyncIdMapping 2 (Both) Fax 2 (Both) FieldPermission 2 (Both) FieldSecurityProfile 2 (Both) FixedMonthlyFiscalCalendar 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) HierarchyRule 2 (Both) HierarchySecurityConfiguration 2 (Both) Import 2 (Both) ImportEntityMapping 2 (Both) ImportFile 2 (Both) ImportJob 2 (Both) ImportLog 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) InvalidDependency 2 (Both) Invoice 2 (Both) InvoiceDetail 2 (Both) IsvConfig 2 (Both) KbArticle 2 (Both) KbArticleComment 2 (Both) KbArticleTemplate 2 (Both) Lead 2 (Both) LeadAddress 2 (Both) LeadCompetitors 2 (Both) LeadProduct 2 (Both) Letter 2 (Both) License 2 (Both) List 2 (Both) ListMember 2 (Both) LookUpMapping 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) MonthlyFiscalCalendar 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OpportunityCompetitors 2 (Both) OpportunityProduct 2 (Both) OrderClose 2 (Both) Organization 2 (Both) OrganizationUI 2 (Both) OwnerMapping 2 (Both) PhoneCall 2 (Both) PickListMapping 2 (Both) PluginAssembly 2 (Both) PluginType 2 (Both) PluginTypeStatistic 2 (Both) Position 2 (Both) Post 2 (Both) PostComment 2 (Both) PostFollow 2 (Both) PostLike 2 (Both) PriceLevel 2 (Both) PrincipalObjectAttributeAccess 2 (Both) Privilege 2 (Both) ProcessSession 2 (Both) ProcessStage 2 (Both) ProcessTrigger 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) ProductPriceLevel 2 (Both) ProductSalesLiterature 2 (Both) ProductSubstitute 2 (Both) Publisher 2 (Both) PublisherAddress 2 (Both) QuarterlyFiscalCalendar 2 (Both) Queue 2 (Both) QueueItem 2 (Both) QueueMembership 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) QuoteDetail 2 (Both) RecurrenceRule 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RelationshipRoleMap 2 (Both) Report 2 (Both) ReportCategory 2 (Both) ReportEntity 2 (Both) ReportLink 2 (Both) ReportVisibility 2 (Both) Resource 2 (Both) ResourceGroup 2 (Both) ResourceSpec 2 (Both) Role 2 (Both) RolePrivileges 2 (Both) RollupField 2 (Both) RoutingRule 2 (Both) RoutingRuleItem 2 (Both) SalesLiterature 2 (Both) SalesLiteratureItem 2 (Both) SalesOrder 2 (Both) SalesOrderDetail 2 (Both) SavedQuery 2 (Both) SavedQueryVisualization 2 (Both) SdkMessage 2 (Both) SdkMessageFilter 2 (Both) SdkMessagePair 2 (Both) SdkMessageProcessingStep 2 (Both) SdkMessageProcessingStepImage 2 (Both) SdkMessageProcessingStepSecureConfig 2 (Both) SdkMessageRequest 2 (Both) SdkMessageRequestField 2 (Both) SdkMessageResponse 2 (Both) SdkMessageResponseField 2 (Both) SemiAnnualFiscalCalendar 2 (Both) Service 2 (Both) ServiceAppointment 2 (Both) ServiceContractContacts 2 (Both) ServiceEndpoint 2 (Both) SharePointData 2 (Both) SharePointDocument 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) Site 2 (Both) SiteMap 2 (Both) SLA 2 (Both) SLAItem 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialInsightsConfiguration 2 (Both) SocialProfile 2 (Both) Solution 2 (Both) SolutionComponent 2 (Both) Subject 2 (Both) SubscriptionTrackingDeletedObject 2 (Both) SystemForm 2 (Both) SystemUser 2 (Both) SystemUserLicenses 2 (Both) SystemUserProfiles 2 (Both) SystemUserRoles 2 (Both) Task 2 (Both) Team 2 (Both) TeamMembership 2 (Both) TeamProfiles 2 (Both) TeamRoles 2 (Both) TeamTemplate 2 (Both) Template 2 (Both) Territory 2 (Both) TimeZoneDefinition 2 (Both) TimeZoneLocalizedName 2 (Both) TimeZoneRule 2 (Both) TraceLog 2 (Both) TransactionCurrency 2 (Both) TransformationMapping 2 (Both) TransformationParameterMapping 2 (Both) UoM 2 (Both) UoMSchedule 2 (Both) UserEntityInstanceData 2 (Both) UserEntityUISettings 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) UserSettings 2 (Both) WebResource 2 (Both) Workflow 2 (Both) WorkflowDependency 2 (Both) WorkflowLog 2 (Both) The following example shows how to use the method. For this sample to work correctly, you must be connected to the server to get an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\BusinessDataModel\BusinessManagement\RetrieveOpportunity.cs. BusinessManagement#RetrieveOpportunity1 BusinessManagementVB#RetrieveOpportunity1 The following example shows how to use the method. For this sample to work correctly, you must be connected to the server to get an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\BusinessDataModel\Templates\GetEmailTemplateAttachments.cs. Templates#GetEmailTemplateAttachments1 TemplatesVB#GetEmailTemplateAttachments1 Retrieve data with queries using SDK assembliesHow field security can be used to control access to field values in Microsoft Dynamics 365Handle exceptions in your codeTroubleshooting and error handlingRetrieve multiple Updates an existing record. Type: . An entity instance that has one or more properties set to be updated in the record. Message Availability This message works regardless whether the caller is connected to the server or offline. Not all entity types support this message offline. See Supported Entities later in this topic. Privileges and Access Rights To perform this action, the caller must have privileges on the entity and access rights on the record specified in the parameter.. For a list of the required privileges, see Update message privileges. Notes for Callers If the entity instance includes properties that are not valid for update, they are ignored. You can find this information in the metadata for your organization. See the preceding metadata browser information. You can use this method to update any record of an entity that supports the message, including custom entities. For more information about the exceptions that can be thrown when this method is called, see Handle exceptions in your code. Supported Entities The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) ActivityMimeAttachment 2 (Both) Annotation 2 (Both) AnnualFiscalCalendar 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) BusinessUnit 2 (Both) BusinessUnitNewsArticle 2 (Both) Calendar 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) Competitor 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) ConstraintBasedGroup 2 (Both) Contact 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ContractTemplate 2 (Both) ConvertRule 2 (Both) ConvertRuleItem 2 (Both) CustomerAddress 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) Discount 2 (Both) DiscountType 2 (Both) DisplayString 2 (Both) DuplicateRule 2 (Both) DuplicateRuleCondition 2 (Both) DynamicProperty 2 (Both) DynamicPropertyAssociation 2 (Both) DynamicPropertyInstance 2 (Both) DynamicPropertyOptionSetItem 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) EntitlementChannel 2 (Both) EntitlementTemplate 2 (Both) EntitlementTemplateChannel 2 (Both) Equipment 2 (Both) ExchangeSyncIdMapping 2 (Both) Fax 2 (Both) FieldPermission 2 (Both) FieldSecurityProfile 2 (Both) FixedMonthlyFiscalCalendar 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) HierarchyRule 2 (Both) Import 2 (Both) ImportFile 2 (Both) ImportJob 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) Invoice 2 (Both) InvoiceDetail 2 (Both) IsvConfig 2 (Both) KbArticle 2 (Both) KbArticleComment 2 (Both) KbArticleTemplate 2 (Both) Lead 2 (Both) Letter 2 (Both) List 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) MonthlyFiscalCalendar 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OpportunityProduct 2 (Both) OrderClose 2 (Both) Organization 2 (Both) OrganizationUI 2 (Both) PhoneCall 2 (Both) PluginAssembly 2 (Both) PluginType 2 (Both) Position 2 (Both) PriceLevel 2 (Both) PrincipalObjectAttributeAccess 2 (Both) ProcessSession 2 (Both) ProcessTrigger 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) ProductPriceLevel 2 (Both) ProductSubstitute 2 (Both) Publisher 2 (Both) PublisherAddress 2 (Both) QuarterlyFiscalCalendar 2 (Both) Queue 2 (Both) QueueItem 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) QuoteDetail 2 (Both) RecurrenceRule 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RelationshipRoleMap 2 (Both) Report 2 (Both) ReportCategory 2 (Both) ReportEntity 2 (Both) ReportVisibility 2 (Both) ResourceSpec 2 (Both) Role 2 (Both) RollupField 2 (Both) RoutingRule 2 (Both) RoutingRuleItem 2 (Both) SalesLiterature 2 (Both) SalesLiteratureItem 2 (Both) SalesOrder 2 (Both) SalesOrderDetail 2 (Both) SavedQuery 2 (Both) SavedQueryVisualization 2 (Both) SdkMessageProcessingStep 2 (Both) SdkMessageProcessingStepImage 2 (Both) SdkMessageProcessingStepSecureConfig 2 (Both) SemiAnnualFiscalCalendar 2 (Both) Service 2 (Both) ServiceAppointment 2 (Both) ServiceEndpoint 2 (Both) SharePointData 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) Site 2 (Both) SiteMap 2 (Both) SLA 2 (Both) SLAItem 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialInsightsConfiguration 2 (Both) SocialProfile 2 (Both) Solution 2 (Both) Subject 2 (Both) SystemForm 2 (Both) SystemUser 2 (Both) Task 2 (Both) Team 2 (Both) TeamTemplate 2 (Both) Template 2 (Both) Territory 2 (Both) TransactionCurrency 2 (Both) UoM 2 (Both) UoMSchedule 2 (Both) UserEntityInstanceData 2 (Both) UserEntityUISettings 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) UserSettings 2 (Both) WebResource 2 (Both) Workflow 2 (Both) WorkflowDependency 2 (Both) WorkflowLog 2 (Both) The following example shows how to use the method to update an account record (early bound). For this sample to work correctly, you must be connected to the server to instantiate an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\EarlyBound\CRUDOperations.cs. StrongTypes#CRUDOperations1 The following example shows how to use the method to update an account record (late bound). For this sample to work correctly, you must be connected to the server to instantiate an interface. You can find the complete sample in the sample code package in the folder SampleCode\CS\GeneralProgramming\LateBound\CRUDOperationsDE.cs. DynamicEntity#CRUDOperationsDE1 Handle exceptions in your codeTroubleshooting and error handlingUpdate Returns an instance for the organization that the specified user is a member of. Type: Nullable<Guid>. Specifies the system user that calls to the service are made for. When called in a plug-in, a value indicates the SYSTEM user and a value indicates the same user as . . Any other value indicates a specific system user. When called in a custom workflow activity, all service calls are made in the IWorkflowExecutionContext. context. Type: An organization service factory object. Executes plug-in code in response to an event. Type: IService_Provider. A container for service objects. Contains references to the plug-in execution context (), tracing service (), organization service (), and notification service (). Called by the event execution pipeline during processing of a message request for which the plug-in was registered. For more information, see the IServiceProvider Interface. The notification service is only provided for asynchronous registered plug-ins. Write a plug-inEvent execution pipelineWrite plug-ins to extend business processes Posts the execution context to the specified service endpoint in the cloud. Type: . The service endpoint to post to in the cloud. Type: . The event execution context. Type: StringThe result. Only a two-way or REST listener will return a string back to the caller. If the post fails, the will continue to attempt the post for a pre-defined length of time. After all attempts to post have failed, the related asynchronous operation (system job) will be set to an error status. Manage of run-time errorsWrite a one-way, two-way, or REST listener Executes plug-in code in response to an event. Type: . Defines the contextual information passed to a plug-in at run-time. The execution context is posted on the Microsoft Azure Service Bus by Microsoft Dynamics 365 and made available to the listener in the execution context parameter. Logs trace information. Type: String. Information to be logged. Type: Object[]. Not documented at this time. Executes plug-in code in response to an event. Type: . Defines the contextual information passed to a plug-in at run-time. Type: String The response from the request. The return value is sent back to Microsoft Dynamics 365 over the service bus and received by the plug-in that initiated the original service bus post. The execution context is posted on the Microsoft Azure Service Bus by Microsoft Dynamics 365 and made available to the listener in the execution context parameter. Azure integration with Microsoft Dynamics 365 Executes plug-in code in response to an event. Type: . Defines the contextual information passed to a plug-in at run-time. Type: String The response from the request. The return value is sent back to Microsoft Dynamics 365 over the service bus and received by the plug-in that initiated the original service bus post. The execution context is posted on the Microsoft Azure Service Bus by Microsoft Dynamics 365 and made available to the listener in the execution context parameter. Azure integration with Microsoft Dynamics 365 Initializes a new instance of the class. Initializes a new instance of the class. Enables users to map a xsi:type name to any type. String. The xsi:type name to map. String. The xsi:type namespace to map. Type. The type declared in the data contract. System.Runtime.Serialization.DataContractResolver. The known type resolver. Type: Type The type the xsi:type name and namespace is mapped to. For information on this method, refer to the DataContractResolver class. Maps any type to a new xsi:type representation. Type. The type to map. Type. The type declared in the data contract. System.Runtime.Serialization.DataContractResolver. The known type resolver. System.Xml.XmlDictionaryString. The xsi:type name. System.Xml.XmlDictionaryString. The xsi:type namespace. Type: Booleantrue if mapping succeeded; otherwise, false. For information on this method, refer to the DataContractResolver class. Initializes a new instance of the class. Initializes a new instance of the class. Type: . The label for the language of the current user. Type: []. An array of localized labels. Initializes a new instance of the class. Type: String. The string for the user localized label. Type: Int32. The language code for the label. Language codes are four-digit or five-digit locale IDs. Valid locale ID values can be found at Locale ID (LCID) Chart). Initializes a new instance of the class. Initializes a new instance of the class setting the label string and the language code. Type: String The localized label string.. Type: Int32 The language code for the label. Language codes are four-digit or five-digit locale IDs. Valid locale ID values can be found at Locale ID (LCID) Chart). Initializes a new instance of the class Initializes a new instance of the class Type: IList<>. Sets a list of localized labels. Initializes a new instance of the class. Initializes a new instance of the class setting the values in the folder-level tracking rule with the values specified in the parameter list. ID of the Exchange folder in the folder-level tracking rule. Name of the Exchange folder in the folder-level tracking rule. ID of the entity record with which the Exchange folder is mapped. Name of the entity represented by the property. Entity type code of the entity represented by the property. Indicates whether the tracking rule for the folder has run. or . Initializes a new instance of the class. Initializes a new instance of the class setting a folder-level tracking rule. List of folder-level tracking rules. Initializes a new instance of the class Initializes a new instance of the class Type: String. The logical name for the managed property. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the . Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Type: . Sets the type for the attribute. Initializes a new instance of the class. Type: . Sets the type for the attribute. Type: String. Sets the schema name of the attribute. Initializes a new instance of the class. Type: . Initializes a new instance of the class. Determines whether two instances are equal. Type: Object. The to compare with the current . Type: Booleantrue if the specified is equal to the object; otherwise, false. Returns a hash code value for this type. Type: Int32 The hash code for the current . Indicates whether two instances are the same. Type: . Specifies a AttributeTypeDisplayName. Type: . Specifies a AttributeTypeDisplayName. Type: Booleantrue if the values of attributeTypeDisplayNameA and attributeTypeDisplayNameB are the same; otherwise, false. Converts a string into a Type: String. Specifies a AttributeTypeDisplayName. Type: A that represents the converted String. Indicates whether two AttributeTypeDisplayName instances are different. Type: . Specifies a AttributeTypeDisplayName. Type: . Specifies a AttributeTypeDisplayName. Type: Booleantrue if the values of attributeTypeDisplayNameA and attributeTypeDisplayNameB are different; otherwise, false. Initializes a new instance of the class Initializes a new instance of the class Type: String The Schema Name for the attribute. Initializes a new instance of the class Initializes a new instance of the class Type: The definition of the options Initializes a new instance of the class Type: String The schema name of the attribute. Initializes a new instance of the class Type: String The schema name of the attribute. Type: The definition of the options Initializes a new instance of the class Initializes a new instance of the class Type: The option metadata for the true option. Type: The option metadata for the false option. Initializes a new instance of the class Returns . Returns . Indicates whether a value exists in the list. Type: Boolean. Initializes a new instance of the class Initializes a new instance of the class Type: Nullable<>. The date/time display format. If this property is not assigned a value, it defaults to . Use the enumeration to set the format. Initializes a new instance of the class Type: Nullable<>. The date/time display format. If this property is not assigned a value, it defaults to . Type: String. The schema name of the attribute. Use the enumeration to set the format. Initializes a new instance of the class. Returns . Returns . Returns . Returns . Returns . Initializes a new instance of the class Initializes a new instance of the class Type: String The schema name of the attribute. Initializes a new instance of the class Initializes a new instance of the class Type: String The schema name for the attribute. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class Type: String The schema name of the attribute. Initializes a new instance of the class. Initializes a new instance of the class. Type: The attribute type code. Type: String The schema name for the attribute. Initializes a new instance of the class. Initializes a new instance of the class. Type: String The schema name for the attribute. Initializes a new instance of the class Initializes a new instance of the class Type: String The schema name for the attribute. Initializes a new instance of the class Initializes a new instance of the class Initializes a new instance of the class For internal use only. Initializes a new instance of the class Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class Type: String The schema name of the attribute. Initializes a new instance of the class Initializes a new instance of the class Initializes a new instance of the class Type: String. The schema name of the attribute. Initializes a new instance of the class Initializes a new instance of the class Initializes a new instance of the class Type: The label containing the text for the option.. Type: Nullable<Int32> The value of the option. Initializes a new instance of the class Type: Nullable<Int32> The value of the option. Initializes a new instance of the class Initializes a new instance of the class Type: IList<>. Sets the options for the collection. Initializes a new instance of the class Initializes a new instance of the class Type: The options available in the option set. Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Type: String The schema name of the attribute. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Type: String. The name of the metadata property in the condition expression. Type: . The condition operator. Type: Object The value for the metadata property. Initializes a new instance of the class. Initializes a new instance of the class. Type: . The filter operator Initializes a new instance of the class. Initializes a new instance of the class. Type: String[]. The strings representing the metadata properties to retrieve. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class Initializes a new instance of the class Type: The type of relationship. For internal use only. Initializes a new instance of the class Initializes a new instance of the class Initializes a new instance of the class Initializes a new instance of the class. Initializes a new instance of the class. Type: Int32. The value of the option. Type: Nullable<Int32>. The state of the option. Initializes a new instance of the class Initializes a new instance of the class Type: String. The schema name of the attribute to create. Initializes a new instance of the class. Determines whether two instances are equal. Type: Object. The to compare with the current . Type: Booleantrue if the specified is equal to the object; otherwise, false. Returns a hash code value for this type. Type: Int32 The hash code for the current . Indicates whether two StringFormatName instances are the same. Type: . Specifies a StringFormatName. Type: . Specifies a StringFormatName. Type: Booleantrue if the values of stringFormatA and stringFormatB are the same; otherwise, false. Converts a string into a Type: String. Specifies a StringFormatName. Type: A that represents the converted String. Indicates whether two StringFormatName instances are different. Type: . Specifies a StringFormatName. Type: . Specifies a StringFormatName. Type: Booleantrue if the values of stringFormatA and stringFormatB are different; otherwise, false. Initializes a new instance of the class. Initializes a new instance of the class. Specifies the schema name. Initializes a new instance of the class. Initializes a new instance of the class setting the value. Type: Decimal. The value of the attribute. Determines whether two instances are equal. Type: Object. The to compare with the current . Type: Booleantrue if the specified is equal to the object; otherwise, false. Returns a hash code value for this type. Type: Int32 The hash code for the current . Initializes a new instance of the class. Specifies the change type. Specifies the entity. Initializes a new instance of the class Initializes a new instance of the class Type: Int32. The option set value. Returns true if the specified OptionSetValue is equal to this OptionSetValue value, otherwise returns false. Type: , The to compare. Type: Booleantrue if the specified is equal to this value; otherwise, false. Gets a hash code for the value. Type: Int32 The hash code for the value. Initializes a new instance of the class. Produces a populated Microsoft.Xrm.Sdk.Organization. from a Microsoft.Xrm.Sdk.Discovery.. Type: . An endpoint collection. Type: The populated endpoint collection. Initializes a new instance of the class. Populates a . from a . object. Type: . An organization detail of the namespace. Type: A populated organization detail of the namespace. Initializes a new instance of the class. Initializes a new instance of the class setting the request name parameter. Type: String. The name of the request. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class setting the property. Type: Boolean. A that specifies whether to retrieve all attributes of a record. You should avoid retrieving all columns in a query result because of the impact on a subsequent update of records. In an update, this will set all field values, even if they are unchanged, and often triggers cascaded updates to child records. Initializes a new instance of the class setting the property. Type: String[]. Specifies an array of containing the names of the attributes. Adds the specified attribute to the column set. Type: String. Specifies a containing the name of the attribute. Adds the specified attribute to the column set. Type: String[]. Specifies an array of containing the names of the attributes. Initializes a new instance of the class. Initializes a new instance of the class setting the attribute name and condition operator. Type: String. The logical name of the attribute in the condition expression. Type: . The condition operator. Initializes a new instance of the class setting the attribute name, condition operator and a collection of values. Type: String. The logical name of the attribute in the condition expression. Type: . The condition operator. Type: ICollection. The collection of attribute values. Initializes a new instance of the class setting the attribute name, condition operator and value object. Type: String. The logical name of the attribute in the condition expression. Type: . The condition operator. Type: Object. The attribute value. Initializes a new instance of the class setting the attribute name, condition operator and an array of value objects. Type: String. The logical name of the attribute in the condition expression. Type: . The condition operator. Type: Object[]. The array of attribute values. Initializes a new instance of the class. Type: String. The logical name of the entity in the condition expression. Type: String. The logical name of the attribute in the condition expression. Type: . The condition operator. Initializes a new instance of the class. Type: String. The logical name of the entity in the condition expression. Type: String. The logical name of the attribute in the condition expression. Type: . The condition operator. Type: Object. The attribute value. Initializes a new instance of the class. Type: String. The logical name of the entity in the condition expression. Type: String. The logical name of the attribute in the condition expression. Type: . The condition operator. Type: Object[]. The array of attribute values. Initializes a new instance of the class. Type: String. The FetchXML query string. Initializes a new instance of the class. Initializes a new instance of the class. Type: . The filter operator. Adds a condition to the filter expression setting the condition expression. Type: . Specifies the condition expression to be added. Adds a condition to the filter expression setting the attribute name, condition operator, and value array. Type: String. The name of the attribute. Type: . The enumeration type. Type: Object[]. The array of values to add. Adds a condition to the filter expression setting the entity name, attribute name, condition operator, and value array. Type: String. The name of the entity. Type: String. The name of the attribute. Type: . The enumeration type. Type: Object[]. The array of values to add. Adds a child filter to the filter expression. Type: . The filter to be added. Adds a child filter to the filter expression setting the logical operator. Type: . The enumeration type. Type: The new filter expression. Initializes a new instance of the class. Initializes a new instance of the class setting the required properties. Type: String. The logical name of the entity to link from. Type: String. The logical name of the entity to link to. Type: String. The name of the attribute to link from. Type: String. The name of the attribute to link to. Type: . The join operator. Adds a link, setting the link to entity name, the link from attribute name and the link to attribute name. Type: String. The name of the entity to link to. Type: String. The name of the attribute to link from. Type: String. The name of the attribute to link to. Type: The link entity that was created. Adds a link setting the link to entity name, the link from attribute name, the link to attribute name, and the join operator. Type: String. The name of the entity to link to. Type: String. The name of the attribute to link from. Type: String. The name of the attribute to link to. Type: . The join operator. Type: The link entity that was created. Initializes a new instance of the class. Initializes a new instance of the class setting the attribute name and the order type. Type: String. The name of the attribute. Type: . The order, ascending or descending. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class. Type: String. The logical name of the entity to query. Adds an attribute value to the attributes collection. Type: String. The logical name of the attribute. Type: Object. The attribute value. Adds an order to the orders collection. Type: String. The logical name of the attribute. Type: . The order for that attribute. Initializes a new instance of the class. Initializes a new instance of the class setting the entity name. Type: String. The name of the entity. Organization service entities Adds the specified link to the query expression setting the entity name to link to, the attribute name to link from and the attribute name to link to. Type: String. The name of entity to link from. Type: String. The name of the attribute to link from. Type: String. The name of the attribute to link to. Type: The link entity instance created and added to the query expression. Adds the specified link to the query expression setting the entity name to link to, the attribute name to link from and the attribute name to link to. Type: String. The name of entity to link from. Type: String. The name of the attribute to link from. Type: String. The name of the attribute to link to. Type: . The join operator. Type: The link entity instance created and added to the query expression. Adds the specified order expression to the query expression. Type: String. The name of the attribute. Type: . The order type. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class setting the schema name property. Type: String. The name of the relationship. Determines whether two instances are equal. Type: Object. The to compare with the current . Type: Booleantrue if the specified is equal to the Object; otherwise, false. Serves as a hash function for this type. Type: Int32 The hash code for the current . Returns a String that represents the current . Type: String The name of the current . Initializes a new instance of the class. Initializes a new instance of the class Type: String The schema name for the entity relationship. Initializes a new instance of the class Type: String The schema name for the entity relationship. Type: The entity role for the entity. Initializes a new instance of the class. Initializes a new instance of the class. Specifies the change type. Specifies the entity reference. Initializes a new instance of the class. Initializes a new instance of the class using method call results. Type: . The results returned from a call. Initializes a new instance of the class using an inner exception and method call results. Type: Exception. The inner exception that is the cause of this exception. Type: . The results returned from a call. Initializes a new instance of the class with an error message. Type: String. The error message that explains the reason for the exception. Initializes a new instance of the class using an error message and method call results. Type: String. The error message that explains the reason for the exception. Type: . The results returned from a call. Initializes a new instance of the class with and error message and an inner exception. Type: String. The error message that explains the reason for the exception. Type: Exception. The inner exception that is the cause of this exception. Initializes a new instance of the class with and error message, an inner exception, and method call results. Type: String. The error message that explains the reason for the exception. Type: Exception. The inner exception that is the cause of this exception. Type: . The results returned from a call. Sets the SerializationInfo with information about the exception. Type: SerializationInfo. The serialized object data about the exception being thrown. Type: StreamingContext. The contextual information about the source or destination. Initializes a new instance of the class. Initializes a new instance of the class with the specified fault reason. Type: String. The reason for the fault. Initializes a new instance of the class using a Discovery service URL. The URL of the Discovery web service. The URL must contain the SDK client version. For example: https://disco.crm.dynamics.com/XRMServices/2011/Discovery.svc/web?SdkClientVersion=7.0.0.0 Discover the OAuth endpoint URL Initializes a new instance of the class using a Discovery service URL and a time span. The URL of the Discovery web service. The maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding. The URL must contain the SDK client version. For example: https://disco.crm.dynamics.com/XRMServices/2011/Discovery.svc/web?SdkClientVersion=7.0.0.0 Discover the OAuth endpoint URL Creates the WCF proxy client initializer which gets invoked on every SDK method call. This method makes sure that the access token and other header values are added to the outbound call. Type: A web proxy client context initializer. A request instance that defines the action to be performed. Type: The response from processing the request. You must cast the return value of this method to the specific instance of the response that corresponds to the request parameter. Discovery service messages (request and response classes) For internal use only. Type: . Initializes a new instance of the class using an Organization service URL. Type: URI. The URL of the Organization web service. Type: Boolean. When true, use early-bound types; otherwise, false. The URL must contain the SDK client version. The client version is set to the version of the SDK assemblies that the client application was linked to. For example: https://myorg.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SdkClientVersion=7.0.0.0 Initializes a new instance of the class using an Organization service URL and an assembly. Type: URI. The URL of the Organization web service. Type: Assembly. An assembly containing early-bound types. The URL must contain the SDK client version. The client version is set to the version of the SDK assemblies that the client application was linked to. For example: https://myorg.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SdkClientVersion=7.0.0.0 Initializes a new instance of the class using an Organization service URL and time span. Type: URI. The URL of the Organization web service. Type: TimeSpan. The maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding. Type: Boolean. When true, use early-bound types; otherwise, false. The URL must contain the SDK client version. The client version is set to the version of the SDK assemblies that the client application was linked to. For example: https://myorg.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SdkClientVersion=7.0.0.0 Initializes a new instance of the class using an Organization service URL, a time span, and an assembly. Type: URI. The URL of the Organization web service. Type: TimeSpan. The maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding. Type: Assembly. An assembly containing early-bound types. The URL must contain the SDK client version. The client version is set to the version of the SDK assemblies that the client application was linked to. For example: https://myorg.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SdkClientVersion=7.0.0.0 Creates a link between records. Type: String. The logical name of the entity specified in the parameter. Type: Guid. The ID of the record to which the related records will be associated. Type: . The name of the relationship to be used to create the link. Type: . A collection of entity references (references to records) to be associated. The core implementation of the method. For more information, see .. For internal use only. Creates a record. Type: . An entity instance that contains the properties to set in the newly created record. Type: GuidThe ID of the created entity. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadata For internal use only. Returns . Creates the WCF proxy client initializer which gets invoked on every SDK method call. This method makes sure that the access token and other header values are added to the outbound call. Type: A web proxy client context initializer. Deletes a record. Type: String. The logical name of the entity specified in the parameter. Type: Guid. The ID of the record of the record to delete. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadata For internal use only. Deletes a link between records. Type: String. The logical name of the entity specified in the parameter. Type: Guid. The ID of the record from which the related records will be disassociated. Type: . The name of the relationship to be used to remove the link. Type: . A collection of entity references (references to records) to be disassociated. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadata For internal use only. Executes a message in the form of a request, and returns a response. Type: . An instance of a request class that defines the action to be performed. Type: . You must cast the return value of this method to the specific instance of the response that corresponds to the parameter. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadataUse messages (request and response classes) with the Execute method For internal use only. Returns . Retrieves a record. Type: String. The logical name of the entity specified in the parameter. Type: Guid. The ID of the record you want to retrieve. Type: . A query that specifies the set of columns, or attributes, to retrieve. Type: .The requested entity. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadata For internal use only. Returns . Retrieves a collection of records. Type: . A query that determines the set of records to retrieve. Type: .A collection of entity records. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadataRetrieve data with queries using SDK assemblies For internal use only. Returns . Updates an existing record. Type: . An entity instance that has one or more properties set to be updated in the record. The core implementation of the method. For more information, see .. For more information about the exceptions that can be thrown when calling methods, see Handle exceptions in your code. Troubleshooting and error handlingUse the Organization Service to read and write data or metadata For internal use only. Initializes a new instance of the class using an Organization service URL. Type: URI. The URL of the Organization web service. Type: Boolean. When true, use early-bound types; otherwise, false. The URL must contain the SDK client version. The client version is set to the version of the SDK assemblies that the client application was linked to. For example: https://myorg.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SdkClientVersion=7.0.0.0 Initializes a new instance of the class using an Organization service URL and an assembly. Type: URI. The URL of the Organization web service. Type: Assembly. An assembly containing early-bound types. The URL must contain the SDK client version. The client version is set to the version of the SDK assemblies that the client application was linked to. For example: https://myorg.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SdkClientVersion=7.0.0.0 Initializes a new instance of the class using an Organization service URL and time span. Type: URI. The URL of the Organization web service. Type: TimeSpan. The maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding. Type: Boolean. When true, use early-bound types; otherwise, false. The URL must contain the SDK client version. The client version is set to the version of the SDK assemblies that the client application was linked to. For example: https://myorg.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SdkClientVersion=7.0.0.0 The timeout is passed to the SendTimeout, ReceiveTimeout, and OpenTimeout properties on the WCF channel binding. Initializes a new instance of the class using an Organization service URL, a time span, and an assembly. Type: URI. The URL of the Organization web service. Type: TimeSpan. The maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding. Type: Assembly. An assembly containing early-bound types. The URL must contain the SDK client version. The client version is set to the version of the SDK assemblies that the client application was linked to. For example: https://myorg.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SdkClientVersion=7.0.0.0 The timeout is passed to the SendTimeout, ReceiveTimeout, and OpenTimeout properties on the WCF channel binding. Creates the WCF proxy client initializer which gets invoked on every SDK method call. This method makes sure that the access token and other header values are added to the outbound call. Type: A web proxy client context initializer. Creates the service endpoint required for the proxy and adds support for early-bound types in the provided assembly. Type: URI. The URL of the web service. Type: Boolean. When true, use early-bound types; otherwise, false. Type: TimeSpan. The maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding. Type: Assembly. An assembly containing early-bound types. Type: ServiceEndpointA web service endpoint. The timeout is passed to the SendTimeout, ReceiveTimeout, and OpenTimeout properties on the WCF channel binding. Disposes the web proxy client object. Implementing a Dispose Methodhttp://msdn.microsoft.com/en-us/library/fs2xkftw.aspx Disposes the web proxy client object. Type: Boolean. Implementing a Dispose Methodhttp://msdn.microsoft.com/en-us/library/fs2xkftw.aspx Destructor for the class. Object.Finalize Methodhttp://msdn.microsoft.com/en-us/library/system.object.finalize.aspx Returns the default BasicHttpBinding that the proxy classes will use. Type: URI. The URL of the web service. Type: TimeSpan. The maximum amount of time an operation has to complete before a timeout fault is raised on a service channel binding. Type: BindingThe WCF channel binding. The timeout is passed to the SendTimeout, ReceiveTimeout, and OpenTimeout properties on the WCF channel binding. Initializes a new instance of the class using a web proxy client. Type: <TService>. A web proxy client for a service. Adds common and required headers to the outbound service call. Adds the access token to the Authorization header of the outbound service call. Disposes the web proxy client context initializer object. Implementing a Dispose Methodhttp://msdn.microsoft.com/en-us/library/fs2xkftw.aspx Disposes the web proxy client context initializer object. Type: Boolean. Implementing a Dispose Methodhttp://msdn.microsoft.com/en-us/library/fs2xkftw.aspx Destructor for objects. Object.Finalize Methodhttp://msdn.microsoft.com/en-us/library/system.object.finalize.aspx Initializes the object using a client base object. Type: ClientBase<TService>. A client base object. Gets the name of the attribute on which the aggregate, group by, or select operation was performed. Type: String The name of the attribute on which the aggregate, group by, or select operation was performed. Gets the name of the entity the attribute belongs to. Type: String The name of the entity the attribute belongs to. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the structure that contains extra data. Gets the value returned by the query. Type: ObjectThe value returned by the query. Gets the logical name of an attribute. Type: String The logical name of an attribute. Type: Int32. Returns . Returns . Returns . Returns . Returns . Returns . Returns . Returns . Returns . Returns . Returns . Returns . Gets the ID of the attribute. Type: GuidThe ID of the attribute. Gets whether create of the attribute value is allowed. Type: Int32. Gets whether read of the attribute value is allowed. Type: Int32. Gets whether update of the attribute value is allowed. Type: Int32. Gets or sets the structure that contains extra data. Type: ExtensionDataObject The extension data. Gets or sets the structure that contains extra data. Gets or sets the fault error code. Type: Int32The fault error code. Gets or sets the details of the fault. Type: The collection of details about the fault. Gets or sets a structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the message for the fault. Type: StringThe message for the fault. Gets or sets the date and time when the fault occurred. Type: DateTimeThe date and time when the fault occurred. Gets or sets the business entity changes collection. Type: . Gets or sets the data token. Type: String Gets or sets the extension data object. Type:. Gets or sets a Boolean value that specifies whether there are more records in the business entity changes collection. Type: Boolean if there are more records; otherwise . Gets or sets the paging cookie. Type: String Gets or sets the scope that a security token request applies to, as defined in the WS-Trust specification. Type: URI The scope that a security token request applies to. This property is optional. For Microsoft Dynamics 365 (online), this property value is automatically determined. Gets or sets the service credential authentication settings for use on the client side of communication. Type: ClientCredentials The service credential authentication settings. Gets or sets the identity provider address. Type: URI The identity provider address. This property is optional. For Microsoft Dynamics 365 (online), this value is automatically determined based on credentials or UPN. Gets or sets the security token response. Type: The security token response. Gets or sets additional credentials required by the site. Type: The additional credentials required by the site. For Microsoft Dynamics CRM Online (Live ID), specify the device credentials as the value of . Active Directory and claims-based authentication Gets or sets the UPN that is an internet-style login name for a user based on the Internet standard RFC 822. Type: StringThe UPN. Gets or sets whether the event is cancelled. Type: Boolean if the event is cancelled, otherwise . Gets the message describing the event. Type: StringThe message describing the event. Gets the exception related to the event. Type: Exceptionthe exception related to the event. Gets the message describing the event. Type: StringThe message describing the event. Gets or sets the issuer endpoint dictionary. Type: URI. Specifies the key used to retrieve a object from the collection. Returns . Gets the new service endpoint URL for an organization. Type: URI The new service endpoint URL for an organization. Gets the previous service endpoint URL for an organization. Type: URI The previous service endpoint URL for an organization. Gets the logical name of the entity. Type: String The logical name of the entity. The type of identity provider used by an endpoint. Type: The identity provider type. Value = 0 (ADFS), 1 (LiveId), 2 (OrgId). Specifies the URL of the identity provider service. Type: URI The URL of the identity provider service. Gets or sets the scope that a security token request applies to, as defined in the WS-Trust specification. Type: StringThe scope that a security token request applies to, as defined in the WS-Trust specification. Gets the endpoint of the identity provider. Type: URI The endpoint of the identity provider. Gets or sets the scope that a Microsoft account security token request applies to, as defined in the WS-Trust specification. Type: String The scope that a Microsoft account security token request applies to, as defined in the WS-Trust specification. Gets or sets a policy configuration that identifies a Secure Token Service (STS). Type: String The policy configuration that identifies a Secure Token Service (STS). Gets the alternate web service endpoint for accessing an organization, if one exists. Type: URIThe alternate web service endpoint. Set when constructing or . Gets or sets whether automatic switching from the current endpoint of the web service to an alternate endpoint is enabled. Type: Booleantrue if the automatic switching is enabled; otherwise, false. Set to by default for organizations that support disaster recover where an alternate endpoint is available. This property relates only to what the client-side SDK classes do, for example , and does not alter the Microsoft Dynamics 365 server functionality in any way. Setting this property to for an organization that is disaster failover enabled causes the client SDK classes to not attempt switching the endpoints if a failover is required. Disaster recovery in Microsoft Dynamics 365 (online) Gets whether the organization’s current endpoint is the primary endpoint. Type: Booleantrue if the current endpoint is the primary endpoint; otherwise, false. Gets the primary web service endpoint for accessing an organization. Type: URIThe primary web service endpoint. Set when constructing or . Gets the type of authentication in use by the identity provider of the service. Type: Thee type of authentication being used. Gets the available endpoints of the user’s home realm identity provider. Type: The available endpoints. Gets or sets the endpoint used by the Secure Token Service (STS) to issue the trusted token. Type: The endpoint used by the Secure Token Service (STS) to issue the trusted token. The must be set and the service configured for federated claims. Gets or sets the current endpoint in use by a service. Type: ServiceEndpointThe current endpoint in use by a service. Defaults to the first available endpoint in the dictionary if this property has not already been set. Gets the available endpoints of the security token service (STS). Type: The available endpoints of the security token service (STS). The available endpoints can vary, depending on how the administrator of the STS has configured the server, but may include the following authentication methods: username and password, Kerberos, certificate, asymmetric token, or symmetric token. Gets the policy configuration that identifies a Secure Token Service (STS). Type: The policy configuration. Gets the available endpoints of the service. Type: The available endpoints of the service. Contains the list of URLs and binding information required to make a call to a WCF service. If the service is configured for on-premises use only, the endpoint(s) contained within will not require the use of an issuer endpoint on the binding. If the service is configured to use federated claims, the binding on the service endpoint must be configured to use the appropriate issuer endpoint – for example: username/password, Kerberos, etc. Gets the type of authentication in use by the identity provider of the service. Type: The type of authentication used by the identity provider. Gets the available endpoints of the user’s home realm identity provider. Type: The available endpoints of the user’s home realm identity provider. Gets or sets the current endpoint in use by a service. Type: ServiceEndpointThe current endpoint in use by a service. Gets the available endpoints of the security token service (STS). Type: The available endpoints of the security token service (STS). Gets the policy configuration that identifies a Secure Token Service (STS). Type: The policy configuration that identifies a Secure Token Service (STS). Gets or sets the type of credentials the endpoint supports. Type: The type of credentials the endpoint supports. Gets or sets the actual URL that provides authentication for a particular credential type. Type: EndpointAddress The actual URL that provides authentication for a particular credential type. Gets or sets the binding information used to construct a channel to the issuer endpoint from a client. Type: Binding The binding information used to construct a channel to the issuer endpoint from a client. Gets or sets the URL that provides metadata about the set of issuer endpoints hosted by a Secure Token Service (STS). Type: EndpointAddress The URL that provides metadata about the set of issuer endpoints hosted by a Secure Token Service (STS). Gets or sets the WS-Trust standard, either 1.3 or 2005, that is supported on the endpoint. Type: TrustVersionThe WS-Trust standard, either 1.3 or 2005, that is supported on the endpoint. WS-Trust 1.3 is supported for issuers other than Microsoft account. For a Microsoft account issuer, WS-Trust 2005 is supported. Gets the endpoint of the Microsoft account identity provider. Type: URI The endpoint of the Microsoft account identity provider. Contains the available identity providers for the Microsoft Dynamics 365 (online) service. Type: The available identity providers for the Microsoft Dynamics 365 (online) service. Specifies the type of optimistic concurrency behavior that should be performed by the Web service when processing this request. Type: The concurrency behavior. Reduce potential data loss using optimistic concurrency Gets or sets the synchronization option for receiving entities from the Web service. Type: The synchronization option for receiving entities from the Web service. This value is read by the deserialization component of the client before materializing objects. Set this property to the appropriate materialization option before executing any queries or updates to the data service. The default value is . Gets the query provider. Type: IQueryProviderThe query provider. Gets or sets the values that are used by the method. Type: The values that are used by the method. This property is provided so that options such as merge and replace semantics can be set one time for the and then overridden as needed by calling . Gets or sets the ID of the user for whom SDK calls are made on behalf of. Type: Guid.The ID of the user for whom SDK calls are made on behalf of. Impersonate another userSample: Impersonate using the ActOnBehalfOf privilege Gets or sets the version of the client. Type: String.The version of the client. .NET clients using the current assemblies will pass the value ‘6.0.0.0’ or higher to indicate the client version. .NET clients using assemblies for earlier versions will not pass a value. This difference allows for messages that retrieve attribute metadata for the appropriate version. This applies to the following messages: Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online introduced a new attribute type: . .NET assemblies for previous versions do not recognize this type and an error occurs attempting to deserialize them. When attribute metadata is retrieved, if the assembly does not pass a value attributes will not be returned. Clients that do not use .NET assemblies need to include with a value of ‘6.0.0.0’ or higher in order to receive attributes. <soapenv:Header><a:SdkClientVersion xmlns:a=\"http://schemas.microsoft.com/xrm/2011/Contracts\">8.0</a:SdkClientVersion></soapenv:Header> No token name is specified <token xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"> <?Comment AL: Marked as internal per bug114678 2013-09-17T18:04:00Z Id='8?>internal<?CommentEnd Id='8' ?></token>. Type: String. Gets the endpoint of the User ID identity provider. Type: URI The endpoint of the User ID identity provider. User ID was previously called Microsoft Online Services ID. Gets the name of the identity service. Type: URIThe name of the identity service. The Windows Live ID provider that has a trust relationship with the OrgId provider. This is related to the transition of Windows Live ID organizations to the Microsoft Online Services environment. Type: StringThe identifier of the Windows Live provider. Gets an identifier of a Secure Token Service (STS) provider. Type: StringThe identifier of a Secure Token Service (STS) provider. For internal use only. Type: Boolean. For internal use only. Type: String. For internal use only. Type: String. For internal use only. Type: String. For internal use only. Type: Int32. For internal use only. Type: String. For internal use only. Type: String. For internal use only. Type: Int32. For internal use only. Type: Boolean. For internal use only. Type: String. For internal use only. Type: String. Type: String. For internal use only. Type: Int32. For internal use only. Type: String. For internal use only. Type: String. For internal use only. Type: String. For internal use only. Type: String. Gets the name of the message request. Type: String The name of the message request. Gets the name of the message response. Type: String The name of the message response. Gets or sets the type of endpoint that the security token applies to. Type: The endpoint type. Gets or sets the security token request response. Type: RequestSecurityTokenResponseThe security token request response. RequestSecurityTokenResponse Classhttp://msdn.microsoft.com/en-us/library/microsoft.identitymodel.protocols.wstrust.requestsecuritytokenresponse.aspx Gets or sets the security token. Type: SecurityTokenThe security token. SecurityToken Classhttp://msdn.microsoft.com/en-us/library/system.identitymodel.tokens.securitytoken.aspx Gets the WCF channel that is associated with the service channel. Type: IOutputChannel or IRequestChannel The WCF channel associated with the service channel. Gets the communication object that is associated with the service channel. Type: ICommunicationObjectThe communication object associated with the service channel. Gets the channel factory associated with the service channel. Type: ChannelFactoryThe channel factory associated with the service channel. Gets the errors that occurred during metadata retrieval from the service. Type: Collection The errors that occurred during metadata retrieval from the service. Gets the service endpoint URIs. Type: The service endpoint URIs. Gets the WSDL metadata for the service. Type: MetadataSetThe WSDL metadata for the service. Gets the primary and alternate URLs for the service. Type: The primary and alternate URLs for the service. Disaster recovery in Microsoft Dynamics 365 (online) Gets a WCF channel factory that manages a single channel instance. Type: ChannelFactoryA WCF channel factory. Gets the login credentials of the client. Type: ClientCredentialsThe login credentials of the client. Gets the Windows Live credentials of a registered device. Type: ClientCredentialsThe Windows Live credentials of a registered device.. Helper code: DeviceIdManager class Gets or sets a value that enables automatic switching from the organization’s current endpoint to an alternate endpoint. Type: Booleantrue to enable automatic switching from the organization’s current endpoint to an alternate endpoint; otherwise, false. Set to by default for organizations that support disaster recover failover where an alternate endpoint is available. Disaster recovery in Microsoft Dynamics 365 (online) Gets the endpoint switch information from the web service configuration. Type: The endpoint switch information from the web service configuration. Disaster recovery in Microsoft Dynamics 365 (online) Gets the security token response of the home realm. Type: The security token response of the home realm. For more information, refer to the constructor that supports a home realm URI parameter. Gets the home realm URI. Type: URIThe home realm URI. For more information, refer to the constructor that supports a home realm URI parameter. Gets a value indicating if the WCF channel has been authenticated. Type: Booleantrue if the created WCF channel has been authenticated, otherwise false. Gets the security token response. Type: The security token response. Gets the communication channel used to access a Microsoft Dynamics 365 service. Type: The communication channel used to access a Microsoft Dynamics 365 service. Gets a service configuration. Type: A service configuration. Gets a service management. Type: A service management. Manages a Microsoft Dynamics 365 web service. Gets or sets the maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding. Type: TimeSpanThe maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding. Gets or sets the UPN that is an Internet-style login name for a user based on the Internet standard RFC 822. Type: StringThe UPN that is an Internet-style login name for a user based on the Internet standard RFC 822. Gets or sets the alternate endpoint of an organization. Type: URI The alternate endpoint of an organization. Gets a value that indicates if the primary endpoint was generated from the alternate endpoint. Type: Booleantrue if the the primary endpoint was generated from the alternate endpoint; otherwise, false. Gets or sets the primary endpoint of an organization. Type: URIThe primary endpoint of an organization. Gets the number of elements in the collection. Type: Int32 The number of elements in the collection. Gets a value indicating whether the is read-only. Type: Booleantrue if the is read-only; otherwise, false. Gets or sets the value associated with the specified key. Type: TKey. The key of the value to get or set. Type: The value associated with the specified key. Gets a collection containing the keys in the . Type: ICollection<TKey> A collection containing the keys in the . Gets a collection containing the values in the . Type: ICollection<TValue> A collection containing the values in the . Gets or sets the type of client that is querying for patches. Type: The type of client that is querying for patches. Gets or sets the Microsoft Dynamics 365 version that the client is running. Type: StringThe version. Gets or sets the language code for which the client has been configured. Type: Int32The language code. Language codes are four-digit or five-digit locale IDs. Valid locale ID values can be found at Locale ID (LCID) Chart). Gets or sets the version of Microsoft Office installed on the client machine. Type: StringThe Microsoft Office version. Gets or sets the ID of the organization for which the client has been configured. Type: GuidThe ID of the organization. Gets or sets the operating system version that the client is running. Type: StringThe version of the operating system. Gets or sets the list of patches that the client has installed. Type: GuidThe list of patched applied. Gets or sets the Microsoft Dynamics 365 system user ID of the client. Type: GuidThe ID of the user. Type: Int32 Type: String Type: Boolean Type: String Type: Guid Type: String Gets or sets the structure that contains extra data. Optional. Type: ExtensionDataObjectThe extension data. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets a collection that identifies the service type and address for each endpoint of the organization. Type: The collection that identifies the service type and address for each endpoint of the organization. Gets or sets extra data of the organization. Type: ExtensionDataObject Extra data of the organization. Gets or sets the friendly name of the organization. Type: String The friendly name of the organization. The friendly name was defined when the organization was provisioned. Gets or sets global unique identifier of the organization. Type: GuidThe global unique identifier of the organization. Gets or sets the version of the organization. Type: String The version of the organization. Gets or sets the state of the organization. Type: The state of the organization. Gets or sets the unique name of the organization. Type: StringThe unique name of the organization. The unique name is not necessarily similar to the friendly name. The organization unique name was defined when the organization was created. To determine the organization unique name using the Microsoft Dynamics 365 Web application, first select Settings, next select Customizations, finally click Developer Resources. Gets or sets the organization name used in the URL for the organization Web service. Type: String The organization name used in the URL for the organization Web service. The organization URL name is AdventureWorksCycle in the following Web service URL example: http://localhost/AdventureWorksCycle/xrmservices/2011/Organization.svc Gets or sets the access type of the organization’s service endpoint. Type: The access type. Identifies the access type of the organization to retrieve. Indicates the applicable version of Microsoft Dynamics 365. Type: The release to retrieve. Identifies the release of the organization to retrieve. Gets or sets the unique name of the organization. Type: StringThe organization unique name. Identifies the name of the organization to retrieve. The organization unique name was defined when the organization was created. To determine the organization unique name using the Microsoft Dynamics 365 Web application, first select Settings, next select Customizations, finally click Developer Resources. You can retrieve information, including the unique name, on all organizations that the logged on user belongs to using . Contains detailed information about the target organization. Type: The details about the organization. Gets or sets the access type of the organizations’ service endpoint. Type: The access type of the organizations’ service endpoint. Indicates the type of network access an endpoint has. For internal use only. Type:Boolean. Get or sets the release version of a Microsoft Dynamics 365 organization. Type: The organizations’ release version. Organizations have a release version and can be upgraded to a newer release. This property can be used to identify if your organization is on a Microsoft Dynamics CRM 2011 release or not. Contains detailed information about the target organizations. Type: The details about the organization. Gets or sets the ID of the target user. Type: StringThe external ID of the user to retrieve. For Microsoft Dynamics 365 (IFD), the identity provider is typically Active Directory Federation Services 2.0 (ADFS). For Microsoft Dynamics 365 (online), the identity provider is typically Microsoft Online Services, but Microsoft account is still possible in some cases. Gets or sets the ID of the organization that the target system user is a member of. Type: GuidThe ID of the organization that the target system user is a member of. Gets or sets the unique name of the organization that the target system user is a member of. Type: StringThe unique name of the organization that the target system user is a member of. Gets or sets the release version of the Microsoft Dynamics 365 product. Type: StringThe release version of the Microsoft Dynamics 365 product. Gets or sets the ID of the Microsoft Dynamics 365 (online) system user. Type: GuidThe ID of the user. Gets or sets the fault instance that caused the current fault. Type: The fault instance that caused the current fault. Gets or sets the collection of attributes for the entity. Type: The collection of attributes for the entity. For performance and security reasons, the attribute collection will typically not contain the complete set of attributes for the entity. Gets or sets the state of the entity. Type: . The state of the entity. lead1.EntityState = EntityState.Changed; Gets or sets the structure that contains extra data. Type: ExtensionDataObjectGets or sets the structure that contains extra data. Gets of sets the collection of formatted values for the entity attributes. Type: The collection of formatted values for the entity attributes. Entity formatted values are only available on a retrieve operation, not on an update operation. if (entity.FormattedValues.Contains(metadata.LogicalName)) actualValue = entity.FormattedValues[metadata.LogicalName]; Gets or sets the ID of the record represented by this entity instance. Type: Guid The ID of the record (entity instance). Provides an indexer for the attribute values. Type: String. The logical name of the attribute. Type: ObjectThe attribute specified by the parameter. Gets or sets the key attributes. Type:. Gets or sets the logical name of the entity. Type: Stringthe logical name of the entity. Gets or sets a collection of entity references (references to records). Type: a collection of entity references (references to records). Gets or sets the row version Type: String Gets the collection of entities. Type: <>The collection of entities. Gets or sets the logical name of the entity. Type: Stringthe logical name of the entity. Organization service entities Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets an item in the collection. Type: Int32. The index of the item. Type: The item at the specified index. Gets or sets the lowest active row version value. Type: StringThe lowest active row version value. Gets or sets whether there are more records available. Type: Booleantrue if there are more records available; otherwise, false. This is used in conjunction with the when working with large record sets. Gets or sets the current paging information. Type: String The current paging information. This is used in conjunction with when working with large record sets. Page large result sets with FetchXMLSample: Use FetchXML with a paging cookie Gets the total number of records in the collection. was when the query was executed . Type: Int32The total number of records in the collection. If was when the query was executed, the value of this property will be -1. Use the QueryExpression class Gets or sets whether the results of the query exceeds the total record count. Type: Booleantrue if the results of the query exceeds the total record count; otherwise, false.. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the ID of the record. Type: Guid The ID of the record. Gets or sets the key attributes. Type: . Gets or sets the logical name of the entity. Type: StringThe logical name of the entity. For a list of the out-of-the-box entity names, see Organization service entities. Gets or sets the value of the primary attribute of the entity. Type: StringThe value of the primary attribute of the entity. This property can contain a value or null. This property is not automatically populated unless the object has been retrieved from the server. This value is used to provide text to represent the related record in any user interface elements, such as the value in a view column. Gets or sets the row version. Type: String. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the organization service fault that occurred when a message request was executed. Type: The organization service fault. Gets or sets the numerical position of a message request in a request collection. Type: Int32The position of a message request in a request collection, starting at zero. Identifies which message request in a request collection that the response item applies to. Gets or sets the response that is returned from executing a message request. Type: The message response. Gets or sets a value indicating whether further execution of message requests in the collection should continue if a fault is returned for the current request being processed. Type: Booleantrue if message request processing should continue; otherwise, false. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets a value indicating if a response for each message request processed should be returned. Type: Booleantrue if responses should be returned for each message request processed; otherwise, false. If set to true and a request does not return a response, because that is its design, the for that request is set to null. However, even when false, the collection will not be empty if errors are returned. If errors are returned, there will be one response item in the collection for each processed request that returned a fault and will be set to the actual fault that occurred. Type: Int32The index in the collection of the message request that resulted in the fault. Gets or sets a value that specifies the change type. Type: . Gets the GUIDGUID of the business unit that the user making the request, also known as the calling user, belongs to. Type: GuidThe GUID of the business unit. This property corresponds to the property, which is the primary key for the entity. BusinessUnit entity Gets the GUID for tracking plug-in or custom workflow activity execution. Type: GuidThe GUID for tracking plug-in or custom workflow activity execution. This property is used by the platform for infinite loop prevention. In most cases, this property can be ignored. Gets the current depth of execution in the call stack. Type: Int32T the current depth of execution in the call stack. Used by the platform for infinite loop prevention. In most cases, this property can be ignored. Every time a running plug-in or Workflow issues a message request to the Web services that triggers another plug-in or Workflow to execute, the property of the execution context is increased. If the depth property increments to its maximum value within the configured time limit, the platform considers this behavior an infinite loop and further plug-in or Workflow execution is aborted. The maximum depth (8) and time limit (one hour) are configurable by the Microsoft Dynamics 365 administrator using the PowerShell command . The setting is . For more information, see, “Administer the deployment using Windows PowerShell” in the Deploying and administering Microsoft Dynamics CRM. Gets the GUID of the system user account under which the current pipeline is executing. Type: GuidThe GUID of the system user account under which the current pipeline is executing. This property corresponds to the property, which is the primary key for the entity. Impersonation in plug-insUser and team entities Gets the parameters of the request message that triggered the event that caused the plug-in to execute. Type: The parameters of the request message that triggered the event that caused the plug-in to execute. Input and output parametersUse messages (request and response classes) with the Execute method Gets whether the plug-in is executing from the Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access client while it is offline. Type: Booleantrue if the plug-in is executing from the Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access client while it is offline; otherwise, false. Write a plug-in Gets a value indicating if the plug-in is executing within the database transaction. Type: Booleantrue if the plug-in is executing within the database transaction; otherwise, false. Event execution pipeline Gets a value indicating if the plug-in is executing as a result of the Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access client transitioning from offline to online and synchronizing with the Microsoft Dynamics 365 server. Type: Booleantrue if the the plug-in is executing as a result of the Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access client transitioning from offline to online; otherwise, false. Gets a value indicating if the plug-in is executing in the sandbox. Type: Int32Indicates if the plug-in is executing in the sandbox. Allowable values are defined in the enumeration defined in SampleCode\CS\HelperCode\OptionSets.cs and SampleCode\VB\HelperCode\OptionSets.vb of the SDK download. Plug-in isolation, trusts, and statistics Gets the name of the Web service message that is being processed by the event execution pipeline. Type: StringThe name of the Web service message being processed by the event execution pipeline. Supported messages and entities for plug-ins Gets the mode of plug-in execution. Type: Int32The mode of plug-in execution. Allowable values are defined in the enumeration defined in SampleCode\CS\HelperCode\OptionSets.cs and SampleCode\VB\HelperCode\OptionSets.vb of the SDK download. Event execution pipeline Gets the date and time that the related was created. Type: DateTimeThe date and time that the related was created. This property is used for the Microsoft Dynamics 365 to Microsoft Azure integration feature. It contains the same date and time value as the property of the related entity. AsyncOperation (system job) entityAzure integration with Microsoft Dynamics 365 Gets the GUID of the related . Type: GuidThe GUID of the related . This corresponds to the attribute, which is the primary key for the entity. This property is used for the Microsoft Dynamics 365 to Microsoft Azure integration feature. AsyncOperation (system job) entityAzure integration with Microsoft Dynamics 365 Gets the GUID of the organization that the entity belongs to and the plug-in executes under. Type: GuidThe GUID of the organization that the entity belongs to and the plug-in executes under. This corresponds to the attribute, which is the primary key for the entity. Organization entities Gets the unique name of the organization that the entity currently being processed belongs to and the plug-in executes under. Type: StringThe unique name of the organization that the entity currently being processed belongs to and the plug-in executes under. See the attribute of the entity. Organization entities Gets the parameters of the response message after the core platform operation has completed. Type: The parameters of the response message after the core platform operation has completed. Input and output parametersUse messages (request and response classes) with the Execute method Gets a reference to the related or . Type: A reference to the related or .entity. An entity is used for plug-in registration and a entity is used for Microsoft Azure integration. Plug-in registration entitiesServiceEndpoint entity messages and methodsWork with Dynamics 365 data in your Azure solution Gets the properties of the primary entity after the core platform operation has been completed. Type: The properties of the primary entity after the core platform operation has been completed. Pre and post entity images Gets the properties of the primary entity before the core platform operation has begins. Type: The properties of the primary entity before the core platform operation has begins. Pre and post entity images Gets the GUID of the primary entity for which the pipeline is processing events. Type: GuidThe GUID of the primary entity for which the pipeline is processing events. For example, if the event pipeline is processing an account, this corresponds to the attribute, which is the primary key for the entity. Event execution pipeline Gets the name of the primary entity for which the pipeline is processing events. Type: StringThe name of the primary entity for which the pipeline is processing events. Event execution pipeline Gets the GUID of the request being processed by the event execution pipeline. Type: Nullable<Guid>The GUID of the request being processed by the event execution pipeline. This corresponds to the property, which is the primary key for the class from which specialized request classes are derived. Use messages (request and response classes) with the Execute methodEvent execution pipeline Gets the name of the secondary entity that has a relationship with the primary entity. Type: StringThe name of the secondary entity that has a relationship with the primary entity. Gets the custom properties that are shared between plug-ins. Type: The custom properties that are shared between plug-ins. Pass data between plug-ins Gets the GUID of the system user for whom the plug-in invokes web service methods on behalf of. Type: GuidThe GUID of the system user for whom the plug-in invokes web service methods on behalf of. This property corresponds to the property, which is the primary key for the entity. User and team entities Gets the numeric code that identifies a specific error condition. Type: Int32The error code. See the ErrorCodes.cs file in the SampleCode\CS\HelperCode folder of the SDK download for a list of Microsoft Dynamics 365 specific error codes. Web service error codes Gets the status of the plug-in exception. Type: The status of the plug-in exception. Gets the execution context from the parent pipeline operation. Type: The execution context from the parent pipeline operation. This property may be populated for a plug-in registered in stage 20 or 40 when a Create, Update, Delete, or RetrieveExchangeRate request is processed by the execution pipeline. Certain message requests require the platform to internally generate another message request, and hence another execution pipeline, to complete processing of the original request. For example, pipeline execution of the results in the internal generation of an . Any plug-in registered in stage 20 or 40 for an update request will have the ParentContext property set to the execution context of the original assign request. Event execution pipelinePass data between plug-ins Gets the stage in the execution pipeline that a synchronous plug-in is registered for. Type: Int32. Valid values are 10 (pre-validation), 20 (pre-operation), 40 (post-operation), and 50 (post-operation, deprecated). A stage identifies when a registered synchronous plug-in is to execute during the processing of a message request. Plug-ins can be further ordered within a stage using the attribute. An enumeration named that defines the supported range of values for this property is available by including the file SampleCode\CS\HelperCode\OptionSets.cs or SampleCode\VB\HelperCode\OptionSets.vb in your project. Plug-in registration entitiesEvent execution pipeline Gets or sets the assembly that contains the early-bound entity types. Type: AssemblyThe assembly. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets the collection of localized labels. Type: The collection of localized labels. Gets or set the label for the language of the current user. Type: The label for the language of the current user. Gets or sets whether the label is managed. Type: Nullable<Boolean>true if the label is managed; otherwise, false. Gets or sets the localized label string. Type: String The localized label string.. Gets or sets the language code for the label. Type: Int32 The language code for the label.. Valid locale ID values can be found at Locale ID (LCID) Chart. Gets the ID of the Exchange folder in the folder-level tracking rule. Returns StringThe ID of the Exchange folder in the folder-level tracking rule. Gets the name of the Exchange folder in the folder-level tracking rule. Returns StringThe name of the Exchange folder in the folder-level tracking rule. Gets whether the tracking rule for the folder has run. Returns Boolean if the tracking rule for the folder has run; otherwise. Gets the ID of the entity record with which the Exchange folder is mapped. Returns GuidThe ID of the entity record with which the Exchange folder is mapped. Gets the name of the entity represented by the property. Returns StringThe name of the entity represented by the property. Gets the entity type code of the entity represented by the property. Returns Int32The entity type code of the entity represented by the property. For internal use only. Returns . Gets or sets whether the managed property value can be changed. Type: Booleantrue if the managed property value can be changed; otherwise, false. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets the logical name for the managed property. Type: String The logical name for the managed property. Gets or sets the value of the managed property. Type: String The value of the managed property. Gets or sets the collection of entity references (references to records) to be associated. Required. Type: The collection of entity references (references to records) to be associated. Get or sets the relationship name to be used for an association. Required. Type: The relationship name to be used for an association. Gets or sets the target that is the record to which the related records are associated. Required. Type: The target that is the record to which the related records are associated. Gets or sets the logical entity name to check whether it can be the primary entity in a one-to-many relationship. Required. Type: String The logical entity name to check whether it can be the primary entity in a one-to-many relationship. Required. Gets the result of the request to see whether the entity can be the primary entity (one) in a one-to-many relationship. Type: Booleantrue if the entity can be the primary entity (one) in a one-to-many relationship; otherwise, false. Gets or sets the logical entity name. Required. Type: String The the logical entity name. Required.. Gets the result of the request to see whether the entity can be the referencing entity (many) in a one-to-many relationship. Type: Booleantrue if the entity can be the referencing entity (many) in a one-to-many relationship.; otherwise, false. Gets or sets the logical entity name. Required Type: String The logical entity name. Required. Gets the result of the request to see whether the entity can participate in a many-to-many relationship. Type: Booleantrue if the entity can participate in a many-to-many relationship.; otherwise, false. Gets or sets a collection of entity and attributes to apply the behavior conversion on. Required Returns . Gets or sets whether to automatically convert to DateOnly value, if possible. Optional. Returns Boolean if automatically convert to DateOnly value; otherwise .. If this parameter is not specified, by default is used. If you specify , the rule specified in the parameter is used. Gets or sets the conversion rule to apply. Required. Returns StringThe conversion rule name to apply. The valid values for this parameter are available in the class. Gets or sets the CRM time zone code to be used for the conversion. Required only if is specified in parameter. Returns Int32The integer value for the CRM time zone code. Gets the ID of the asynchronous job that executes the behavior conversion from UTC to DateOnly in the database. Returns GuidID of the asynchronous job. An asynchronous job is created with the name. Gets or sets the definition of the attribute type that you want to create. Required. Type: The definition of the attribute type that you want to create. Required. Use one of the following classes to specify the type of attribute that you want to create: Gets or sets the name of the entity for which you want to create an attribute. Required. Type: String The name of the entity for which you want to create an attribute. Required. Gets or sets the name of the unmanaged solution to which you want to add this attribute. Optional. Type: String The name of the unmanaged solution to which you want to add this attribute. Optional. All entities are added to the default solution. When you use this optional property, you also add this attribute as a solution component to the specified unmanaged solution. Gets the of the attribute that is created. Type: Guid The of the attribute that is created. This is the unique identifier of the attribute. Gets or sets the metadata for the lookup field used to store the ID of the related record. Required. Type: The metadata for the lookup field used to store the ID of the related record. Required. Gets or sets the metadata array for the one-to-many relationships to the Account and Contact entity. Required. The metadata array for the one-to-many relationships to the Account and Contact entity. Required. Gets or sets the name of the unmanaged solution to which you want to add this customer lookup attribute to. Optional. Type: String The name of the unmanaged solution to which you want to add this customer lookup attribute to. Optional. All entities are added to the default solution. When you use this optional property, you also add this customer lookup attribute as a solution component to the specified unmanaged solution. Gets the of the that is created. Type: GuidThe of the that is created. Gets an array of relationship IDs created for the attribute to Account and Contact entities. Array of relationship IDs created for the attribute to Account and Contact entities. Gets or sets the entity key. Type: Gets or sets the entity name. Type: String The name of the entity. Gets or sets the unique name of the solution. Type: String The name of the solution. Gets the entity key ID. Type: Guid Gets or sets the metadata for the custom entity that you want to create. Required. Type The metadata for the custom entity that you want to create. Required. Gets or sets whether a custom entity is created that has a special relationship to activity entities and is a valid regarding object for the activity. Optional. Type: Boolean if the custom entity that you create has a special relationship to activity entities; otherwise, . The default is . Gets or sets whether the entity will have a special relationship to the Feedback entity. Optional. Type: Nullable<Boolean>true if the entity will have a special relationship to the Feedback entity; otherwise, false. This capability can only be enabled once. After it is enabled, it cannot be disabled. Use the Feedback entity to manage feedback and ratings for Dynamics 365 records Gets or sets whether the custom entity that is created has a special relationship to the annotation entity. Optional. Type: Booleantrue if the custom entity that is created has a special relationship to the annotation entity; otherwise, false. The default is . Gets or sets the metadata for the primary attribute for the new entity. Required. Type: The metadata for the primary attribute for the new entity. Required.. Gets or sets the name of the unmanaged solution to which you want to add this custom entity. Optional. Type: String The name of the unmanaged solution to which you want to add this custom entity. Optional. All custom entities are automatically added to the default solution. However, when you use this optional property, you also add the custom entity as a solution component to the specified unmanaged solution. Gets the of the primary attribute for the newly created entity. Type: Guid The of the primary attribute for the newly created entity. Gets the of the newly created entity. Type: Guid The of the newly created entity. Gets or sets the name of the intersect entity to be created for this entity relationship. Required. Type: StringThe name of the intersect entity to be created for this entity relationship. Required. This property is required. This property must begin with a valid customization prefix. We recommend that you use a consistent naming convention. This is usually: <customization prefix>_<entity 1 logical name + “s”>_<entity 2 logical name +”s”>. For example “new_accounts_campaigns”. Gets or sets the definition of the Many-to-Many entity relationship to be created. Required. Type: The definition of the Many-to-Many entity relationship to be created. Required. Gets or sets the name of the unmanaged solution you want to add this many-to-many entity relationship to. Optional. Type: StringThe name of the unmanaged solution you want to add this many-to-many entity relationship to. Optional. This property is optional. All entity relationships are added to the default solution. Using this optional property will also add this entity as a solution component to the specified unmanaged solution. Add a new solution component Gets the ID of the many-to-many entity relationship that is created. Type: Guid The ID of the many-to-many entity relationship that is created. This corresponds to the . Gets or sets the metadata for the lookup field used to store the ID of the related record. Required. Type: The metadata for the lookup field used to store the ID of the related record. Required. This attribute is added to the referencing entity. Gets or sets the metadata for the relationship. Required. Type: The metadata for the relationship. Required. Gets or sets the name of the unmanaged solution you want to add this one-to-Many entity relationship to. Optional. Type: StringThe name of the unmanaged solution you want to add this one-to-Many entity relationship to. Optional.. This property is optional. All entity relationships are added to the default solution. Using this optional property will also add this entity relationship as a solution component to the specified unmanaged solution. Add a new solution component Gets the of the that is created. Type: GuidThe of the that is created.. Gets the of the that is created. Type: GuidThe of the that is created.. Gets or sets the definition of the global option set. Required. Type: The definition of the global option set. Required. The property must be . Gets or sets the name of the unmanaged solution you want to add this global option set to. Optional. Type: StringThe name of the unmanaged solution you want to add this global option set to. Optional. This property is optional. All global option sets are added to the default solution. Using this optional property will also add this global option set as a solution component to the specified unmanaged solution. Add a new solution component Gets the of the newly created . Type: GuidThe of the newly created . Gets or sets an instance of an entity that you can use to create a new record. Required. Type: The entity instance. The specified target record must contain values for all the attributes where the is set to . You can see the required level value for each entity in the Entity Metadata topic for the entity. If the entity instance includes properties where is false, the values are ignored. You can find this information in the metadata for your organization. See the preceding metadata browser information. Gets the ID of the newly created record. Type: GuidThe ID of the newly created record. Gets or sets the logical name of the entity that contains the attribute. Required. Type: StringThe logical name of the entity that contains the attribute. Required. Gets or sets the logical name of the attribute to delete. Required. Type: StringThe logical name of the attribute to delete. Required. Gets or sets the entity name. Type: StringThe name of the entity. Gets or sets the key name. Type: StringThe name of the alternate key. Gets or sets the logical name of the entity. Required. Type: StringThe logical name of the entity. Required. Gets or sets the name of the global option set to delete. Required. Type: StringThe name of the global option set to delete. Required. Gets or sets the logical name of the attribute from which to delete the option value. Optional. Type: StringThe logical name of the attribute from which to delete the option value. Optional. Gets or sets the logical name of the entity that contains the attribute. Optional. Type: StringThe logical name of the entity that contains the attribute. Optional. Gets or sets the name of the option set that contains the value. Optional. Type: StringThe name of the option set that contains the value. Optional. Gets or sets the solution name associated with this option value. Optional. Type: StringThe solution name associated with this option value. Optional. Gets or sets the value of the option to delete. Required. Type: Int32The value of the option to delete. Required. Gets or sets the name of the relationship to delete. Required. Type: StringThe name of the relationship to delete. Required. Specifies the type of optimistic concurrency behavior that should be performed by the Web service when processing this request. Type: The concurrency behavior. Reduce potential data loss using optimistic concurrency Gets or sets the reference to the record that you want to delete. Required. Type: The reference to the record that you want to delete. Gets or sets the collection of entity references (references to records) to be disassociated. Required. Type: The collection of entity references (references to records) to be disassociated. Get or sets the name of the relationship to be used for the disassociation. Required. Type: The name of the relationship to be used for the disassociation. The relationship name can be found in the property in the metadata. Gets or sets the target, which is the record from which the related records will be disassociated. Required. Type: The target, which is the record from which the related records will be disassociated. Gets or sets the request to execute asynchronously. Returns The request to execute asynchronously. Currently this only supports the message. Gets or sets the ID of the asynchronous job that was started from processing the . Type: Guid The ID of the asynchronous job. Gets or sets the collection of message requests to execute. Type: The collection of message requests to execute. Gets or sets the settings that define whether execution should continue if an error occurs and if responses for each message request processed are to be returned. Type: Settings that define whether execution should continue if an error occurs and if responses are to be returned. Gets a value that indicates if processing at least one of the individual message requests resulted in a fault. Type: Booleantrue if at least one of the individual message requests resulted in a fault; otherwise, false. Gets the collection of responses. Type: The collection of responses. Whether responses are returned or not is configured by . Gets or sets the collection of message requests to execute. Type: The collection of message requests to execute. Gets or sets a value indicating if responses are to be returned for each message request processed. Type: BooleanSet to if responses should be returned; otherwise, . Gets the collection of responses. Type: The collection of responses. Gets an array of logical entity names that can have many-to-many entity relationships. Type: String[]An array of logical entity names that can have many-to-many entity relationships. Gets or sets the logical name of the entity to get valid referenced entities. Optional. Type: StringThe logical name of the entity to get valid referenced entities. Optional. Gets the array of valid entity names that can be the primary entity in a many-to-many relationship. Type: String[]The array of valid entity names that can be the primary entity in a many-to-many relationship. Gets or sets the name of the entity that would be the primary entity in the relationship. Optional. Type: StringThe name of the entity that would be the primary entity in the relationship. Optional. Gets the array of valid entity names that can be the related entity in a many-to-many relationship. Type: String[]The array of valid entity names that can be the related entity in a many-to-many relationship. Gets or sets the name of the attribute when updating a local option set in a picklist attribute. Optional. Type: StringThe name of the attribute when updating a local option set in a picklist attribute. Optional. Gets or sets a description for the option. Optional. Type: A description for the option. Gets or sets the logical name of the entity when updating the local option set in a picklist attribute. Optional. Type: StringThe logical name of the entity when updating the local option set in a picklist attribute. Optional. Gets or sets the label for the option. Required. Type: The label for the option. Required.. Gets or sets the name of the global option set. Optional. Type: StringThe name of the global option set. Optional. Gets or sets the unique name of the unmanaged solution when updating a global option set. Optional. Type: StringThe unique name of the unmanaged solution when updating a global option set. Optional. Setting this value will add the global option set to the specified unmanaged solution. Gets or sets the value for the option. Optional. Type: Nullable<Int32>The value for the option. Optional. We recommend that you do not specify an option and instead allow the system to auto-generate one for you. This will help make sure that the option value prefix for your solution is applied and the value will be more likely to be unique when the solution is installed in another organization. Merge option set options Gets the option value for the new option. Type: Int32The option value for the new option. If you do not specify an option value, a value is automatically generated for you. Gets or sets the logical name of the status attribute. Optional. Type: StringThe logical name of the status attribute. Optional. Gets or sets a description for the option. Optional. Type: The description for the option. Optional. While this data can be set for the option the application does not provide a place where this description can be viewed or edited. Gets or sets the logical name of the entity that contains the attribute. Optional. Type: StringThe logical name of the entity that contains the attribute. Optional. Gets or sets the label for the new status. Required. Type: The label for the new status. Required.. Reserved for future use. Optional. Type: StringReserved for future use. Optional. attributes always use local option sets. Gets or sets the solution that this attribute should be added to. Optional. Type: StringThe solution that this attribute should be added to. Optional. When you update an attribute you have the option to add the attribute to a specific solution. Gets or sets the state code for the new status. Required. Type: Int32The state code for the new status. Required. The value must represent a valid option in the attribute in the same entity. Gets or sets the value for the new status. Optional. Type: Nullable<Int32>the value for the new status. Optional. Passing a null value is recommended. If a null value is passed the system will generate a new value. The new value will include the option value prefix that will help make the value more unique and facilitate correct merging of custom options. Merge option set options Gets the option value for the new option. Type: Int32The option value for the new option. Gets whether data encryption is active or not. Type: String if data encryption is active; otherwise, . Gets or sets the logical name of the attribute. Optional. Type: StringThe logical name of the attribute. Optional. Gets or sets the logical name of the entity that contains the attribute. Optional. Type: StringThe logical name of the entity that contains the attribute. Optional. Gets or sets the name of the global option set you want to edit options for. Optional. Type: StringThe name of the global option set you want to edit options for. Optional. Gets or sets the name of the solution you want to add the solution component to. Optional. Type: StringThe name of the solution you want to add the solution component to. Optional. Gets or sets the array of option values in the wanted order. Required. Type: Int32The array of option values in the wanted order. Required. Gets or sets the entity key name. Type: String Gets or sets the entity name. Type: String Gets or sets a filter to control how much data for each entity is retrieved. Required. Type: A filter to control how much data for each entity is retrieved. Required. To improve performance use the appropriate entity filter to provide just the data you need. Gets or sets whether to retrieve the metadata that has not been published. Required. Type: Booleantrue if the metadata that has not been published should be retrieved; otherwise, false. If you are creating an entity editor you will need to retrieve entity data that has been saved but not published. For other scenarios you will want to only retrieve published metadata. Set this value to true to include unpublished changes, as it would look if you called publish. Set this value to false to include only the currently published changes, ignoring the changes that haven't yet been published. Gets an array of instances. Type: []an array of instances.. The data that is included in each instance varies based on the parameter that is passed to the request. Gets a time stamp that represents the time when the data was retrieved. Type: StringA time stamp that represents the time when the data was retrieved. Gets an array of managed property definitions. Type: []An array of managed property definitions. Gets or sets whether to retrieve the metadata that has not been published. Required. Type: Booleantrue if the metadata that has not been published should be retrieved; otherwise, false. If you are creating a global optionset editor you will need to retrieve entity data that has been saved but not published. For other scenarios you will want to only retrieve published metadata. Set this value to true to include unpublished changes, as it would look if you called publish. Set this value to false to include only the currently published changes, ignoring the changes that haven't yet been published. Gets an array of definitions for each global option set. Type: []An array of definitions for each global option set. Gets or sets a column number value to identify an attribute from the . property. Optional. Type: Int32A column number value to identify an attribute from the . property. Optional. This property can be used in place of the when querying entity records. The property contains a column delimited list of column number values representing the attributes modified when the record was updated. You can use these values to retrieve the metadata for the attribute that was changed. Audit entity data changesAudit entity messages and methods Gets or sets the logical name of the entity that contains the attribute. Optional. Type: StringThe logical name of the entity that contains the attribute. Optional. The and the are required if the is not provided. Gets or sets the logical name of the attribute to be retrieved. Optional. Type: StringThe logical name of the attribute to be retrieved. Optional. The and the are required if the is not provided. The unique identifier for the attribute. Optional. Type: GuidThe unique identifier for the attribute. This corresponds to the .. The is required if the and the iiis not provided. Gets or sets whether to retrieve the metadata that has not been published. Required. Type: Booleantrue if the metadata that has not been published should be retrieved; otherwise, false. If you are creating an attribute editor you will need to retrieve entity data that has been saved but not published. For other scenarios you will want to only retrieve published metadata. Set this value to true to include unpublished changes, as it would look if you called publish. Set this value to false to include only the currently published changes, ignoring the changes that haven't yet been published. Gets the metadata for the requested attribute. Type: The metadata for the requested attribute. Gets or sets the encryption key. Type: String. The value returned is the decrypted data encryption key. Gets or sets the columns to retrieve. Type:. Gets or sets the data version. Type: StringThe data version. Gets or sets the entity name. Type: StringThe entity name. Gets or sets the paging information. Type:. Gets the changes for an entity. Type: . Gets or sets the entity name. Type: String The name of the entity. Gets or sets the key name. Type: StringThe key name. Gets or sets the metadata ID. Type: GuidThe metadata ID. Gets or sets whether to retrieve the metadata that has not been published. Required. Type: Boolean if the metadata that has not been published should be retrieved; otherwise, . Gets the entity key metadata values. Returns . Gets or sets a filter to control how much data for the entity is retrieved. Required. Type: a filter to control how much data for the entity is retrieved. Required. Gets or sets the logical name of the entity to be retrieved. Optional. Type: StringThe logical name of the entity to be retrieved. Optional. The is required if the is not provided. A unique identifier for the entity. Optional. Type: GuidThe A unique identifier for the entity. This corresponds to the . for the entity. The is required if the is not provided. Gets or sets whether to retrieve the metadata that has not been published. Required. Type: Booleantrue if the metadata that has not been published should be retrieved; otherwise, false. If you are creating an entity editor you will need to retrieve entity data that has been saved but not published. For other scenarios you will want to only retrieve published metadata. Set this value to true to include unpublished changes, as it would look if you called publish. Set this value to false to include only the currently published changes, ignoring the changes that haven't yet been published. Gets the metadata for the requested entity. Type: The metadata for the requested entity. Gets or sets the name of the managed property. Optional. Type: StringThe name of the managed property. Optional. Gets or sets the ID of the managed property. Required, Type: GuidThe ID of the managed property. This corresponds to the . for the managed property. Gets the definition of the managed property. Type: The definition of the managed property. Gets or sets a timestamp value representing when the last request was made. Type: String A timestamp value representing when the last request was made. Set this using a value from a previous request and you will retrieve only the metadata changes, including deleted metadata. Set this value to and you will retrieve all the metadata defined in the query. Gets or sets a value to filter what deleted metadata items will be returned. Type: A value to filter what deleted metadata items will be returned. Both the and this parameter must be included for any deleted metadata to be returned. Gets or sets the query representing the metadata to return. Type:The query representing the metadata to return. Gets the deleted metadata since the last request. Type: The deleted metadata since the last request. Deleted metadata is only returned when a valid is included in a request. This collection is a dictionary of GUID values using a as a key. The GUID values represent values of the metadata items. Gets the metadata defined by the request. Type: The metadata defined by the request. This is a collection of where the entities match the ... The properties within the entities that match the .. will contain values. Any properties that do not match the requested properties will be null. Gets a timestamp identifier for the metadata retrieved. Type: String A timestamp identifier for the metadata retrieved.. Use this as a . in a later request to retrieve just the metadata changes since the intial request. Gets or sets the query criteria for the retrieval. Required. Type: The query criteria for the retrieval. Assign an instance of the , , or class. The query must specify entity names and a column set. If the column set includes attributes where is , they are ignored, and the message response contains no data for those attributes. You can find this information in the metadata for your organization. See the preceding metadata browser information. Gets the collection of records that satisfy the query in the request. Type: The collection of records that satisfy the query in the request. Gets or sets the of the to be retrieved. Optional. Type: GuidThe of the to be retrieved. Optional. If the is not set the muuust be set. Gets or sets the name for the global option set to be retrieved. Optional. Type: String The name for the global option set to be retrieved.. Optional.. If the is not set the must be set. Gets or sets whether to retrieve the metadata that has not been published. Required. Type: Booleantrue if the the unpublished metadata should be retrieved; otherwise, false.. If you are creating a global option set editor you will need to retrieve data that has been saved but not published. For other scenarios you will want to only retrieve published metadata. Set this value to to include unpublished changes, as it would look if you called publish. Set this value to to include only the currently published changes, ignoring the changes that haven't yet been published. Gets the metadata for the global option set. Type: The metadata for the global option set. Gets or sets the of the to be retrieved. Optional. Type: Guid The of the to be retrieved. Optional. If the is not set the must be set. Gets or sets the unique name for the entity relationship to be retrieved. Optional. Type: StringThe unique name for the entity relationship to be retrieved. Optional.. If the is not set the must be set. Gets or sets whether to retrieve the metadata that has not been published. Required. Type: Booleantrue if the unpublished metadata should be retrieved; otherwise, false. If you are creating an entity relationship editor, you will need to retrieve data that has been saved but not published. For other scenarios, you will want to only retrieve published metadata. Set this value to to include unpublished changes. Set this value to to include only the currently published changes, ignoring the changes that have not yet been published. Gets the metadata for the entity relationship. Type: The metadata for the entity relationship. Gets or sets the collection of attributes for which non-null values are returned from a query. Required. Type: The collection of attributes for which non-null values are returned from a query. Assign null to this property to retrieve only the primary key. The query returns non-null values for the specified attributes in the column set. The attributes that are not included in the column set contain null values. If the column set includes attributes where is false, they are ignored and the message response contains no data for those attributes. You can find this information in the metadata for your organization. See the preceding metadata browser information. Gets or sets the query that describes the related records to be retrieved. Optional. Type: The query that describes the related records to be retrieved. This property value is a collection of link-entity/query pairs. For each relationship between the entity and another entity, you can specify a query for the records that are related to the record. For internal use only. Type: Boolean. Gets or sets the target, which is the record to be retrieved. Required. Type: The target, which is the record to be retrieved. Gets the specified record from the request. Type: The specified record from the request. For internal use only. Type: Object Gets the time stamp of the metadata. Type: StringThe time stamp of the metadata. Gets or sets the operation to perform with the data encryption key. Type: Boolean indicates to set (change) the data encryption key; otherwise, indicates to restore the data encryption key. When performing a restore, the new key is saved in the MS_CONFIG database. When performing a change, all fields that were encrypted using the old key are first decrypted, and then encrypted using the new key. The new key is then stored in the MS_CONFIG database. No more than one can be processed at a time for an organization. Gets or sets the value of the data encryption key. Type: String. Gets or sets the attribute metadata to be updated. Required. Type: The attribute metadata to be updated. Required. Gets or sets the logical name of the entity to which the attribute belongs. Required. Type: StringThe logical name of the entity to which the attribute belongs. Required. Gets or sets whether the label metadata will be merged or overwritten. Required. Type: Booleantrue if the label metadata will be merged or overwritten; otherwise, false. A is a collection of localized labels, each containing a string and a language code. If a label for an item already has labels for other languages and you update it with a label that contains only one label for a specific language the parameter provides the option to overwrite the existing labels or merge your new label with any existing language labels. With set to true, any new labels defined will only overwrite existing labels when the languagecode matches. Gets or sets the name of the solution to associate the entity with. Optional. Type: StringThe name of the solution to associate the entity with. Optional. Gets or sets the metadata for the entity. Required. Type: the metadata for the entity. Required. Gets or sets whether the entity will have a special relationship to activity entities and is a valid regarding object for the activity. Optional. Type: Nullable<Boolean>true if the entity will have a special relationship to activity entities and is a valid regarding object for the activity; otherwise, false. This capability can only be enabled once. After it is enabled it cannot be disabled. Gets or sets whether the entity will have a special relationship to the Feedback entity. Optional. Type: Nullable<Boolean>true if the entity will have a special relationship to the Feedback entity; otherwise, false. This capability can only be enabled once. After it is enabled, it cannot be disabled. Use the Feedback entity to manage feedback and ratings for Dynamics 365 records Gets or sets whether the entity will have a special relationship to the annotation entity. Optional. Type: Nullable<Boolean>true if the entity will have a special relationship to the annotation entity; otherwise, false. This capability can only be enabled once. After it is enabled it cannot be disabled. Gets or sets whether to merge the new labels with any existing labels. Required. Type: Booleantrue if the new labels should be merged with any existing labels; otherwise, false. A is a collection of localized labels, each containing a string and a language code. If a label for an item already has labels for other languages and you update it with a label that contains only one label for a specific language the MergeLabels parameter provides the option to overwrite the existing labels or merge your new label with any existing language labels. With MergeLabels set to true, any new labels defined will only overwrite existing labels when the languagecode matches. Gets or sets the unique name of the unmanaged solution that this entity should be associated with. Optional. Type: StringThe unique name of the unmanaged solution that this entity should be associated with. Optional. Gets or sets whether the label metadata will be merged or overwritten. Required. Type: Booleantrue if the label metadata will be merged or overwritten; otherwise, false. A is a collection of localized labels, each containing a string and a language code. If a label for an item already has labels for other languages and you update it with a label that contains only one label for a specific language the parameter provides the option to overwrite the existing labels or merge your new label with any existing language labels. With set to true, any new labels defined will only overwrite existing labels when the languagecode matches. Gets or sets the metadata for the global option set. Required. Type: the metadata for the global option set. Required. Gets or sets the name of a solution to associate the global option set with. Optional. Type: StringThe name of a solution to associate the global option set with. Optional. Gets or sets the name of the attribute when updating a local option set in a picklist attribute. Optional. Type: StringThe name of the attribute when updating a local option set in a picklist attribute. Optional. Gets or sets a description for the option. Optional. Type:The description for the option. Optional. Gets or sets the logical name of the entity when updating the local option set in a picklist attribute. Optional. Type: StringThe logical name of the entity when updating the local option set in a picklist attribute. Optional. Gets or sets the label for the option. Optional. Type: The label for the option. Optional. Gets or sets whether to keep text defined for languages not included in the . Required. Type: Booleantrue if the text defined for languages not included in the is kept; otherwise, false. A contains a property that contains a . Each contains a string and a LanguageCode. When you specify a new Label this property provides you the option to preserve any label text for languages not included in the new label. Set this value to false if you want to remove text for languages not included in the label. Gets or sets the name of the global option set. Optional. Type: StringThe name of the global option set. Optional. Gets or sets the name of the unmanaged solution that this global option set should be associated with. Optional. Type: StringThe name of the unmanaged solution that this global option set should be associated with. Optional. Gets or sets the value for the option. Required. Type: Int32The value for the option. Required. Gets or sets whether to merge the new labels with any existing labels. Required. Type: Booleantrue if the new labels will be merged with any existing labels; otherwise, false. A is a collection of localized labels, each containing a string and a language code. If a label for an item already has labels for other languages and you update it with a label that contains only one label for a specific language the MergeLabels parameter provides the option to overwrite the existing labels or merge your new label with any existing language labels. With MergeLabels set to true, any new labels defined will only overwrite existing labels when the languagecode matches. Gets or sets the relationship metadata to be updated. Required. Type: The relationship metadata to be updated. Required.. Gets or sets the unique name of the unmanaged solution that this entity relationship should be associated with. Optional. Type: StringThe unique name of the unmanaged solution that this entity relationship should be associated with. Optional. Specifies the type of optimistic concurrency behavior that should be performed by the Web service when processing this request. Type: The concurrency behavior. Reduce potential data loss using optimistic concurrency Gets or sets an instance of an entity that is used to update a record. Required. Type: The entity instance used to update the record. If the target contains values for attributes that are not valid for update, they are ignored. This is where is false. You can find this information in the metadata for your organization. See the preceding metadata browser information. Gets or sets the logical name of the attribute. Optional. Type: StringThe logical name of the attribute. Optional. The logical name of the state attribute is always . Gets or sets the default value for the statuscode (status reason) attribute when this statecode value is set. Optional. Type: Nullable<Int32>The default value for the statuscode (status reason) attribute when this statecode value is set. Optional. Gets or sets the description label for the statecode option that is specified in the property. Optional. Type: the description label for the statecode option that is specified in the property. Optional. Gets or sets the name of the entity that has this statecode attribute. Optional. Type: StringThe name of the entity that has this statecode attribute. Optional. Gets or sets the display label for this statecode option that is specified by the property. Optional. Type: The display label for this statecode option that is specified by the property. Optional. Gets or sets whether to merge the current label with any existing labels that are already specified for this attribute. Required. Type: Boolean if any newly defined labels should only overwrite existing labels when their language code matches; otherwise, . A is a collection of localized labels where each collection contains a string and a language code. If a label for an item already has labels for other languages and you update it with a label that contains only one label for a specific language, the property provides the option to overwrite the existing labels or merge your new label with any existing labels. If you set to , any newly defined labels only overwrite existing labels when their language code matches. For internal use only. Type: StringFor internal use only. Gets or sets the statecode attribute options to update. Required. Type: Int32The statecode attribute options to update. Required. Gets or sets the target entity. Type: . Gets a Boolean value that specifies whether a record was created. Type: Boolean if a record was created, otherwise. Gets the target entity.. Gets or sets the behavior of the associated menu for an entity relationship. Type: Nullable<> One of the enumeration values that specify the behavior of the associated menu for a one-to-many relationship. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the group for the associated menu for an entity relationship. Type: Nullable<> One of the enumeration values that specify the group in which to display the associated menu for an entity relationship. Gets or sets the label for the associated menu. Type: A string that contains the menu label. Gets or sets the order for the associated menu. Type: Nullable<int> An integer that controls the relative position of navigation items in the group. The lower the integer value, the higher the item appears relative to the values of other items in the group. Gets the name of the attribute that this attribute extends. Type: String The attribute name. This property is read-only. This property will be set if the metadata attribute describes an attribute of another attribute. If this property contains a value, the attribute is for internal use only and won’t appear in the customization user interface (UI) in the web application. If you retrieve the metadata for the entity, there are three attributes that extend the attribute. They are , and . For each of these three attributes, the value of the property is "". Gets the type for the attribute. Type: Nullable<> The attribute type. This property is read-only it is set based on the type of passed to the message. For this value will return . Use to get a value that is correct for all types. Gets the name of the type for the attribute. Type: The name of the attribute type. This property is read-only. It is set based on the type of passed to the message, Use this property rather than to get a valid value for all types. Gets whether field-level security can be applied to prevent a user from adding data to this attribute. Type: Nullable<Boolean>true if the field-level security can be applied; otherwise, false. How field security can be used to control access to field values in Microsoft Dynamics 365Field security entities Gets whether field-level security can be applied to prevent a user from viewing data from this attribute. Type: Nullable<Boolean>true if field-level security can be applied; otherwise, false. How field security can be used to control access to field values in Microsoft Dynamics 365Field security entities Gets whether field-level security can be applied to prevent a user from updating data for this attribute. Type: Nullable<Boolean>true if field-level security can be applied; otherwise, false. How field security can be used to control access to field values in Microsoft Dynamics 365Field security entities Gets or sets the property that determines whether any settings not controlled by managed properties can be changed. Type: The property that determines whether any settings not controlled by managed properties can be changed. The properties that this setting controls varies depending on the type of attribute as shown in the following table. Property Description Applies to , , and attributes. Specifies which form value will be the default value. Applies to attributes only. Specifies whether a time is displayed with the date. Applies to , , , , , and attributes Specifies whether the Input method editor mode can be changed. Applies to and attributes. Specifies the maximum allowed length of string data that the attribute can store. Applies to the , , and attributes. Specifies the level of precision for data stored in these attributes. Gets an organization-specific ID for the attribute used for auditing. Type: Nullable<Int32> The organization-specific ID for the attribute used for auditing. This ID isn’t consistent between organizations. Use as the unique identifier for an attribute. Gets the Microsoft Dynamics 365 version that the attribute was deprecated in. Type: String The Microsoft Dynamics 365 version that the attribute was deprecated in. Gets or sets the description of the attribute. Type: The description of the attribute. This property can be specified for both and messages. Gets or sets the display name for the attribute. Type: The display name of the attribute. This property is required for the message. It can be specified for the message.This property must always have value set for the base language. Gets the logical name of the entity that contains the attribute. Type: String The logical name of the entity that contains the attribute. This property is read-only. It is set when the attribute is created, using the value from the . property. Gets a string identifying the solution version that the solution component was added in. Type: String The solution version number when the attribute was created. This identifies the major and minor versions of the solution that added this metadata item. For metadata that existed in Microsoft Dynamics CRM 2011 the value will be 5.0.0.0 and for metadata added with Microsoft Dynamics CRM 2013 the value will be 6.0.0.0. If new metadata is added in updates or future releases the version number will be incremented to the corresponding version. For metadata added by custom solutions the version of the solution that the item was created it is used. Gets or sets the property that determines whether the attribute is enabled for auditing. Type: The property that determines whether the attribute is enabled for auditing. Configure entities and attributes for auditing Gets whether the attribute is a custom attribute. Type: Nullable<Boolean>true if the attribute is a custom attribute; otherwise, false. Gets or sets the property that determines whether the attribute allows customization. Type: The property that determines whether the attribute allows customization. Gets whether the attribute is a logical attribute. Type: Nullable<Boolean>true if the attribute a logical attribute; otherwise, false. Logical attributes contain values which are stored in different database tables than other attributes in the entity. In most cases this internal implementation is not relevant to working with Microsoft Dynamics CRM. When you use logical attributes as sources for a calculated field the values in the calculated field cannot be sorted. Logical attributes Gets whether the attribute is part of a managed solution. Type: Nullable<Boolean>true if the attribute is part of a managed solution; otherwise, false. Gets whether the attribute represents the unique identifier for the record. Type: Nullable<Boolean>true if the attribute is the unique identifier for the record; otherwise, false. Entities that contain an address may have more than one attribute where is . Gets or sets whether the attribute represents the primary attribute for the entity. Type: Nullable<Boolean>true if the attribute is primary attribute for the entity; otherwise, false. If the value of this property is true, the value of the attribute is what will be displayed in lookup fields in the application. Gets or sets the property that determines whether the attribute display name can be changed. Type: The property that determines whether the attribute display name can be changed. Gets or sets whether the attribute is secured for field-level security. Type: Nullable<Boolean>true if the attribute is secured for field-level security; otherwise, false. How field security can be used to control access to field values in Microsoft Dynamics 365Field security entities Gets or sets the property that determines whether the attribute appears in Advanced Find. Type: The property that determines whether the attribute appears in Advanced Find. Gets whether the value can be set when a record is created. Type: Nullable<Boolean>true if the value can be set when a record is created; otherwise, false. Gets whether the value can be retrieved. Type: Nullable<Boolean>true if the value can be retrieved; otherwise, false. Gets whether the value can be updated. Type: Nullable<Boolean>true if the value can be updated; otherwise, false. Gets or sets an attribute that is linked between appointments and recurring appointments. Type: Nullable<Guid> The attribute ID that is linked between appointments and recurring appointments. Link custom attributes of the recurring appointment master (series) and appointment entities Gets or sets the logical name for the attribute. Type: String The logical name for the attribute. This property is read-only. The logical name is created by the system when an attribute is created. The logical name is an all lowercase version of the property. Options available when you create a custom entity Gets or sets the property that determines the data entry requirement level enforced for the attribute. Type: The property that determines the data entry requirement level enforced for the attribute. This property is required for the message. It can be specified for the message.The following values are valid when you create an attribute. Gets or sets the schema name for the attribute. Type: String The schema name for the attribute. This property is read-only except when you create an attribute. For the method, it is required and must be unique. This name has different length requirements depending on its use. The value of the property should be in Pascal case. It is converted to all lowercase for the property. Options available when you create a custom entity Gets or sets the value that indicates the source type for a calculated or rollup attribute. Type: Nullable<Int32> The value that indicates the source type for a calculated or rollup attribute. The following table contains the valid values for this attribute. Value Source Type null Not a valid type of attribute to be a calculated or rollup attribute. 0 Simple attribute. The attribute isn’t defined as a calculated or rollup attribute. 1 Calculated attribute 2 Rollup attribute Calculated and rollup attributes Gets or sets the maximum value for the attribute. Type: Nullable<Int64> The maximum value for the attribute. Gets or sets the minimum value for the attribute. Type: Nullable<Int64> The minimum value for the attribute. Gets or sets the default value for a Boolean option set. Type: Nullable<Boolean> The default value for a Boolean option set. Gets or sets the formula definition for calculated and rollup attributes. Type: StringThe formula definition for calculated and rollup attributes. To edit this property, you must use the formula editor in the application. More information: Customization Guide: Define Calculated Fields and Customization Guide: Define Rollup Fields. Calculated and rollup attributes Gets or sets the options for a boolean attribute. Type: The definition of the options. Gets the bitmask value that describes the sources of data used in a calculated attribute or whether the data sources are invalid. Type: Nullable<Int32> The value that indicates the source of data for a calculated or rollup attribute. The following table contains the valid values for this attribute. Value Description 0 Undefined: The default value for simple and rollup attributes. 1 Simple: The calculated attribute refers to an attribute in the same record. 2 Related: The calculated attribute refers to an attribute in a related record. 4 Logical: The calculated attribute refers to an attribute in the same record that is actually stored in a different database table. More information: Logical attributes 8 Calculated: The calculated attribute refers to another calculated attribute. 16 Rollup: The calculated attribute refers to a rollup attribute. 32 Invalid: The calculated or rollup attribute is invalid. Typically this would be where a field refers to an attribute that no longer exists. The SourceTypeMasks enumeration is useful when performing bitwise operations to check whether specific values are present in this bitmask value. Calculated and rollup attributesSourceTypeMasks enumerationLogical attributes Gets or sets option displayed when the attribute is false. Type: The option metadata for the false option.. Gets or sets option displayed when the attribute is true. Type: The option metadata for the true option.. The referenced entity record owner is changed. Type: Nullable<> The referenced entity record owner is changed. Valid options for the property are: . . . . The referenced entity record is deleted. Type: Nullable<> The referenced entity record is deleted. Valid options for the property are: . . . Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the structure that contains extra data. The record is merged with another record. Type: Nullable<> The record is merged with another record.. Valid options for the property are: . . The value of the referencing attribute in a parental relationship changes. changes. Type: Nullable<> The value of the referencing attribute in a parental relationship changes. changes. Valid options for the property are: . . . . About the reparent action The referenced entity record is shared with another user. Type: Nullable<> The referenced entity record is shared with another user. Valid options for the property are: . . . . Sharing is removed for the referenced entity record. Type: Nullable<> Sharing is removed for the referenced entity record. Valid options for the property are: . . . . Returns . Returns . Gets or sets whether the date and time behavior can be changed for the attribute. Returns if the behavior can be changed; otherwise, . Behavior and format of the date and time attribute Gets or sets the behavior of the attribute. Returns Behavior of the attribute. Behavior and format of the date and time attribute Gets or sets the date/time display format. Type: Nullable<> The date/time display format. If this property is not assigned a value, it defaults to . Gets or sets the formula definition for calculated and rollup attributes. Type: StringThe formula definition for calculated and rollup attributes. To edit this property, you must use the formula editor in the application. More information: Customization Guide: Define Calculated Fields and Customization Guide: Define Rollup Fields. Calculated and rollup attributes Gets or sets the input method editor (IME) mode for the attribute. Type: Nullable<> The input method editor mode for the attribute. If this property is not assigned a value, it defaults to . Gets the maximum supported value for this attribute. Type: DateTimeThe maximum supported date for this attribute. Gets the minimum supported value for this attribute. Type: DateTimeThe minimum supported date for this attribute. Gets the bitmask value that describes the sources of data used in a calculated attribute or whether the data sources are invalid. Type: Nullable<Int32> The value that indicates the source of data for a calculated or rollup attribute. The following table contains the valid values for this attribute. Value Description 0 Undefined: The default value for simple and rollup attributes. 1 Simple: The calculated attribute refers to an attribute in the same record. 2 Related: The calculated attribute refers to an attribute in a related record. 4 Logical: The calculated attribute refers to an attribute in the same record that is actually stored in a different database table. More information: Logical attributes. 8 Calculated: The calculated attribute refers to another calculated attribute. 16 Rollup: The calculated attribute refers a rollup attribute. 32 Invalid: The calculated or rollup attribute is invalid. Typically this would be where a field refers to an attribute that no longer exists. The SourceTypeMasks enumeration is useful when performing bitwise operations to check whether specific values are present in this bitmask value. Calculated and rollup attributesSourceTypeMasks enumerationLogical attributes Gets or sets the formula definition for calculated and rollup attributes. Type: StringThe formula definition for calculated and rollup attributes. To edit this property, you must use the formula editor in the application. More information: Customization Guide: Define Calculated Fields and Customization Guide: Define Rollup Fields. Calculated and rollup attributes Gets or sets the input method editor (IME) mode for the attribute. Type: Nullable<> The input method editor (IME) mode for the attribute.. If this property is not assigned a value, it defaults to Gets or sets the maximum value for the attribute. Type: Nullable<Decimal> The maximum value for the attribute. Possible values are -100 billion to 100 billion. If this property is not assigned a value, it defaults to 1000000000. Gets or sets the minimum value for the attribute. Type: Nullable<Decimal> The minimum value for the attribute. Possible values are -100 billion to 100 billion. If this property is not assigned a value, it defaults to 0. Gets or sets the precision for the attribute. Type: Nullable<Int32> The precision for the attribute. Possible values are 1-10. If this property is not assigned a value, it defaults to 2. Gets the bitmask value that describes the sources of data used in a calculated attribute or whether the data sources are invalid. Type: Nullable<Int32> The value that indicates the source of data for a calculated or rollup attribute. The following table contains the valid values for this attribute. Value Description 0 Undefined: The default value for simple and rollup attributes. 1 Simple: The calculated attribute refers to an attribute in the same record. 2 Related: The calculated attribute refers to an attribute in a related record. 4 Logical: The calculated attribute refers to an attribute in the same record that is actually stored in a different database table. More information: Logical attributes. 8 Calculated: The calculated attribute refers to another calculated attribute. 16 Rollup: The calculated attribute refers a rollup attribute. 32 Invalid: The calculated or rollup attribute is invalid. Typically this would be where a field refers to an attribute that no longer exists. The SourceTypeMasks enumeration is useful when performing bitwise operations to check whether specific values are present in this bitmask value. Calculated and rollup attributesSourceTypeMasks enumerationLogical attributes Gets or sets the input method editor (IME) mode for the attribute. Type: Nullable<> The input method editor (IME) mode for the attribute.. If this property is not assigned a value, it defaults to Gets or sets the maximum value for the attribute. Type: Nullable<Double> The maximum value for the attribute. If this property is not assigned a value, it defaults to 1000000000 Gets or sets the minimum value for the attribute. Type: Nullable<Double> The minimum value for the attribute. If this property is not assigned a value, it defaults to 0. Gets or sets the precision for the attribute. Type: Nullable<Int32> The precision for the attribute. If this property is not assigned a value, it defaults to2. Gets or sets the asynchronous job. Type: . Gets or sets the display name. Type:. Gets or sets the entity key index status. Type:. Gets or sets the entity logical name. Type: String Gets or sets the introduced version. Type: String Gets or sets a Boolean value that specifies whether the entity key metadata is customizable. Type: . Gets or sets a Boolean value that specifies whether entity key metadata is managed or not. Type: Boolean if it is managed, otherwise. Gets or sets the key attributes. Type: String Gets or sets the logical name. Type: String Gets or sets the schema name. Type: String Gets or sets whether a custom activity should appear in the activity menus in the Web application. Type: Nullable<Int32> The value indicates whether a custom activity should appear in the activity menus in the Web application. For a custom activity the default value is 1. This means that the custom activity is available in activity menus. Set this property to 0 at the creation of a custom activity to prevent displaying it in the activity menus. This value cannot be updated after the custom activity is created. Custom activitiesSample: Create a custom activity entity Gets the array of attribute metadata for the entity. Type: []The array of attribute metadata for the entity. Customize entity attribute metadata Gets or sets whether the entity is enabled for auto created access teams. Type: Nullable<Boolean>true if the entity will be enabled for auto created access teams; otherwise, false. For more information about access teams, see Use access teams and owner teams to collaborate and share information. Gets or sets whether to automatically move records to the owner’s default queue when a record of this type is created or assigned. Type: Nullable<Boolean>true if the record will automatically move to the owner’s default queue when a record of this type is created or assigned; otherwise, false. Gets the property that determines whether the entity can be in a Many-to-Many entity relationship. Type: The property that determines whether the entity can be in a Many-to-Many entity relationship. Use managed properties Gets the property that determines whether the entity can be the referenced entity in a One-to-Many entity relationship. Type: The property that determines whether the entity can be the referenced entity in a One-to-Many entity relationship. Use managed properties Gets the property that determines whether the entity can be the referencing entity in a One-to-Many entity relationship. Type: The property that determines whether the entity can be the referencing entity in a One-to-Many entity relationship. Use managed properties Gets or sets whether the hierarchical state of entity relationships included in your managed solutions can be changed. Type: The property that determines whether the hierarchical state of entity relationships included in your managed solutions can be changed. Customize entity metadata Gets or sets the property that determines whether additional attributes can be added to the entity. Type: The property that determines whether additional attributes can be added to the entity. Use managed properties Gets or sets the property that determines whether new charts can be created for the entity. Type: The property that determines whether new charts can be created for the entity. Use managed properties Gets or sets the property that determines whether new forms can be created for the entity. Type: The property that determines whether new forms can be created for the entity. Use managed properties Gets or sets the property that determines whether new views can be created for the entity. Type: The property that determines whether new views can be created for the entity. Use managed properties Gets or sets whether this entity can be enabled for relevance search when customizing a managed solution. Whether this entity can be enabled for relevance search when customizing a managed solution. Relevance search is feature planned for an future release. This setting will not apply until the feature is enabled. This setting will allow data for this entity to be synchronized with the external search index when relevance search is enabled. Gets or sets the property that determines whether any other entity properties not represented by a managed property can be changed. Type: The property that determines whether any other entity properties not represented by a managed property can be changed. Set this property to false if you want to prevent changes to the following properties when the Entity is added as part of a managed solution. Property Description HasActivities This is a property of the and that creates a special entity relationship with the ActivityPointer (activity) entity that allows activities to be associated with the entity. HasNotes This is a property of the and that creates a special entity relationship to the Annotation (note) entity that allows notes to be associated with the entity. This property allows users of Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access to access entity records while offline. This property allows documents in an organization with an integrated Sharepoint instance to be associated with this entity. Use managed properties Gets whether the entity can trigger a workflow process. Type: Nullable<Boolean>true if the entity can trigger a workflow process; otherwise, false. Supported entities for processes Gets or sets a Boolean value that specifies whether change tracking is enabled for an entity or not. Type: Nullable<Boolean> if change tracking is enabled; otherwise. Use change tracking to synchronize data with external systems Gets or sets the collection schema name of the entity. Type: String The collection schema name of the entity. Gets or sets the label containing the description for the entity. Type: The label containing the description for the entity. Sample: Create and update entity metadataExport and import translations Gets or sets the label containing the plural display name for the entity. Type: The label containing the plural display name for the entity. Sample: Create and update entity metadataExport and import translations Gets or sets the label containing the display name for the entity. Type The label containing the display name for the entity. Sample: Create and update entity metadataExport and import translations Gets whether the entity will enforce custom state transitions. Type: Nullable<Boolean>true if the entity supports custom status transitions.; otherwise, false. This property can only be set using the application. More information: Define custom state model transitions. Incident (case) is the only system entity that supports custom state transitions. Custom entities may also support custom state transitions. The definitions for the allowed transitions are stored in the . property. Gets or sets the hexadecimal code to represent the color to be used for this entity in the application. Type: StringThe hexadecimal code to represent the color to be used for this entity in the application. The value must conform to the hexadecimal color code format, such as "#FF0000" (red). Query and edit an organization theme Gets or sets the URL of the resource to display help content for this entity Type: String The URL of the resource to display help content for this entity Add custom help content Gets or sets whether the entity supports custom help content. Type: Nullable<Boolean>true if the entity supports custom help content.; otherwise, false. Add custom help content Gets or sets the entity set name. Type: String The entity set name. This value is used in the resource path for this entity in the Web API. For custom entities, you can change the name of the entity set used. By default it is the same as the . More information: Web API types and operations Gets or sets the name of the image web resource for the large icon for the entity. Type: String The name of the image web resource for the large icon for the entity.. This size icon is not currently used by the application. Modify the icons for an entity Gets or sets the name of the image web resource for the medium icon for the entity. Type: String The name of the image web resource for the medium icon for the entity.. Modify the icons for an entity Gets or sets the name of the image web resource for the small icon for the entity. Type: String The name of the image web resource for the small icon for the entity. Modify the icons for an entity Gets a string identifying the solution version that the solution component was added in. Type: String A string identifying the solution version that the solution component was added in. This identifies the major and minor versions of the solution that added this metadata item. For metadata that existed in Microsoft Dynamics CRM 2011 the value will be 5.0.0.0 and for metadata added with Microsoft Dynamics CRM 2013 the value will be 6.0.0.0. If new metadata is added in updates or future releases the version number will be incremented to the corresponding version. For metadata added by custom solutions the version of the solution that the item was created it is used. Gets or sets whether the entity is an activity. Type: Nullable<Boolean>true if the entity is an activity; otherwise, false. Custom activities Gets or sets whether the email messages can be sent to an email address stored in a record of this type. Type: Nullable<Boolean>true if emails can be sent to an email address stored in a record of this type; otherwise, false. Create and update an entity than can be emailed Gets whether the entity uses the updated user interface. Type: Nullable<Boolean>true if the entity uses the updated user interface; otherwise, false. Gets or sets the property that determines whether auditing has been enabled for the entity. Type: Nullable<>The property that determines whether auditing has been enabled for the entity. Configure entities and attributes for auditing Gets or sets whether the entity is available offline. Type: Nullable<Boolean>true if the entity is available offline; otherwise, false. Editable entity properties Gets whether the entity is enabled for business process flows. Type: Nullable<Boolean>true if; the entity is enabled for business process flows otherwise, false. See Model business process flows for more information. Gets whether the entity is a child entity. Type: Nullable<Boolean>true if the entity is a child entity; otherwise, false. A child entity is an entity that inherits security from a parent. There are no privileges associated with child entities. For example is a child entity of . If you can create records you can create records. Most child entities represent line items for the parent. The following table contains the child entities in Microsoft Dynamics CRM Online 2015 Update 1. Gets or sets the property that determines whether connections are enabled for this entity. Type: Nullable<>The property that determines whether connections are enabled for this entity. Connection entities Gets whether the entity is a custom entity. Type: Nullable<Boolean>true if the entity is a custom entity; otherwise, false. Gets or sets the property that determines whether the entity is customizable. Type: The property that determines whether the entity is customizable. Use managed properties Gets or sets the property that determines whether document management is enabled. Type: Nullable<Boolean>true if the entity is enabled for document management; otherwise, false Enable document management for entities Gets or sets whether the entity is enabled for document recommendations. Type: Nullable<Boolean>true if the entity is enabled for document recommendations; otherwise, false Gets or sets the property that determines whether duplicate detection is enabled. Type: The property that determines whether duplicate detection is enabled.. Detect duplicate data Gets whether charts are enabled. Type: Nullable<Boolean>true if charts are enabled; otherwise, false. Type: Nullable<Boolean>. For internal use only. Type: Nullable<Boolean>For internal use only. Gets whether the entity can be imported using the Import Wizard. Type: Nullable<Boolean>true if the entity can be imported using the Import Wizard; otherwise, false. Import data Gets or sets whether the entity is enabled for interactive experience. Type: Nullable<Boolean> if the entity is enabled for interactive experience; otherwise, . You can change this setting for custom entities or system entities, such as incident, where it is enabled. You cannot change this setting for system entities where it is not enabled by default. Gets whether the entity is an intersection table for two other entities. Type: Nullable<Boolean>true if the entity is an intersection table for two other entities.; otherwise, false Sample: Create and retrieve entity relationships Gets or sets whether Parature knowledge management integration is enabled for the entity. Type: Nullable<Boolean> if Parature knowledge management integration is enabled; otherwise. Use Parature knowledge in Dynamics 365TechNet: Connect Microsoft Dynamics CRM to Parature knowledge basehttps://technet.microsoft.com/en-us/library/dn946909.aspx Gets or sets the property that determines whether mail merge is enabled for this entity. Type: The property that determines whether mail merge is enabled for this entity.. Editable entity properties Gets whether the entity is part of a managed solution. Type: Nullable<Boolean>true if the entity is part of a managed solution; otherwise, false. Unmanaged and managed solutions Gets or sets the property that determines whether entity mapping is available for the entity. Type: The property that determines whether entity mapping is available for the entity.. Customize entity and attribute mappingsUse managed properties Gets or sets whether OneNote integration is enabled for the. Type: Nullable<Boolean>true if the OneNote integration is enabled for the entity; otherwise, false. Integrate Microsoft Dynamics 365 with OneNote Gets whether optimistic concurrency is enabled for the entity Type: Nullable<Boolean>true if the optimistic concurrency is enabled for the entity; otherwise, false. For Microsoft Dynamics CRM Online 2015 Update 1 this property is true for selected system entities and custom entities. Reduce potential data loss using optimistic concurrency Gets whether the entity is public or private. Type: Nullable<Boolean>true if the entity is private; otherwise, false. Gets or sets the value indicating if the entity is enabled for quick create forms. Type: Nullable<Boolean>true if the entity is enabled for quick create forms ; otherwise, false. For activity entities or any system entities where is false, setting this value to true will not enable quick create forms. For internal use only. Type: Nullable<Boolean>For internal use only. Gets or sets the property that determines whether Microsoft Dynamics 365 for tablets users can update data for this entity. Type: The property that determines whether Microsoft Dynamics 365 for tablets users can update data for this entity. Use managed properties Gets or sets the property that determines whether the entity and can be changed by editing the entity in the application. Type: The property that determines whether the entity and can be changed by editing the entity in the application. The labels for the display names can be updated programmatically even when this property is set to false. Use managed properties Gets or sets the value indicating if the entity is enabled for service level agreements (SLAs). Type: Nullable<Boolean>true if the entity is enabled for SLAs; otherwise, false. Enable entities for applying SLAs Gets whether the entity supports setting custom state transitions. Type: Nullable<Boolean>true if the entity supports custom status transitions.; otherwise, false. The incident (case) entity is the only system entity that supports custom status transitions. Custom entities are also state model aware. More information: Define custom state model transitions. Gets or sets whether the entity is will be shown in Advanced Find. Type: Nullable<Boolean>true if the entity is will be shown in Advanced Find.; otherwise, false. Gets or sets the property that determines whether the entity is enabled for queues. Type: The property that determines whether the entity is enabled for queues. Use managed propertiesEnable entities for queues Gets or sets the property that determines whether Microsoft Dynamics 365 for phones users can see data for this entity. Type: The property that determines whether Microsoft Dynamics 365 for phones users can see data for this entity. Use managed properties Gets or sets the property that determines whether Microsoft Dynamics 365 for tablets users can see data for this entity. Type: The property that determines whether Microsoft Dynamics 365 for tablets users can see data for this entity. Use managed properties Gets an array of keys for an entity. Type: []An array of keys for an entity. When an entity has alternate keys defined, this property contains the definitions for those keys. Define alternate keys for an entity Gets the logical collection name. Type: String The logical collection name. Gets or sets the logical name for the entity. Type: String The logical name for the entity. Gets the array of many-to-many relationships for the entity. Type: []The array of many-to-many relationships for the entity. Gets the array of many-to-one relationships for the entity. Type: []The array of many-to-one relationships for the entity. Gets the entity type code. Type: Nullable<Int32> The entity type code. Always use the entity schema name () to refer to a custom entity in code and queries. Do not use the object type code (also referred to as entity type) code because tis integer value varies for custom entities in different organizations. Best practices for developing with Microsoft Dynamics 365 Gets the array of one-to-many relationships for the entity. Type :[]The array of one-to-many relationships for the entity. Gets or sets the ownership type for the entity. Type: Nullable<> The ownership type for the entity.. Entity ownership Gets the name of the attribute that is the primary id for the entity. Type: String The name of the attribute that is the primary id for the entity. The value is usually <entity logical name> + “id”. Gets the name of the primary image attribute for an entity. Type: String The name of the primary image attribute for an entity. When an entity contains a attribute this value will be the name of the attribute containing the image used in the application. Each entity can have only one image attribute and the logical name of that attribute is always . This property has been added to prepare for a future release in which entities may support multiple image attributes and there may be need to change which image is used as the primary image for the entity. Gets the name of the primary attribute for an entity. Type: String The name of the primary attribute for an entity.. Each entity that contains records that can appear in the application will have a primary attribute. Each custom entity will have a primary attribute. The default name for the primary attribute is ‘name’ and this is the most common value for PrimaryNameAttribute. The value in the corresponding attribute is the value that will appear in a lookup attribute when that record is selected. Many entities do not appear in the application and do not have a value set for PrimaryNameAttribute. Gets the privilege metadata for the entity. Returns []The privilege metadata for the entity.. Gets the name of the entity that is recurring. Type: String The name of the entity that is recurring. Only the entity contains a value for this attribute, and that value is ‘appointment’ to indicate that appointments are the types of records created. Gets the name of the report view for the entity. Type: String The name of the report view for the entity.. Gets or sets the schema name for the entity. Type: String The schema name for the entity. Gets or sets whether this entity is searchable in relevance search. Type: Nullable<Boolean>true if the entity is searchable in relevance search; otherwise, false. Relevance search is feature planned for an future release. This setting will not apply until the feature is enabled. This setting will allow data for this entity to be synchronized with the external search index when relevance search is enabled. Gets or sets the default form value for the attribute. Type: Nullable<Int32> The default form value for the attribute.. Gets or sets the available options for the attribute. Type: The available options for the attribute. Gets or sets whether the attribute is the primary image for the entity. Type: Nullable<Boolean>true if the attribute is the primary image for the entity; otherwise, false. Gets the maximum height of the image. Type: Nullable<Int16> The maximum height for the image. Gets the maximum width of the image. Type: Nullable<Int16> The maximum width for the image. Gets or sets the format options for the integer attribute. Type: Nullable<> The format options for the integer attribute. If this property is not assigned a value, it defaults to Gets or sets the formula definition for calculated and rollup attributes. Type: StringThe formula definition for calculated and rollup attributes. To edit this property, you must use the formula editor in the application. More information: Customization Guide: Define Calculated Fields and Customization Guide: Define Rollup Fields. Calculated and rollup attributes Gets or sets the maximum value for the attribute. Type: Nullable<Int32> The maximum value for the attribute. If this property is not assigned a value, it defaults to2147483647 Possible values are -2147483648 to 2147483647. Gets or sets the minimum value for the attribute. Type: Nullable<Int32> The minimum value for the attribute. If this property is not assigned a value, it defaults to-2147483648 Possible values are -2147483648 to 2147483647. Gets the bitmask value that describes the sources of data used in a calculated attribute or whether the data sources are invalid. Type: Nullable<Int32> The value that indicates the source of data for a calculated or rollup attribute. The following table contains the valid values for this attribute. Value Description 0 Undefined: The default value for simple and rollup attributes. 1 Simple: The calculated attribute refers to an attribute in the same record. 2 Related: The calculated attribute refers to an attribute in a related record. 4 Logical: The calculated attribute refers to an attribute in the same record that is actually stored in a different database table. More information: Logical attributes. 8 Calculated: The calculated attribute refers to another calculated attribute. 16 Rollup: The calculated attribute refers a rollup attribute. 32 Invalid: The calculated or rollup attribute is invalid. Typically this would be where a field refers to an attribute that no longer exists. The SourceTypeMasks enumeration is useful when performing bitwise operations to check whether specific values are present in this bitmask value. Calculated and rollup attributesSourceTypeMasks enumerationLogical attributes Gets or sets the target entity types for the lookup. Type: String[] The array of target entity types for the lookup. The value contains an array of entity logical names. If this value is not null, the lookup can only reference the entities contained in the array. If the value is null, use of the of the lookup attribute is not supported. For internal use only. Type: StringFor internal use only. For internal use only. Type: StringFor internal use only. For internal use only. Type: Nullable<Int32>For internal use only. For internal use only. Type: For internal use only. For internal use only. Type: For internal use only. For internal use only. Type: For internal use only. For internal use only. Type: StringFor internal use only. For internal use only. Type: StringFor internal use only. For internal use only. Type: Nullable<Int32>For internal use only. For internal use only. Type: Nullable<>For internal use only. Gets a string identifying the solution version that the solution component was added in. Type: String A string identifying the solution version that the solution component was added in. This identifies the major and minor versions of the solution that added this metadata item. For metadata that existed in Microsoft Dynamics CRM 2011 the value will be 5.0.0.0 and for metadata added with Microsoft Dynamics CRM 2013 the value will be 6.0.0.0. If new metadata is added in updates or future releases the version number will be incremented to the corresponding version. For metadata added by custom solutions the version of the solution that the item was created it is used. For internal use only. Type: Nullable<Boolean>For internal use only. For internal use only. Type: Nullable<Boolean>For internal use only. For internal use only. Type: StringFor internal use only. For internal use only. Type: Nullable<>For internal use only. For internal use only. Type: Nullable<>For internal use only. Gets or sets the associated menu configuration for the first entity. Type: The associated menu configuration for the first entity. Gets or sets the attribute that defines the relationship in the first entity. Type: String The attribute that defines the relationship in the first entity. Gets or sets the logical name of the first entity in the relationship. Type: String The logical name of the first entity in the relationship. Gets or sets the navigation property name for the first entity in the relationship. Type: String The navigation property name for the first entity in the relationship. Gets or sets the associated menu configuration for the second entity. Type: The associated menu configuration for the second entity. Gets or sets the attribute that defines the relationship in the second entity. Type: String The attribute that defines the relationship in the second entity.. Gets or sets the logical name of the second entity in the relationship. Type: String The logical name of the second entity in the relationship.. Gets or sets the navigation property name for the second entity in the relationship. Type: String The navigation property name for the second entity in the relationship. Gets or sets the name of the intersect entity for the relationship. Type: String The name of the intersect entity for the relationship.. Gets or sets the format options for the memo attribute. Type: Nullable<> The format options for the memo attribute. Optional for Create.If this property is not assigned a value, it defaults to. Gets or sets the value for the input method editor mode. Type: Nullable<> The value for the input method editor mode.. Optional for Create. If this property is not assigned a value, it defaults to Gets whether the attribute supports localizable values. Type: Nullable<Boolean> if the attribute supports localizable values; otherwise, . The value is false for all but a few system entities that support this capability. More information: Attributes that support localized property values. Gets or sets the maximum length for the attribute. Type: Nullable<Int32> The maximum length for the attribute. Required for Create. Possible values are between 1 and 1048576. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets whether the item of metadata has changed. Type: Nullable<Boolean>true if metadata item has changed since the last query; otherwise, false. When metadata is retrieved using , with a valid parameter, the . property contains an of all the changed metadata. When a child item has changed but a parent item has not, the property of the child will be but for the parent it will be . It is not valid to use this attribute as part of a query because the value is calculated. The value will be null except in the results of a query that returns information about changes from a previous query. Gets or sets a unique identifier for the metadata item. Type: Nullable<Guid> The unique identifier for the metadata item. For internal use only. Type: StringFor internal use only. If this property is not assigned a value, it defaults to . Gets or sets the formula definition for calculated and rollup attributes. Type: StringThe formula definition for calculated and rollup attributes. If you want to edit the value of this property, you have to use the formula editor in the application. More information: Customization Guide: Define Calculated Fields and Customization Guide: Define Rollup Fields. Calculated and rollup attributes Gets or sets the input method editor (IME) mode for the attribute. Type: Nullable<> The input method editor (IME) mode for the attribute.. If this property is not assigned a value, it defaults to . Gets whether the attribute represents the base currency or the transaction currency. Type : Nullable<Boolean> if the attribute is the base currency; otherwise, . Each transaction currency money attribute in an entity will have a corresponding base currency money attribute that uses the following naming convention: <money attribute name>. This property identifies whether the attribute is the base currency money attribute. Gets or sets the maximum value for the attribute. Type: Nullable<Double> The maximum value for the attribute. If this property is not assigned a value, it defaults to 1000000000. Gets or sets the minimum value for the attribute. Type: Nullable<Double> The minimum value for the attribute. If this property is not assigned a value, it defaults to 0. Gets or sets the precision for the attribute. Type: Nullable<Int32> The precision for the attribute. If this property is not assigned a value, it defaults to 2. Gets or sets the precision source for the attribute. Type: Nullable<Int32> The precision source for the attribute. If this property is not assigned a value, it defaults to 2. For most money fields the precision comes from the property. However, for money fields related to price, the precision come from the .. For money fields which use another currency the . may be used. Valid values for this property are: Value Description 0 Precision specified in the . property should be used. 1 Precision specified in . attribute should be used. 2 Precision specified in the . property of the transaction currency that is associated the current record. Gets the bitmask value that describes the sources of data used in a calculated attribute or indicates whether the data sources are invalid. Type: Nullable<Int32> The value that indicates the source of data for a calculated or rollup attribute. The following table contains the valid values for this attribute: Value Description 0 Undefined: The default value for simple and rollup attributes. 1 Simple: The calculated attribute refers to an attribute in the same record. 2 Related: The calculated attribute refers to an attribute in a related record. 4 Logical: The calculated attribute refers to an attribute in the same record that is actually stored in a different database table. More information: Logical attributes. 8 Calculated: The calculated attribute refers to another calculated attribute. 16 Rollup: The calculated attribute refers a rollup attribute. 32 Invalid: The calculated or rollup attribute is invalid. Typically this would be where a field refers to an attribute that no longer exists. The SourceTypeMasks enumeration is useful when performing bitwise operations to check whether specific values are present in this bitmask value. Calculated and rollup attributesSourceTypeMasks enumerationLogical attributes Gets or sets the associated menu configuration. Type: The associated menu configuration. Gets or sets cascading behaviors for the entity relationship. Type: The cascading behaviors for the entity relationship. Configure entity relationship behavior Gets or sets whether this relationship is the designated hierarchical self-referential relationship for this entity. Type: Nullable<Boolean> if this relationships is the designated hierarchical self-referential relationship for this entity; otherwise, . Hierarchical one-to-many entity relationshipsQuery hierarchical data Get or set the name of primary attribute for the referenced entity. Type: String The name of primary attribute for the referenced entity.. For example, if Account is the referenced entity the referenced attribute would be . Get or set the name of the referenced entity. Type: String The name of the referenced entity. Gets or sets the name of the collection-valued navigation property used by this relationship. Type: String The name of the collection-valued navigation property used by this relationship.. Get or set the name of the referencing attribute. Type: String The name of the referencing attribute. The referencing attribute is a lookup attribute created on the referencing entity when the one-to-many entity relationship is created. Gets or sets the name of the referencing entity. Type: String The name of the referencing entity. Gets or sets the name of the single-valued navigation property used by this relationship. Type: String The name of the single -valued navigation property used by this relationship. Gets or sets the hexadecimal value set to assign a color for the option. Type: StringThe hexadecimal value set to assign a color for the option. Gets or sets the label containing the description for the option. Type: The label containing the description for the option.. Gets whether the option is part of a managed solution. Type: Nullable<Boolean>true if the option is part of a managed solution.; otherwise, false Gets or sets the label containing the text for the option. Type: The label containing the text for the option.. Gets or sets the value of the option. Type: Nullable<Int32> The value of the option. It is recommended that you do not set the value. Leave it null when you create the option and allow the system to generate a unique value. Merge option set options Gets the options available in the option set. Type: The options available in the option set. Gets or sets a description for the option set. Type: The description for the option set. Gets or sets a display name for a global option set. Type: The display name for a global option set. Gets a string identifying the solution version that the solution component was added in. Type: String A string identifying the solution version that the solution component was added in. This identifies the major and minor versions of the solution that added this metadata item. For metadata that existed in Microsoft Dynamics CRM 2011 the value will be 5.0.0.0 and for metadata added with Microsoft Dynamics CRM 2013 the value will be 6.0.0.0. If new metadata is added in updates or future releases the version number will be incremented to the corresponding version. For metadata added by custom solutions the version of the solution that the item was created it is used. Gets or sets a property that determines whether the option set is customizable. Type: The property that determines whether the option set is customizable. Gets or sets whether the option set is a custom option set. Type: Nullable<Boolean>true if the option set is a custom option set; otherwise, false. Gets or sets whether the option set is a global option set. Type: Nullable<Boolean>true if the option set is a global option set; otherwise, false. Gets or sets whether the option set is part of a managed solution. Type: Nullable<Boolean>true if the option set is part of a managed solution; otherwise, false. Gets or sets the name of a global option set. Type: String The name of a global option set. Gets or sets the type of option set. Type: Nullable<> The type of option set. Gets or sets the formula definition for calculated and rollup attributes. Type: StringThe formula definition for calculated and rollup attributes. To edit this property, you must use the formula editor in the application. More information: Customization Guide: Define Calculated Fields and Customization Guide: Define Rollup Fields. Calculated and rollup attributes Gets the bitmask value that describes the sources of data used in a calculated attribute or whether the data sources are invalid. Type: Nullable<Int32> The value that indicates the source of data for a calculated or rollup attribute. The following table contains the valid values for this attribute. Value Description 0 Undefined: The default value for simple and rollup attributes. 1 Simple: The calculated attribute refers to an attribute in the same record. 2 Related: The calculated attribute refers to an attribute in a related record. 4 Logical: The calculated attribute refers to an attribute in the same record that is actually stored in a different database table. More information: Logical attributes. 8 Calculated: The calculated attribute refers to another calculated attribute. 16 Rollup: The calculated attribute refers a rollup attribute. 32 Invalid: The calculated or rollup attribute is invalid. Typically this would be where a field refers to an attribute that no longer exists. The SourceTypeMasks enumeration is useful when performing bitwise operations to check whether specific values are present in this bitmask value. Calculated and rollup attributesSourceTypeMasks enumerationLogical attributes Gets or sets a query expression for the entity attribute metadata to return. Type: . Gets or sets a query expression for the labels to return. Type:. Gets or sets a query expression for the entity relationship metadata to return. Type:. Gets the LCID values for localized labels to be retrieved for metadata items. Type <Int32>The LCID values for localized labels to be retrieved for metadata items. This value is read-only. Use the methods to set the values. When this optional parameter is set to 1, the query will include labels for the base language if the label for the requested language is not there. Type: Int32. Gets or sets the condition operator. Type: . The condition operator. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the name of the metadata property in the condition expression. Type: String The name of the metadata property in the condition expression. Gets or sets the value for the metadata property. Type: Object The value for the metadata property. Gets condition expressions that include metadata properties, condition operators and values. Type: <>The collection of metadata condition expressions. This property is read-only. Use the methods to manipulate the condition expressions. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the logical AND/OR filter operator. Type: The filter operator. Gets a collection of logical filter expressions that filter the results of the metadata query. Type: <>. This property is read-only. Use the methods to manipulate the filters. Gets or sets whether to retrieve all the properties of a metadata object. Type: Booleantrue to specify to retrieve all metadata object properties; false to retrieve only specified metadata object properties. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets a collection of strings representing the metadata properties to retrieve. Type: <String> The collection of strings representing the metadata properties to retrieve. Use the methods to manipulate the property names. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the filter criteria for the metadata query. Returns The filter criteria for the metadata query. Gets or sets the properties to be returned by the query. Returns The properties to be returned by the query. Gets a string identifying the solution version that the solution component was added in. Type: String A string identifying the solution version that the solution component was added in. This identifies the major and minor versions of the solution that added this metadata item. For metadata that existed in Microsoft Dynamics CRM 2011 the value will be 5.0.0.0 and for metadata added with Microsoft Dynamics CRM 2013 the value will be 6.0.0.0. If new metadata is added in updates or future releases the version number will be incremented to the corresponding version. For metadata added by custom solutions the version of the solution that the item was created it is used. Gets or sets whether the entity relationship is customizable. Type: Whether the entity relationship is customizable. Use managed properties Gets whether the relationship is a custom relationship. Type: Nullable<Boolean>true if the relationship is a custom relationship; otherwise, false. Gets whether the entity relationship is part of a managed solution. Type: Nullable<Boolean>true if the entity relationships is part of a managed solution; otherwise, false. Gets or sets whether the entity relationship should be shown in Advanced Find. Type: Nullable<Boolean>true if the entity relationship should be shown in Advanced Find; otherwise, false. Gets the type of relationship. Type:. This attribute provides a way for a to differentiate between ManyToMany relationships and OneToMany relationships. This value will be set by the system. You should not set this value when you create an entity relationship. Gets or sets the schema name for the entity relationship. Type: String The schema name for the entity relationship. Gets or sets the security type for the relationship. Type: Nullable<> The security type for the relationship. This value will be set by the system. You should not set this value when you create an entity relationship. Gets whether the privilege can be basic access level. Type: Booleantrue if the privilege can be basic access level.; otherwise, false. Gets whether the privilege can be deep access level. Type: Booleantrue if the privilege can be deep access level; otherwise, false. Gets whether the privilege can be global access level. Type: Booleantrue if the privilege can be global access level; otherwise, false. Gets whether the privilege can be local access level. Type: Booleantrue if the privilege can be local access level; otherwise, false. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets the name of the privilege. Type: String The name of the privilege. Gets the ID of the privilege. Type: Guid The ID of the privilege. Gets the type of the privilege. Type: The type of the privilege. Gets or sets the default status value associated with this state. Type: Nullable<Int32> The default status value associated with this state. Gets or sets the name of the state that does not change. Type: String The name of the state that does not change. Gets or sets the state that this status is associated with. Type: Nullable<Int32> The state that this status is associated with. Gets or sets the status transitions allowed for this status. Type: String The encoded XML document that defines the allowed transitions. When the . property is , the data in this property defines which status changes are allowed. The document defines both the current status and the allowed status values . &lt;allowedtransitions xmlns="http://schemas.microsoft.com/crm/2009/WebServices"&gt; &lt;allowedtransition sourcestatusid="1" tostatusid="6" /&gt; &lt;/allowedtransitions&gt; Information about the value that corresponds to the allowed status values is available by querying the . property of the option with the . that corresponds to the value. More information: Define custom state model transitions Gets or sets the format for the string Type: Nullable<> The format of the string attribute. If this property is not assigned a value, and is also not assigned a value, it defaults to . Use instead of this property to set the format. The enumeration is deprecated. If both properties are set the value will be used. Gets or sets the format for the string. Type: The format for the string attribute. If this property is not set and is not set it defaults to . Use this property rather than . If both properties are set, this property will be used. Gets or sets the formula definition for calculated and rollup attributes. Type: StringThe formula definition for calculated and rollup attributes. To edit this property, you must use the formula editor in the application. More information: Customization Guide: Define Calculated Fields and Customization Guide: Define Rollup Fields. Calculated and rollup attributes Gets or sets the IME mode for the attribute. Type: Nullable<> The input method editor mode. If this property is not assigned a value, it defaults to Gets whether the attribute supports localizable values. Type: Nullable<Boolean> if the attribute supports localizable values; otherwise, . The value is false for all but a few system entities that support this capability. More information: Attributes that support localized property values. Gets or sets the maximum length for the string. Type: Nullable<int> The maximum length. Required For Create. Increasing the maximum length of an attribute that is the source field for an attribute mapping may cause truncation of data or errors when a solution containing these attributes is imported into another system. When you increase the of an attribute, check whether any other attributes are mapped to it and ensure that the maximum length of any attributes that are the target in the mapping are an equal or longer length. For more information, see Using entity and attribute mapping data. Gets the bitmask value that describes the sources of data used in a calculated attribute or whether the data sources are invalid. Type: Nullable<Int32> The value that indicates the source of data for a calculated or rollup attribute. The following table contains the valid values for this attribute. Value Description 0 Undefined: The default value for simple and rollup attributes. 1 Simple: The calculated attribute refers to an attribute in the same record. 2 Related: The calculated attribute refers to an attribute in a related record. 4 Logical: The calculated attribute refers to an attribute in the same record that is actually stored in a different database table. More information: Logical attributes. 8 Calculated: The calculated attribute refers to another calculated attribute. 16 Rollup: The calculated attribute refers a rollup attribute. 32 Invalid: The calculated or rollup attribute is invalid. Typically this would be where a field refers to an attribute that no longer exists. The SourceTypeMasks enumeration is useful when performing bitwise operations to check whether specific values are present in this bitmask value. Calculated and rollup attributesSourceTypeMasks enumerationLogical attributes For internal use only. Type: StringFor internal use only. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the value of the attribute. Type: DecimalThe value of the attribute. Gets or sets the extension data. Type:. Gets or sets the new or updated entity. Type: . Gets or sets the change type. Type: . Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the structure that contains extra data. Gets or sets the current value. Type: Int32 The current value. Gets a collection that identifies the service type and address for each endpoint of the organization. Type: The collection that identifies the service type and address for each endpoint of the organization. Gets or sets extra data of the organization. Type: ExtensionDataObjectExtra data of the organization. Gets or sets the friendly name of the organization. Type: StringThe friendly name of the organization. The friendly name was defined when the organization was provisioned. Gets or sets the global unique identifier of the organization. Type: GuidThe global unique identifier of the organization. Gets or sets the version of the organization. Type: StringThe version of the organization. Gets or sets the state of the organization. Type: The state of the organization. Gets or sets the unique name of the organization. Type: StringThe unique name of the organization. The unique name isn’t necessarily similar to the friendly name. The organization unique name was defined when the organization was created. To determine the organization unique name using the Microsoft Dynamics 365 web application, go to Settings > Customizations > Developer Resources. Gets or sets the organization name used in the URL for the organization web service. Type: String The organization name used in the URL for the organization web service. The organization URL name is AdventureWorksCycle in the following web service URL example. http://localhost/AdventureWorksCycle/xrmservices/2011/Organization.svc Gets or sets the structure that contains extra data. Optional. Type: ExtensionDataObject The extension data. Gets or sets the indexer for the collection. Type: String. The name of the parameter. Type: Object The indexer for the request. Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes. Type: The collection of parameters for the request. Required, but is supplied by derived classes. The parameters collection is populated automatically if you are using a derived message class such as . Otherwise you must populate the collection with the parameters required for the message. Gets or sets the ID of an asynchronous operation (system job). Optional. Type: Nullable<Guid>The ID of an asynchronous operation (system job). You can pass an optional parameter into any message by setting this property. For any message that can be used in an asynchronous operation, set this to the value of . Gets or sets the name of the request. Required, but is supplied by derived classes. Type: StringThe name of the request. Message request names can be found in the SDK Message entity. The following is a list of valid message names that have been retrieved from the SDK Message entity and whether they can be used online (connected to the server), offline (disconnected) or both. Sdk message request name Sdk message filter availability AddItemCampaignActivity Both AddItemCampaign Both AddListMembersList Online AddMemberList Online AddMembersTeam Online AddPrivilegesRole Online AddProductToKit Both AddRecurrence Both AddSolutionComponent Online AddSubstituteProduct Both AddToQueue Both Assign Online Associate Both AssociateEntities Both AutoMapEntity Online BackgroundSendEmail Both Book Online BulkDelete Online BulkDetectDuplicates Online SendBulkMail Online BulkOperationStatusClose Both CalculateActualValueOpportunity Both CalculateTotalTimeIncident Both CanBeReferenced Online CanBeReferencing Online CancelSalesOrder Both CancelContract Both CanManyToMany Online CheckIncomingEmail Both CheckPromoteEmail Both CleanUpBulkOperation Both CloneContract Both CloseQuote Both CloseIncident Both CompoundCreate Both CompoundUpdate Both CompoundUpdateDuplicateDetectionRule Online ConvertKitToProduct Online ConvertProductToKit Online ConvertQuoteToSalesOrder Both ConvertSalesOrderToInvoice Online CopyCampaign Online CopyCampaignResponse Both CopyDynamicListToStatic Online CopyMembersList Online CopySystemForm Online Create Online CreateActivitiesList Online CreateAttribute Online CreateEntity Online CreateException Both CreateInstance Online CreateManyToMany Online CreateOneToMany Online CreateOptionSet Online CreateWorkflowFromTemplate Online Delete Online DeleteAttribute Online DeleteAuditData Online DeleteEntity Online DeleteOpenInstances Both DeleteOptionSet Online DeleteOptionValue Online DeleteRelationship Online DeliverIncomingEmail Online DeliverPromoteEmail Both DeprovisionLanguage Online Disassociate Both DisassociateEntities Both DistributeCampaignActivity Online DownloadReportDefinition Online QueryExpressionToFetchXml Both ExecuteFetch Online ExecuteByIdSavedQuery Both ExecuteByIdUserQuery Both ExecuteWorkflow Online ExpandCalendar Both ExportMappingsImportMap Online ExportSolution Online ExportTranslation Online FetchXmlToQueryExpression Both FindParentResourceGroup Both FulfillSalesOrder Both GenerateInvoiceFromOpportunity Both GenerateQuoteFromOpportunity Both GenerateSalesOrderFromOpportunity Both GetAllTimeZonesWithDisplayName Both GetDecryptionKey Online GetDistinctValuesImportFile Both GetHeaderColumnsImportFile Both GetInvoiceProductsFromOpportunity Both GetQuantityDecimal Both GetQuoteProductsFromOpportunity Both GetReportHistoryLimit Online GetSalesOrderProductsFromOpportunity Both GetTimeZoneCodeByLocalizedName Both GetTrackingTokenEmail Both GetValidManyToMany Online GetValidReferencedEntities Both GetValidReferencingEntities Online GrantAccess Online ImportMappingsImportMap Online ImportRecordsImport Both ImportSolution Online ImportTranslation Online InitializeFrom Both InsertOptionValue Online InsertStatusValue Online InstallSampleData Online InstantiateTemplate Both InstantiateFilters Online IsBackOfficeInstalled Both IsComponentCustomizable Both IsValidStateTransition Both LocalTimeFromUtcTime Both LockInvoicePricing Online LockSalesOrderPricing Online LogFailureBulkOperation Both LogSuccessBulkOperation Both LoseOpportunity Both MakeAvailableToOrganizationReport Online MakeAvailableToOrganizationTemplate Online MakeUnavailableToOrganizationReport Online MakeUnavailableToOrganizationTemplate Online Merge Online ModifyAccess Online OrderOption Online ParseImport Both ProcessInboundEmail Online ProcessOneMemberBulkOperation Both PropagateByExpression Both ProvisionLanguage Online PublishXml Online PublishDuplicateRule Online PublishAllXml Online QualifyLead Both QualifyMemberList Both QuerySchedule Both QueryMultipleSchedules Both ReassignObjectsSystemUser Online ReassignObjectsOwner Online Recalculate Online RemoveItemCampaign Both RemoveItemCampaignActivity Both RemoveMemberList Online RemoveMembersTeam Online RemoveParent Online RemovePrivilegeRole Online RemoveProductFromKit Both RemoveRelated Both RemoveSolutionComponent Online RemoveSubstituteProduct Both RenewContract Both ReplacePrivilegesRole Online Reschedule Online ResetUserFilters Both Retrieve Online RetrieveAbsoluteAndSiteCollectionUrl Online RetrieveAllChildUsersSystemUser Both RetrieveAllEntities Both RetrieveAllManagedProperties Both RetrieveAllOptionSets Both RetrieveApplicationRibbon Online RetrieveAttribute Both RetrieveAttributeChangeHistory Online RetrieveAuditDetails Online RetrieveAuditPartitionList Online RetrieveAvailableLanguages Both RetrieveBusinessHierarchyBusinessUnit Online RetrieveByGroupResource Both RetrieveByResourceResourceGroup Both RetrieveByResourcesService Both RetrieveByTopIncidentProductKbArticle Both RetrieveByTopIncidentSubjectKbArticle Both RetrieveDependenciesForDelete Online RetrieveDependenciesForUninstall Online RetrieveDependentComponents Online RetrieveDeploymentLicenseType Online RetrieveDeprovisionedLanguages Online RetrieveDuplicates Online RetrieveEntity Both RetrieveEntityRibbon Online RetrieveExchangeRate Both RetrieveFilteredForms Both RetrieveFormattedImportJobResults Online RetrieveFormXml Both RetrieveInstalledLanguagePacks Online RetrieveInstalledLanguagePackVersion Online RetrieveLicenseInfo Online RetrieveLocLabels Both RetrieveManagedProperty Both RetrieveMembersTeam Both RetrieveMembersBulkOperation Both RetrieveMissingComponents Online RetrieveMissingDependencies Online RetrieveMultiple Both RetrieveOptionSet Both RetrieveOrganizationResources Online RetrieveParentGroupsResourceGroup Both RetrieveParsedDataImportFile Both RetrievePrincipalAccess Both RetrievePrincipalAttributePrivileges Both RetrievePrivilegeSet Both RetrieveProvisionedLanguagePackVersion Online RetrieveProvisionedLanguages Online RetrieveRecordChangeHistory Online RetrieveRelationship Both RetrieveRequiredComponents Online RetrieveRolePrivilegesRole Both RetrieveSharedPrincipalsAndAccess Both RetrieveSubGroupsResourceGroup Both RetrieveSubsidiaryTeamsBusinessUnit Both RetrieveSubsidiaryUsersBusinessUnit Both RetrieveTeamPrivileges Both RetrieveTeamsSystemUser Both RetrieveTimestamp Both RetrieveUnpublished Online RetrieveUnpublishedMultiple Online RetrieveUserPrivileges Both RetrieveUserSettingsSystemUser Both RetrieveVersion Both ReviseQuote Both RevokeAccess Online Rollup Both Search Online SearchByBodyKbArticle Both SearchByKeywordsKbArticle Both SearchByTitleKbArticle Both SendTemplate Both SendFax Both SendEmail Both SendEmailFromTemplate Online SetBusinessSystemUser Online SetBusinessEquipment Online SetLocLabels Online SetParentBusinessUnit Online SetParentSystemUser Online SetParentTeam Online SetRelated Both SetReportRelated Online SetState Both StatusUpdateBulkOperation Both TransformImport Both TriggerServiceEndpointCheck Online UninstallSampleData Online UnlockInvoicePricing Online UnlockSalesOrderPricing Online UnpublishDuplicateRule Online Update Online UpdateAttribute Online UpdateEntity Online UpdateOptionSet Online UpdateOptionValue Online UpdateRelationship Online UpdateStateValue Online UpdateUserSettingsSystemUser Both UtcTimeFromLocalTime Both ValidateSavedQuery Both Validate Both ValidateRecurrenceRule Both VerifyProcessStateData Online WhoAmI Both WinOpportunity Both WinQuote Both Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets an indexer for the collection. Type: String. The name of the parameter. Type: ObjectThe indexer for the collection. Gets or sets the name of the response. Type: StringThe name of the response. The response name is the same as the request name. For more information, see Gets the results of the request that was performed. Type: The results of the request that was performed. If you are using a derived message class such as , the contents of this parameter collection are populated automatically to the properties of the response class. Gets the fault instance that caused the current fault. Type: The fault instance that caused the current fault. Gets the text of the fault trace. Type: StringThe text of the fault trace. Gets or sets whether to retrieve all the attributes of a record. Type: Booleantrue to specify to retrieve all attributes; false to to retrieve only specified attributes. You should avoid retrieving all columns in a query result because of the impact on a subsequent update of records. In an update, this will set all field values, even if they are unchanged, and often triggers cascaded updates to child records. Gets the collection of s containing the names of the attributes to be retrieved from a query. Type: ICollection The collection of attribute names to return from a query. Use to set the collection. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the logical name of the attribute in the condition expression. Type: String The logical name of the attribute in the condition expression. Gets or sets the entity name for the condition. Type: StringThe name of the entity. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the condition operator. Type: The condition operator. Gets or sets the values for the attribute. Type: <Object>The attribute values. Gets or sets the FetchXML query string. Type: StringThe FetchXML query string. The query must specify entity names and a column set. If the column set includes attributes that are not valid for retrieve or that you do not have access to, they will be ignored. Build queries with FetchXMLFetchXML schema Gets condition expressions that include attributes, condition operators, and attribute values. Type: <> The collection of condition expressions. This property is read-only. Use the method to change the contents of the collection. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the logical AND/OR filter operator. Type: The filter operator. Gets a collection of condition and logical filter expressions that filter the results of the query. Type: <>The collection of filters. This property is read only. Use the method to change the contents of the array list. Gets or sets whether the expression is part of a quick find query. Type: Booleantrue if the filter is part of a quick find query; otherwise, false. For more information, see About the IsQuickFindFilter property. Use the FilterExpression class Gets or sets the column set. Type: The set of columns (fields) to be returned for the query. Gets or sets the alias for the entity. Type: String The alias for the entity. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the join operator. Type: The join operator. Gets or sets the complex condition and logical filter expressions that filter the results of the query. Type: The complex condition and logical filter expressions that filter the results of the query. Gets the links between multiple entity types. Type: <>The collection of links between entities. This property is read-only. Use the or method to add a link. Gets or sets the logical name of the attribute of the entity that you are linking from. Type: String The logical name of the attribute of the entity that you are linking from. Gets or sets the logical name of the entity that you are linking from. Type: String The logical name of the entity that you are linking from. Gets or sets the logical name of the attribute of the entity that you are linking to. Type: String The logical name of the attribute of the entity that you are linking to. Gets or sets the logical name of the entity that you are linking to. Type: String The logical name of the entity that you are linking to. Gets or sets the name of the attribute in the order expression. Type: String The name of the attribute in the order expression. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the order, ascending or descending. Returns The order, ascending or descending. Gets or sets the number of entity instances returned per page. Type: Int32 The number of entity instances returned per page. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets or sets the number of pages returned from the query. Type: Int32 The number of pages returned from the query. Gets or sets the info used to page large result sets. Type: String The info used to page large result sets. Page large result sets with QueryExpressionPage large result sets with FetchXMLPage large result sets with LINQ Sets whether the total number of records should be returned from the query. Type: Booleantrue if the should be set when the query is executed; otherwise, false. Use the QueryExpression class Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets the set of attributes selected in the query. Type: <String> The collection of attributes selected in the query. Gets or sets the column set. Type: The set of columns (fields) to be returned, used collection. Gets or sets the logical name of the entity to query. Type: StringThe logical name of the entity. Organization service entities Gets the order in which the entity instances are returned from the query. Type: <>A collection that defines the order in which the entity instances are returned from the query. Use to add to this collection. Gets or sets the number of pages and the number of entity instances per page returned from the query. Type: The number of pages and the number of entity instances per page returned from the query. A query can contain either or property values. If both are specified, an error will be thrown. Using a paging cookie with QueryExpression Gets or sets the number of rows to be returned. Type: Int32The number of rows to be returned. When specified, this limits the number rows returned in a query result set to the specified number of rows. A query can contain either or property values. If both are specified, an error will be thrown. public void TestQueryByAttributeWithTopCount() { QueryByAttribute query = new QueryByAttribute(); query.EntityName = "Account"; query.ColumnSet = new Microsoft.Xrm.Sdk.Query.ColumnSet(new string[] { "name" }); query.AddAttributeValue("address1_city", "seattle"); query.TopCount = 3; } Gets the attribute values to look for when the query is executed. Type: <Object>A collection that defines the attribute values to look for when the query is executed. Use to add to this collection. Gets or sets the columns to include. Type: The set of columns to return in the query results. For more information, see . Gets or sets the complex condition and logical filter expressions that filter the results of the query. Type: The query condition and filter criteria. Gets or sets whether the results of the query contain duplicate entity instances. Type: Booleantrue if the results of the query contain duplicate entity instances; otherwise, false. Gets or sets the logical name of the entity. Type: String The logical name of the primary entity for the query. Organization service entities Gets a collection of the links between multiple entity types. Type: <>The collection of links between entities for the query. This property is read-only. Use the or method to change the contents of the array list. Gets or sets a value that indicates that no shared locks are issued against the data that would prohibit other transactions from modifying the data in the records returned from the query. Type: Booleantrue if there are no shared locks are issued against the data that would prohibit other transactions from modifying the data in the records returned from the query; otherwise, false. The benefit of setting to is that it allows you to keep the system from issuing locks against the entities in your queries; this increases concurrency and performance because the database engine does not have to maintain the shared locks involved. The downside is that, because no locks are issued against the records being read, some "dirty” or uncommitted data could potentially be read. A "dirty" read is one in which the data being read is involved in a transaction from another connection. If that transaction rolls back its work, the data read from the query using will have read uncommitted data. This type of read makes processing inconsistent and can lead to problems. Gets the order in which the entity instances are returned from the query. Type: <>The order expression that defines the order in which the entity instances are returned from the query. This property is read only. Use the method to change the contents of the array list. Gets or sets the number of pages and the number of entity instances per page returned from the query. Type: The number of pages and the number of entity instances per page returned from the query. A query can contain either or property values. If both are specified, an error will be thrown. Page large result sets with QueryExpression Gets or sets the number of rows to be returned. Type: Int32The number of rows to be returned. When specified, this limits the number rows returned in a query result set to the specified number of rows. A query can contain either or property values. If both are specified, an error will be thrown. For internal use only. String For internal use only. Type: . For internal use only. Type: Int32 For internal use only. Type: ExtensionDataObject For internal use only. Type: . Gets a value indicating whether the is read-only. Type: Booleantrue if the is read-only; otherwise, false. Gets or sets the structure that contains extra data. Type: The extension data. Gets or sets the entity role: referenced or referencing. Type: <> The entity role. Types of entity relationships Gets or sets the name of the relationship. Type: String The name of the relationship as defined defined in the property. Gets the entity role for the entity. Type: The entity role for the entity. Gets the schema name for the entity relationship. Type: String The schema name for the entity relationship. Gets the global unique identifier of the business unit that the entity currently being processed by the event execution pipeline belongs to. Type: GuidThe global unique identifier of the business unit. This property corresponds to the property, which is the primary key for the entity. BusinessUnit entity Gets the global unique identifier for tracking plug-in execution. Type: GuidThe global unique identifier for tracking plug-in execution. This property is used by the platform for infinite loop prevention. In most cases, this property can be ignored. Gets the current depth of execution in the call stack. Type: Int32The current depth of execution in the call stack. Used by the platform for infinite loop prevention. In most cases, this property can be ignored. Every time a running plug-in or Workflow issues a message request to the Web services that triggers another plug-in or Workflow to execute, the property of the execution context is increased. If the depth property increments to its maximum value within the configured time limit, the platform considers this behavior an infinite loop and further plug-in or Workflow execution is aborted. The maximum depth (8) and time limit (one hour) are configurable by the Microsoft Dynamics 365 administrator. A structure that contains extra data. Type: ExtensionDataObjectA structure that contains extra data. Extra data that is stored in the and as they are processed by the event execution pipeline. Use messages (request and response classes) with the Execute method Gets the global unique identifier of the system user account under which the current pipeline is executing. Type: GuidThe global unique identifier of the system user account. This property corresponds to the property, which is the primary key for the entity. Impersonation in plug-insUser and team entities Gets the parameters of the request message that triggered the event that caused the plug-in to execute. Type: The parameters of the request message that triggered the event. Understand the data context passed to a plug-inUse messages (request and response classes) with the Execute method Gets a value indicating if the plug-in is executing from the Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access client while it is offline. Type: Boolean if the client is offline; otherwise . Write a plug-in Gets a value indicating if the plug-in is executing within the database transaction. Type: Boolean if the plug-in is executing within the database transaction; otherwise, . Event execution pipeline Gets a value indicating if the plug-in is executing as a result of the Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access client transitioning from offline to online and synchronizing with the Microsoft Dynamics 365 server. Type: Boolean if the plug-in is executing as a result of the client synchronizing with the Microsoft Dynamics 365 server; otherwise, . Gets a value indicating if the plug-in is executing in the sandbox. Type: Int32A value indicating if the plug-in is executing in the sandbox. Valid values are 1 (none) or 2 (sandbox). Plug-in isolation, trusts, and statistics Gets the name of the Web service message that is being processed by the event execution pipeline. Type: StringThe name of the Web service message. Supported messages and entities for plug-ins For internal use only. Type: . Gets the mode of plug-in execution. Type: Int32The mode of plug-in execution. Valid values are 0 (synchronous) and 1 (asynchronous). Event execution pipeline Gets the date and time that the related was created. Type: DateTimeThe date and time the related was created. This property is used for the Microsoft Dynamics 365 to Windows Azure integration feature. It contains the same date and time value as the property of the related entity. AsyncOperation (system job) entityAzure integration with Microsoft Dynamics 365 Gets the global unique identifier of the related . Type: GuidThe global unique identifier of the related . This property is used for the Microsoft Dynamics 365 to Windows Azure integration feature. It contains the same ID as the property of the related entity. AsyncOperation (system job) entityAzure integration with Microsoft Dynamics 365 Gets the global unique identifier of the organization that the entity belongs to and the plug-in executes under. Type: GuidThe global unique identifier of the organization. Organization entities Gets the unique name of the organization that the entity currently being processed belongs to and the plug-in executes under. Type: StringThe unique name of the organization. See the attribute. Organization entities Gets the parameters of the response message after the core platform operation has completed. Type: The parameters of the response message. Understand the data context passed to a plug-inUse messages (request and response classes) with the Execute method Gets a reference to the related or . Type: The reference to the related or . Plug-in registration entitiesWork with Dynamics 365 data in your Azure solution Gets the remote execution context from the parent operation. Type: The remote execution context from the parent operation. This property may be populated for a plug-in registered in stage 20 or 40 when a Create, Update, Delete, or RetrieveExchangeRate request is processed by the execution pipeline. Certain message requests require the platform to internally generate another message request, and hence another execution pipeline, to complete processing of the original request. For example, pipeline execution of the results in the internal generation of an . Any plug-in registered in stage 20 or 40 for an update request will have the ParentContext property set to the remote execution context of the original assign request. Event execution pipelinePass data between plug-ins Gets the properties of the primary entity after the core platform operation has been completed. Type: The properties of the primary entity. Understand the data context passed to a plug-in Gets the properties of the primary entity before the core platform operation has begins. Type: The properties of the primary entity. Understand the data context passed to a plug-in Gets the global unique identifier of the primary entity for which the pipeline is processing events. Type: GuidThe global unique identifier of the primary entity. Event execution pipeline Gets the name of the primary entity for which the pipeline is processing events. Type: StringThe name of the primary entity. Event execution pipeline Gets the global unique identifier of the request being processed by the event execution pipeline. Type: Nullable<Guid>The global unique identifier of the request. Use messages (request and response classes) with the Execute methodEvent execution pipeline Gets the name of the secondary entity that has a relationship with the primary entity. Type: StringThe name of the secondary entity. Gets the custom properties that are shared between plug-ins. Type: The custom properties that are shared between plug-ins. Pass data between plug-ins Gets the stage in the execution pipeline that a synchronous plug-in is registered for. Type: Int32. Valid values are 10, 20, 40, and 50The stage in the execution pipeline that a synchronous plug-in is registered for. A stage identifies when a registered synchronous plug-in is to execute during the processing of a message request. Plug-ins can be further ordered within a stage using the attribute. Plug-in registration entitiesEvent execution pipeline Gets the global unique identifier of the system user for whom the plug-in invokes Web service methods on behalf of. Type: GuidThe global unique identifier of the system user. This property corresponds to the property, which is the primary key for the entity. User and team entities Gets or sets the extension data object. Type:. Gets or sets the removed item. Type: . Gets or sets the change type. Type: . Gets the results from a method call. Type: The collection of results. Gets the exception that occurred when a message request was processed by the organization web service. Type: ExceptionThe exception that occurred. This property is only set when an exception occurs. Gets the message request that was submitted to the organization web service. Type: The request instance that was submitted. Gets the result of a successful operation against the organization web server. Type: The response to the request. This property is set to a value when the property is set. Gets whether there is an error. Type: Booleantrue if there is an error; otherwise, false. Gets how the method behaves when an error occurs. Type: The option that describes the save changes behavior. Gets the details of the fault. Type: The details of the fault. Gets or sets the structure that contains extra data. Type: ExtensionDataObjectThe extension data. Gets the message for the fault. Type: StringThe message for the fault. Gets or sets the ID of the user for whom SDK calls are made on behalf of. Type: GuidThe ID of the user for whom SDK calls are made on behalf of. Impersonate another user For internal use only. Returns . The access token returned from OAuth authentication. Type: StringGets or sets the the access token. Authenticate the user with the web servicesSample: Windows 8 desktop modern OData appRFC 6749 - The OAuth 2.0 Authorization Frameworkhttp://tools.ietf.org/html/rfc6749Azure Active Directory Authentication Librarieshttp://msdn.microsoft.com/en-us/library/azure/dn151135.aspxActive Directory Authentication Libraryhttp://www.nuget.org/packages/Microsoft.IdentityModel.Clients.ActiveDirectory/3.0.110281957-alpha The version of your client application. Type: StringThe client application version. The value can be any version number than has at least one decimal point and is greater than 6.0.0002.0000. It’s recommended that the property value be set to the product build version of the CRM SDK assemblies that were linked to the client application. Gets the web proxy client for the service. Type: The web proxy client for the service. For internal use only. Used to return aggregate, group by, and aliased values from a query. // Fetch the average of estimatedvalue for all opportunities. This is the equivalent of // SELECT AVG(estimatedvalue) AS estimatedvalue_avg ... in SQL. System.Console.WriteLine("==============================="); string estimatedvalue_avg = @" <fetch distinct='false' mapping='logical' aggregate='true'> <entity name='opportunity'> <attribute name='estimatedvalue' alias='estimatedvalue_avg' aggregate='avg' /> </entity> </fetch>"; EntityCollection estimatedvalue_avg_result = _serviceProxy.RetrieveMultiple(new FetchExpression(estimatedvalue_avg)); foreach (var c in estimatedvalue_avg_result.Entities) { decimal aggregate1 = ((Money)((AliasedValue)c["estimatedvalue_avg"]).Value).Value; System.Console.WriteLine("Average estimated value: " + aggregate1); } Build queries with FetchXMLUse FetchXML aggregationSample: Use aggregation in FetchXML Provides a collection of attributes for an entity. For each attribute in the collection there is a key/value pair. The key is the logical name of the attribute as defined in the attribute metadata. Used by the code generation tool to create classes based on entities. Use the early bound entity classes in code For internal use only. For the Web API the corresponding type is AttributeMapping ComplexType. This type doesn’t have any extensibility scenarios in this release. Specifies the field level security privileges allowed for an attribute. For the Web API the corresponding type is AttributePrivilege ComplexType. How field security can be used to control access to field values in Microsoft Dynamics 365 Specifies a collection of field level security privileges allowed for the specified attributes. How field security can be used to control access to field values in Microsoft Dynamics 365 Represents a service fault. Defines a managed property that stores a Boolean value. For the Web API the corresponding type is BooleanManagedProperty ComplexType. Use managed propertiesSample: Create and update entity metadata Represents the business entity changes. Represents the business entity changes collection. Identifies a user as the owner of all data changes made by calls to a Web service. The specified user does not have to be the same user that instantiated the service. When the object goes out of scope and is disposed, calls to the service are owned by the original user that instantiated the service. using (new CallerImpersonationScope(service, userId)) { // Display information about the logged on user. Guid effectiveUserId = ((WhoAmIResponse)service.Execute(new WhoAmIRequest())).UserId; SystemUser systemUser = (SystemUser)service.Retrieve("systemuser", effectiveUserId, new ColumnSet(new string[] {"firstname", "lastname"})); Console.WriteLine("Logged on user is {0} {1}.", systemUser.FirstName, systemUser.LastName); } Impersonate another user Represents the enumeration for the change type. Specifies that the records are new or updated. Specifies that the records were removed or deleted. Identifies the types of claims that are supported or may be supported in a future product release. Additional information about the security (SAML) token Represents client-side user logon credentials. For internal use only. Identifies the type of identity provider used for authentication. No identity provider. Value = 0. An Active Directory identity provider. Value = 1. A federated claims identity provider. Value = 2. A Microsoft account identity provider. Value = 3. An online (Office 365) federated identity provider. Value = 4. Contains arguments for a cancel event. Contains arguments for a WCF channel event. Contains arguments for a faulted WCF channel event. Contains a policy configuration that identifies a Secure Token Service for use with claims authentication. Specifies the type of authentication used by a client application. Kerberos authentication. Value = 0. A security token for use with claims authentication. Value = 1. Contains a collection of objects. Implements and provides an authenticated WCF channel to the discovery service endpoint. You can make SDK calls using the interface by casting the proxy instance to a type. This class is not thread safe. Microsoft Dynamics 365 (online) authentication using the Microsoft Online Services environment identity provider, including Microsoft Office 365, is supported. Sample: Access the Discovery serviceHelper code: ServerConnection class Identifies the new and previous service endpoint URL’s for an organization. Disaster recovery in Microsoft Dynamics 365 (online) Identifies the logical name of an entity. Represents an identity provider. A collection of identity providers. Contains the configuration information required to use an identity provider. Specifies the supported types of identity providers. Active Directory Federation Services. Value = 0. Windows Live ID. Value = 1. OrgId, also known as User Id. Value = 2. Contains the available identity providers for a Microsoft Dynamics 365 service. Represents the switching of a web service endpoint for an organization from a primary URL to an alternate URL. Disaster recovery in Microsoft Dynamics 365 (online) Represents a configured Microsoft Dynamics 365 service. Type: Type. The type of service. Instances of the and interfaces are basically interchangeable, the only real difference being that the interface exposes support for the class and a single call that covers most scenarios. For best performance, create an instance of the interface only one time per client session and re-use that instance as necessary. An interface which provides a simpler authentication experience. Type: or . Specifies a service type. Instances of the and interfaces are basically interchangeable, the only real difference being that the interface exposes support for the class and a single call that covers most scenarios. For best performance, create an instance of this interface only one time per client session and re-use that instance as necessary. Sample: Authenticate users with Microsoft Dynamics 365 web servicesImprove service channel allocation performance Represents an issuer endpoint. Contains a dictionary of objects. Contains identity provider configuration information specific to Microsoft account. Contains a policy configuration that identifies a Secure Token Service for use with Microsoft account authentication. Represents an Active Directory Federation Services (ADFS) based identity provider. Describes the synchronization option for sending or receiving entity data to or from a data service using the . New Microsoft Dynamics 365 entities are appended. Existing entities or their original values are not be modified. No client-side changes are lost in this merge. This is the default behavior. Value = 0. All current values on the client are overwritten with current values from the Web service regardless of whether they have been changed on the client. Value = 1. Current values that have been changed on the client are not modified, but any unchanged values are updated with current values from the Web service. No client-side changes are lost in this merge. Value = 2. Microsoft Dynamics 365 entities are always loaded from persisted storage. Any attribute changes made to entities in the are overwritten by the data source values. Value = 3. Contains Microsoft Online Services specific information for connecting to the Microsoft Dynamics 365 (online) server. Represents a Microsoft Online Services based identity provider. Contains general information used when connecting to Microsoft Dynamics 365 (online). Represents the runtime context of the data service that is used to track Microsoft Dynamics 365 entities and that sends and receives entities from the server. The organization service context class maintains state on the client between interactions with the Microsoft Dynamics 365 Web service to support features such as change management. This class also manages identities and tracks changes to Microsoft Dynamics 365 data. The organization service context class implements the IQueryable interface and a .NET Language-Integrated Query (LINQ) query provider so you can write LINQ queries against Microsoft Dynamics 365 data. Objects tracked by the organization service context are instances of entity types that represent data in Microsoft Dynamics 365. You can designate actions to be performed on these objects and the service context tracks the changes. When the method is called, the service context instructs Microsoft Dynamics 365 to generate commands to create, update or delete the entities the tracked objects represent. The code generation tool (CrmSvcUtil.exe) can be used to create a custom instance of the class. This class includes customizations and provides helper properties and methods for working with entities. Several enumerations are used with the class. The enumeration indicates how changes are applied to Microsoft Dynamics 365 data. The enumeration determines how changes are managed by the service context if an error occurs. Create early bound entity classes with the code generation tool (CrmSvcUtil.exe)Use the early-bound entity classes for create, update, and deleteUse the early bound entity classes to add or update associations between related recordsSample: Use the organization service context Implements and provides an authenticated WCF channel to the organization service. To call the Microsoft Dynamics 365 web service using the interface, cast the proxy instance to an type. This class is not thread safe. Microsoft Dynamics 365 (online) authentication using the Microsoft Online Services environment identity provider, including Microsoft Office 365, is supported. Active Directory and claims-based authenticationSample: Authenticate users with Microsoft Dynamics 365 web servicesTroubleshooting and error handlingUse the Organization Service to read and write data or metadata Contains identity provider configuration information specific to Microsoft Online Services ID. Contains a policy configuration that identifies a Secure Token Service (STS). Indicates that the assembly contains early-bound types generated by the CrmSvcUtil utility. Create early bound entity classes with the code generation tool (CrmSvcUtil.exe) Enables early-bound entity types on a service proxy. For internal use only. Indicates the name of the message request, represented by the entity, to which the request corresponds. This type is only created when the CrmSvcUtil program generates a request, which is turned off by default. Create early bound entity classes with the code generation tool (CrmSvcUtil.exe) Indicates the name of the message response, represented by the entity, to which the response corresponds. This type is only created when the CrmSvcUtil program generates a response, which is turned off by default. Create early bound entity classes with the code generation tool (CrmSvcUtil.exe) Describes how the method behaves when an error occurs while updating data in Microsoft Dynamics 365. The method applies changes to tracked entities in Microsoft Dynamics 365. If an error occurs while performing these updates, this enumeration indicates to the how it should handle errors. If the value is set to and an error occurs, an exception is thrown with the attached. The method should throw an exception when an error occurs while updating data in Microsoft Dynamics 365. Value = 0. The method should continue applying changes to tracked entities in Microsoft Dynamics 365 even if an action fails. Value = 1. Contains a security token response. This class is a wrapper containing a security token request response and a security token. Represents a communication channel to a Microsoft Dynamics 365 service. Type: IOutputChannel or IRequestChannel. The type of channel produced by a channel factory. ChannelFactory(TChannel) Classhttp://msdn.microsoft.com/en-us/library/ms576132.aspx Represents a client factory for creating service configurations. Contains a dictionary of ServiceEndpoint objects. Container class for metadata information about a service. Provides an abstract base class to encapsulate service connection operations and user authentication management. Type: or . A service that an instance of this class can access. The two commonly used derived classes are and . Active Directory and claims-based authentication Contains the primary and alternate endpoints of an organization. Disaster recovery in Microsoft Dynamics 365 (online) Defines the kinds of credentials accepted by a security token service. No credential endpoint is found. Value = 0. A username and password credential. Value = 1. A Kerberos credential. Value = 2. A symmetric credential token. Value = 3. An asymmetric credential token. Value =4. A certificate configured for user identification. Value = 5. An integrated Windows authentication credential. Value = 6. A bearer token. Value = 7. System.IdentityModel.Tokens Namespacehttp://msdn.microsoft.com/en-us/library/system.identitymodel.tokens.aspx The type of user that a message request executes for. A CRM system user. An external party user. Contains a policy configuration that identifies an Active Directory provider. For internal use only. Contains values to indicate the optimistic concurrency behavior that should be applied when performing entity update and delete operations. For the Default option, the following behavior applies based on the indicated conditions. IsOptimisticConcurrencyEnabled Source Behavior Reduce potential data loss using optimistic concurrency Specifies to use the default behavior. Value = 0. The default value is also used if no value is set in the ConcurrencyBehavior property of the request. The meaning of “default” is interpreted differently based on the calling context. Specifies the behavior where an update or delete operation is only applied if the entity record in the database has the same row version as the entity or entity reference in the request. Value = 1. If no row version value is provided on the entity or entity references in the request, the request fails immediately. Specifies the behavior where an update or delete operation is applied without regard to the version of the record in the database. Value = 2. If optimistic concurrency is not enabled for the target entity, the AlwaysOverwrite behavior is applied. Represents a strongly typed list of objects that can be accessed by index. Provides methods to search, sort, and manipulate lists. Extends Collection. The type of elements in the list. For more information, see Collection. Represents a collection of keys and values. The type of the keys in the dictionary. The type of the values in the dictionary. Represents a conversion rule for converting date and time value from UTC to DateOnly in the database. Behavior and format of the date and time attributeSample: Convert date and time behavior For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. Contains the data that is needed to execute a request and the base class for all discovery service requests. This is the base class for all discovery Web service requests. Pass an instance of a request class to the method. Discovery service messages (request and response classes) Contains the response from the request and is the base class for all discovery service responses. This is the base class for all discovery Web service responses. An instance of a response class is returned from the method. Discovery service messages (request and response classes) Indicates the type of network access an endpoint has. For the Web API use the EndpointAccessType EnumType. Sample: Access the Discovery service Default access. The actual access is determined by the endpoint URL. Value = 0. Internet access. Value = 1. Intranet access. Value = 2. A collection of service endpoints. Typically used to identify each available service, and the service address, for an organization. For the Web API the corresponding type is EndpointCollection ComplexType. Helper code: ServerConnection class Identifies the type of service available at an endpoint. For the Web API use the EndpointType EnumType. Helper code: ServerConnection class The organization service. Value = 0. The organization data service. Value = 1. The Web application service. Value = 2. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. Provides programmatic access to organization and user information. Refer to for an implementation of this interface. Discover the URL for your organization using the Organization ServiceSample: Access the Discovery service Provides detailed information on an organization. Helper code: ServerConnection class Provides a collection of instances. Helper code: ServerConnection class Describes the release of an organization. Sample: Access the Discovery service The current release. Value = 0. The Microsoft Dynamics CRM 2011 release. Value = 1. Describes the current state of an organization. Related to organization provisioning and maintenance. The organization is enabled. Value = 0. The organization is disabled. Value = 1. Contains the data that is needed to retrieve information about an organization. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method. Privileges and Access Rights To perform this action, the caller must have a system user account in Microsoft Dynamics 365. DiscoveryService#DiscoveryService3 DiscoveryServiceVB#DiscoveryService3 Discover the URL for your organization using the Organization ServiceDiscovery service messages (request and response classes)Sample: Access the Discovery service Contains the response from processing . An instance of a response class is returned from the method. Discovery service messages (request and response classes)Sample: Access the Discovery service Contains the data that is needed to retrieve information on all organizations that the logged on user belongs to. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method. Privileges and Access Rights To perform this action, the caller must have a system user account in Microsoft Dynamics 365. DiscoveryService#DiscoveryService2 DiscoveryServiceVB#DiscoveryService2 Discover the URL for your organization using the Organization ServiceDiscovery service messages (request and response classes)Sample: Access the Discovery service Contains the response from processing . An instance of a response class is returned from the method. Discovery service messages (request and response classes)Sample: Access the Discovery service Contains the data that is needed to retrieve the Microsoft Dynamics 365 or Microsoft Dynamics 365 (online) system user ID that is associated with a given identity provider ID. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method. Privileges and Access Rights To perform this action, the caller must have a system user account in Microsoft Dynamics 365. Discovery service messages (request and response classes) Contains the response from processing . An instance of a response class is returned from the method. Discovery service messages (request and response classes) Represents a discovery service fault. Represents an instance of an entity (a record). is the base class for all types of entities in Microsoft Dynamics 365. You use this class for both early and late bound programming. Use the early bound entity classes in codeUse the late bound entity class in code Represents the entity attribute collection. Contains a collection of entity instances. Contains a collection of image objects. Represents the enumerator for the entity key status when the index creation job is in progress. For the Web API use the EntityKeyIndexStatus EnumType. Specifies that the key index creation is pending. Specifies that the key index creation is in progress. Specifies that the key index creation is active. Specifies that the key index creation failed. Identifies a record. This class replaces the Moniker class from Microsoft Dynamics CRM 4.0. Contains a collection of entity references. Contains values to indicate the role the entity plays in a relationship. Specifies that the entity is the referencing entity. Value = 0. Specifies that the entity is the referenced entity. Value = 1. Indicates the state of an entity as tracked by the and indicates to the server the operation that should be performed for a related entity. The sets this value after the method is called and uses this value to track changes to entities. You can also set this value to for a related entity to indicate to the service context that the related entity has been changed and that those changes need to be passed to the server. The service context sends changes to the server when the method is called. The entity is unchanged since the last call to . Value = 0. The entity was created since the last call to . Value = 1. The entity was changed since the last call to . Value = 2. Contains a collection of objects that provide details on an error. Contains the response from execution of a message request. Contains a collection of instances. Defines the execution behavior of . Use messages (request and response classes) with the Execute methodSample: Execute multiple requests Represents a fault that occurs when a message request fails execution during a single database transaction. Execute messages in a single database transaction Defines the possible field permission types. These values are used to set the , and attributes. Corresponds to the values of the A Yes or No Boolean (field_security_permission_type) global option set. Contains a collection of formatted values for the attributes for an entity. Represents the interface for the changed item. Base interface that defines the contextual information passed to a plug-in or custom workflow activity at run-time. Populated by the event execution pipeline in response to the processing of a message request before any plug-ins or custom workflow activities are executed. Event execution pipelineUnderstand the data context passed to a plug-in Represents an exception that occurred during plug-in execution. When thrown by a plug-in, the Microsoft Dynamics 365 platform displays the exception message in a dialog of the Web application. Handle exceptions in plug-ins Provides programmatic access to the metadata and data for an organization. Use the Organization Service to read and write data or metadataUse the IOrganization web service in a custom workflow activitySample: Create, retrieve, update, and delete records (early bound)Troubleshooting and error handling Represents a factory for creating instances. Exploring the Factory Design Patternhttp://msdn.microsoft.com/en-us/library/ee817667.aspx Base interface for a plug-in. Write a plug-inWrite plug-ins to extend business processes Defines the contextual information passed to a plug-in at run-time. Contains information that describes the run-time environment that the plug-in is executing in, information related to the execution pipeline, and entity business information. The execution context is passed to a plug-in at run time in the System.IServiceProvider parameter of the method. You can obtain the context from the service provider as shown in the following plug-in code. Plug-ins#FollowupPlugin1 Understand the data context passed to a plug-inWrite plug-ins to extend business processes Provides the early-bound entity types assembly that was created using the CrmSvcUtil utility. Create early bound entity classes with the code generation tool (CrmSvcUtil.exe) Posts the plug-in execution context to the Microsoft Azure Service Bus. Both the Microsoft Azure Service Bus and Microsoft Dynamics 365 must be properly configured before using this service. Configure Azure integration with Microsoft Dynamics 365Write a custom Azure-aware plug-in Defines a plug-in that implements the service behavior of a Microsoft Azure Service Bus listener. This interface implements a one-way listener contract. Write a listener application for a Microsoft Azure solution Provides a method of logging run-time trace information for plug-ins. A reference to a tracing service implementation can be obtained from the service provider passed to plug-in’s method. The interface provides a way to log plug-in run-time information. This method of logging information is especially useful for sandboxed plug-ins registered with Microsoft Dynamics 365 (online) that cannot otherwise be debugged using a debugger. The tracing information is displayed in a dialog of the Microsoft Dynamics 365 Web application only if an exception is passed from a plug-in back to the platform. Debug a plug-InSample: Web access from a sandboxed plug-inPlug-in isolation, trusts, and statistics Defines a plug-in that implements the service behavior of a Microsoft Azure Service Bus listener. This interface implements a two-way listener contract. Write a listener application for a Microsoft Azure solution Defines a plug-in that implements the service behavior of a Microsoft Azure Service Bus listener. This interface implements a REST listener contract. Write a listener application for a Microsoft Azure solution Represents the key attribute collection. Resolves known organization message request and response types for the SDK contracts. Contains a collection of translations for a label. For the Web API the corresponding type is Label ComplexType. You can only set a localized label for a language that is installed on the server. Contains a localized label, including the label string and the language code. For the Web API the corresponding type is LocalizedLabel ComplexType. Defines a collection of . Customize labels to support multiple languages Represents an individual folder-level tracking rule item in the collection (). For the Web API the corresponding type is MailboxTrackingFolderMapping ComplexType. Configure Exchange folder-level tracking rules Represents a collection of folder-level tracking rules. The folder-level tracking rules collection is returned in the message when you execute the message. Configure Exchange folder-level tracking rules Represents a strongly typed managed property. Type: Type. The type of managed property. Use managed properties Contains the data that is needed to create a link between records. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the property and access rights on the specified records in the and properties. For a list of the required privileges, see Associate message privileges. Notes for Callers This message uses a single transaction to create multiple associations between the record that is specified by the in the property and each record in the property. The associations are created for the specified relationship in the property. You can also use the method to perform the same action. For a one-to-many relationship, this message sets the property in the related record to the value of the in the . For a many-to-many relationship, this message creates a record in the intersect table for the relationship, which contains the ID of both the referenced and referencing records. The intersect table name is defined in the property for the relationship. You need this when you query for the records. However, you need the relationship name to set the property. This name is defined in the property for the relationship. Supported Entities You can use this message to associate records of any two entities (includes records for custom entities) that participate in a relationship. To find a list of the default relationships, see the Entity Metadata topic for each entity. The following sample shows how to execute the message. FieldSecurity#EnableFieldSecurityForAnEntity2 FieldSecurityVB#EnableFieldSecurityForAnEntity2 Entity metadataEntity relationship behaviorCustomize entity relationship metadataSample: Retrieve field permissionsAssociate message privileges Contains the response from the class. There is no return value from this operation. Contains the data that is needed to check whether the specified entity can be the primary entity (one) in a one-to-many relationship. For the Web API use the CanBeReferenced Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in CanBeReferenced message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. relationships#WorkWithRelationships4 relationshipsVB#WorkWithRelationships4 Sample: Create and retrieve entity relationshipsEligibleCreateOneToManyRelationshipEntity relationship eligibilityCanBeReferenced message privileges Contains the response from the class. For the Web API the CanBeReferencedResponse ComplexType is the response value from the CanBeReferenced Action. Contains the data that is needed to check whether an entity can be the referencing entity in a one-to-many relationship. For the Web API use the CanBeReferencing Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in CanBeReferencing message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. relationships#WorkWithRelationships4 relationshipsVB#WorkWithRelationships4 CanBeReferencing message privilegesSample: Create and retrieve entity relationshipsEligibleCreateOneToManyRelationship Contains the response from the class. For the Web API the CanBeReferencingResponse ComplexType is the response value from the CanBeReferencing Action. Contains the data that is needed to check whether an entity can participate in a many-to-many relationship. For the Web API use the CanManyToMany Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in CanManyToMany message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. relationships#WorkWithRelationships3 relationshipsVB#WorkWithRelationships3 Sample: Create and retrieve entity relationshipsEligibleCreateManyToManyRelationshipCustomize entity relationship metadataCanManyToMany message privileges Contains the response from the class. For the Web API the CanManyToManyResponse ComplexType is the response value from the CanManyToMany Action. Contains the data to convert existing UTC date and time values in the database to DateOnly values. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the System Administrator role. Notes to Caller This message is available for Microsoft Dynamics CRM Online 2015 Update 1 only. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. DateTimeAttributeBehavior#ConvertDateandTimeBehavior1 Behavior and format of the date and time attributeSample: Convert date and time behavior Contains the response from the class. Behavior and format of the date and time attribute Contains the data that is needed to create a new attribute, and optionally, to add it to a specified unmanaged solution. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in CreateAttribute message privileges. Notes for Callers This message cannot be used to create a attribute or a customer lookup attribute. Use the message to create a lookup attribute and the message to create a customer lookup attribute. Supported Entities You can only add attributes to customizable entities where the managed property is . The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. This code defines the for a number of different types of attributes and adds them to a List<AttributeMetadata>. At the end of the code, the class prepares the request, and the attribute is created by using the method. This code sample assumes that the current customization prefix is ‘new’ because that is the default customization prefix for the organization solution publisher. You should use the customization prefix for the solution publisher that makes sense for the solution context in which you work. Attributes#WorkWithAttributes2 AttributesVB#WorkWithAttributes2 Customize entity attribute metadataEntity attribute metadata messagesSample: Create and update entity metadataCreateAttribute message privilegesIntroduction to solutions Contains the response from the class. Contains the data that is needed to create a new customer lookup attribute, and optionally, to add it to a specified unmanaged solution. For the Web API use the CreateCustomerRelationships Action . Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in CreateCustomerRelationships message privileges. Notes for Callers Use the message to create two entity relationships to the lookup attribute: one to the entity and the other one to the entity. You cannot add relationship to any other entity except for and entities. Supported Entities You can only add attributes to customizable entities where the managed property is . The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Entities#CreateUpdateEntityMetadata13 Create a customer lookup attributeSample: Create and update entity metadata Contains the response from the class. Contains data that is needed to create an alternate key. This message takes the entity name and values as input to create the key. Usage When you pass an instance of this class to the method, it returns an instance of the class. Contains the response from the class. Contains the data that is needed to create a custom entity, and optionally, to add it to a specified unmanaged solution. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in CreateEntity message privileges. Notes for Callers When you programmatically create a custom entity, it does not appear in the application navigation pane unless you edit the SiteMap to display the entity in the location where you want it displayed. Alternatively, in the application edit the entity properties to set Areas that display this entity to the location where you want the entity displayed. For more information, see Change application navigation using the SiteMap. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. The _customEntityName value is “new_BankAccount”. Entities#CreateUpdateEntityMetadata1 EntitiesVB#CreateUpdateEntityMetadata1 CreateEntity message privilegesSample: Create and update entity metadataIntroduction to solutions Contains the response from the class. Contains the data that is needed to create a new Many-to-Many (N:N) entity relationship. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in CreateManyToMany message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. . This sample creates the entity relationship between the and entities by using . Relationships#WorkWithRelationships2 RelationshipsVB#WorkWithRelationships2 Create and retrieve entity relationshipsSample: Create and retrieve entity relationships Contains the response from the class. Contains the data that is needed to create a new One-to-Many (1:N) entity relationship. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in CreateOneToMany message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. This sample creates an entity relationship between and entities by using . Relationships#WorkWithRelationships1 RelationshipsVB#WorkWithRelationships1 Entity relationship eligibilityCreate and retrieve entity relationshipsCustomize entity relationship metadataEntity relationship behaviorSample: Create and retrieve entity relationshipsSample: Dump entity relationship information to a file Contains the response from the class. Contains the data that is needed to create a new global option set. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in CreateOptionSet message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. OptionSets#WorkwithGlobalOptionSets2 OptionSetsVB#WorkwithGlobalOptionSets2 Sample: Create a global option setCustomize global option sets Contains the response from the class. Contains the data that is needed to create a record. Message Availability Not all entity types support this message offline. For some supported entities, this message works regardless whether the caller is connected to the server or offline. For other entities, the caller must be connected to the server before the message works. For more information, see Supported Entities later in this topic. Usage Pass an instance of this class to the method, which returns an instance of the class. This message supports one or more optional parameters. For more information, see Use messages (request and response classes) with the Execute method. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the parameter. For a list of the required privileges, see Create message privileges. Notes for Callers This message creates a record with related records in one transaction. For a less complex method that creates a single record, use the method. By default, the caller becomes the owner for the new record. For this message to work, the caller must have both Create and Read privileges for the entity. For more information, see Privileges by entity. Or you can set the attribute for the record to the ID of another user. Supported Entities You can use this method to create any record of an entity (includes custom entities) that supports the message. The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) ActivityMimeAttachment 2 (Both) Annotation 2 (Both) AnnualFiscalCalendar 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) AttributeMap 2 (Both) BusinessUnit 2 (Both) BusinessUnitNewsArticle 2 (Both) Calendar 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) ColumnMapping 2 (Both) Competitor 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) ConnectionRoleObjectTypeCode 2 (Both) ConstraintBasedGroup 2 (Both) Contact 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ContractTemplate 2 (Both) ConvertRule 2 (Both) ConvertRuleItem 2 (Both) CustomerAddress 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) Discount 2 (Both) DiscountType 2 (Both) DuplicateRule 2 (Both) DuplicateRuleCondition 2 (Both) DynamicProperty 2 (Both) DynamicPropertyAssociation 2 (Both) DynamicPropertyInstance 2 (Both) DynamicPropertyOptionSetItem 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) EntitlementChannel 2 (Both) EntitlementTemplate 2 (Both) EntitlementTemplateChannel 2 (Both) Equipment 2 (Both) ExchangeSyncIdMapping 2 (Both) Fax 2 (Both) FieldPermission 2 (Both) FieldSecurityProfile 2 (Both) FixedMonthlyFiscalCalendar 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) HierarchyRule 2 (Both) HierarchySecurityConfiguration 2 (Both) Import 2 (Both) ImportEntityMapping 2 (Both) ImportFile 2 (Both) ImportJob 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) Invoice 2 (Both) InvoiceDetail 2 (Both) IsvConfig 2 (Both) KbArticle 2 (Both) KbArticleComment 2 (Both) KbArticleTemplate 2 (Both) Lead 2 (Both) Letter 2 (Both) List 2 (Both) LookUpMapping 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) MonthlyFiscalCalendar 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OpportunityProduct 2 (Both) OrderClose 2 (Both) OrganizationUI 2 (Both) OwnerMapping 2 (Both) PhoneCall 2 (Both) PickListMapping 2 (Both) PluginAssembly 2 (Both) PluginType 2 (Both) Position 2 (Both) Post 2 (Both) PostComment 2 (Both) PostFollow 2 (Both) PostLike 2 (Both) PriceLevel 2 (Both) PrincipalObjectAttributeAccess 2 (Both) ProcessSession 2 (Both) ProcessTrigger 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) ProductPriceLevel 2 (Both) ProductSubstitute 2 (Both) Publisher 2 (Both) PublisherAddress 2 (Both) QuarterlyFiscalCalendar 2 (Both) Queue 2 (Both) QueueItem 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) QuoteDetail 2 (Both) RecurrenceRule 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RelationshipRoleMap 2 (Both) Report 2 (Both) ReportCategory 2 (Both) ReportEntity 2 (Both) ReportVisibility 2 (Both) ResourceSpec 2 (Both) Role 2 (Both) RollupField 2 (Both) RoutingRule 2 (Both) RoutingRuleItem 2 (Both) SalesLiterature 2 (Both) SalesLiteratureItem 2 (Both) SalesOrder 2 (Both) SalesOrderDetail 2 (Both) SavedQuery 2 (Both) SavedQueryVisualization 2 (Both) SdkMessageProcessingStep 2 (Both) SdkMessageProcessingStepImage 2 (Both) SdkMessageProcessingStepSecureConfig 2 (Both) SemiAnnualFiscalCalendar 2 (Both) Service 2 (Both) ServiceAppointment 2 (Both) ServiceEndpoint 2 (Both) SharePointDocument 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) Site 2 (Both) SLA 2 (Both) SLAItem 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialInsightsConfiguration 2 (Both) SocialProfile 2 (Both) Solution 2 (Both) Subject 2 (Both) SystemForm 2 (Both) SystemUser 2 (Both) Task 2 (Both) Team 2 (Both) TeamTemplate 2 (Both) Template 2 (Both) Territory 2 (Both) TraceLog 2 (Both) TransactionCurrency 2 (Both) TransformationMapping 2 (Both) TransformationParameterMapping 2 (Both) UoM 2 (Both) UoMSchedule 2 (Both) UserEntityInstanceData 2 (Both) UserEntityUISettings 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) WebResource 2 (Both) Workflow 2 (Both) WorkflowDependency 2 (Both) WorkflowLog 2 (Both) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. ImportWebResources#ImportWebResources2 ImportWebResourcesVB#ImportWebResources2 Sample: Import files as web resourcesPrivileges by entityCreate a new entity record using the early-bound entity classes and the OrganizationServiceContext class Contains the response from the class. Contains the data that is needed to delete an attribute. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in DeleteAttribute message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. attributes#WorkWithAttributes9 attributesVB#WorkWithAttributes9 Sample: Work with attribute metadata Contains the response from the class. There is no return value from this operation. Contains the data that is needed to delete the specified key for an entity. This message takes the entity name and key name as input to delete the key. Usage When you pass an instance of this class to the method, it returns an instance of the class. Contains the response from the class. Contains the data that is needed to delete an entity. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in DeleteEntity message privileges. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. entities#CreateUpdateEntityMetadata10 entitiesVB#CreateUpdateEntityMetadata10 Delete a custom entitySample: Create and update entity metadataCustomize entity metadataDeleteEntity message privileges Contains the response from the class. There is no return value from this operation. Contains the data that is needed to delete a global option set. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in DeleteOptionSet message privileges. Notes for Callers You cannot delete a global option set that is used by a picklist attribute. Use to determine whether the global option set has any dependencies. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. optionsets#WorkwithGlobalOptionSets.DeleteOptionSetRequest optionsetsVB#WorkwithGlobalOptionSets.DeleteOptionSetRequest Sample: Work with global option sets Contains the response from the class. There is no return value from this operation. Contains the data that is needed to delete an option value in a global or local option set. For the Web API use the DeleteOptionValue Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in DeleteOptionValue message privileges. Notes for Callers Use the property when working with global option sets. For local option sets in a picklist attribute, use the and properties. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. optionsets#WorkwithGlobalOptionSets11 optionsetsVB#WorkwithGlobalOptionSets11 Sample: Work with global option setsInsert, update, delete, and order global option set optionsCustomize global option sets Contains the response from the class. There is no return value from this operation. Contains the data that is needed to delete an entity relationship. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in DeleteRelationship message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. relationships#WorkWithRelationships5 relationshipsVB#WorkWithRelationships5 Sample: Create and retrieve entity relationshipsCustomize entity relationship metadata Contains the response from the class. There is no return value from this operation. Contains the data that is needed to delete a record. Message Availability Not all entity types support this message offline. For some supported entities, this message works regardless whether the caller is connected to the server or offline. For other entities, the caller must be connected to the server before the message works. For more information, see Supported Entities later in this topic. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the property and access rights on the specified record in the property. For a list of the required privileges, see Delete message privileges. Notes for Callers This message deletes a record and its related records in one transaction. For a less complex method that deletes a single record, use the method. When a record is deleted, all child records are also deleted. The entire deletion fails if the caller does not have the delete privilege or access rights for any of these records. This method may cascade to related records according to the cascade configuration for each entity relationship. For a description of how actions on a parent record affect related records, see Cascading behavior. Typically, you should only delete records that you entered by mistake. For some record types, you can deactivate or close the record instead. Supported Entities You can use this method to delete any record of an entity (includes custom entities) that supports the message. The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) ActivityMimeAttachment 2 (Both) Annotation 2 (Both) AnnualFiscalCalendar 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) AttributeMap 2 (Both) BulkDeleteOperation 2 (Both) BulkOperation 2 (Both) BusinessUnit 2 (Both) BusinessUnitNewsArticle 2 (Both) Calendar 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) ColumnMapping 2 (Both) Competitor 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) ConnectionRoleObjectTypeCode 2 (Both) ConstraintBasedGroup 2 (Both) Contact 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ContractTemplate 2 (Both) ConvertRule 2 (Both) ConvertRuleItem 2 (Both) CustomerAddress 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) Discount 2 (Both) DiscountType 2 (Both) DuplicateRule 2 (Both) DuplicateRuleCondition 2 (Both) DynamicProperty 2 (Both) DynamicPropertyAssociation 2 (Both) DynamicPropertyInstance 2 (Both) DynamicPropertyOptionSetItem 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) EntitlementChannel 2 (Both) EntitlementTemplate 2 (Both) EntitlementTemplateChannel 2 (Both) Equipment 2 (Both) ExchangeSyncIdMapping 2 (Both) Fax 2 (Both) FieldPermission 2 (Both) FieldSecurityProfile 2 (Both) FixedMonthlyFiscalCalendar 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) HierarchyRule 2 (Both) HierarchySecurityConfiguration 2 (Both) Import 2 (Both) ImportEntityMapping 2 (Both) ImportFile 2 (Both) ImportJob 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) Invoice 2 (Both) InvoiceDetail 2 (Both) IsvConfig 2 (Both) KbArticle 2 (Both) KbArticleComment 2 (Both) KbArticleTemplate 2 (Both) Lead 2 (Both) Letter 2 (Both) List 2 (Both) LookUpMapping 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) MonthlyFiscalCalendar 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OpportunityProduct 2 (Both) OrderClose 2 (Both) OwnerMapping 2 (Both) PhoneCall 2 (Both) PickListMapping 2 (Both) PluginAssembly 2 (Both) PluginType 2 (Both) Position 2 (Both) Post 2 (Both) PostComment 2 (Both) PostFollow 2 (Both) PostLike 2 (Both) PriceLevel 2 (Both) PrincipalObjectAttributeAccess 2 (Both) ProcessSession 2 (Both) ProcessTrigger 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) ProductPriceLevel 2 (Both) ProductSubstitute 2 (Both) Publisher 2 (Both) PublisherAddress 2 (Both) QuarterlyFiscalCalendar 2 (Both) Queue 2 (Both) QueueItem 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) QuoteDetail 2 (Both) RecurrenceRule 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RelationshipRoleMap 2 (Both) Report 2 (Both) ReportCategory 2 (Both) ReportEntity 2 (Both) ReportVisibility 2 (Both) ResourceSpec 2 (Both) Role 2 (Both) RollupField 2 (Both) RoutingRule 2 (Both) RoutingRuleItem 2 (Both) SalesLiterature 2 (Both) SalesLiteratureItem 2 (Both) SalesOrder 2 (Both) SalesOrderDetail 2 (Both) SavedQuery 2 (Both) SavedQueryVisualization 2 (Both) SdkMessageProcessingStep 2 (Both) SdkMessageProcessingStepImage 2 (Both) SdkMessageProcessingStepSecureConfig 2 (Both) SemiAnnualFiscalCalendar 2 (Both) Service 2 (Both) ServiceAppointment 2 (Both) ServiceEndpoint 2 (Both) SharePointDocument 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) Site 2 (Both) SLA 2 (Both) SLAItem 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialInsightsConfiguration 2 (Both) SocialProfile 2 (Both) Solution 2 (Both) Subject 2 (Both) SystemForm 2 (Both) Task 2 (Both) Team 2 (Both) TeamTemplate 2 (Both) Template 2 (Both) Territory 2 (Both) TraceLog 2 (Both) TransactionCurrency 2 (Both) TransformationMapping 2 (Both) TransformationParameterMapping 2 (Both) UoM 2 (Both) UoMSchedule 2 (Both) UserEntityInstanceData 2 (Both) UserEntityUISettings 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) WebResource 2 (Both) Workflow 2 (Both) WorkflowDependency 2 (Both) WorkflowLog 2 (Both) Delete message privilegesUse the early-bound entity classes for create, update, and delete Contains the response from the class. There is no return value from this operation. Contains the data that is needed to delete a link between records. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges on the entity specified in the parameter and access rights on the records specified in the and parameters. For a list of the privileges required, see Delete message privileges. Notes for Callers This method removes multiple associations in one transaction between the record specified by the parameter and each record in the parameter for the relationship specified in the parameter. For a one-to-many relationship, this method clears the in the related record to the value of . For a many-to-many relationship, this method deletes a record in the intersect table for the relationship. The intersect table name is defined in the property for the relationship. You need this when you query for the records. However, you need the relationship name to set the property. This name is defined in the property for the relationship. Supported Entities You can use this method to disassociate any records that participate in a relationship, including records for custom entities. You can find the default relationships listed in the Entity Metadata topic for each entity. Entity metadataEntity relationship behaviorCustomize entity relationship metadata Contains the response from the class. There is no return value from this operation. Contains the data that is needed to execute a message asynchronously. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must havethe privileges needed for the message passed in the parameter. Notes for Callers None Execute messages in the background (asynchronously) Contains the response from the class. Field-level data encryption Contains the data that is needed to execute one or more message requests as a single batch operation, and optionally return a collection of results. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights There are no specific privileges required for this request. Refer to the required privileges and access rights of each message request you add to the collection. Refer to Privileges by message. Notes for Callers is honored for each message request. See the related topics for throttling limitations. The following sample shows how to execute the message. ExecuteMultiple#ExecuteMultiple1 ExecuteMultipleVB#ExecuteMultiple1 Use messages (request and response classes) with the Execute methodSample: Execute multiple requests Contains the response from the class. Use messages (request and response classes) with the Execute method Contains the data that is needed to execute one or more message requests in a single database transaction, and optionally return a collection of results. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights There are no specific privileges required for this request. Refer to the required privileges and access rights of each message request you add to the collection. Refer to Privileges by message. Notes for Callers is honored for each message request. See the related topics for throttling limitations. Execute messages in a single database transaction Contains the response from the class. Execute messages in a single database transaction Contains the data that is needed to retrieve a list of all the entities that can participate in a Many-to-Many entity relationship. For the Web API use the GetValidManyToMany Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in GetValidManyToMany message privileges. Notes for Callers Entity relationship eligibilityCustomize entity relationship metadata Contains the response from the class. For the Web API the GetValidManyToManyResponse ComplexType is the response value from the GetValidManyToMany Function. Contains the data that is needed to retrieve a list of entity logical names that are valid as the primary entity (one) from the specified entity in a one-to-many relationship. For the Web API use GetValidReferencedEntities Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in GetValidReferencedEntities message privileges. Notes for Callers If no entity is specified, this message returns all entities that can be the primary entity in a one-to-many relationship. Customize entity relationship metadataEntity relationship eligibility Contains the response from the class. For the Web API the GetValidReferencedEntitiesResponse ComplexType is the response value from the GetValidReferencingEntities Function. Contains the data that is needed to retrieve the set of entities that are valid as the related entity (many) to the specified entity in a one-to-many relationship. For the Web API use the GetValidReferencingEntities Function. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in GetValidReferencingEntities message privileges. Notes for Callers Entity relationship eligibilityCustomize entity relationship metadata Contains the response from the class. For the Web API the GetValidReferencingEntitiesResponse ComplexType is the response value from the GetValidReferencingEntities Function. Contains the data that is needed to insert a new option value for a global or local option set. For the Web API use the InsertOptionValue Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in InsertOptionValue message privileges. Notes for Callers Use this message to update global option sets or local option sets within picklist attributes. When you update a global option set only and are required. When you update a local option set only , , and are required. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. attributes#WorkWithAttributes7 attributesVB#WorkWithAttributes7 The following example shows how to insert a new option into a global option set. optionsets#WorkwithGlobalOptionSets5 optionsetsVB#WorkwithGlobalOptionSets5 Sample: Work with attribute metadataSample: Work with global option sets Contains the response from the class. For the Web API the InsertOptionValueResponse ComplexType is the response value from the InsertOptionValue Action. Contains the data that is needed to insert a new option into a attribute. For the Web API use the InsertStatusValue Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in InsertStatusValue message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. attributes#WorkWithAttributes3 attributesVB#WorkWithAttributes3 Sample: Work with attribute metadataCustomize entity attribute metadataEntity attribute metadata messages Contains the response from the class. For the Web API the InsertStatusValueResponse ComplexType is the response value from the InsertStatusValue Action. Contains the data that is needed to check if data encryption is currently running (active or inactive). For the Web API use the IsDataEncryptionActive Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Notes for Callers None Field-level data encryption Contains the response from the class. For the Web API the IsDataEncryptionActiveResponse ComplexType is the response value from the IsDataEncryptionActive Function. Field-level data encryption Contains the data that is needed to set the order for an option set. For the Web API use the OrderOption Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in OrderOption message privileges. Notes for Callers You can use this message to edit options for global option sets or local option sets inside a attribute. For global option sets use the property. For local option sets specify the and the . The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. This sample shows how to change the order of options in a local option set. The following sample retrieves a custom attribute and changes the order of the original options using the OrderBy LINQ function to sort items in ascending order by the label text. Then it uses to set the new order of the options for the attribute. Use the OrderByDecending LINQ function to order the items in descending order. attributes#WorkWithAttributes8 attributesVB#WorkWithAttributes8 Sample: Work with attribute metadataCustomize entity attribute metadata Contains the response from the class. There is no return value from this operation. Contains data that is needed to submit a new asynchronous system job to create the index for the key. This message does not have a corresponding Web API action or function in Microsoft Dynamics 365 (online & on-premises). More information: Missing functions and actions for some organization service messages. Contains the response from class. Contains the data that is needed to retrieve metadata information about all the entities. For the Web API use the RetrieveAllEntities Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveAllEntities message privileges. Notes for Callers This request returns a large amount of data and may take significant time to return all the data. When there are a large number of customizations it is possible that this request could fail due to time limitations using Microsoft Dynamics 365 (online). Use the to request just the metadata you need. Otherwise, use . as the parameter to minimize the amount of data retrieved. Then, using the returned for each entity, use the class to for each entity that you need metadata for. Splitting up the requests can reduce the chance that your request will time out. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. entities#DumpEntityInfo1 entitiesVB#DumpEntityInfo1 Sample: Dump entity metadata to a fileSample: Dump entity relationship information to a fileSample: Dump entity privilege information to a fileRetrieve and detect changes to metadataCustomize entity metadata Contains the response from the class. Contains the data that is needed to retrieve all managed property definitions Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveAllManagedProperties message privileges. Use managed propertiesPlan for solution developmentPackage and distribute extensions using solutions Contains the response from the class. Contains the data that is needed to retrieve information about all global option sets. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveAllOptionSets message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. optionsets#WorkwithGlobalOptionSets9 optionsetsVB#WorkwithGlobalOptionSets9 Retrieve all global option setsSample: Dump global option set information to a fileCustomize global option sets Contains the response from the class. Contains the data that is needed to retrieve attribute metadata. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveAttribute message privileges. Notes for Callers You can use either the or the to specify the attribute you want to retrieve. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. // Create the request RetrieveAttributeRequest attributeRequest = new RetrieveAttributeRequest { EntityLogicalName = Contact.EntityLogicalName, LogicalName = "new_string", RetrieveAsIfPublished = false }; // Execute the request RetrieveAttributeResponse attributeResponse = (RetrieveAttributeResponse)_serviceProxy.Execute(attributeRequest); Console.WriteLine("Retrieved the attribute {0}.", attributeResponse.AttributeMetadata.SchemaName); Sample: Work with attribute metadataCustomize entity attribute metadata Contains the response from the class. There is no return value from this operation. Contains the data that is needed to retrieve the data encryption key value. For the Web API use the RetrieveDataEncryptionKey Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Notes for Callers None Field-level data encryption Contains the response from the class. For the Web API the RetrieveDataEncryptionKeyResponse ComplexType is the response value from the RetrieveDataEncryptionKey Function. Field-level data encryption Contains data that is needed to retrieve the changes for an entity. For the Web API use the RetrieveEntityChanges Function. Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) . Contains the response from class. Contains data that is needed to retrieve an alternate key. This message takes the entity name and key name as input values to retrieve the specified key for the entity. Usage Pass an instance of this class to the method, which returns an instance of . Notes for Callers You have to specify the and the to specify the key you want to retrieve. Contains the response from the class. Contains the data that is needed to retrieve entity metadata. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveEntity message privileges. Notes for Callers You can use either the or the to specify the entity you want to retrieve. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. entities#CreateUpdateEntityMetadata.RetrieveEntity entitiesVB#CreateUpdateEntityMetadata.RetrieveEntity Sample: Create and update entity metadataCustomize entity metadata Contains the response from the class. Contains the data that is needed to retrieve a managed property definition. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveManagedProperty message privileges. Use managed properties Contains the response from the class. Contains the data that is needed to to retrieve a collection of metadata records that satisfy the specified criteria. The returns a timestamp value that can be used with this request at a later time to return information about how metadata has changed since the last request. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. MetadataQuery#getMetadataChanges Retrieve and detect changes to metadataSample: Query metadata and detect changesCustomize entity metadataCustomize entity attribute metadataCustomize entity relationship metadata Contains the response from the message. The following code snippets from Sample: Query metadata and detect changes show the use of and properties. MetadataQuery#updateOptionLabelList,addOptionLabelsToCache,removeOptionLabelsFromCache Retrieve and detect changes to metadataSample: Query metadata and detect changes Contains the data that is needed to retrieve a collection of records that satisfy the specified query criteria. Message Availability This message works regardless whether the caller is connected to the server or offline. However, a few entities of this message class are exceptions to that availability. To determine which entities have a more restricted availability, see Supported Entities later in this topic. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entities in the property and read access rights on the records that are returned from the query. For a list of the required privileges, see RetrieveMultiple message privileges. Notes for Callers This message supports queries that use Query Expression and FetchXML. For more information, see Retrieve data with queries using SDK assemblies. You can also use the method. The collection of returned records from this message contains only the records for which the caller has read access. The returned records contain values for specified properties in the parameter that are valid for retrieval and for which the calling user has access rights. Any other property values are not returned. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365. Supported Entities You can use this method to retrieve any records for entities that support the message, including custom entities. The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) AccountLeads 2 (Both) ActivityMimeAttachment 2 (Both) ActivityParty 2 (Both) ActivityPointer 2 (Both) Annotation 2 (Both) AnnualFiscalCalendar 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) AttributeMap 2 (Both) Audit 2 (Both) BulkDeleteFailure 2 (Both) BulkDeleteOperation 2 (Both) BulkOperation 2 (Both) BulkOperationLog 2 (Both) BusinessUnit 2 (Both) BusinessUnitNewsArticle 2 (Both) Calendar 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignActivityItem 2 (Both) CampaignItem 2 (Both) CampaignResponse 2 (Both) ColumnMapping 2 (Both) Competitor 2 (Both) CompetitorProduct 2 (Both) CompetitorSalesLiterature 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) ConnectionRoleAssociation 2 (Both) ConnectionRoleObjectTypeCode 2 (Both) ConstraintBasedGroup 2 (Both) Contact 2 (Both) ContactInvoices 2 (Both) ContactLeads 2 (Both) ContactOrders 2 (Both) ContactQuotes 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ContractTemplate 2 (Both) ConvertRule 2 (Both) ConvertRuleItem 2 (Both) CustomerAddress 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) Dependency 2 (Both) Discount 2 (Both) DiscountType 2 (Both) DisplayString 2 (Both) DuplicateRecord 2 (Both) DuplicateRule 2 (Both) DuplicateRuleCondition 2 (Both) DynamicProperty 2 (Both) DynamicPropertyAssociation 2 (Both) DynamicPropertyInstance 2 (Both) DynamicPropertyOptionSetItem 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) EntitlementChannel 2 (Both) EntitlementContacts 2 (Both) EntitlementProducts 2 (Both) EntitlementTemplate 2 (Both) EntitlementTemplateChannel 2 (Both) EntitlementTemplateProducts 2 (Both) EntityMap 2 (Both) Equipment 2 (Both) ExchangeSyncIdMapping 2 (Both) Fax 2 (Both) FieldPermission 2 (Both) FieldSecurityProfile 2 (Both) FixedMonthlyFiscalCalendar 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) HierarchyRule 2 (Both) HierarchySecurityConfiguration 2 (Both) Import 2 (Both) ImportEntityMapping 2 (Both) ImportFile 2 (Both) ImportJob 2 (Both) ImportLog 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) InvalidDependency 2 (Both) Invoice 2 (Both) InvoiceDetail 2 (Both) IsvConfig 2 (Both) KbArticle 2 (Both) KbArticleComment 2 (Both) KbArticleTemplate 2 (Both) Lead 2 (Both) LeadAddress 2 (Both) LeadCompetitors 2 (Both) LeadProduct 2 (Both) Letter 2 (Both) License 2 (Both) List 2 (Both) ListMember 2 (Both) LookUpMapping 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) MonthlyFiscalCalendar 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OpportunityCompetitors 2 (Both) OpportunityProduct 2 (Both) OrderClose 2 (Both) Organization 2 (Both) OrganizationUI 2 (Both) OwnerMapping 2 (Both) PhoneCall 2 (Both) PickListMapping 2 (Both) PluginAssembly 2 (Both) PluginType 2 (Both) PluginTypeStatistic 2 (Both) Position 2 (Both) Post 2 (Both) PostComment 2 (Both) PostFollow 2 (Both) PostLike 2 (Both) PriceLevel 2 (Both) PrincipalObjectAttributeAccess 2 (Both) Privilege 2 (Both) ProcessSession 2 (Both) ProcessStage 2 (Both) ProcessTrigger 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) ProductPriceLevel 2 (Both) ProductSalesLiterature 2 (Both) ProductSubstitute 2 (Both) Publisher 2 (Both) PublisherAddress 2 (Both) QuarterlyFiscalCalendar 2 (Both) Queue 2 (Both) QueueItem 2 (Both) QueueMembership 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) QuoteDetail 2 (Both) RecurrenceRule 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RelationshipRoleMap 2 (Both) Report 2 (Both) ReportCategory 2 (Both) ReportEntity 2 (Both) ReportLink 2 (Both) ReportVisibility 2 (Both) Resource 2 (Both) ResourceGroup 2 (Both) ResourceSpec 2 (Both) Role 2 (Both) RolePrivileges 2 (Both) RollupField 2 (Both) RoutingRule 2 (Both) RoutingRuleItem 2 (Both) SalesLiterature 2 (Both) SalesLiteratureItem 2 (Both) SalesOrder 2 (Both) SalesOrderDetail 2 (Both) SavedQuery 2 (Both) SavedQueryVisualization 2 (Both) SdkMessage 2 (Both) SdkMessageFilter 2 (Both) SdkMessagePair 2 (Both) SdkMessageProcessingStep 2 (Both) SdkMessageProcessingStepImage 2 (Both) SdkMessageProcessingStepSecureConfig 2 (Both) SdkMessageRequest 2 (Both) SdkMessageRequestField 2 (Both) SdkMessageResponse 2 (Both) SdkMessageResponseField 2 (Both) SemiAnnualFiscalCalendar 2 (Both) Service 2 (Both) ServiceAppointment 2 (Both) ServiceContractContacts 2 (Both) ServiceEndpoint 2 (Both) SharePointData 2 (Both) SharePointDocument 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) Site 2 (Both) SiteMap 2 (Both) SLA 2 (Both) SLAItem 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialInsightsConfiguration 2 (Both) SocialProfile 2 (Both) Solution 2 (Both) SolutionComponent 2 (Both) Subject 2 (Both) SubscriptionTrackingDeletedObject 2 (Both) SystemForm 2 (Both) SystemUser 2 (Both) SystemUserLicenses 2 (Both) SystemUserProfiles 2 (Both) SystemUserRoles 2 (Both) Task 2 (Both) Team 2 (Both) TeamMembership 2 (Both) TeamProfiles 2 (Both) TeamRoles 2 (Both) TeamTemplate 2 (Both) Template 2 (Both) Territory 2 (Both) TimeZoneDefinition 2 (Both) TimeZoneLocalizedName 2 (Both) TimeZoneRule 2 (Both) TraceLog 2 (Both) TransactionCurrency 2 (Both) TransformationMapping 2 (Both) TransformationParameterMapping 2 (Both) UoM 2 (Both) UoMSchedule 2 (Both) UserEntityInstanceData 2 (Both) UserEntityUISettings 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) UserSettings 2 (Both) WebResource 2 (Both) Workflow 2 (Both) WorkflowDependency 2 (Both) WorkflowLog 2 (Both) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Query#RetrieveRecordsFromAnIntersectTable1 QueryVB#RetrieveRecordsFromAnIntersectTable1 Retrieve data with queries using SDK assembliesBuild queries with QueryExpressionBuild queries with FetchXMLRetrieve records for many-to-many relationships using intersect entitiesSample: Retrieve records from an intersect table Contains the response from the class. Contains the data that is needed to retrieve a global option set. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveOptionSet message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. OptionSets#WorkwithGlobalOptionSets6 OptionSetsVB#WorkwithGlobalOptionSets6 Sample: Work with global option setsCustomize global option sets Contains the response from the class. Contains the data that is needed to retrieve entity relationship metadata. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in RetrieveRelationship message privileges. Notes for Callers You can use either the or the of the relationship. The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. relationships#WorkWithRelationships.RetrieveRelationship relationshipsVB#WorkWithRelationships.RetrieveRelationship Sample: Create and retrieve entity relationshipsCustomize entity relationship metadata Contains the response from the class. Contains the data that is needed to retrieve a record. Message Availability This message works regardless whether the caller is connected to the server or offline. However, a few entities of this message class are exceptions to that availability. To determine which entities have a more restricted availability, see later in this topic. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have access rights on the specified records in the property. For a list of the required privileges, see Retrieve message privileges. Notes for Callers The returned record contains the values for the properties that are specified in the property for which the calling user has access rights. No other property values are returned. For more information about field security, see How field security can be used to control access to field values in Microsoft Dynamics 365. Supported Entities You can use this method to retrieve any records for entities (includes custom entities) that support the message. The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) ActivityMimeAttachment 2 (Both) ActivityPointer 2 (Both) Annotation 2 (Both) AnnualFiscalCalendar 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) AttributeMap 2 (Both) Audit 2 (Both) BulkDeleteFailure 2 (Both) BulkDeleteOperation 2 (Both) BulkOperation 2 (Both) BulkOperationLog 2 (Both) BusinessUnit 2 (Both) BusinessUnitNewsArticle 2 (Both) Calendar 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) ColumnMapping 2 (Both) Competitor 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) ConnectionRoleObjectTypeCode 2 (Both) ConstraintBasedGroup 2 (Both) Contact 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ContractTemplate 2 (Both) ConvertRule 2 (Both) ConvertRuleItem 2 (Both) CustomerAddress 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) Dependency 2 (Both) Discount 2 (Both) DiscountType 2 (Both) DisplayString 2 (Both) DuplicateRecord 2 (Both) DuplicateRule 2 (Both) DuplicateRuleCondition 2 (Both) DynamicProperty 2 (Both) DynamicPropertyAssociation 2 (Both) DynamicPropertyInstance 2 (Both) DynamicPropertyOptionSetItem 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) EntitlementChannel 2 (Both) EntitlementTemplate 2 (Both) EntitlementTemplateChannel 2 (Both) EntityMap 2 (Both) Equipment 2 (Both) ExchangeSyncIdMapping 2 (Both) Fax 2 (Both) FieldPermission 2 (Both) FieldSecurityProfile 2 (Both) FixedMonthlyFiscalCalendar 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) HierarchyRule 2 (Both) Import 2 (Both) ImportEntityMapping 2 (Both) ImportFile 2 (Both) ImportJob 2 (Both) ImportLog 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) InvalidDependency 2 (Both) Invoice 2 (Both) InvoiceDetail 2 (Both) IsvConfig 2 (Both) KbArticle 2 (Both) KbArticleComment 2 (Both) KbArticleTemplate 2 (Both) Lead 2 (Both) LeadAddress 2 (Both) Letter 2 (Both) List 2 (Both) LookUpMapping 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) MonthlyFiscalCalendar 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OpportunityProduct 2 (Both) OrderClose 2 (Both) Organization 2 (Both) OrganizationUI 2 (Both) OwnerMapping 2 (Both) PhoneCall 2 (Both) PickListMapping 2 (Both) PluginAssembly 2 (Both) PluginType 2 (Both) PluginTypeStatistic 2 (Both) Position 2 (Both) Post 2 (Both) PostComment 2 (Both) PostFollow 2 (Both) PostLike 2 (Both) PriceLevel 2 (Both) PrincipalObjectAttributeAccess 2 (Both) Privilege 2 (Both) ProcessSession 2 (Both) ProcessStage 2 (Both) ProcessTrigger 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) ProductPriceLevel 2 (Both) ProductSubstitute 2 (Both) Publisher 2 (Both) PublisherAddress 2 (Both) QuarterlyFiscalCalendar 2 (Both) Queue 2 (Both) QueueItem 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) QuoteDetail 2 (Both) RecurrenceRule 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RelationshipRoleMap 2 (Both) Report 2 (Both) ReportCategory 2 (Both) ReportEntity 2 (Both) ReportLink 2 (Both) ReportVisibility 2 (Both) Resource 2 (Both) ResourceGroup 2 (Both) ResourceSpec 2 (Both) Role 2 (Both) RollupField 2 (Both) RoutingRule 2 (Both) RoutingRuleItem 2 (Both) SalesLiterature 2 (Both) SalesLiteratureItem 2 (Both) SalesOrder 2 (Both) SalesOrderDetail 2 (Both) SavedQuery 2 (Both) SavedQueryVisualization 2 (Both) SdkMessage 2 (Both) SdkMessageFilter 2 (Both) SdkMessagePair 2 (Both) SdkMessageProcessingStep 2 (Both) SdkMessageProcessingStepImage 2 (Both) SdkMessageProcessingStepSecureConfig 2 (Both) SdkMessageRequest 2 (Both) SdkMessageRequestField 2 (Both) SdkMessageResponse 2 (Both) SdkMessageResponseField 2 (Both) SemiAnnualFiscalCalendar 2 (Both) Service 2 (Both) ServiceAppointment 2 (Both) ServiceEndpoint 2 (Both) SharePointData 2 (Both) SharePointDocument 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) Site 2 (Both) SiteMap 2 (Both) SLA 2 (Both) SLAItem 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialInsightsConfiguration 2 (Both) SocialProfile 2 (Both) Solution 2 (Both) SolutionComponent 2 (Both) Subject 2 (Both) SystemForm 2 (Both) SystemUser 2 (Both) Task 2 (Both) Team 2 (Both) TeamTemplate 2 (Both) Template 2 (Both) Territory 2 (Both) TimeZoneDefinition 2 (Both) TimeZoneLocalizedName 2 (Both) TimeZoneRule 2 (Both) TraceLog 2 (Both) TransactionCurrency 2 (Both) TransformationMapping 2 (Both) TransformationParameterMapping 2 (Both) UoM 2 (Both) UoMSchedule 2 (Both) UserEntityInstanceData 2 (Both) UserEntityUISettings 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) UserSettings 2 (Both) WebResource 2 (Both) Workflow 2 (Both) WorkflowDependency 2 (Both) WorkflowLog 2 (Both) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. TestNet4Activity#ReleaseISVActivities1 Build queries with QueryExpressionBuild queries with FetchXMLSample: Update next birthday using a custom workflow activityRetrieve message privileges Contains the response from the class. Contains the data that is needed to retrieves a time stamp for the metadata. For the Web API use the RetrieveTimestamp Function. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights No special privileges or access rights are required to perform this action. Notes for Callers Execute this message before you retrieve metadata. You can repeat this process later to see if the metadata has changed in the intervening time. If the value is the same, the metadata has not changed. If the value is different, you retrieve the metadata again to get the updated values. Use the Organization service with Dynamics 365 metadata Contains the response from the class. For the Web API the RetrieveTimestampResponse ComplexType is the response value from the RetrieveTimestamp Function. Contains the data that is needed to set or restore the data encryption key. For the Web API use the SetDataEncryptionKey Action. Message Availability This message works regardless whether the caller is connected to the server or offline. Usage Pass an instance of this class to the method, which returns an instance of . Notes for Callers None Field-level data encryption Contains the response from the class. Field-level data encryption Contains the data that is needed to update the definition of an attribute. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in UpdateAttribute message privileges. Notes for Callers You must publish the changes to the metadata before this change will be visible in the application. For more information, see Publish customizations The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. attributes#WorkWithAttributes5 attributesVB#WorkWithAttributes5 Sample: Work with attribute metadataCustomize entity attribute metadataUse the Organization service with Dynamics 365 metadata Contains the response from the class. There is no return value from this operation. Contains the data that is needed to update the definition of an entity. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in UpdateEntity message privileges. Notes for Callers You must publish the changes to the metadata before this change will be visible in the application. For more information, see Publish customizations The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. entities#CreateUpdateEntityMetadata8 entitiesVB#CreateUpdateEntityMetadata8 Sample: Create and update entity metadataRetrieve, update, and delete entitiesCustomize entity metadata Contains the response from the class. There is no return value from this operation. Contains the data that is needed to update the definition of a global option set. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in UpdateOptionSet message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. optionsets#WorkwithGlobalOptionSets4 optionsetsVB#WorkwithGlobalOptionSets4 Sample: Work with global option setsUpdate a global option setCustomize global option sets Contains the response from the class. There is no return value from this operation. Contains the data that is needed to update an option value in a global or local option set. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in UpdateOptionValue message privileges. Notes for Callers The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. optionsets#WorkwithGlobalOptionSets7 optionsetsVB#WorkwithGlobalOptionSets7 Customize global option setsSample: Work with global option sets Contains the response from the class. There is no return value from this operation. Contains the data that is needed to update the definition of an entity relationship. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of . Privileges and Access Rights To perform this action, the caller must have privileges listed in UpdateRelationship Privileges. Notes for Callers You must publish the changes to the metadata before this change will be visible in the application. For more information, see Publish customizations Customize entity relationship metadata Contains the response from the class. There is no return value from this operation. Contains the data that is needed to update an existing record. Message Availability This message works regardless whether the caller is connected to the server or offline. Not all entity types support this message offline. For more information, see Supported Entities later in this topic. Usage Pass an instance of this class to the method, which returns an instance of the class. This message supports one or more optional parameters. For more information, see Use messages (request and response classes) with the Execute method. Privileges and Access Rights To perform this action, the caller must have privileges on the specified entity in the parameter. For a list of the required privileges, see Update message privileges. Notes for Callers This message updates a record and its related records in one transaction. For a less complex method that updates a single record, use the method. If the entity instance that is specified in the parameter includes attributes that are not valid for update, they are ignored. Supported Entities You can use this method to update any record of an entity that supports the message, including custom entities. The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server. Entity Availability Account 2 (Both) ActivityMimeAttachment 2 (Both) Annotation 2 (Both) AnnualFiscalCalendar 2 (Both) Appointment 2 (Both) AsyncOperation 2 (Both) BusinessUnit 2 (Both) BusinessUnitNewsArticle 2 (Both) Calendar 2 (Both) Campaign 2 (Both) CampaignActivity 2 (Both) CampaignResponse 2 (Both) Competitor 2 (Both) Connection 2 (Both) ConnectionRole 2 (Both) ConstraintBasedGroup 2 (Both) Contact 2 (Both) Contract 2 (Both) ContractDetail 2 (Both) ContractTemplate 2 (Both) ConvertRule 2 (Both) ConvertRuleItem 2 (Both) CustomerAddress 2 (Both) CustomerOpportunityRole 2 (Both) CustomerRelationship 2 (Both) Discount 2 (Both) DiscountType 2 (Both) DisplayString 2 (Both) DuplicateRule 2 (Both) DuplicateRuleCondition 2 (Both) DynamicProperty 2 (Both) DynamicPropertyAssociation 2 (Both) DynamicPropertyInstance 2 (Both) DynamicPropertyOptionSetItem 2 (Both) Email 2 (Both) EmailServerProfile 2 (Both) Entitlement 2 (Both) EntitlementChannel 2 (Both) EntitlementTemplate 2 (Both) EntitlementTemplateChannel 2 (Both) Equipment 2 (Both) ExchangeSyncIdMapping 2 (Both) Fax 2 (Both) FieldPermission 2 (Both) FieldSecurityProfile 2 (Both) FixedMonthlyFiscalCalendar 2 (Both) Goal 2 (Both) GoalRollupQuery 2 (Both) HierarchyRule 2 (Both) Import 2 (Both) ImportFile 2 (Both) ImportJob 2 (Both) ImportMap 2 (Both) Incident 2 (Both) IncidentResolution 2 (Both) Invoice 2 (Both) InvoiceDetail 2 (Both) IsvConfig 2 (Both) KbArticle 2 (Both) KbArticleComment 2 (Both) KbArticleTemplate 2 (Both) Lead 2 (Both) Letter 2 (Both) List 2 (Both) Mailbox 2 (Both) MailMergeTemplate 2 (Both) Metric 2 (Both) MonthlyFiscalCalendar 2 (Both) msdyn_PostAlbum 2 (Both) msdyn_PostConfig 2 (Both) msdyn_PostRuleConfig 2 (Both) msdyn_wallsavedquery 2 (Both) msdyn_wallsavedqueryusersettings 2 (Both) Opportunity 2 (Both) OpportunityClose 2 (Both) OpportunityProduct 2 (Both) OrderClose 2 (Both) Organization 2 (Both) OrganizationUI 2 (Both) PhoneCall 2 (Both) PluginAssembly 2 (Both) PluginType 2 (Both) Position 2 (Both) PriceLevel 2 (Both) PrincipalObjectAttributeAccess 2 (Both) ProcessSession 2 (Both) ProcessTrigger 2 (Both) Product 2 (Both) ProductAssociation 2 (Both) ProductPriceLevel 2 (Both) ProductSubstitute 2 (Both) Publisher 2 (Both) PublisherAddress 2 (Both) QuarterlyFiscalCalendar 2 (Both) Queue 2 (Both) QueueItem 2 (Both) Quote 2 (Both) QuoteClose 2 (Both) QuoteDetail 2 (Both) RecurrenceRule 2 (Both) RecurringAppointmentMaster 2 (Both) RelationshipRole 2 (Both) RelationshipRoleMap 2 (Both) Report 2 (Both) ReportCategory 2 (Both) ReportEntity 2 (Both) ReportVisibility 2 (Both) ResourceSpec 2 (Both) Role 2 (Both) RollupField 2 (Both) RoutingRule 2 (Both) RoutingRuleItem 2 (Both) SalesLiterature 2 (Both) SalesLiteratureItem 2 (Both) SalesOrder 2 (Both) SalesOrderDetail 2 (Both) SavedQuery 2 (Both) SavedQueryVisualization 2 (Both) SdkMessageProcessingStep 2 (Both) SdkMessageProcessingStepImage 2 (Both) SdkMessageProcessingStepSecureConfig 2 (Both) SemiAnnualFiscalCalendar 2 (Both) Service 2 (Both) ServiceAppointment 2 (Both) ServiceEndpoint 2 (Both) SharePointData 2 (Both) SharePointDocumentLocation 2 (Both) SharePointSite 2 (Both) Site 2 (Both) SiteMap 2 (Both) SLA 2 (Both) SLAItem 2 (Both) SLAKPIInstance 2 (Both) SocialActivity 2 (Both) SocialInsightsConfiguration 2 (Both) SocialProfile 2 (Both) Solution 2 (Both) Subject 2 (Both) SystemForm 2 (Both) SystemUser 2 (Both) Task 2 (Both) Team 2 (Both) TeamTemplate 2 (Both) Template 2 (Both) Territory 2 (Both) TransactionCurrency 2 (Both) UoM 2 (Both) UoMSchedule 2 (Both) UserEntityInstanceData 2 (Both) UserEntityUISettings 2 (Both) UserForm 2 (Both) UserQuery 2 (Both) UserQueryVisualization 2 (Both) UserSettings 2 (Both) WebResource 2 (Both) Workflow 2 (Both) WorkflowDependency 2 (Both) WorkflowLog 2 (Both) The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. BusinessManagement#UpdateRequest BusinessManagementVB#UpdateRequest Extend Microsoft Dynamics 365 on the serverSample: Process quotes, sales orders and invoices Contains the response from the class. There is no return value from this operation. Contains the data that is needed to update an option set value in for a attribute. For the Web API use the UpdateStateValue Action. Message Availability For this message to work, the caller must be connected to the server. Usage Pass an instance of this class to the method, which returns an instance of the class. Privileges and Access Rights To perform this action, the caller must have the required privileges, as listed in UpdateAttribute message privileges. Supported Attributes You can use this method to update any unmanaged attribute of type . The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an interface. For the complete sample, see the link later in this topic. Attributes#WorkWithAttributes6 AttributesVB#WorkWithAttributes6 Update a state valueSample: Work with attribute metadataUpdateAttribute message privileges Contains the response from the class. There is no return value from this operation. Contains data that is needed to update or insert a record in CRM. Usage Pass an instance of this class to the method, which returns an instance of the class. Contains the response from Describes the behavior of the associated menu for a one-to-many relationship. For the Web API use the AssociatedMenuBehavior EnumType. Create and retrieve entity relationshipsCustomize entity relationship metadata Use the collection name for the associated menu. Value = 0. Use the label for the associated menu. Value = 1. Do not show the associated menu. Value = 2. Defines how the associated records are displayed for an entity relationship. For the Web API the corresponding type is AssociatedMenuConfiguration ComplexType. Configure associated menus Describes the group in which to display the associated menu for an entity relationship For the Web API use the AssociatedMenuGroup EnumType. Customize entity relationship metadata Show the associated menu in the details group. Value = 0. Show the associated menu in the sales group. Value = 1. Show the associated menu in the service group. Value = 2. Show the associated menu in the marketing group. Value = 3. Contains all the metadata for an entity attribute. This class is returned in the . Customize entity attribute metadataSample: Dump attribute metadata to a fileSample: Work with attribute metadata Describes the requirement level for an attribute. For the Web API use the AttributeRequiredLevel EnumType. Customize entity attribute metadata No requirements are specified. Value = 0. The attribute is required to have a value. Value = 1. The attribute is required to have a value. Value = 2. It is recommended that the attribute has a value. Value = 3. Represents the data to define a property for an attribute. For the Web API the corresponding type is AttributeRequiredLevelManagedProperty ComplexType. Customize entity attribute metadataWork with attribute metadataSample: Create and update entity metadata Describes the type of an attribute. For the Web API use the AttributeTypeCode EnumType. Customize entity attribute metadata A Boolean attribute. Value = 0. An attribute that represents a customer. Value = 1. A date/time attribute. Value = 2. A decimal attribute. Value = 3. A double attribute. Value = 4. An integer attribute. Value = 5. A lookup attribute. Value = 6. A memo attribute. Value = 7. A money attribute. Value = 8. An owner attribute. Value = 9. A partylist attribute. Value = 10. A picklist attribute. Value = 11. A state attribute. Value = 12. A status attribute. Value = 13. A string attribute. Value = 14. An attribute that is an ID. Value = 15. An attribute that contains calendar rules. Value = 0x10. An attribute that is created by the system at run time. Value = 0x11. A big integer attribute. Value = 0x12. A managed property attribute. Value = 0x13. An entity name attribute. Value = 20. Provides a list of types of attributes used by . For the Web API the corresponding type is AttributeTypeDisplayName ComplexType. Contains the metadata for an attribute type . Customize entity attribute metadata Contains the metadata for an attribute type . Customize entity attribute metadataWork with attribute metadata Contains the metadata for an attribute of type . Customize entity attribute metadataWork with attribute metadata Contains properties representing actions that may be performed on the referenced entity in a one-to-many entity relationship. For the Web API the corresponding type is CascadeConfiguration ComplexType. Entity relationship behaviorOne-to-many relationshipsCreate a lookup attributeCreate and retrieve entity relationships Describes the type of behavior for a specific action applied to the referenced entity in a one-to-many entity relationship. For the Web API use the CascadeType EnumType. Do nothing. Value = 0. Perform the action on all referencing entity records associated with the referenced entity record. Value = 1. Perform the action on all active referencing entity records associated with the referenced entity record. Value = 2. Perform the action on all referencing entity records owned by the same user as the referenced entity record. Value = 3. Remove the value of the referencing attribute for all referencing entity records associated with the referenced entity record. Value = 4. Prevent the Referenced entity record from being deleted when referencing entities exist. Value = 5. A base class for static classes whose properties represent constants There are two derived classes: and . Contains the metadata for an attribute of type . A date and time attribute. You can format the attribute to show only the date or the date and the time. Behavior and format of the date and time attributeCustomize entity attribute metadataWork with attribute metadata Specifies the behavior of a attribute using the property. For the Web API the corresponding type is DateTimeBehavior ComplexType. Behavior and format of the date and time attribute Describes the formatting of a attribute. For the Web API use the DateTimeFormat EnumType. Customize entity attribute metadata Display the date only. Value = 0. Display the date and time. Value = 1. Contains the metadata for an attribute type Decimal. Customize entity attribute metadataWork with attribute metadata Contains the metadata for an attribute type Double. Describes the type of entity metadata to retrieve. Use this enumeration with and . Sample: Dump entity metadata to a file Use this to retrieve only entity information. Equivalent to . Value = 1. Use this to retrieve entity information plus attributes for the entity. Value = 2. Use this to retrieve entity information plus privileges for the entity. Value = 4. Use this to retrieve entity information plus entity relationships for the entity. Value = 8. Use this to retrieve only entity information. Equivalent to . Value = 1. Use this to retrieve all data for an entity. Value = 15. Represents the entity key metadata. Contains the metadata for an entity. Customize entity metadataSample: Create and update entity metadataSample: Dump entity metadata to a file Defines a collection of Contains the metadata for an attribute that references an entity. You cannot create this type of attribute. Sample: Dump entity metadata to a file Contains the data for an attribute that provides options. Customize entity attribute metadata Contains the metadata for an attribute type Image. To retrieve attributes of this type you must use current .NET assemblies or include a valid . value with your request. More information: and Sample: Retrieve entity metadata using JavaScript. Describes the input method editor mode For the Web API use the ImeMode EnumType. Far Eastern Input Method Editorshttp://msdn.microsoft.com/en-us/library/cc194844.aspx Specifies that the IME mode is chosen automatically. Value =0. Specifies that the IME mode is inactive. Value = 1. Specifies that the IME mode is active. Value = 2. Specifies that the IME mode is disabled. Value = 3. Contains the metadata for an attribute type Integer. Customize entity attribute metadata Describes the formatting of an integer attribute. For the Web API use the IntegerFormat EnumType. Specifies to display an edit field for an integer. Value = 0. Specifies to display the integer as a drop down list of durations. Value = 1. Specifies to display the integer as a drop down list of time zones. Value = 2. Specifies the display the integer as a drop down list of installed languages. Value = 3. Specifies a locale. Value = 4. Valid locale ID values can be found at Locale ID (LCID) Chart. Contains the metadata for an attribute of type lookup. Customize entity attribute metadataWork with attribute metadataCreate a lookup attribute For internal use only. For internal use only. For the Web API use the ManagedPropertyEvaluationPriority EnumType. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For the Web API use the ManagedPropertyOperation EnumType. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For internal use only. For the Web API use the ManagedPropertyType EnumType. For internal use only. For internal use only. For internal use only. For internal use only. Contains the metadata for a many-to-many entity relationship. Customize entity relationship metadata Contains the metadata for the attribute type . Customize entity attribute metadata Specifies the base class for classes that contains metadata information. Use the Organization service with Dynamics 365 metadata Contains the metadata for an attribute type Money. Customize entity attribute metadata Contains the metadata for a one-to-many entity relationship. Customize entity relationship metadata Contains metadata representing an option within an Option set. For the Web API the corresponding type is OptionMetadata ComplexType. Customize global option sets Contains the options in for the . class. Customize global option sets Contains metadata that defines a set of options. Customize global option sets Contains data that defines a set of options. Customize global option sets Indicates the type of option set. For the Web API use the OptionSetType EnumType. The option set provides a list of options. Value = 0. The option set represents state options for a attribute. Value = 1. The option set represents status options for a attribute. Value = 2. The option set provides two options for a attribute. Value = 3. Specifies the type of ownership for an entity. For the Web API use the OwnershipTypes EnumType. The only valid values for custom entities are OrgOwned or UserOwned. For Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online, all UserOwned entities can be assigned to teams. Entity ownershipOptions available when you create a custom entity The entity does not have an owner. For internal use only. Value = 0. The entity is owned by a system user. Value = 1. The entity is owned by a team. For internal use only.Value = 2. The entity is owned by a business unit. For internal use only. Value = 4. The entity is owned by an organization. Value = 8. The entity is parented by a business unit. For internal use only. Value = 16. Contains the metadata for an attribute type . Customize entity attribute metadataWork with attribute metadata Describes the type of operation for the privilege For the Web API use the PrivilegeType EnumType. How role-based security can be used to control access to entities in Microsoft Dynamics 365 Specifies no privilege. Value = 0. The create privilege. Value = 1. The read privilege. Value = 2. The write privilege. Value = 3. The delete privilege. Value = 4. The assign privilege. Value = 5. The share privilege. Value = 6. The append privilege. Value = 7. The append to privilege. Value = 8. Defines a complex query to retrieve attribute metadata for entities retrieved using an The following example shows the use of an to retrieve entity metadata. MetadataQuery#AttributeQueryExpression,InitialRequest Retrieve and detect changes to metadataSample: Query metadata and detect changes The structure used to return deleted metadata. This is the collection returned as the . property when the has values set for the and properties. The following code snippets taken from Sample: Query metadata and detect changes show how the can be used to detect deleted . MetadataQuery#updateOptionLabelList,removeOptionLabelsFromCache Retrieve and detect changes to metadataRetrieve information about deleted metadataSample: Query metadata and detect changes An enumeration that specifies the type of deleted metadata to retrieve. The enumeration can also be used as a key to access a subset of deleted metadata included in a . The following code snippets show usage of in Sample: Query metadata and detect changes. MetadataQuery#getMetadataChanges,updateOptionLabelList,removeOptionLabelsFromCache Retrieve and detect changes to metadataSample: Query metadata and detect changes Deleted Entity metadata. Value = 1. Deleted Attribute metadata. Value = 2. Deleted Relationship metadata. Value = 4. Deleted Label metadata. Value = 8. Deleted OptionSet metadata. Value = 16. The value used if not set. Equals All deleted metadata. Value = 31. Defines a complex query to retrieve entity metadata. The following example shows the use of an to retrieve entity metadata. MetadataQuery#InitialRequest,getMetadataChanges Retrieve and detect changes to metadataSample: Query metadata and detect changes Defines the languages for the labels to be retrieved for metadata items that have labels. The number of labels returned for each item depends on the number of language packs installed by the organization. If no additional language packs are installed, there will only be labels for the organization base language. For best performance when additional language packs are installed you can limit labels to those that correspond to the user’s language preference. These preferences can be determined using the values returned by the client-side context getUserLcid function or by querying the value. The following example shows those portions of the Sample: Query metadata and detect changes which deal with setting the . MetadataQuery#LabelQueryExpression0,LabelQueryExpression1,LabelQueryExpression2,LabelQueryExpression3 Retrieve and detect changes to metadataCustomize labels to support multiple languagesSample: Query metadata and detect changes Contains a condition expression used to filter the results of the metadata query. The following code snippet from Sample: Query metadata and detect changes shows the use of to set conditions for Entities and Attributes to return. MetadataQuery#EntityFilter,AttributeQueryExpression,InitialRequest Retrieve and detect changes to metadataSample: Query metadata and detect changes Describes the type of comparison for two values in a metadata condition expression. Retrieve and detect changes to metadataSample: Query metadata and detect changes The values are compared for equality. Value = 0. The two values are not equal. Value = 1. The value exists in a list of values. Value = 2. The given value is not matched to a value in a list. Value = 3. The value is greater than the compared value. Value = 4. The value is less than the compared value. Value = 5. Specifies complex condition and logical filter expressions used for filtering the results of a metadata query. The following example shows the use of a to return non-intersect, user-owned entities not found in a list of excluded entities. MetadataQuery#EntityFilter Retrieve and detect changes to metadataSample: Query metadata and detect changes Specifies the properties for which non-null values are returned from a query. When the metadata object is instantiated all properties are included but any properties not specified by the will contain null values. Retrieve and detect changes to metadataSample: Query metadata and detect changes Represents the abstract base class for constructing a metadata query. Retrieve and detect changes to metadataSample: Query metadata and detect changes Represents the abstract base class for constructing a metadata query. Retrieve and detect changes to metadataSample: Query metadata and detect changes Defines a complex query to retrieve entity relationship metadata for entities retrieved using an Retrieve and detect changes to metadataSample: Query metadata and detect changes Contains the metadata for an entity relationship. This is the base class used by and . Customize entity relationship metadata Specifies the type of entity relationship. For the Web API use the RelationshipType EnumType. The entity relationship is a One-to-Many relationship. Value = 0. The entity relationship is a Many-to-Many relationship. Value = 1. The default value. Equivalent to OneToManyRelationship. Value = 0. Contains the metadata that describes a security privilege for access to an entity. For the Web API the corresponding type is SecurityPrivilegeMetadata ComplexType. Describes the security type for the relationship. For the Web API use the SecurityTypes EnumType. This enumeration is used for the . property. This value is set by the system. You should not set this value. Customize entity relationship metadata No security privileges are checked during create or update operations. Value = 0. The and privileges are checked for create or update operations. Value = 1. Security for the referencing entity record is derived from the referenced entity record. Value = 2. Entities with the property set to derive their security from the parent record. For example, is a child of the entity. Security for the referencing entity record is derived from a pointer record. Value = 4. The only available type of pointer record is – the base class for all types of activity records. All activity records share the same privileges. If you can create an activity you can create any type of activity. The referencing entity record inherits security from the referenced security record. Value = 8. Contains the metadata for an attribute of type . This type of attribute has the label Status in the application. The options available for this attribute are read-only. Customize entity attribute metadata Contains data to define an option for the options in a State attribute. For the Web API the corresponding type is StateOptionMetadata ComplexType. Customize entity attribute metadata Contains the metadata for an attribute of type . Customize entity attribute metadata Contains one of the possible values for an attribute of type . For the Web API the corresponding type is StatusOptionMetadata ComplexType. Customize entity attribute metadata Contains the metadata for an attribute of type String. Customize entity attribute metadata Deprecated. Describes the formatting of a string attribute for the . property. For the Web API use the StringFormat EnumType. Use the . property instead. This property uses values rather than this enumeration. Customize entity attribute metadata Specifies to display the string as an e-mail. Value = 0. Specifies to display the string as text. Value = 1. Specifies to display the string as a text area. Value = 2. Specifies to display the string as a URL. Value = 3. Specifies to display the string as a ticker symbol. Value = 4. Specifies to display the string as a phonetic guide. Value = 5. Specifies to display the string as a version number. Value = 6. For internal use only. Specifies the format of a attribute using the property. For the Web API the corresponding type is StringFormatName ComplexType. This class replaces the deprecated enumeration used to set the . property. Represents the unique identifier attribute metadata. Contains the value for a money attribute. This corresponds to the class from Microsoft Dynamics CRM 4.0. Represents the new or updated item. Represents the current state of an operation. The operation has failed. Value = 0. The operation has been canceled. Value = 1. The operation is being retried. Value = 2. The operation has been suspended. Value = 3. The operation has succeeded. Value = 4. Represents a value for an attribute that has an option set. Indicates the type of network access an endpoint has. Sample: Access the Discovery service Default access. The actual access is determined by the endpoint URL. Value = 0. Internet access. Value = 1. Intranet access. Value = 2. A collection of service endpoints. Typically used to identify each available service, and the service address, for an organization. Identifies the type of service available at an endpoint. The organization service. Value = 0. The organization data service. Value = 1. The web application service. Value = 2. Provides detailed information on an organization. For the Web API the corresponding type is OrganizationDetail ComplexType. Describes the current state of an organization. Related to organization provisioning and maintenance. For the Web API use the OrganizationState EnumType. The organization is enabled. Value = 0. The organization is disabled. Value = 1. Contains the data needed to execute a request and the base class for all organization requests. This is the base class for all organization Web service requests. Pass an instance of a request class to the method. You can use this class, specifying the parameter collection. However, when you use the derived class, the parameter collection is created for you. Use messages (request and response classes) with the Execute method Contains a collection of organization requests. Use ExecuteMultiple to improve performance for bulk data load Contains the response from a request and the base class for all organization responses. This is the base class for all organization Web service responses. An instance of a response class is returned from the method. Some messages do not have a return value. In those classes the collection will be empty. Use messages (request and response classes) with the Execute method Contains a collection of organization responses. Use ExecuteMultiple to improve performance for bulk data load Represents an organization service fault. Provides a collection of parameters for a request. For each parameter in the collection there is a key/value pair. The key is the name of the request parameter as defined in the message. SdkMessage entity messages and methods Specifies the attributes for which non-null values are returned from a query. For the Web API the corresponding type is ColumnSet ComplexType. The class is used with methods and messages that retrieve one or more records from the database. The query returns non-null values for the attributes that are contained in the property. The attributes not included in the will contain null values. If the column set includes attributes that are not valid for retrieve, they will be ignored and no values will be returned for those attributes. The primary key is always returned and contains a non-null value. Attributes are specified by name. For more information, see . Use the ColumnSet classUse the QueryByAttribute classUse the QueryExpression class Contains a condition expression used to filter the results of the query. For more information, see Use the ConditionExpression class. Build queries with QueryExpression Describes the type of comparison for two values (or expressions) in a condition expression. filter.AddCondition("accountid", ConditionOperator.Equal, _accountIdArray[j]); The values are compared for equality. Value = 0. The two values are not equal. Value = 1. The value is greater than the compared value. Value = 2. The value is less than the compared value. Value = 3. The value is greater than or equal to the compared value. Value = 4. The value is less than or equal to the compared value. Value = 5. The character string is matched to the specified pattern. Value = 6. The character string does not match the specified pattern. Value = 7. TheThe value exists in a list of values. Value = 8. The given value is not matched to a value in a subquery or a list. Value = 9. The value is between two values. Value = 10. The value is not between two values. Value = 11. The value is null. Value = 12. The value is not null. Value = 13. The value equals yesterday’s date. Value = 14. The value equals today’s date. Value = 15. The value equals tomorrow’s date. Value = 16. The value is within the last seven days including today. Value = 17. The value is within the next seven days. Value = 18. The value is within the previous week including Sunday through Saturday. Value = 19. The value is within the current week. Value = 20. The value is within the next week. Value = 21. The value is within the last month including first day of the last month and last day of the last month. Value = 22. The value is within the current month. Value = 23. The value is within the next month. Value = 24. The value is on a specified date. Value = 25. The value is on or before a specified date. Value = 26. The value is on or after a specified date. Value = 27. The value is within the previous year. Value = 28. The value is within the current year. Value = 29. The value is within the next year. Value = 30. The value is within the last X hours. Value =31. The value is within the next X (specified value) hours. Value = 32. The value is within last X days. Value = 33. The value is within the next X (specified value) days. Value = 34. The value is within the last X (specified value) weeks. Value = 35. The value is within the next X weeks. Value = 36. The value is within the last X (specified value) months. Value = 37. The value is within the next X (specified value) months. Value = 38. The value is within the last X years. Value = 39. The value is within the next X years. Value = 40. The value is equal to the specified user ID. Value = 41. The value is not equal to the specified user ID. Value = 42. The value is equal to the specified business ID. Value = 43. The value is not equal to the specified business ID. Value = 44. No token name is specified <token xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"> <?Comment AL: Bug fix 5/30/12 2012-05-30T11:03:00Z Id='2?>internal<?CommentEnd Id='2' ?></token>. The value is found in the specified bit-mask value. Value = 46. The value is not found in the specified bit-mask value. Value = 47. For internal use only. Value = 48. The string contains another string. Value = 49. You must use the Contains operator for only those attributes that are enabled for full-text indexing. Otherwise, you will receive a generic SQL error message while retrieving data. In a Microsoft Dynamics 365 default installation, only the attributes of the KBArticle (article) entity are enabled for full-text indexing. The string does not contain another string. Value = 50. The value is equal to the language for the user. Value = 51. For internal use only. The value is older than the specified number of months. Value = 53. The string occurs at the beginning of another string. Value = 54. The string does not begin with another string. Value = 55. The string ends with another string. Value = 56. The string does not end with another string. Value = 57. The value is within the current fiscal year . Value = 58. The value is within the current fiscal period. Value = 59. The value is within the next fiscal year. Value = 60. The value is within the next fiscal period. Value = 61. The value is within the last fiscal year. Value = 62. The value is within the last fiscal period. Value = 63. The value is within the last X (specified value) fiscal periods. Value = 0x40. The value is within the last X (specified value) fiscal periods. Value = 65. The value is within the next X (specified value) fiscal years. Value = 66. The value is within the next X (specified value) fiscal period. Value = 67. The value is within the specified year. Value = 68. The value is within the specified fiscal period. Value = 69. The value is within the specified fiscal period and year. Value = 70. The value is within or before the specified fiscal period and year. Value = 71. The value is within or after the specified fiscal period and year. Value = 72. The record is owned by teams that the user is a member of. Value = 73. The record is owned by a user or teams that the user is a member of. Value = 74. Returns all child records below the referenced record in the hierarchy. Value = 76. Returns all records not below the referenced record in the hierarchy. Value = 77. Returns the referenced record and all child records below it in the hierarchy. Value = 79. Returns all records in referenced record's hierarchical ancestry line. Value = 75. Returns the referenced record and all records above it in the hierarchy. Value = 78. When hierarchical security models are used, Equals current user or their reporting hierarchy. Value = 80. When hierarchical security models are used, Equals current user and his teams or their reporting hierarchy and their teams. Value = 81. Contains a query expressed in FetchXML. Build queries with FetchXMLFetchXML schema Specifies complex condition and logical filter expressions used for filtering the results of the query. Use the FilterExpression classSample: Query connection roles by entity type code (early bound)Sample: Clean up history for a queue (early bound)Sample: Retrieve an opportunity (early bound)Sample: Retrieve records from an intersect table Contains the possible values for a join operator in a . Sample: Query connections by reciprocal roles (early bound)Sample: Retrieve multiple with the QueryExpression class The values in the attributes being joined are compared using a comparison operator. Value = 0. All instances of the entity in the FROM clause are returned if they meet WHERE or HAVING search conditions. Value = 1. Only one value of the two joined attributes is returned if an equal-join operation is performed and the two values are identical. Value = 2. Specifies the links between multiple entity types used in creating complex queries. q = new QueryExpression(); q.EntityName = "account"; q.ColumnSet = new ColumnSet(); q.ColumnSet.Columns.Add("name"); q.LinkEntities.Add(new LinkEntity("account", "contact", "primarycontactid", "contactid", JoinOperator.Inner)); q.LinkEntities[0].Columns.AddColumns("firstname", "lastname"); q.LinkEntities[0].EntityAlias = "temp"; q.Criteria = new FilterExpression(); q.Criteria.AddCondition("accountnumber", ConditionOperator.Equal, accountNumber); q.Orders.Add(new OrderExpression("name", OrderType.Descending)); q.Distinct = true; EntityCollection ec = this.Context.Proxy.RetrieveMultiple(q); Log.Assert(ec.Entities.Count == 3, "Expected 3 entities, received {0}", ec.Entities.Count); Log.Assert((string)ec.Entities[0]["name"] == "SdkAccount3", "First Entity should be SdkAccount3"); Log.Assert((string)ec.Entities[1]["name"] == "SdkAccount2", "First Entity should be SdkAccount2"); Log.Assert((string)ec.Entities[2]["name"] == "SdkAccount1", "First Entity should be SdkAccount1"); Log.Assert((string)((AliasedValue)ec.Entities[0]["temp.firstname"]).Value == (string)contact["firstname"], "Expected {0} Got {1}", contact["firstname"], ec.Entities[0]["temp.firstname"]); Log.Assert((string)((AliasedValue)ec.Entities[1]["temp.lastname"]).Value == (string)contact["lastname"], "Expected {0} Got {1}", contact["lastname"], ec.Entities[1]["temp.lastname"]); Contains the possible values for an operator in a . Test for a null valueUse the FilterExpression classSample: Query connections by reciprocal roles (early bound)Sample: Retrieve records from an intersect table A logical AND operation is performed. Value = 0. A logical OR operation is performed. Value = 1. Sets the order in which the entity instances are returned from the query. Page large result sets with QueryExpression Contains the possible values for the order type in an . Page large result sets with QueryExpressionSample: Create and update records with related records (early bound) The values of the specified attribute should be sorted in ascending order, from lowest to highest. Value = 0. The values of the specified attribute should be sorted in descending order, from highest to lowest. Value = 1. Specifies a number of pages and a number of entity instances per page to return from the query. For the Web API the corresponding type is PagingInfo ComplexType. Page large result sets with QueryExpressionSample: Use FetchXML with a paging cookie Represents the abstract base class for constructing a query. Build queries with QueryExpression Contains a query that is expressed as a set of attribute and value pairs. // Create query using QueryByAttribute. QueryByAttribute querybyattribute = new QueryByAttribute("account") { ColumnSet = new ColumnSet("name", "address1_city", "emailaddress1"), Attributes.AddRange("address1_city"), Values.AddRange("Redmond") }; Build queries with QueryExpressionSample: Retrieve multiple with the QueryByAttribute class Contains a complex query expressed in a hierarchy of expressions. QueryExpression provides an object model to construct a query. Queries can also be created using FetchXML, a proprietary XML based query language. You can convert queries between FetchXML and QueryExpression using and messages. More information: Sample: Convert queries between Fetch and QueryExpression. Query#RetrieveMultipleConditionOperatorsQE1 Build queries with QueryExpressionSample: Retrieve multiple with the QueryExpression classSample: Query connection roles by entity type code (early bound) For internal use only. For internal use only. For internal use only. For internal use only. Contains a collection of related entities. For each related entity in the collection there is a key/value pair. Represents a relationship between two entities. Customize entity relationship metadata Provides a collection of relationship queries. For each relationship query in the collection there is a key/value pair. The key is the logical name of the relationship. Used by the code generation tool to create classes based on entities. Use the early bound entity classes in code Defines the contextual information sent to a remote service endpoint at run-time. A populated instance is passed from Microsoft Dynamics 365 to a Microsoft Azure Service Bus solution listener. The remote execution context contains the same information that is passed to an asynchronous registered Microsoft Dynamics 365 plug-in plus some additional information. Write a listener application for a Microsoft Azure solution Represents the removed or deleted item. Represents an exception that occurred when saving changes to the . Contains the result of the save changes operation returned from the organization web service. This class is only used in conjunction with . An instance of this class is returned when is called. Use the OrganizationServiceContext class Provides a collection of results for a save changes operation. Returned from these methods: , Use the OrganizationServiceContext classSample: Use the organization service context Represents a fault at a service endpoint in the cloud. Implements and provides an authenticated connection to the Discovery.svc/web endpoint. This /web endpoint is also used by web resources. You must set the and property values before using the proxy object to make service calls. To call the Discovery web service using the interface, cast the proxy instance to an type. Discover the URL for your organization using the Organization ServiceAuthenticate the user with the web services Implements and provides an authenticated connection to the Organization.svc/web endpoint. This /web endpoint is also used by web resources. You must set the and property values before using the proxy object to make service calls. To call the Organization web service using the interface, cast the proxy instance to an type. Use the Organization Service to read and write data or metadataAuthenticate the user with the web services The type of user that a message request executes for. A CRM system user. An external party user. A base class that creates an authenticated web service endpoint on a WCF channel. A type of web service. Ensures that the access token and other header values are added to every outbound service call. A web service.