Annotation (note) entity

Note

Effective November 2020:

  • Common Data Service has been renamed to Microsoft Dataverse. Learn more
  • Some terminology in Microsoft Dataverse has been updated. For example, entity is now table and field is now column. Learn more

This article will be updated soon to reflect the latest terminology.

The annotations (notes) provide easy ways to append additional information to any record in the Microsoft Dataverse database. An annotation (note) is a text entry that can be associated with any entity in Dataverse. However, you can associate annotations with only those custom entities that are created with the HasNotes property set to true in the CreateEntityRequest class. You can update a custom entity, which is not enabled for notes, to have notes by setting the UpdateEntityRequest.HasNotes property to true.

Using the Web API, set the HasNotes property of the EntityMetadata EntityType controls this.

The Annotation entity represents an annotation (note), and contains the following information:

  • Annotation (note) text

  • Who created and modified the annotation (note)

  • Whether a file is attached to the annotation (note)

An attached file can be any standard computer file format that includes Office Word documents, Office Excel spreadsheets, CAD files, and PDF files. An attachment can be associated with any object, other than an annotation (note), in Dataverse.

To upload or remove an attachment, use the IOrganizationService.Update method or UpdateRequest message, setting the Annotation.Filename and Annotation.MimeType properties. This uploads an attachment that has been decoded into a base64 string format. The System.Convert.ToBase64String method can be used to convert the contents of a data file into a base64-formatted string. The maximum size of files that can be uploaded is determined by the Organization.MaxUploadFileSize property. This property is set in the Email tab of the System Settings in the Dynamics 365 application. This setting limits the size of files that can be attached to email messages, notes, and web resources. The default setting is 5 MB.

In This Section

Sample: Upload, Retrieve, and Download an Attachment

See also

Annotation Entity
Model Your Business Data
UserQuery (Saved View) Entity

Note

Can you tell us about your documentation language preferences? Take a short survey.

The survey will take about seven minutes. No personal data is collected (privacy statement).