Annotation entity reference

11/14/2020
読み終わるまで 4 分

Note

Effective Nov 2020, Common Data Service has been renamed to 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

Entity 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 attributes

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

AnnotationId
DocumentBody
DummyFileName
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

DummyFileName

Added by: Activities Patch Solution

Property	Value
Description	Dummy attribute associated with the note attachment
DisplayName	File Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	dummyfilename
MaxLength	500
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 Options

Value	Label
1	Yes
0	No

DefaultValue: False

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	Email
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	notetext
MaxLength	1073741823
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,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 attributes

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

CreatedBy
CreatedByName
CreatedByYomiName
CreatedOn
CreatedOnBehalfBy
CreatedOnBehalfByName
CreatedOnBehalfByYomiName
DummyRegarding
FilePointer
FileSize
IsPrivate
ModifiedBy
ModifiedByName
ModifiedByYomiName
ModifiedOn
ModifiedOnBehalfBy
ModifiedOnBehalfByName
ModifiedOnBehalfByYomiName
OwnerIdName
OwnerIdYomiName
OwningBusinessUnit
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

DummyRegarding

Added by: Activities Patch Solution

Property	Value
Description	Dummy attribute associated with the note regarding
DisplayName	Regarding
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
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 Options

Value	Label
1	Yes
0	No

DefaultValue: False

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	False
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	None
Targets	businessunit
Type	Lookup

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 syncerror entity Annotation_SyncErrors Many-To-One relationship.

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 asyncoperation entity Annotation_AsyncOperations Many-To-One relationship.

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 bulkdeletefailure entity Annotation_BulkDeleteFailures Many-To-One relationship.

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 processsession entity Annotation_ProcessSessions Many-To-One relationship.

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 entity. 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

knowledgearticle_Annotations

See knowledgearticle Entity knowledgearticle_Annotations One-To-Many relationship.

KnowledgeBaseRecord_Annotations

See knowledgebaserecord Entity KnowledgeBaseRecord_Annotations One-To-Many relationship.

lk_annotationbase_modifiedonbehalfby

See systemuser Entity lk_annotationbase_modifiedonbehalfby One-To-Many relationship.

Mailbox_Annotation

See mailbox Entity Mailbox_Annotation One-To-Many relationship.

team_annotations

See team Entity team_annotations One-To-Many relationship.

annotation_owning_user

See systemuser Entity annotation_owning_user One-To-Many relationship.

PhoneCall_Annotation

See phonecall Entity PhoneCall_Annotation One-To-Many relationship.

Contact_Annotation

See contact Entity Contact_Annotation One-To-Many relationship.

SocialActivity_Annotation

See socialactivity Entity SocialActivity_Annotation One-To-Many relationship.

sla_Annotation

See sla Entity sla_Annotation One-To-Many relationship.

Calendar_Annotation

See calendar Entity Calendar_Annotation One-To-Many relationship.

Email_Annotation

See email Entity Email_Annotation One-To-Many relationship.

Task_Annotation

See task Entity Task_Annotation One-To-Many relationship.

lk_annotationbase_createdby

See systemuser Entity lk_annotationbase_createdby One-To-Many relationship.

EmailServerProfile_Annotation

See emailserverprofile Entity EmailServerProfile_Annotation One-To-Many relationship.

Account_Annotation

See account Entity Account_Annotation One-To-Many relationship.

RecurringAppointmentMaster_Annotation

See recurringappointmentmaster Entity RecurringAppointmentMaster_Annotation One-To-Many relationship.

business_unit_annotations

See businessunit Entity business_unit_annotations One-To-Many relationship.

lk_annotationbase_modifiedby

See systemuser Entity lk_annotationbase_modifiedby One-To-Many relationship.

Letter_Annotation

See letter Entity Letter_Annotation One-To-Many relationship.

Fax_Annotation

See fax Entity Fax_Annotation One-To-Many relationship.

Workflow_Annotation

See workflow Entity Workflow_Annotation One-To-Many relationship.

Appointment_Annotation

See appointment Entity Appointment_Annotation One-To-Many relationship.

lk_annotationbase_createdonbehalfby

See systemuser Entity lk_annotationbase_createdonbehalfby One-To-Many relationship.

Goal_Annotation

See goal Entity Goal_Annotation One-To-Many relationship.

KbArticle_Annotation

See kbarticle Entity KbArticle_Annotation One-To-Many relationship.

DuplicateRule_Annotation

See duplicaterule Entity DuplicateRule_Annotation One-To-Many relationship.

msdyn_aimodel_Annotations

Added by: AISolution Solution

See msdyn_aimodel Entity msdyn_aimodel_Annotations One-To-Many relationship.

msdyn_aifptrainingdocument_Annotations

Added by: AI Solution default templates Solution

See msdyn_aifptrainingdocument Entity msdyn_aifptrainingdocument_Annotations One-To-Many relationship.

msdyn_aiodimage_Annotations

Added by: AI Solution default templates Solution

See msdyn_aiodimage Entity msdyn_aiodimage_Annotations One-To-Many relationship.