xRM messages in the Organization service

 

Updated: November 29, 2016

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

The Microsoft.Xrm.Sdk.Messages namespace supports the core messages used to work with the data stored in any entity. This namespace also contains the messages you can use to retrieve and customize the metadata for entities, attributes, and relationships.

Messages are used with the IOrganizationService.Execute method. All messages available in the Microsoft.Xrm.Sdk.Messages namespace apply to all three deployment types.

The request page indicates whether the message works while online (connected to the server) or offline (disconnected from the server).

The following table lists the data messages available in the xRM namespace.

Message

Description

AssociateRequest

Creates a link between records that participate in a relationship.

ConvertDateAndTimeBehaviorRequest

For internal use only.

CreateRequest

Creates a record of any type that supports the Create message, including custom entities.

DeleteRequest

Deletes an existing record.

DisassociateRequest

Removes the link between records.

ExecuteAsyncRequest

Executes a message asynchronously. Currently this only supports the ImportSolutionRequest message.

ExecuteTransactionRequest

Executes multiple message requests in a single database transaction.

ReactivateEntityKeyRequest

Submits a new asynchronous system job to create the index for the key.

RetrieveEntityChangesRequest

Retrieves the changes in an entity since the last sync.

RetrieveRequest

Retrieves a record.

RetrieveMultipleRequest

Retrieves a collection of records. The query can be specified using a query expression or a FetchXML query.

UpdateRequest

Updates an existing record.

UpsertRequest

Updates or inserts a record.

The following table lists the metadata messages available in the XRM namespace.

Message

Description

CanBeReferencedRequest

Checks to see if the specified entity can be the primary entity (one) in a one-to-many relationship.

CanBeReferencingRequest

Checks to see if the specified entity can be the referencing entity (many) in a one-to-many relationship.

CanManyToManyRequest

Checks to see if the entity can participate in a many-to-many relationship.

CreateAttributeRequest

Creates a custom attribute for an entity.

CreateEntityKeyRequest

Creates an alternate key for an entity.

CreateEntityRequest

Creates a custom entity.

CreateManyToManyRequest

Creates a many-to-many relationship between two entities.

CreateOneToManyRequest

Creates a one-to-many relationship between two entities.

CreateOptionSetRequest

Creates a custom global option set.

DeleteAttributeRequest

Deletes an attribute from an entity.

DeleteEntityKeyRequest

Deletes the alternate key for an entity.

DeleteEntityRequest

Deletes an entity.

DeleteOptionSetRequest

Deletes an option set.

DeleteOptionValueRequest

Deletes an option value from a list of options.

DeleteRelationshipRequest

Deletes a relationship.

ExecuteMultipleRequest

Executes one or more message requests as a single batch operation.

GetValidManyToManyRequest

Returns the set of entities that can participate in a many-to-many relationship.

GetValidReferencedEntitiesRequest

Returns the set of entities that are valid as the primary entity (one) from the specified entity in a one-to-many relationship. If no entity is specified, this message returns all entities that can be the primary entity in a one-to-many relationship.

GetValidReferencingEntitiesRequest

Returns the set of entities that are valid as the related entity (many) to the specified entity in a one-to-many relationship. If no entity is specified, this message returns all entities that can be the related entity in a one-to-many relationship.

InsertOptionValueRequest

Inserts an option value into a list of options.

InsertStatusValueRequest

Inserts a status value into a list of status values.

IsDataEncryptionActiveRequest

Checks if data encryption is currently running (active or inactive).

OrderOptionRequest

Sets the order of a list of options.

RetrieveAllEntitiesRequest

Retrieves the metadata for all entities.

RetrieveAllOptionSetsRequest

Retrieves information about all global option sets.

RetrieveAttributeRequest

Retrieves the metadata for the specified attribute.

RetrieveDataEncryptionKeyRequest

Retrieves the data encryption key value.

RetrieveEntityChangesRequest

Retrieves the changes for an entity.

RetrieveEntityKeyRequest

Retrieves an alternate key for an entity.

RetrieveEntityRequest

Retrieves the metadata for the specified entity.

RetrieveManagedPropertyRequest

Retrieves a managed property definition.

RetrieveMetadataChangesRequest

Retrieves a collection of metadata records that satisfy the specified criteria.

RetrieveOptionSetRequest

Retrieves a specified option set.

RetrieveRelationshipRequest

Retrieve the metadata for the specified relationship.

RetrieveTimestampRequest

Retrieves a time stamp indicating the last time that the metadata was changed.

SetDataEncryptionKeyRequest

Sets or restores the data encryption key.

UpdateAttributeRequest

Updates the metadata for an attribute.

UpdateEntityRequest

Updates the metadata for an entity.

UpdateOptionSetRequest

Updates an option set.

UpdateOptionValueRequest

Updates the metadata for an option value.

UpdateRelationshipRequest

Updates the metadata for a relationship.

UpdateStateValueRequest

Updates the metadata for a state value.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

Show: