Microsoft.Xrm.Sdk.Messages Namespace

  • Article

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Classes

Class Description
System_CAPS_pubclass AssociateRequest

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

Contains the response from the AssociateRequest class.
System_CAPS_pubclass 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.
System_CAPS_pubclass CanBeReferencedResponse

Contains the response from the CanBeReferencedRequest class.

For the Web API the CanBeReferencedResponse ComplexType is the response value from the CanBeReferenced Action.
System_CAPS_pubclass 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.
System_CAPS_pubclass CanBeReferencingResponse

Contains the response from the CanBeReferencingRequest class.

For the Web API the CanBeReferencingResponse ComplexType is the response value from the CanBeReferencing Action.
System_CAPS_pubclass 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.
System_CAPS_pubclass CanManyToManyResponse

Contains the response from the CanManyToManyRequest class.

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

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

Contains the response from the ConvertDateAndTimeBehaviorRequest class.
System_CAPS_pubclass CreateAttributeRequest

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

Contains the response from the CreateAttributeRequest class.
System_CAPS_pubclass 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) .
System_CAPS_pubclass CreateCustomerRelationshipsResponse

Contains the response from the CreateCustomerRelationshipsRequest class.
System_CAPS_pubclass CreateEntityKeyRequest

Contains data that is needed to create an alternate key.
System_CAPS_pubclass CreateEntityKeyResponse

Contains the response from the CreateEntityKeyRequest class.
System_CAPS_pubclass CreateEntityRequest

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

Contains the response from the CreateEntityRequest class.
System_CAPS_pubclass CreateManyToManyRequest

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

Contains the response from the CreateManyToManyRequest class.
System_CAPS_pubclass CreateOneToManyRequest

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

Contains the response from the CreateOneToManyRequest class.
System_CAPS_pubclass CreateOptionSetRequest

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

Contains the response from the CreateOptionSetRequest class.
System_CAPS_pubclass CreateRequest

Contains the data that is needed to create a record.
System_CAPS_pubclass CreateResponse

Contains the response from the CreateRequest class.
System_CAPS_pubclass DeleteAttributeRequest

Contains the data that is needed to delete an attribute.
System_CAPS_pubclass DeleteAttributeResponse

Contains the response from the DeleteAttributeRequest class.
System_CAPS_pubclass DeleteEntityKeyRequest

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

Contains the response from the DeleteEntityKeyRequest class.
System_CAPS_pubclass DeleteEntityRequest

Contains the data that is needed to delete an entity.
System_CAPS_pubclass DeleteEntityResponse

Contains the response from the DeleteEntityRequest class.
System_CAPS_pubclass DeleteOptionSetRequest

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

Contains the response from the DeleteOptionSetRequest class.
System_CAPS_pubclass 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.
System_CAPS_pubclass DeleteOptionValueResponse

Contains the response from the DeleteOptionValueRequest class.
System_CAPS_pubclass DeleteRelationshipRequest

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

Contains the response from the DeleteRelationshipRequest class.
System_CAPS_pubclass DeleteRequest

Contains the data that is needed to delete a record.
System_CAPS_pubclass DeleteResponse

Contains the response from the DeleteRequest class.
System_CAPS_pubclass DisassociateRequest

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

Contains the response from the DisassociateRequest class.
System_CAPS_pubclass ExecuteAsyncRequest

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

Contains the response from the ExecuteAsyncRequest class.
System_CAPS_pubclass 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.
System_CAPS_pubclass ExecuteMultipleResponse

Contains the response from the ExecuteMultipleRequest class.
System_CAPS_pubclass 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.
System_CAPS_pubclass ExecuteTransactionResponse

Contains the response from the ExecuteTransactionRequest class.
System_CAPS_pubclass 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.
System_CAPS_pubclass GetValidManyToManyResponse

Contains the response from the GetValidManyToManyRequest class.

For the Web API the GetValidManyToManyResponse ComplexType is the response value from the GetValidManyToMany Function.
System_CAPS_pubclass 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.
System_CAPS_pubclass GetValidReferencedEntitiesResponse

Contains the response from the GetValidReferencedEntitiesRequest class.

For the Web API the GetValidReferencedEntitiesResponse ComplexType is the response value from the GetValidReferencingEntities Function.
System_CAPS_pubclass 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.
System_CAPS_pubclass GetValidReferencingEntitiesResponse

Contains the response from the GetValidReferencingEntitiesRequest class.

For the Web API the GetValidReferencingEntitiesResponse ComplexType is the response value from the GetValidReferencingEntities Function.
System_CAPS_pubclass 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.
System_CAPS_pubclass InsertOptionValueResponse

Contains the response from the InsertOptionValueRequest class.

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

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

For the Web API use the InsertStatusValue Action.
System_CAPS_pubclass InsertStatusValueResponse

Contains the response from the InsertStatusValueRequest class.

For the Web API the InsertStatusValueResponse ComplexType is the response value from the InsertStatusValue Action.
System_CAPS_pubclass 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.
System_CAPS_pubclass IsDataEncryptionActiveResponse

Contains the response from the IsDataEncryptionActiveRequest class.

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

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

For the Web API use the OrderOption Action.
System_CAPS_pubclass OrderOptionResponse

Contains the response from the OrderOptionRequest class.
System_CAPS_pubclass 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.
System_CAPS_pubclass ReactivateEntityKeyResponse

Contains the response from ReactivateEntityKeyRequest class.
System_CAPS_pubclass RetrieveAllEntitiesRequest

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

For the Web API use the RetrieveAllEntities Function.
System_CAPS_pubclass RetrieveAllEntitiesResponse

Contains the response from the RetrieveAllEntitiesRequest class.
System_CAPS_pubclass RetrieveAllManagedPropertiesRequest

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

Contains the response from the RetrieveAllManagedPropertiesRequest class.
System_CAPS_pubclass RetrieveAllOptionSetsRequest

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

Contains the response from the RetrieveAllOptionSetsRequest class.
System_CAPS_pubclass RetrieveAttributeRequest

Contains the data that is needed to retrieve attribute metadata.
System_CAPS_pubclass RetrieveAttributeResponse

Contains the response from the RetrieveAttributeRequest class.
System_CAPS_pubclass RetrieveDataEncryptionKeyRequest

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

For the Web API use the RetrieveDataEncryptionKey Function.
System_CAPS_pubclass RetrieveDataEncryptionKeyResponse

Contains the response from the RetrieveDataEncryptionKeyResponse class.

For the Web API the RetrieveDataEncryptionKeyResponse ComplexType is the response value from the RetrieveDataEncryptionKey Function.
System_CAPS_pubclass 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) .
System_CAPS_pubclass RetrieveEntityChangesResponse

Contains the response from RetrieveEntityChangesRequest class.
System_CAPS_pubclass RetrieveEntityKeyRequest

Contains data that is needed to retrieve an alternate key.
System_CAPS_pubclass RetrieveEntityKeyResponse

Contains the response from the RetrieveEntityKeyRequest class.
System_CAPS_pubclass RetrieveEntityRequest

Contains the data that is needed to retrieve entity metadata.
System_CAPS_pubclass RetrieveEntityResponse

Contains the response from the RetrieveEntityRequest class.
System_CAPS_pubclass RetrieveManagedPropertyRequest

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

Contains the response from the RetrieveManagedPropertyRequest class.
System_CAPS_pubclass 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.
System_CAPS_pubclass RetrieveMetadataChangesResponse

Contains the response from the RetrieveMetadataChangesRequest message.
System_CAPS_pubclass RetrieveMultipleRequest

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

Contains the response from the RetrieveMultipleRequest class.
System_CAPS_pubclass RetrieveOptionSetRequest

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

Contains the response from the RetrieveOptionSetRequest class.
System_CAPS_pubclass RetrieveRelationshipRequest

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

Contains the response from the RetrieveRelationshipRequest class.
System_CAPS_pubclass RetrieveRequest

Contains the data that is needed to retrieve a record.
System_CAPS_pubclass RetrieveResponse

Contains the response from the RetrieveRequest class.
System_CAPS_pubclass RetrieveTimestampRequest

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

For the Web API use the RetrieveTimestamp Function.
System_CAPS_pubclass RetrieveTimestampResponse

Contains the response from the RetrieveTimestampRequest class.

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

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

For the Web API use the SetDataEncryptionKey Action.
System_CAPS_pubclass SetDataEncryptionKeyResponse

Contains the response from the SetDataEncryptionKeyRequest class.
System_CAPS_pubclass UpdateAttributeRequest

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

Contains the response from the UpdateAttributeRequest class.
System_CAPS_pubclass UpdateEntityRequest

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

Contains the response from the UpdateEntityRequest class.
System_CAPS_pubclass UpdateOptionSetRequest

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

Contains the response from the UpdateOptionSetRequest class.
System_CAPS_pubclass UpdateOptionValueRequest

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

Contains the response from the UpdateOptionValueRequest class.
System_CAPS_pubclass UpdateRelationshipRequest

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

Contains the response from the UpdateRelationshipRequest class.
System_CAPS_pubclass UpdateRequest

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

Contains the response from the UpdateRequest class.
System_CAPS_pubclass 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.
System_CAPS_pubclass UpdateStateValueResponse

Contains the response from the UpdateStateValueRequest class.
System_CAPS_pubclass UpsertRequest

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

Contains the response from UpsertRequest

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright