msdyn_macrosession Entity Reference
Omnichannel for Customer Service offers a suite of capabilities that extend the power of Dynamics 365 Customer Service Enterprise to enable organizations to instantly connect and engage with their customers across digital messaging channels. An additional license is required to access Omnichannel for Customer Service. For more information, see the Dynamics 365 Customer Service pricing overview and Dynamics 365 Customer Service pricing plan pages.
Stores history of macro runs
Added by: Macros Solution
Messages
| Message | Web API Operation | SDK Assembly |
|---|---|---|
| Assign | PATCH [org URI]/api/data/v9.1/msdyn_macrosessions(msdyn_macrosessionid) Update ownerid property. |
AssignRequest |
| Create | POST [org URI]/api/data/v9.1/msdyn_macrosessions See Create |
CreateRequest or Create |
| Delete | DELETE [org URI]/api/data/v9.1/msdyn_macrosessions(msdyn_macrosessionid) See Delete |
DeleteRequest or Delete |
| GrantAccess | GrantAccess Action | GrantAccessRequest |
| IsValidStateTransition | IsValidStateTransition Function | IsValidStateTransitionRequest |
| ModifyAccess | ModifyAccess Action | ModifyAccessRequest |
| Retrieve | GET [org URI]/api/data/v9.1/msdyn_macrosessions(msdyn_macrosessionid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET [org URI]/api/data/v9.1/msdyn_macrosessions See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
| RetrievePrincipalAccess | RetrievePrincipalAccess Function | RetrievePrincipalAccessRequest |
| RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccess Function | RetrieveSharedPrincipalsAndAccessRequest |
| RevokeAccess | RevokeAccess Action | RevokeAccessRequest |
| SetState | PATCH [org URI]/api/data/v9.1/msdyn_macrosessions(msdyn_macrosessionid) Update statecode and statuscode properties. |
SetStateRequest |
| Update | PATCH [org URI]/api/data/v9.1/msdyn_macrosessions(msdyn_macrosessionid) See Update |
UpdateRequest or Update |
Entity Properties
| Property | Value |
|---|---|
| CollectionSchemaName | msdyn_macrosessions |
| DisplayCollectionName | Macro Run Histories |
| DisplayName | Macro Run History |
| EntitySetName | msdyn_macrosessions |
| IsBPFEntity | False |
| LogicalCollectionName | msdyn_macrosessions |
| LogicalName | msdyn_macrosession |
| OwnershipType | UserOwned |
| PrimaryIdAttribute | msdyn_macrosessionid |
| PrimaryNameAttribute | msdyn_name |
| SchemaName | msdyn_macrosession |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- msdyn_executioncontext
- msdyn_macroname
- msdyn_macrosessionId
- msdyn_name
- msdyn_status
- OverriddenCreatedOn
- OwnerId
- OwnerIdType
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UTCConversionTimeZoneCode
ImportSequenceNumber
| Property | Value |
|---|---|
| Description | Sequence number of the import 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 |
msdyn_executioncontext
| Property | Value |
|---|---|
| Description | Stores execution JSON for the macro |
| DisplayName | Execution data |
| Format | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_executioncontext |
| MaxLength | 1000000 |
| RequiredLevel | None |
| Type | Memo |
msdyn_macroname
| Property | Value |
|---|---|
| Description | Lookup field for the macro for which the session is created |
| DisplayName | Macro name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_macroname |
| RequiredLevel | None |
| Targets | workflow |
| Type | Lookup |
msdyn_macrosessionId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | Macro Run History ID |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | msdyn_macrosessionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
msdyn_name
| Property | Value |
|---|---|
| Description | The name of the custom entity. |
| DisplayName | Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_name |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
msdyn_status
| Property | Value |
|---|---|
| Description | Stores whether macro succeeded or failed |
| DisplayName | Macro status |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_status |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
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
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Owner Id |
| DisplayName | User |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | ownerid |
| RequiredLevel | SystemRequired |
| Targets | systemuser,team |
| Type | Owner |
OwnerIdType
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Owner Id Type |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridtype |
| RequiredLevel | SystemRequired |
| Type | EntityName |
statecode
| Property | Value |
|---|---|
| Description | Status of the macrosrunhistory |
| DisplayName | Status |
| IsValidForCreate | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
statecode Options
| Value | Label | DefaultStatus | InvariantName |
|---|---|---|---|
| 0 | Active | 1 | Active |
| 1 | Inactive | 2 | Inactive |
statuscode
| Property | Value |
|---|---|
| Description | Reason for the status of the macrosrunhistory |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
statuscode Options
| Value | Label | State |
|---|---|---|
| 1 | Active | 0 |
| 2 | Inactive | 1 |
TimeZoneRuleVersionNumber
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Time Zone Rule Version Number |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | timezoneruleversionnumber |
| MaxValue | 2147483647 |
| MinValue | -1 |
| RequiredLevel | None |
| Type | Integer |
UTCConversionTimeZoneCode
| Property | Value |
|---|---|
| Description | Time zone code that was in use when the record was created. |
| DisplayName | UTC Conversion Time Zone Code |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | utcconversiontimezonecode |
| MaxValue | 2147483647 |
| MinValue | -1 |
| RequiredLevel | None |
| Type | Integer |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- msdyn_macronameName
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- VersionNumber
CreatedBy
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the user who created the record. |
| DisplayName | Created By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedByName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedByYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
CreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the record was created. |
| DisplayName | Created On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
CreatedOnBehalfBy
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who created the record. |
| DisplayName | Created By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdonbehalfby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedOnBehalfByName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedOnBehalfByYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
ModifiedBy
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the user who modified the record. |
| DisplayName | Modified By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ModifiedByName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedByYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
ModifiedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the record was modified. |
| DisplayName | Executed on |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
ModifiedOnBehalfBy
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who modified the record. |
| DisplayName | Modified By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ModifiedOnBehalfByName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedOnBehalfByYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
msdyn_macronameName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | msdyn_macronamename |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
OwnerIdName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Name of the owner |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridname |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OwnerIdYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Yomi name of the owner |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OwningBusinessUnit
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier for the business unit that owns the record |
| DisplayName | Owning Business Unit |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningbusinessunit |
| RequiredLevel | None |
| Targets | businessunit |
| Type | Lookup |
OwningTeam
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier for the team that owns the record. |
| DisplayName | Owning Team |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningteam |
| RequiredLevel | None |
| Targets | team |
| Type | Lookup |
OwningUser
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier for the user that owns the record. |
| DisplayName | Owning User |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owninguser |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
VersionNumber
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Version Number |
| DisplayName | Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
Related information
Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service