msdyn_macroactiontemplate 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.
Attributes for macro action template
Added by: Macros Solution
Messages
| Message | Web API Operation | SDK Assembly |
|---|---|---|
| Assign | PATCH [org URI]/api/data/v9.1/msdyn_macroactiontemplates(msdyn_macroactiontemplateid) Update ownerid property. |
AssignRequest |
| Create | POST [org URI]/api/data/v9.1/msdyn_macroactiontemplates See Create |
CreateRequest or Create |
| Delete | DELETE [org URI]/api/data/v9.1/msdyn_macroactiontemplates(msdyn_macroactiontemplateid) 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_macroactiontemplates(msdyn_macroactiontemplateid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET [org URI]/api/data/v9.1/msdyn_macroactiontemplates 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_macroactiontemplates(msdyn_macroactiontemplateid) Update statecode and statuscode properties. |
SetStateRequest |
| Update | PATCH [org URI]/api/data/v9.1/msdyn_macroactiontemplates(msdyn_macroactiontemplateid) See Update |
UpdateRequest or Update |
Entity Properties
| Property | Value |
|---|---|
| CollectionSchemaName | msdyn_macroactiontemplates |
| DisplayCollectionName | Macro Action Templates |
| DisplayName | Macro Action Template |
| EntitySetName | msdyn_macroactiontemplates |
| IsBPFEntity | False |
| LogicalCollectionName | msdyn_macroactiontemplates |
| LogicalName | msdyn_macroactiontemplate |
| OwnershipType | UserOwned |
| PrimaryIdAttribute | msdyn_macroactiontemplateid |
| PrimaryNameAttribute | msdyn_name |
| SchemaName | msdyn_macroactiontemplate |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- msdyn_actionDescription
- msdyn_brandcolor
- msdyn_displayname
- msdyn_icon
- msdyn_InputParameters
- msdyn_kind
- msdyn_macroactiontemplateId
- msdyn_macroconnector
- msdyn_name
- msdyn_OutputParameters
- msdyn_runtimeapi
- msdyn_subtitle
- msdyn_summary
- msdyn_title
- msdyn_visibility
- 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_actionDescription
| Property | Value |
|---|---|
| Description | The description of this macro action. |
| DisplayName | Description |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_actionDescription |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
msdyn_brandcolor
| Property | Value |
|---|---|
| Description | Unique value to set the brand color |
| DisplayName | Brand Color |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_brandcolor |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
msdyn_displayname
| Property | Value |
|---|---|
| Description | Unique value to set the display name |
| DisplayName | Display Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_displayname |
| MaxLength | 1000 |
| RequiredLevel | None |
| Type | String |
msdyn_icon
| Property | Value |
|---|---|
| Description | Unique value to set the icon |
| DisplayName | Icon |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_icon |
| MaxLength | 1000 |
| RequiredLevel | None |
| Type | String |
msdyn_InputParameters
| Property | Value |
|---|---|
| Description | Input parameters for the macro action template |
| DisplayName | Input Parameters |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_inputparameters |
| MaxLength | 4000 |
| RequiredLevel | None |
| Type | String |
msdyn_kind
| Property | Value |
|---|---|
| Description | Kind is either 'TRIGGERS' or 'ACTIONS' |
| DisplayName | Kind |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_kind |
| MaxLength | 1000 |
| RequiredLevel | ApplicationRequired |
| Type | String |
msdyn_macroactiontemplateId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | Macro Action Template |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | msdyn_macroactiontemplateid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
msdyn_macroconnector
| Property | Value |
|---|---|
| Description | Sets the value of macro connector |
| DisplayName | FUNDU_MACRO_CONNECTOR |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_macroconnector |
| RequiredLevel | None |
| Targets | msdyn_macroconnector |
| Type | Lookup |
msdyn_name
| Property | Value |
|---|---|
| Description | The name of this Macro template. |
| DisplayName | Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_name |
| MaxLength | 100 |
| RequiredLevel | ApplicationRequired |
| Type | String |
msdyn_OutputParameters
| Property | Value |
|---|---|
| Description | Output parameters for macro action template entity |
| DisplayName | Output Parameters |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_outputparameters |
| MaxLength | 4000 |
| RequiredLevel | None |
| Type | String |
msdyn_runtimeapi
| Property | Value |
|---|---|
| Description | Function to be executed at runtime |
| DisplayName | Runtime API |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_runtimeapi |
| MaxLength | 1000 |
| RequiredLevel | None |
| Type | String |
msdyn_subtitle
| Property | Value |
|---|---|
| Description | Unique value to set the subtitle value |
| DisplayName | Subtitle |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_subtitle |
| MaxLength | 1000 |
| RequiredLevel | None |
| Type | String |
msdyn_summary
| Property | Value |
|---|---|
| Description | Unique value to set the summary |
| DisplayName | Summary |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_summary |
| MaxLength | 2000 |
| RequiredLevel | None |
| Type | String |
msdyn_title
| Property | Value |
|---|---|
| Description | The title of this macro action. |
| DisplayName | Title |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_title |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
msdyn_visibility
| Property | Value |
|---|---|
| Description | Unique value to set the visibility value |
| DisplayName | Visibility |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_visibility |
| 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 | Owner |
| 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 Macro Action Template |
| 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 Macro Action Template |
| 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_macroconnectorName
- 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 | Modified 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_macroconnectorName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | msdyn_macroconnectorname |
| 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 |
One-To-Many Relationships
Listed by SchemaName.
msdyn_msdyn_macroactiontemplate_msdyn_actioninput
Same as msdyn_actioninputparameter entity msdyn_msdyn_macroactiontemplate_msdyn_actioninput Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_actioninputparameter |
| ReferencingAttribute | msdyn_actiontemplateinputparameterid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | msdyn_msdyn_macroactiontemplate_msdyn_actioninput |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
msdyn_msdyn_macroactiontemplate_msdyn_actionout
Same as msdyn_actionoutputparameter entity msdyn_msdyn_macroactiontemplate_msdyn_actionout Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_actionoutputparameter |
| ReferencingAttribute | msdyn_actiontemplateoutputparameterid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | msdyn_msdyn_macroactiontemplate_msdyn_actionout |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink 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.
msdyn_msdyn_macroconnector_msdyn_macroactiontemplate_macroconnector
See msdyn_macroconnector Entity msdyn_msdyn_macroconnector_msdyn_macroactiontemplate_macroconnector One-To-Many relationship.
Related information
Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service