annotation EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

Entity Set path:[organization URI]/api/data/v8.2/annotations

Base Type: crmbaseentity EntityType

Display Name: Note

Primary Key: annotationid

Primary Name Attribute: subject

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

annotationid

Edm.Guid

Description: Unique identifier of the note.

Display Name: Note

createdon

Edm.DateTimeOffset

Description: Date and time when the note was created.

Display Name: Created On

Read-only property

documentbody

Edm.String

Description: Contents of the note's attachment.

Display Name: Document

documentbody_binary

Edm.Binary

Description: Contents of the note's attachment.

filename

Edm.String

Description: File name of the note.

Display Name: File Name

filesize

Edm.Int32

Description: File size of the note.

Display Name: File Size (Bytes)

Read-only property

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

isdocument

Edm.Boolean

Description: Specifies whether the note is an attachment.

Default Options:

1 : Yes
0 : No

Display Name: Is Document

langid

Edm.String

Description: Language identifier for the note.

Display Name: Language ID

mimetype

Edm.String

Description: MIME type of the note's attachment.

Display Name: Mime Type

modifiedon

Edm.DateTimeOffset

Description: Date and time when the note was last modified.

Display Name: Modified On

Read-only property

notetext

Edm.String

Description: Text of the note.

Display Name: Description

objecttypecode

Edm.String

Description: Type of entity with which the note is associated.

Display Name: Object Type

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

stepid

Edm.String

Description: workflow step id associated with the note.

Display Name: Step Id

subject

Edm.String

Description: Subject associated with the note.

Display Name: Title

versionnumber

Edm.Int64

Description: Version number of the note.

Display Name: Version Number

Read-only property

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties

Name

Single-valued navigation property

Description

_createdby_value

createdby

Unique identifier of the user who created the note.

_createdonbehalfby_value

createdonbehalfby

Unique identifier of the delegate user who created the annotation.

_modifiedby_value

modifiedby

Unique identifier of the user who last modified the note.

_modifiedonbehalfby_value

modifiedonbehalfby

Unique identifier of the delegate user who last modified the annotation.

_objectid_value

objectid_knowledgearticle

objectid_entitlement

objectid_entitlementchannel

objectid_entitlementtemplate

objectid_bookableresource

objectid_bookableresourcebooking

objectid_bookableresourcebookingheader

objectid_bookableresourcecategoryassn

objectid_bookableresourcecharacteristic

objectid_bookableresourcegroup

objectid_knowledgebaserecord

objectid_account

objectid_list

objectid_kbarticle

objectid_sla

objectid_calendar

objectid_contact

objectid_service

objectid_salesorder

objectid_competitor

objectid_contract

objectid_goal

objectid_workflow

objectid_incident

objectid_equipment

objectid_contractdetail

objectid_campaign

objectid_lead

objectid_mailbox

objectid_resourcespec

objectid_duplicaterule

objectid_quote

objectid_invoice

objectid_emailserverprofile

objectid_product

objectid_opportunity

Unique identifier of the object with which the note is associated.

_ownerid_value

ownerid

Unique identifier of the user or team who owns the note.

_owningbusinessunit_value

owningbusinessunit

Unique identifier of the business unit that owns the note.

_owningteam_value

owningteam

Unique identifier of the team who owns the note.

_owninguser_value

owninguser

Unique identifier of the user who owns the note.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name

Type

Partner

createdby

systemuser EntityType

lk_annotationbase_createdby

createdonbehalfby

systemuser EntityType

lk_annotationbase_createdonbehalfby

modifiedby

systemuser EntityType

lk_annotationbase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_annotationbase_modifiedonbehalfby

objectid_account

account EntityType

Account_Annotation

objectid_appointment

appointment EntityType

Appointment_Annotation

objectid_bookableresource

bookableresource EntityType

bookableresource_Annotations

objectid_bookableresourcebooking

bookableresourcebooking EntityType

bookableresourcebooking_Annotations

objectid_bookableresourcebookingheader

bookableresourcebookingheader EntityType

bookableresourcebookingheader_Annotations

objectid_bookableresourcecategoryassn

bookableresourcecategoryassn EntityType

bookableresourcecategoryassn_Annotations

objectid_bookableresourcecharacteristic

bookableresourcecharacteristic EntityType

bookableresourcecharacteristic_Annotations

objectid_bookableresourcegroup

bookableresourcegroup EntityType

bookableresourcegroup_Annotations

objectid_calendar

calendar EntityType

Calendar_Annotation

objectid_campaign

campaign EntityType

Campaign_Annotation

objectid_campaignactivity

campaignactivity EntityType

CampaignActivity_Annotation

objectid_campaignresponse

campaignresponse EntityType

CampaignResponse_Annotation

objectid_competitor

competitor EntityType

Competitor_Annotation

objectid_contact

contact EntityType

Contact_Annotation

objectid_contract

contract EntityType

Contract_Annotation

objectid_contractdetail

contractdetail EntityType

ContractDetail_Annotation

objectid_duplicaterule

duplicaterule EntityType

DuplicateRule_Annotation

objectid_email

email EntityType

Email_Annotation

objectid_emailserverprofile

emailserverprofile EntityType

EmailServerProfile_Annotation

objectid_entitlement

entitlement EntityType

entitlement_Annotations

objectid_entitlementchannel

entitlementchannel EntityType

entitlementchannel_Annotations

objectid_entitlementtemplate

entitlementtemplate EntityType

entitlementtemplate_Annotations

objectid_equipment

equipment EntityType

Equipment_Annotation

objectid_fax

fax EntityType

Fax_Annotation

objectid_goal

goal EntityType

Goal_Annotation

objectid_incident

incident EntityType

Incident_Annotation

objectid_incidentresolution

incidentresolution EntityType

IncidentResolution_Annotation

objectid_invoice

invoice EntityType

Invoice_Annotation

objectid_kbarticle

kbarticle EntityType

KbArticle_Annotation

objectid_knowledgearticle

knowledgearticle EntityType

knowledgearticle_Annotations

objectid_knowledgebaserecord

knowledgebaserecord EntityType

KnowledgeBaseRecord_Annotations

objectid_lead

lead EntityType

Lead_Annotation

objectid_letter

letter EntityType

Letter_Annotation

objectid_list

list EntityType

List_Annotation

objectid_mailbox

mailbox EntityType

Mailbox_Annotation

objectid_opportunity

opportunity EntityType

Opportunity_Annotation

objectid_opportunityclose

opportunityclose EntityType

OpportunityClose_Annotation

objectid_orderclose

orderclose EntityType

OrderClose_Annotation

objectid_phonecall

phonecall EntityType

PhoneCall_Annotation

objectid_product

product EntityType

Product_Annotation

objectid_quote

quote EntityType

Quote_Annotation

objectid_quoteclose

quoteclose EntityType

QuoteClose_Annotation

objectid_recurringappointmentmaster

recurringappointmentmaster EntityType

RecurringAppointmentMaster_Annotation

objectid_resourcespec

resourcespec EntityType

ResourceSpec_Annotation

objectid_salesorder

salesorder EntityType

SalesOrder_Annotation

objectid_service

service EntityType

Service_Annotation

objectid_serviceappointment

serviceappointment EntityType

ServiceAppointment_Annotation

objectid_sla

sla EntityType

sla_Annotation

objectid_socialactivity

socialactivity EntityType

SocialActivity_Annotation

objectid_task

task EntityType

Task_Annotation

objectid_workflow

workflow EntityType

Workflow_Annotation

ownerid

principal EntityType

owner_annotations

owningbusinessunit

businessunit EntityType

business_unit_annotations

owningteam

team EntityType

team_annotations

owninguser

systemuser EntityType

annotation_owning_user

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name

Type

Partner

Annotation_AsyncOperations

asyncoperation EntityType

regardingobjectid_annotation

Annotation_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_annotation

Annotation_SyncErrors

syncerror EntityType

regardingobjectid_annotation_syncerror

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright