Annotation (note) entity messages and methods

 

Applies To: Dynamics CRM 2013

An annotation is a note that is attached to one or more objects, including other notes. The schema name for this entity is Annotation. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AssignRequest	Assigns an annotation (note) to another user.
AssociateRequest	Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see the Annotation entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
CreateRequest	Creates an annotation (note). You can also call the IOrganizationService.Create method.
DeleteRequest	Deletes an annotation (note). You can also call the IOrganizationService.Delete method.
DisassociateRequest	Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see the Annotation entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
GrantAccessRequest	Shares an annotation (note) with another security principal (user or team).
InitializeFromRequest	Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.
ModifyAccessRequest	Changes the access rights for an annotation (note) previously shared with another security principal (user or team).
RetrieveDuplicatesRequest	Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.
RetrieveRequest	Retrieves an annotation (note). You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of accounts. You can also call the IOrganizationService.RetrieveMultiple method.
RetrievePrincipalAccessRequest	Retrieves the access that the specified security principal (user or team) has to an annotation (note).
RetrieveSharedPrincipalsAndAccessRequest	Retrieves the security principals (users or teams) that have access to an annotation (note), and also retrieves their access rights to the account.
RevokeAccessRequest	Removes all access to an annotation (note) for the specified security principal (user or team).
RollupRequest	Retrieves the annotations (notes) related to the specified record (account, contact, or opportunity).
UpdateRequest	Updates an annotation (note). You can also call the IOrganizationService.Update method.

See Also

Annotation (note) entity
Annotation (note) entity privileges
Sample: Upload, retrieve, and download an attachment