Microsoft.Xrm.Sdk.Messages Namespace

Classes

AssociateRequest

Contains the data that is needed to create a link between records.

AssociateResponse

Contains the response from the AssociateRequest class.

CanBeReferencedRequest

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.

CanBeReferencedResponse

Contains the response from the CanBeReferencedRequest class.

For the Web API the CanBeReferencedResponse ComplexType is the response value from the CanBeReferenced Action.

CanBeReferencingRequest

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.

CanBeReferencingResponse

Contains the response from the CanBeReferencingRequest class.

For the Web API the CanBeReferencingResponse ComplexType is the response value from the CanBeReferencing Action.

CanManyToManyRequest

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.

CanManyToManyResponse

Contains the response from the CanManyToManyRequest class.

For the Web API the CanManyToManyResponse ComplexType is the response value from the CanManyToMany Action.

ConvertDateAndTimeBehaviorRequest

Contains the data to convert existing UTC date and time values in the database to DateOnly values.

ConvertDateAndTimeBehaviorResponse

Contains the response from the ConvertDateAndTimeBehaviorRequest class.

CreateAttributeRequest

Contains the data that is needed to create a new attribute, and optionally, to add it to a specified unmanaged solution.

CreateAttributeResponse

Contains the response from the CreateAttributeRequest class.

CreateCustomerRelationshipsRequest

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) .

CreateCustomerRelationshipsResponse

Contains the response from the CreateCustomerRelationshipsRequest class.

CreateEntityKeyRequest

Contains data that is needed to create an alternate key.

CreateEntityKeyResponse

Contains the response from the CreateEntityKeyRequest class.

CreateEntityRequest

Contains the data that is needed to create a custom entity, and optionally, to add it to a specified unmanaged solution.

CreateEntityResponse

Contains the response from the CreateEntityRequest class.

CreateManyToManyRequest

Contains the data that is needed to create a new Many-to-Many (N:N) entity relationship.

CreateManyToManyResponse

Contains the response from the CreateManyToManyRequest class.

CreateOneToManyRequest

Contains the data that is needed to create a new One-to-Many (1:N) entity relationship.

CreateOneToManyResponse

Contains the response from the CreateOneToManyRequest class.

CreateOptionSetRequest

Contains the data that is needed to create a new global option set.

CreateOptionSetResponse

Contains the response from the CreateOptionSetRequest class.

CreateRequest

Contains the data that is needed to create a record.

CreateResponse

Contains the response from the CreateRequest class.

DeleteAttributeRequest

Contains the data that is needed to delete an attribute.

DeleteAttributeResponse

Contains the response from the DeleteAttributeRequest class.

DeleteEntityKeyRequest

Contains the data that is needed to delete the specified key for an entity.

DeleteEntityKeyResponse

Contains the response from the DeleteEntityKeyRequest class.

DeleteEntityRequest

Contains the data that is needed to delete an entity.

DeleteEntityResponse

Contains the response from the DeleteEntityRequest class.

DeleteOptionSetRequest

Contains the data that is needed to delete a global option set.

DeleteOptionSetResponse

Contains the response from the DeleteOptionSetRequest class.

DeleteOptionValueRequest

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.

DeleteOptionValueResponse

Contains the response from the DeleteOptionValueRequest class.

DeleteRelationshipRequest

Contains the data that is needed to delete an entity relationship.

DeleteRelationshipResponse

Contains the response from the DeleteRelationshipRequest class.

DeleteRequest

Contains the data that is needed to delete a record.

DeleteResponse

Contains the response from the DeleteRequest class.

DisassociateRequest

Contains the data that is needed to delete a link between records.

DisassociateResponse

Contains the response from the DisassociateRequest class.

ExecuteAsyncRequest

Contains the data that is needed to execute a message asynchronously.

ExecuteAsyncResponse

Contains the response from the ExecuteAsyncRequest class.

ExecuteMultipleRequest

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.

ExecuteMultipleResponse

Contains the response from the ExecuteMultipleRequest class.

ExecuteTransactionRequest

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.

ExecuteTransactionResponse

Contains the response from the ExecuteTransactionRequest class.

GetValidManyToManyRequest

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.

GetValidManyToManyResponse

Contains the response from the GetValidManyToManyRequest class.

For the Web API the GetValidManyToManyResponse ComplexType is the response value from the GetValidManyToMany Function.

GetValidReferencedEntitiesRequest

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.

GetValidReferencedEntitiesResponse

Contains the response from the GetValidReferencedEntitiesRequest class.

For the Web API the GetValidReferencedEntitiesResponse ComplexType is the response value from the GetValidReferencingEntities Function.

GetValidReferencingEntitiesRequest

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.

GetValidReferencingEntitiesResponse

Contains the response from the GetValidReferencingEntitiesRequest class.

For the Web API the GetValidReferencingEntitiesResponse ComplexType is the response value from the GetValidReferencingEntities Function.

InsertOptionValueRequest

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.

InsertOptionValueResponse

Contains the response from the InsertOptionValueRequest class.

For the Web API the InsertOptionValueResponse ComplexType is the response value from the InsertOptionValue Action.

InsertStatusValueRequest

Contains the data that is needed to insert a new option into a StatusAttributeMetadata attribute.

For the Web API use the InsertStatusValue Action.

InsertStatusValueResponse

Contains the response from the InsertStatusValueRequest class.

For the Web API the InsertStatusValueResponse ComplexType is the response value from the InsertStatusValue Action.

IsDataEncryptionActiveRequest

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.

IsDataEncryptionActiveResponse

Contains the response from the IsDataEncryptionActiveRequest class.

For the Web API the IsDataEncryptionActiveResponse ComplexType is the response value from the IsDataEncryptionActive Function.

OrderOptionRequest

Contains the data that is needed to set the order for an option set.

For the Web API use the OrderOption Action.

OrderOptionResponse

Contains the response from the OrderOptionRequest class.

ReactivateEntityKeyRequest

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.

ReactivateEntityKeyResponse

Contains the response from ReactivateEntityKeyRequest class.

RetrieveAllEntitiesRequest

Contains the data that is needed to retrieve metadata information about all the entities.

For the Web API use the RetrieveAllEntities Function.

RetrieveAllEntitiesResponse

Contains the response from the RetrieveAllEntitiesRequest class.

RetrieveAllManagedPropertiesRequest

Contains the data that is needed to retrieve all managed property definitions

RetrieveAllManagedPropertiesResponse

Contains the response from the RetrieveAllManagedPropertiesRequest class.

RetrieveAllOptionSetsRequest

Contains the data that is needed to retrieve information about all global option sets.

RetrieveAllOptionSetsResponse

Contains the response from the RetrieveAllOptionSetsRequest class.

RetrieveAttributeRequest

Contains the data that is needed to retrieve attribute metadata.

RetrieveAttributeResponse

Contains the response from the RetrieveAttributeRequest class.

RetrieveDataEncryptionKeyRequest

Contains the data that is needed to retrieve the data encryption key value.

For the Web API use the RetrieveDataEncryptionKey Function.

RetrieveDataEncryptionKeyResponse

Contains the response from the RetrieveDataEncryptionKeyResponse class.

For the Web API the RetrieveDataEncryptionKeyResponse ComplexType is the response value from the RetrieveDataEncryptionKey Function.

RetrieveEntityChangesRequest

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) .

RetrieveEntityChangesResponse

Contains the response from RetrieveEntityChangesRequest class.

RetrieveEntityKeyRequest

Contains data that is needed to retrieve an alternate key.

RetrieveEntityKeyResponse

Contains the response from the RetrieveEntityKeyRequest class.

RetrieveEntityRequest

Contains the data that is needed to retrieve entity metadata.

RetrieveEntityResponse

Contains the response from the RetrieveEntityRequest class.

RetrieveManagedPropertyRequest

Contains the data that is needed to retrieve a managed property definition.

RetrieveManagedPropertyResponse

Contains the response from the RetrieveManagedPropertyRequest class.

RetrieveMetadataChangesRequest

Contains the data that is needed to to retrieve a collection of metadata records that satisfy the specified criteria. The RetrieveMetadataChangesResponse 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.

RetrieveMetadataChangesResponse

Contains the response from the RetrieveMetadataChangesRequest message.

RetrieveMultipleRequest

Contains the data that is needed to retrieve a collection of records that satisfy the specified query criteria.

RetrieveMultipleResponse

Contains the response from the RetrieveMultipleRequest class.

RetrieveOptionSetRequest

Contains the data that is needed to retrieve a global option set.

RetrieveOptionSetResponse

Contains the response from the RetrieveOptionSetRequest class.

RetrieveRelationshipRequest

Contains the data that is needed to retrieve entity relationship metadata.

RetrieveRelationshipResponse

Contains the response from the RetrieveRelationshipRequest class.

RetrieveRequest

Contains the data that is needed to retrieve a record.

RetrieveResponse

Contains the response from the RetrieveRequest class.

RetrieveTimestampRequest

Contains the data that is needed to retrieves a time stamp for the metadata.

For the Web API use the RetrieveTimestamp Function.

RetrieveTimestampResponse

Contains the response from the RetrieveTimestampRequest class.

For the Web API the RetrieveTimestampResponse ComplexType is the response value from the RetrieveTimestamp Function.

SetDataEncryptionKeyRequest

Contains the data that is needed to set or restore the data encryption key.

For the Web API use the SetDataEncryptionKey Action.

SetDataEncryptionKeyResponse

Contains the response from the SetDataEncryptionKeyRequest class.

UpdateAttributeRequest

Contains the data that is needed to update the definition of an attribute.

UpdateAttributeResponse

Contains the response from the UpdateAttributeRequest class.

UpdateEntityRequest

Contains the data that is needed to update the definition of an entity.

UpdateEntityResponse

Contains the response from the UpdateEntityRequest class.

UpdateOptionSetRequest

Contains the data that is needed to update the definition of a global option set.

UpdateOptionSetResponse

Contains the response from the UpdateOptionSetRequest class.

UpdateOptionValueRequest

Contains the data that is needed to update an option value in a global or local option set.

UpdateOptionValueResponse

Contains the response from the UpdateOptionValueRequest class.

UpdateRelationshipRequest

Contains the data that is needed to update the definition of an entity relationship.

UpdateRelationshipResponse

Contains the response from the UpdateRelationshipRequest class.

UpdateRequest

Contains the data that is needed to update an existing record.

UpdateResponse

Contains the response from the UpdateRequest class.

UpdateStateValueRequest

Contains the data that is needed to update an option set value in for a StateAttributeMetadata attribute.

For the Web API use the UpdateStateValue Action.

UpdateStateValueResponse

Contains the response from the UpdateStateValueRequest class.

UpsertRequest

Contains data that is needed to update or insert a record in CRM.

UpsertResponse

Contains the response from UpsertRequest