Rediger

Share via


msdyn_segment table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Added by: Segment solution Solution

Messages

Message Web API Operation SDK class or method
Assign PATCH /msdyn_segments(msdyn_segmentid)
Update ownerid property.
AssignRequest
BulkRetain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Create POST /msdyn_segments
See Create
CreateRequest or
Create
CreateMultiple CreateMultiple CreateMultipleRequest
Delete DELETE /msdyn_segments(msdyn_segmentid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess GrantAccessRequest
IsValidStateTransition IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess ModifyAccess ModifyAccessRequest
PurgeRetainedContent This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retrieve GET /msdyn_segments(msdyn_segmentid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET /msdyn_segments
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess RevokeAccessRequest
RollbackRetain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
SetState PATCH /msdyn_segments(msdyn_segmentid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH /msdyn_segments(msdyn_segmentid)
See Update
UpdateRequest or
Update
UpdateMultiple UpdateMultiple UpdateMultipleRequest
ValidateRetentionConfig This message is to be executed only by Dataverse to trigger registered plug-ins and flows.

Properties

Property Value
CollectionSchemaName msdyn_segments
DisplayCollectionName Segments
DisplayName Segment
EntitySetName msdyn_segments
IsBPFEntity False
LogicalCollectionName msdyn_segments
LogicalName msdyn_segment
OwnershipType UserOwned
PrimaryIdAttribute msdyn_segmentid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_segment

Writable columns/attributes

These columns/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_description

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

msdyn_entityfieldname

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

msdyn_entityfilter

Property Value
Description
DisplayName Entity Filter
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_entityfilter
MaxLength 4000
RequiredLevel None
Type Memo

msdyn_isresegmentationenabled

Property Value
Description
DisplayName Enable resegmentation
IsValidForForm True
IsValidForRead True
LogicalName msdyn_isresegmentationenabled
RequiredLevel None
Type Boolean

msdyn_isresegmentationenabled Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

msdyn_isroutingenabledforresegmentation

Property Value
Description
DisplayName Enable resegmentation for routing activity
IsValidForForm True
IsValidForRead True
LogicalName msdyn_isroutingenabledforresegmentation
RequiredLevel None
Type Boolean

msdyn_isroutingenabledforresegmentation Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

msdyn_name

Property Value
Description The name of the segment.
DisplayName Segment name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_name
MaxLength 100
RequiredLevel ApplicationRequired
Type String

msdyn_objecttype

Property Value
Description The name of entity on which Segment is created.
DisplayName Record type
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_objecttype
MaxLength 1000
RequiredLevel None
Type String

msdyn_objecttypecode

Property Value
Description
DisplayName Record type
IsValidForForm True
IsValidForRead True
LogicalName msdyn_objecttypecode
RequiredLevel None
Type Picklist

msdyn_objecttypecode Choices/Options

Value Label Description
3 Opportunity
4 Lead
5 Other Entity

msdyn_segmentId

Property Value
Description Unique identifier for entity instances
DisplayName segment
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_segmentid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_sequence

Property Value
Description The sequence associated with the segment.
DisplayName Sequence
IsValidForForm True
IsValidForRead True
LogicalName msdyn_sequence
RequiredLevel None
Targets msdyn_sequence
Type Lookup

msdyn_triggertype

Property Value
Description
DisplayName TriggerType
IsValidForForm True
IsValidForRead True
LogicalName msdyn_triggertype
RequiredLevel None
Type Picklist

msdyn_triggertype Choices/Options

Value Label Description
0 Entity Create
1 FieldUpdate

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 segment
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive
2 Pause 3 Pause

statuscode

Property Value
Description Reason for the status of the segment
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
1 Active 0
2 Inactive 1
3 Pause 2

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 columns/attributes

These columns/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 Last modified
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_SequenceName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_sequencename
MaxLength 160
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 True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningBusinessUnitName

Added by: Active Solution Solution

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

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_segment_lead

Same as the msdyn_msdyn_segment_lead many-to-one relationship for the lead table/entity.

Property Value
ReferencingEntity lead
ReferencingAttribute msdyn_segmentid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_msdyn_segment_lead
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_msdyn_segment_opportunity

Same as the msdyn_msdyn_segment_opportunity many-to-one relationship for the opportunity table/entity.

Property Value
ReferencingEntity opportunity
ReferencingAttribute msdyn_segmentid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_msdyn_segment_opportunity
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_msdyn_segment_msdyn_saruninstance

Same as the msdyn_msdyn_segment_msdyn_saruninstance many-to-one relationship for the msdyn_saruninstance table/entity.

Property Value
ReferencingEntity msdyn_saruninstance
ReferencingAttribute msdyn_segmentid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_msdyn_segment_msdyn_saruninstance
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

msdyn_msdyn_segment_msdyn_assignmentrule_segment

Added by: Assignment Rules Solution

Same as the msdyn_msdyn_segment_msdyn_assignmentrule_segment many-to-one relationship for the msdyn_assignmentrule table/entity.

Property Value
ReferencingEntity msdyn_assignmentrule
ReferencingAttribute msdyn_segmentid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_msdyn_segment_msdyn_assignmentrule_segment
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_msdyn_segment_msdyn_salesroutingrun_segment

Added by: Assignment Rules Solution

Same as the msdyn_msdyn_segment_msdyn_salesroutingrun_segment many-to-one relationship for the msdyn_salesroutingrun table/entity.

Property Value
ReferencingEntity msdyn_salesroutingrun
ReferencingAttribute msdyn_segmentid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_msdyn_segment_msdyn_salesroutingrun_segment
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

See also

Dataverse table/entity reference
Web API Reference