chat EntityType

For internal use only. Entity which stores association data of Dynamics 365 records with Microsoft Teams chat

Entity Set Path
[organization URI]/api/data/v9.0/chats
Base Type
activitypointer
Display Name
Teams chat
Primary Key
activityid
Primary Key Attribute
subject
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
activityadditionalparams Edm.String

Additional information provided by the external application as JSON. For internal use only.

Display Name: Activity Additional Parameters

activityid Edm.Guid

Unique identifier of the activity.

Display Name: Activity

activitytypecode Edm.String

Type of activity.

Display Name: Activity Type

Read Only
actualdurationminutes Edm.Int32

Actual duration of the activity in minutes.

Display Name: Actual Duration

actualend Edm.DateTimeOffset

Actual end time of the activity.

Display Name: Actual End

actualstart Edm.DateTimeOffset

Actual start time of the activity.

Display Name: Actual Start

community Edm.Int32

Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only.

Display Name: Social Channel

Default Options
Value Label
1 Facebook
2 Twitter
0 Other
createdon Edm.DateTimeOffset

Date and time when the activity was created.

Display Name: Date Created

Read Only
deliverylastattemptedon Edm.DateTimeOffset

Date and time when the delivery of the activity was last attempted.

Display Name: Date Delivery Last Attempted

Read Only
deliveryprioritycode Edm.Int32

Priority of delivery of the activity to the email server.

Display Name: Delivery Priority

Default Options
Value Label
0 Low
1 Normal
2 High
description Edm.String

Description of the activity.

Display Name: Description

exchangeitemid Edm.String

The message id of activity which is returned from Exchange Server.

Display Name: Exchange Item ID

exchangerate Edm.Decimal

Exchange rate for the currency associated with the activitypointer with respect to the base currency.

Display Name: Exchange Rate

Read Only
exchangeweblink Edm.String

Shows the web link of Activity of type email.

Display Name: Exchange WebLink

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

instancetypecode Edm.Int32

Type of instance of a recurring series.

Display Name: Recurring Instance Type

Read Only
Default Options
Value Label
0 Not Recurring
1 Recurring Master
2 Recurring Instance
3 Recurring Exception
4 Recurring Future Exception
isbilled Edm.Boolean

Information regarding whether the activity was billed as part of resolving a case.

Display Name: Is Billed

Default Options
Value Label
1 Yes
0 No
ismapiprivate Edm.Boolean

For internal use only.

Display Name: Is Private

Default Options
Value Label
1 Yes
0 No
isregularactivity Edm.Boolean

Information regarding whether the activity is a regular activity type or event type.

Display Name: Is Regular Activity

Read Only
Default Options
Value Label
1 Yes
0 No
isworkflowcreated Edm.Boolean

Information regarding whether the activity was created from a workflow rule.

Display Name: Is Workflow Created

Default Options
Value Label
1 Yes
0 No
lastonholdtime Edm.DateTimeOffset

Contains the date and time stamp of the last on hold time.

Display Name: Last On Hold Time

leftvoicemail Edm.Boolean

Left the voice mail

Display Name: Left Voice Mail

Default Options
Value Label
1 Yes
0 No
linkedon Edm.DateTimeOffset

For internal use only. Date and time when the record was linked.

Display Name: Linked On

Read Only
modifiedon Edm.DateTimeOffset

Date and time when activity was last modified.

Display Name: Last Updated

Read Only
onholdtime Edm.Int32

Shows how long, in minutes, that the record was on hold.

Display Name: On Hold Time (Minutes)

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

postponeactivityprocessinguntil Edm.DateTimeOffset

For internal use only.

Display Name: Delay activity processing until

Read Only
prioritycode Edm.Int32

Priority of the activity.

Display Name: Priority

Default Options
Value Label
0 Low
1 Normal
2 High
processid Edm.Guid

Unique identifier of the Process.

Display Name: Process

scheduleddurationminutes Edm.Int32

Scheduled duration of the activity, specified in minutes.

Display Name: Scheduled Duration

scheduledend Edm.DateTimeOffset

Scheduled end time of the activity.

Display Name: Due Date

scheduledstart Edm.DateTimeOffset

Scheduled start time of the activity.

Display Name: Start Date

senton Edm.DateTimeOffset

Date and time when the activity was sent.

Display Name: Date Sent

Read Only
seriesid Edm.Guid

Uniqueidentifier specifying the id of recurring series of an instance.

Display Name: Series Id

Read Only
sortdate Edm.DateTimeOffset

Shows the date and time by which the activities are sorted.

Display Name: Sort Date

stageid Edm.Guid

Unique identifier of the Stage.

Display Name: (Deprecated) Process Stage

statecode Edm.Int32

Status of the activity.

Display Name: Activity Status

Default Options
Value Label
0 Open
1 Completed
2 Canceled
3 Scheduled
statuscode Edm.Int32

Reason for the status of the activity.

Display Name: Status Reason

Default Options
Value Label
1 Open
2 Completed
3 Canceled
4 Scheduled
subject Edm.String

Subject associated with the activity.

Display Name: Subject

teamschatid Edm.String

For internal use only. Teams Chat Id

Display Name: Teams Chat Id

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

traversedpath Edm.String

For internal use only.

Display Name: (Deprecated) Traversed Path

unlinkedon Edm.DateTimeOffset

For internal use only. Date and time when the record was unlinked.

Display Name: UnLinked On

Read Only
utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version number of the activity.

Display Name: Version Number

Read Only

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

Unique identifier of the user who created the activity.

_createdonbehalfby_value

Unique identifier of the delegate user who created the activitypointer.

_linkedby_value LinkedBy

For internal use only. Unique identifier of the user who linked the record.

_modifiedby_value

Unique identifier of user who last modified the activity.

_modifiedonbehalfby_value

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

_ownerid_value

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

_owningbusinessunit_value

Unique identifier of the business unit that owns the activity.

_owningteam_value

Unique identifier of the team that owns the activity.

_owninguser_value

Unique identifier of the user that owns the activity.

_regardingobjectid_value

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

_sendermailboxid_value

Unique identifier of the mailbox associated with the sender of the email message.

_slaid_value

Choose the service level agreement (SLA) that you want to apply to the case record.

_slainvokedid_value

Last SLA that was applied to this case. This field is for internal use only.

_transactioncurrencyid_value

Unique identifier of the currency associated with the activitypointer.

_unlinkedby_value UnLinkedBy

For internal use only. Unique identifier of the user who unlinked the record.

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
activityid_chat activitypointer activity_pointer_chat
createdby systemuser lk_activitypointer_createdby
createdby_chat systemuser chat_systemuser_createdby
createdonbehalfby systemuser lk_activitypointer_createdonbehalfby
createdonbehalfby_chat systemuser chat_systemuser_createdonbehalfby
LinkedBy systemuser teams_chat_activity_linkrecord
modifiedby systemuser lk_activitypointer_modifiedby
modifiedby_chat systemuser chat_systemuser_modifiedby
modifiedonbehalfby systemuser lk_activitypointer_modifiedonbehalfby
modifiedonbehalfby_chat systemuser chat_systemuser_modifiedonbehalfby
ownerid principal owner_activitypointers
ownerid_chat principal chat_owner_ownerid
owningbusinessunit businessunit business_unit_activitypointer
owningbusinessunit_chat businessunit chat_businessunit_owningbusinessunit
owningteam team team_activity
owningteam_chat team chat_team_owningteam
owninguser systemuser user_activity
owninguser_chat systemuser chat_systemuser_owninguser
regardingobjectid_account account Account_ActivityPointers
regardingobjectid_account_chat account account_chats
regardingobjectid_contact contact Contact_ActivityPointers
regardingobjectid_contact_chat contact contact_chats
regardingobjectid_knowledgearticle knowledgearticle KnowledgeArticle_ActivityPointers
regardingobjectid_knowledgearticle_chat knowledgearticle knowledgearticle_chats
regardingobjectid_knowledgebaserecord knowledgebaserecord KnowledgeBaseRecord_ActivityPointers
regardingobjectid_knowledgebaserecord_chat knowledgebaserecord knowledgebaserecord_chats
regardingobjectid_new_interactionforemail interactionforemail new_interactionforemail_ActivityPointers
regardingobjectid_new_interactionforemail_chat interactionforemail interactionforemail_chats
sendermailboxid mailbox activitypointer_sendermailboxid_mailbox
sendermailboxid_chat mailbox chat_mailbox_sendermailboxid
sla_activitypointer_sla sla manualsla_activitypointer
sla_activitypointer_sla_chat sla chat_sla_slaid
slainvokedid_activitypointer_sla sla sla_activitypointer
slainvokedid_activitypointer_sla_chat sla chat_sla_slainvokedid
transactioncurrencyid transactioncurrency TransactionCurrency_ActivityPointer
transactioncurrencyid_chat transactioncurrency chat_transactioncurrency_transactioncurrencyid
UnLinkedBy systemuser teams_chat_activity_unlinkrecord

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
activity_pointer_activity_mime_attachment activitymimeattachment objectid_activitypointer
activity_pointer_appointment appointment activityid_activitypointer
activity_pointer_chat chat activityid_chat
activity_pointer_email email activityid_activitypointer
activity_pointer_fax fax activityid_activitypointer
activity_pointer_letter letter activityid_activitypointer
activity_pointer_phonecall phonecall activityid_activitypointer
activity_pointer_recurrencerule recurrencerule objectid
activity_pointer_recurringappointmentmaster recurringappointmentmaster activityid_activitypointer
activity_pointer_socialactivity socialactivity activityid_activitypointer
activity_pointer_task task activityid_activitypointer
activitypointer_activity_parties activityparty activityid_activitypointer
ActivityPointer_AsyncOperations asyncoperation regardingobjectid_activitypointer
ActivityPointer_BulkDeleteFailures bulkdeletefailure regardingobjectid_activitypointer
activitypointer_connections1 connection record1id_activitypointer
activitypointer_connections2 connection record2id_activitypointer
ActivityPointer_QueueItem queueitem objectid_activitypointer
chat_ActionCards actioncard regardingobjectid_chat
chat_activity_parties activityparty activityid_chat_activityparty
chat_Annotations annotation objectid_chat
chat_AsyncOperations asyncoperation regardingobjectid_chat
chat_BulkDeleteFailures bulkdeletefailure regardingobjectid_chat
chat_DuplicateBaseRecord duplicaterecord baserecordid_chat
chat_DuplicateMatchingRecord duplicaterecord duplicaterecordid_chat
chat_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_chat
chat_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_chat
chat_ProcessSession processsession regardingobjectid_chat
chat_QueueItems queueitem objectid_chat
chat_SyncErrors syncerror regardingobjectid_chat
slakpiinstance_activitypointer slakpiinstance regarding_activitypointer

Operations

The following operations can be used with the chat entity type.

Name Binding
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the chat entity type.

Name Description
Activities Patch Patch for Dynamics 365 workload for activities.

See also