Editar

Partilhar via


Note (Annotation) entity reference

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

Messages

Message SDK class or method
Assign AssignRequest
Create CreateRequest or
Create
Delete DeleteRequest or
Delete
GrantAccess GrantAccessRequest
ModifyAccess ModifyAccessRequest
Retrieve RetrieveRequest or
Retrieve
RetrieveMultiple RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccessRequest
Rollup RollupRequest
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 attributes

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

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,bookableresource,bookableresourcebooking,bookableresourcebookingheader,bookableresourcecategoryassn,bookableresourcecharacteristic,bookableresourcegroup,bulkoperation,calendar,campaign,campaignactivity,campaignresponse,channelaccessprofile,channelaccessprofilerule,channelaccessprofileruleitem,commitment,competitor,contact,contract,contractdetail,convertrule,duplicaterule,email,emailserverprofile,entitlement,entitlementchannel,entitlementtemplate,equipment,fax,goal,incident,incidentresolution,invoice,kbarticle,knowledgearticle,knowledgebaserecord,lead,letter,list,mailbox,msdyn_postalbum,msdyn_solutioncomponentdatasource,opportunity,opportunityclose,orderclose,phonecall,product,quote,quoteclose,recurringappointmentmaster,resourcespec,routingrule,routingruleitem,salesorder,service,serviceappointment,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

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

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

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

Same as the Annotation_SyncErrors many-to-one relationship for the syncerror 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 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 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 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 entity. Listed by SchemaName.

knowledgearticle_Annotations

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

msdyn_solutioncomponentdatasource_Annotations

Added by: Microsoft Dynamics 365 Settings APIs Solution

See the msdyn_solutioncomponentdatasource_Annotations one-to-many relationship for the msdyn_solutioncomponentdatasource entity.

Lead_Annotation

Added by: Lead Management Solution

See the Lead_Annotation one-to-many relationship for the lead entity.

Product_Annotation

Added by: Product Management Solution

See the Product_Annotation one-to-many relationship for the product entity.

bookableresource_Annotations

Added by: Scheduling Solution

See the bookableresource_Annotations one-to-many relationship for the bookableresource entity.

bookableresourcebooking_Annotations

Added by: Scheduling Solution

See the bookableresourcebooking_Annotations one-to-many relationship for the bookableresourcebooking entity.

bookableresourcebookingheader_Annotations

Added by: Scheduling Solution

See the bookableresourcebookingheader_Annotations one-to-many relationship for the bookableresourcebookingheader entity.

bookableresourcecategoryassn_Annotations

Added by: Scheduling Solution

See the bookableresourcecategoryassn_Annotations one-to-many relationship for the bookableresourcecategoryassn entity.

bookableresourcecharacteristic_Annotations

Added by: Scheduling Solution

See the bookableresourcecharacteristic_Annotations one-to-many relationship for the bookableresourcecharacteristic entity.

bookableresourcegroup_Annotations

Added by: Scheduling Solution

See the bookableresourcegroup_Annotations one-to-many relationship for the bookableresourcegroup entity.

bulkoperation_Annotations

Added by: Marketing Solution

See the bulkoperation_Annotations one-to-many relationship for the bulkoperation entity.

Campaign_Annotation

Added by: Marketing Solution

See the Campaign_Annotation one-to-many relationship for the campaign entity.

CampaignActivity_Annotation

Added by: Marketing Solution

See the CampaignActivity_Annotation one-to-many relationship for the campaignactivity entity.

CampaignResponse_Annotation

Added by: Marketing Solution

See the CampaignResponse_Annotation one-to-many relationship for the campaignresponse entity.

List_Annotation

Added by: Marketing Solution

See the List_Annotation one-to-many relationship for the list entity.

Contract_Annotation

Added by: Service Solution

See the Contract_Annotation one-to-many relationship for the contract entity.

ContractDetail_Annotation

Added by: Service Solution

See the ContractDetail_Annotation one-to-many relationship for the contractdetail entity.

entitlement_Annotations

Added by: Service Solution

See the entitlement_Annotations one-to-many relationship for the entitlement entity.

entitlementchannel_Annotations

Added by: Service Solution

See the entitlementchannel_Annotations one-to-many relationship for the entitlementchannel entity.

entitlementtemplate_Annotations

Added by: Service Solution

See the entitlementtemplate_Annotations one-to-many relationship for the entitlementtemplate entity.

Equipment_Annotation

Added by: Service Solution

See the Equipment_Annotation one-to-many relationship for the equipment entity.

Incident_Annotation

Added by: Service Solution

See the Incident_Annotation one-to-many relationship for the incident entity.

IncidentResolution_Annotation

Added by: Service Solution

See the IncidentResolution_Annotation one-to-many relationship for the incidentresolution entity.

ResourceSpec_Annotation

Added by: Service Solution

See the ResourceSpec_Annotation one-to-many relationship for the resourcespec entity.

Service_Annotation

Added by: Service Solution

See the Service_Annotation one-to-many relationship for the service entity.

ServiceAppointment_Annotation

Added by: Service Solution

See the ServiceAppointment_Annotation one-to-many relationship for the serviceappointment entity.

Invoice_Annotation

Added by: Sales Solution

See the Invoice_Annotation one-to-many relationship for the invoice entity.

Opportunity_Annotation

Added by: Sales Solution

See the Opportunity_Annotation one-to-many relationship for the opportunity entity.

OpportunityClose_Annotation

Added by: Sales Solution

See the OpportunityClose_Annotation one-to-many relationship for the opportunityclose entity.

OrderClose_Annotation

Added by: Sales Solution

See the OrderClose_Annotation one-to-many relationship for the orderclose entity.

Quote_Annotation

Added by: Sales Solution

See the Quote_Annotation one-to-many relationship for the quote entity.

QuoteClose_Annotation

Added by: Sales Solution

See the QuoteClose_Annotation one-to-many relationship for the quoteclose entity.

SalesOrder_Annotation

Added by: Sales Solution

See the SalesOrder_Annotation one-to-many relationship for the salesorder entity.

Competitor_Annotation

Added by: Sales Solution

See the Competitor_Annotation one-to-many relationship for the competitor entity.

msdyn_postalbum_Annotations

Added by: Activity Feeds Solution

See the msdyn_postalbum_Annotations one-to-many relationship for the msdyn_postalbum entity.

KnowledgeBaseRecord_Annotations

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

lk_annotationbase_modifiedonbehalfby

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

Mailbox_Annotation

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

team_annotations

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

annotation_owning_user

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

PhoneCall_Annotation

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

Contact_Annotation

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

SocialActivity_Annotation

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

sla_Annotation

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

Calendar_Annotation

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

Email_Annotation

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

Task_Annotation

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

lk_annotationbase_createdby

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

EmailServerProfile_Annotation

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

Account_Annotation

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

RecurringAppointmentMaster_Annotation

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

business_unit_annotations

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

lk_annotationbase_modifiedby

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

Letter_Annotation

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

Fax_Annotation

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

Workflow_Annotation

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

Appointment_Annotation

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

lk_annotationbase_createdonbehalfby

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

Goal_Annotation

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

KbArticle_Annotation

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

DuplicateRule_Annotation

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

See also

About the Entity Reference
Web API EntityType Reference