Edit

Share via

msdyn_agentscriptstep Entity Reference

  • Article

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.

Agent script step

Added by: Agent scripts Solution

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.1/msdyn_agentscriptsteps(msdyn_agentscriptstepid)
Update ownerid property.		 AssignRequest
Create POST [org URI]/api/data/v9.1/msdyn_agentscriptsteps
See Create		 CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.1/msdyn_agentscriptsteps(msdyn_agentscriptstepid)
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_agentscriptsteps(msdyn_agentscriptstepid)
See Retrieve		 RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.1/msdyn_agentscriptsteps
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_agentscriptsteps(msdyn_agentscriptstepid)
Update statecode and statuscode properties.		 SetStateRequest
Update PATCH [org URI]/api/data/v9.1/msdyn_agentscriptsteps(msdyn_agentscriptstepid)
See Update		 UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName msdyn_agentscriptsteps
DisplayCollectionName Agent script steps
DisplayName Agent script step
EntitySetName msdyn_agentscriptsteps
IsBPFEntity False
LogicalCollectionName msdyn_agentscriptsteps
LogicalName msdyn_agentscriptstep
OwnershipType UserOwned
PrimaryIdAttribute msdyn_agentscriptstepid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_agentscriptstep

Writable attributes

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

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_ActionType

Property Value
Description Action type for agent script step
DisplayName Action type
IsValidForForm True
IsValidForRead True
LogicalName msdyn_actiontype
RequiredLevel ApplicationRequired
Type Picklist

msdyn_ActionType Options

Value Label
192350000 Text
192350001 Macro
192350002 Script

msdyn_AgentScriptId

Property Value
Description Unique identifier for agent script associated with agent script step.
DisplayName Agent script
IsValidForForm True
IsValidForRead True
LogicalName msdyn_agentscriptid
RequiredLevel None
Targets msdyn_agentscript
Type Lookup

msdyn_agentscriptstepId

Property Value
Description Unique identifier for entity instances
DisplayName Agent script step
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_agentscriptstepid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_Description

Property Value
Description Description for agent script step
DisplayName Description
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_description
MaxLength 2000
RequiredLevel None
Type String

msdyn_MacroActionId

Property Value
Description Unique identifier for macro associated with agent script step.
DisplayName Target macro
IsValidForForm True
IsValidForRead True
LogicalName msdyn_macroactionid
RequiredLevel None
Targets workflow
Type Lookup

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 2000
RequiredLevel ApplicationRequired
Type String

msdyn_Order

Property Value
Description Display order
DisplayName Order
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_order
MaxValue 2147483647
MinValue 1
RequiredLevel ApplicationRequired
Type Integer

msdyn_RouteActionId

Property Value
Description Unique identifier for target script associated with agent script step.
DisplayName Target script
IsValidForForm True
IsValidForRead True
LogicalName msdyn_routeactionid
RequiredLevel None
Targets msdyn_agentscript
Type Lookup

msdyn_TextInstruction

Property Value
Description Instruction for text action type
DisplayName Text instructions
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_textinstruction
MaxLength 2000
RequiredLevel None
Type Memo

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 Agent script step
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 Agent script step
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

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_AgentScriptIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_agentscriptidname
MaxLength 100
RequiredLevel None
Type String

msdyn_MacroActionIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_macroactionidname
MaxLength 100
RequiredLevel None
Type String

msdyn_RouteActionIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_routeactionidname
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

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_agentscript_msdyn_agentscriptstep

See msdyn_agentscript Entity msdyn_msdyn_agentscript_msdyn_agentscriptstep One-To-Many relationship.

msdyn_msdyn_agentscript_routeaction

See msdyn_agentscript Entity msdyn_msdyn_agentscript_routeaction One-To-Many relationship.

See also

Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service