Note (Annotation) table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Note that is attached to one or more objects, including other notes.

Messages

Message	Web API Operation	SDK Assembly
Assign	PATCH [org URI]/api/data/v9.0/annotations(annotationid) Update ownerid property.	AssignRequest
Create	POST [org URI]/api/data/v9.0/annotations See Create	CreateRequest or Create
Delete	DELETE [org URI]/api/data/v9.0/annotations(annotationid) See Delete	DeleteRequest or Delete
GrantAccess	GrantAccess Action	GrantAccessRequest
ModifyAccess	ModifyAccess Action	ModifyAccessRequest
Retrieve	GET [org URI]/api/data/v9.0/annotations(annotationid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET [org URI]/api/data/v9.0/annotations See Query Data	RetrieveMultipleRequest or RetrieveMultiple
RetrievePrincipalAccess	RetrievePrincipalAccess Function	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccess Function	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess	RevokeAccess Action	RevokeAccessRequest
Rollup	Rollup Function	RollupRequest
Update	PATCH [org URI]/api/data/v9.0/annotations(annotationid) See Update	UpdateRequest or Update

Properties

Property	Value
CollectionSchemaName	Annotations
DisplayCollectionName	Notes
DisplayName	Note
EntitySetName	annotations
IsBPFEntity	False
LogicalCollectionName	annotations
LogicalName	annotation
OwnershipType	UserOwned
PrimaryIdAttribute	annotationid
PrimaryNameAttribute	subject
SchemaName	Annotation

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

• AnnotationId
• DocumentBody
• FileName
• ImportSequenceNumber
• IsDocument
• LangId
• MimeType
• NoteText
• ObjectId
• ObjectIdTypeCode
• ObjectTypeCode
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• StepId
• Subject

AnnotationId

Property	Value
Description	Unique identifier of the note.
DisplayName	Note
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	annotationid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

DocumentBody

Property	Value
Description	Contents of the note's attachment.
DisplayName	Document
FormatName	TextArea
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	documentbody
MaxLength	1073741823
RequiredLevel	None
Type	String

FileName

Property	Value
Description	File name of the note.
DisplayName	File Name
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	filename
MaxLength	255
RequiredLevel	None
Type	String

ImportSequenceNumber

Property	Value
Description	Unique identifier of the data import or data migration that created this record.
DisplayName	Import Sequence Number
Format	None
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	importsequencenumber
MaxValue	2147483647
MinValue	-2147483648
RequiredLevel	None
Type	Integer

IsDocument

Property	Value
Description	Specifies whether the note is an attachment.
DisplayName	Is Document
IsValidForForm	False
IsValidForRead	True
LogicalName	isdocument
RequiredLevel	SystemRequired
Type	Boolean

IsDocument Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

LangId

Property	Value
Description	Language identifier for the note.
DisplayName	Language ID
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	langid
MaxLength	2
RequiredLevel	None
Type	String

MimeType

Property	Value
Description	MIME type of the note's attachment.
DisplayName	Mime Type
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	mimetype
MaxLength	256
RequiredLevel	None
Type	String

NoteText

Property	Value
Description	Text of the note.
DisplayName	Description
Format	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	notetext
MaxLength	100000
RequiredLevel	None
Type	Memo

ObjectId

Property	Value
Description	Unique identifier of the object with which the note is associated.
DisplayName	Regarding
IsValidForForm	False
IsValidForRead	True
LogicalName	objectid
RequiredLevel	None
Targets	account,appointment,calendar,channelaccessprofile,channelaccessprofilerule,channelaccessprofileruleitem,chat,contact,convertrule,duplicaterule,email,emailserverprofile,fax,goal,kbarticle,knowledgearticle,knowledgebaserecord,letter,mailbox,msdyn_aifptrainingdocument,msdyn_aimodel,msdyn_aiodimage,phonecall,recurringappointmentmaster,routingrule,routingruleitem,sharepointdocument,sla,socialactivity,task,workflow
Type	Lookup

ObjectIdTypeCode

Property	Value
Description
DisplayName	Regarding Object Type
IsValidForForm	False
IsValidForRead	True
LogicalName	objectidtypecode
RequiredLevel	None
Type	EntityName

ObjectTypeCode

Property	Value
Description	Type of entity with which the note is associated.
DisplayName	Object Type
IsValidForForm	False
IsValidForRead	True
LogicalName	objecttypecode
RequiredLevel	None
Type	EntityName

OverriddenCreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time that the record was migrated.
DisplayName	Record Created On
Format	DateOnly
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime

OwnerId

Property	Value
Description	Unique identifier of the user or team who owns the note.
DisplayName	Owner
IsValidForForm	False
IsValidForRead	True
LogicalName	ownerid
RequiredLevel	SystemRequired
Targets	systemuser,team
Type	Owner

OwnerIdType

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridtype
RequiredLevel	SystemRequired
Type	EntityName

StepId

Property	Value
Description	workflow step id associated with the note.
DisplayName	Step Id
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	stepid
MaxLength	32
RequiredLevel	None
Type	String

Subject

Property	Value
Description	Subject associated with the note.
DisplayName	Title
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	subject
MaxLength	500
RequiredLevel	ApplicationRequired
Type	String

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• DummyFileName
• DummyRegarding
• FilePointer
• FileSize
• IsPrivate
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningBusinessUnitName
• OwningTeam
• OwningUser
• Prefix
• StoragePointer
• VersionNumber

CreatedBy

Property	Value
Description	Unique identifier of the user who created the note.
DisplayName	Created By
IsValidForForm	False
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyyominame
MaxLength	100
RequiredLevel	None
Type	String

CreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the note was created.
DisplayName	Created On
Format	DateAndTime
IsValidForForm	False
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the annotation.
DisplayName	Created By (Delegate)
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedOnBehalfByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedOnBehalfByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

DummyFileName

Added by: Activities Patch Solution

Property	Value
Description	Dummy attribute associated with the note attachment
DisplayName	File Name(deprecated)
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	False
LogicalName	dummyfilename
MaxLength	500
RequiredLevel	None
Type	String

DummyRegarding

Added by: Activities Patch Solution

Property	Value
Description	Dummy attribute associated with the note regarding
DisplayName	Regarding(deprecated)
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	False
LogicalName	dummyregarding
MaxLength	500
RequiredLevel	None
Type	String

FilePointer

Property	Value
Description	File pointer of the attachment.
DisplayName	File Pointer
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	False
LogicalName	filepointer
MaxLength	255
RequiredLevel	None
Type	String

FileSize

Property	Value
Description	File size of the note.
DisplayName	File Size (Bytes)
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	filesize
MaxValue	1000000000
MinValue	0
RequiredLevel	None
Type	Integer

IsPrivate

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	False
LogicalName	isprivate
RequiredLevel	None
Type	Boolean

IsPrivate Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

ModifiedBy

Property	Value
Description	Unique identifier of the user who last modified the note.
DisplayName	Modified By
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyyominame
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the note was last modified.
DisplayName	Modified On
Format	DateAndTime
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who last modified the annotation.
DisplayName	Modified By (Delegate)
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedOnBehalfByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOnBehalfByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

OwnerIdName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwnerIdYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwningBusinessUnit

Property	Value
Description	Unique identifier of the business unit that owns the note.
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	None
Targets	businessunit
Type	Lookup

OwningBusinessUnitName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owningbusinessunitname
MaxLength	160
RequiredLevel	None
Type	String

OwningTeam

Property	Value
Description	Unique identifier of the team who owns the note.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	owningteam
RequiredLevel	None
Targets	team
Type	Lookup

OwningUser

Property	Value
Description	Unique identifier of the user who owns the note.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Targets	systemuser
Type	Lookup

Prefix

Property	Value
Description	Prefix of the file pointer in blob storage.
DisplayName	Prefix
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	prefix
MaxLength	10
RequiredLevel	None
Type	String

StoragePointer

Property	Value
Description	Storage pointer.
DisplayName	Storage Pointer
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	False
LogicalName	storagepointer
MaxLength	10
RequiredLevel	None
Type	String

VersionNumber

Property	Value
Description	Version number of the note.
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

One-To-Many Relationships

Listed by SchemaName.

• Annotation_SyncErrors
• Annotation_AsyncOperations
• Annotation_BulkDeleteFailures
• Annotation_ProcessSessions

Annotation_SyncErrors

Same as the Annotation_SyncErrors many-to-one relationship for the syncerror table/entity.

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
IsHierarchical	False
IsCustomizable	True
ReferencedEntityNavigationPropertyName	Annotation_SyncErrors
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order:
CascadeConfiguration	Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade Share: Cascade Unshare: Cascade

Annotation_AsyncOperations

Same as the Annotation_AsyncOperations many-to-one relationship for the asyncoperation table/entity.

Property	Value
ReferencingEntity	asyncoperation
ReferencingAttribute	regardingobjectid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	Annotation_AsyncOperations
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order:
CascadeConfiguration	Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade

Annotation_BulkDeleteFailures

Same as the Annotation_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.

Property	Value
ReferencingEntity	bulkdeletefailure
ReferencingAttribute	regardingobjectid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	Annotation_BulkDeleteFailures
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order:
CascadeConfiguration	Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade

Annotation_ProcessSessions

Same as the Annotation_ProcessSessions many-to-one relationship for the processsession table/entity.

Property	Value
ReferencingEntity	processsession
ReferencingAttribute	regardingobjectid
IsHierarchical	False
IsCustomizable	False
ReferencedEntityNavigationPropertyName	Annotation_ProcessSessions
AssociatedMenuConfiguration	Behavior: UseCollectionName Group: Details Label: Order: 110
CascadeConfiguration	Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

• knowledgearticle_Annotations
• KnowledgeBaseRecord_Annotations
• lk_annotationbase_modifiedonbehalfby
• Mailbox_Annotation
• team_annotations
• annotation_owning_user
• PhoneCall_Annotation
• Contact_Annotation
• SocialActivity_Annotation
• sla_Annotation
• Calendar_Annotation
• Email_Annotation
• Task_Annotation
• lk_annotationbase_createdby
• EmailServerProfile_Annotation
• Account_Annotation
• RecurringAppointmentMaster_Annotation
• business_unit_annotations
• lk_annotationbase_modifiedby
• Letter_Annotation
• Fax_Annotation
• Workflow_Annotation
• Appointment_Annotation
• lk_annotationbase_createdonbehalfby
• Goal_Annotation
• KbArticle_Annotation
• DuplicateRule_Annotation
• msdyn_aimodel_Annotations
• msdyn_aifptrainingdocument_Annotations
• msdyn_aiodimage_Annotations
• chat_Annotations

knowledgearticle_Annotations

See the knowledgearticle_Annotations one-to-many relationship for the knowledgearticle table/entity.

KnowledgeBaseRecord_Annotations

See the KnowledgeBaseRecord_Annotations one-to-many relationship for the knowledgebaserecord table/entity.

lk_annotationbase_modifiedonbehalfby

See the lk_annotationbase_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

Mailbox_Annotation

See the Mailbox_Annotation one-to-many relationship for the mailbox table/entity.

team_annotations

See the team_annotations one-to-many relationship for the team table/entity.

annotation_owning_user

See the annotation_owning_user one-to-many relationship for the systemuser table/entity.

PhoneCall_Annotation

See the PhoneCall_Annotation one-to-many relationship for the phonecall table/entity.

Contact_Annotation

See the Contact_Annotation one-to-many relationship for the contact table/entity.

SocialActivity_Annotation

See the SocialActivity_Annotation one-to-many relationship for the socialactivity table/entity.

sla_Annotation

See the sla_Annotation one-to-many relationship for the sla table/entity.

Calendar_Annotation

See the Calendar_Annotation one-to-many relationship for the calendar table/entity.

Email_Annotation

See the Email_Annotation one-to-many relationship for the email table/entity.

Task_Annotation

See the Task_Annotation one-to-many relationship for the task table/entity.

lk_annotationbase_createdby

See the lk_annotationbase_createdby one-to-many relationship for the systemuser table/entity.

EmailServerProfile_Annotation

See the EmailServerProfile_Annotation one-to-many relationship for the emailserverprofile table/entity.

Account_Annotation

See the Account_Annotation one-to-many relationship for the account table/entity.

RecurringAppointmentMaster_Annotation

See the RecurringAppointmentMaster_Annotation one-to-many relationship for the recurringappointmentmaster table/entity.

business_unit_annotations

See the business_unit_annotations one-to-many relationship for the businessunit table/entity.

lk_annotationbase_modifiedby

See the lk_annotationbase_modifiedby one-to-many relationship for the systemuser table/entity.

Letter_Annotation

See the Letter_Annotation one-to-many relationship for the letter table/entity.

Fax_Annotation

See the Fax_Annotation one-to-many relationship for the fax table/entity.

Workflow_Annotation

See the Workflow_Annotation one-to-many relationship for the workflow table/entity.

Appointment_Annotation

See the Appointment_Annotation one-to-many relationship for the appointment table/entity.

lk_annotationbase_createdonbehalfby

See the lk_annotationbase_createdonbehalfby one-to-many relationship for the systemuser table/entity.

Goal_Annotation

See the Goal_Annotation one-to-many relationship for the goal table/entity.

KbArticle_Annotation

See the KbArticle_Annotation one-to-many relationship for the kbarticle table/entity.

DuplicateRule_Annotation

See the DuplicateRule_Annotation one-to-many relationship for the duplicaterule table/entity.

msdyn_aimodel_Annotations

Added by: AISolution Solution

See the msdyn_aimodel_Annotations one-to-many relationship for the msdyn_aimodel table/entity.

msdyn_aifptrainingdocument_Annotations

Added by: AI Solution deprecated templates Solution

See the msdyn_aifptrainingdocument_Annotations one-to-many relationship for the msdyn_aifptrainingdocument table/entity.

msdyn_aiodimage_Annotations

Added by: AI Solution deprecated templates Solution

See the msdyn_aiodimage_Annotations one-to-many relationship for the msdyn_aiodimage table/entity.

chat_Annotations

Added by: Activities Patch Solution

See the chat_Annotations one-to-many relationship for the chat table/entity.

See also

About the table reference
Web API Reference
annotation EntityType