Synapse Link External Table State (synapselinkexternaltablestate) table/entity reference

Synapse Link external table states

Messages

The following table lists the messages for the Synapse Link External Table State (synapselinkexternaltablestate) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?
Web API Operation SDK for .NET
Create
Event: True
POST /synapselinkexternaltablestates
See Create
Create records
CreateMultiple
Event: True
CreateMultiple CreateMultipleRequest
Delete
Event: True
DELETE /synapselinkexternaltablestates(synapselinkexternaltablestateid)
See Delete
Delete records
IsValidStateTransition
Event: False
IsValidStateTransition IsValidStateTransitionRequest
Retrieve
Event: True
GET /synapselinkexternaltablestates(synapselinkexternaltablestateid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: True
GET /synapselinkexternaltablestates
See Query data
Query data
SetState
Event: True
PATCH /synapselinkexternaltablestates(synapselinkexternaltablestateid)
Update the statecode and statuscode properties.
SetStateRequest
Update
Event: True
PATCH /synapselinkexternaltablestates(synapselinkexternaltablestateid)
See Update
Update records
UpdateMultiple
Event: True
UpdateMultiple UpdateMultipleRequest
Upsert
Event: False
PATCH /synapselinkexternaltablestates(synapselinkexternaltablestateid)
See Upsert a table row
UpsertRequest
UpsertMultiple
Event: False
UpsertMultiple UpsertMultipleRequest

Properties

The following table lists selected properties for the Synapse Link External Table State (synapselinkexternaltablestate) table.

Property Value
DisplayName Synapse Link External Table State
DisplayCollectionName Synapse Link External Table States
SchemaName synapselinkexternaltablestate
CollectionSchemaName synapselinkexternaltablestates
EntitySetName synapselinkexternaltablestates
LogicalName synapselinkexternaltablestate
LogicalCollectionName synapselinkexternaltablestates
PrimaryIdAttribute synapselinkexternaltablestateid
PrimaryNameAttribute name
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

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

datalakefolder

Property Value
Description Unique identifier for Data Lake Folder associated with Synapse Link External Table State.
DisplayName Data Lake Folder
IsValidForForm True
IsValidForRead True
LogicalName datalakefolder
RequiredLevel ApplicationRequired
Type Lookup
Targets datalakefolder

EntityName

Property Value
Description Name of the entity
DisplayName Entity Name
IsValidForForm True
IsValidForRead True
LogicalName entityname
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 64

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

LakehouseShortcutState

Property Value
Description State of lakehouse shortcut creation for an entity
DisplayName Lakehouse Shortcut State
IsValidForForm True
IsValidForRead True
LogicalName lakehouseshortcutstate
RequiredLevel None
Type Picklist
DefaultFormValue 0
GlobalChoiceName synapselinkexternaltablestate

LakehouseShortcutState Choices/Options

Value Label
0 Not Created
1 Created
2 Failed
3 Deleted
4 In Progress

LastSynchronizedOn

Property Value
Description Last SynchronizedOn Date time
DisplayName Last Synchronized On
IsValidForForm True
IsValidForRead True
LogicalName lastsynchronizedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior True
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Auto
SourceTypeMask 0

LastSyncState

Property Value
Description Last data synchronization state
DisplayName Last Synchronization State
IsValidForForm True
IsValidForRead True
LogicalName lastsyncstate
RequiredLevel None
Type Picklist
DefaultFormValue 0
GlobalChoiceName synapselinkexternaltablestate

LastSyncState Choices/Options

Value Label
0 Not Created
1 Created
2 Failed
3 Deleted
4 In Progress

MaxRecordVersion

Property Value
Description Maximum record version synchronized to the lake
DisplayName Maximum Record Version
IsValidForForm False
IsValidForRead True
LogicalName maxrecordversion
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

MetadataVersion

Property Value
Description Metadata version
DisplayName Metadata Version
IsValidForForm True
IsValidForRead True
LogicalName metadataversion
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 32

name

Property Value
Description The name of the custom entity.
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OverriddenCreatedOn

Property Value
Description Date and time that the record was migrated.
DisplayName Record Created On
IsValidForForm False
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

RecordCount

Property Value
Description Record count synchronized to lake
DisplayName Record Count
IsValidForForm False
IsValidForRead True
LogicalName recordcount
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

SchemaModifiedOn

Property Value
Description Schema modified on date-time
DisplayName Schema Modified On
IsValidForForm True
IsValidForRead True
LogicalName schemamodifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior True
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Auto
SourceTypeMask 0

statecode

Property Value
Description Status of the Synapse Link External Table State
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue
GlobalChoiceName synapselinkexternaltablestate_statecode

statecode Choices/Options

Value Details
0 Label: Active
DefaultStatus: 1
InvariantName: Active
1 Label: Inactive
DefaultStatus: 2
InvariantName: Inactive

statuscode

Property Value
Description Reason for the status of the Synapse Link External Table State
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue
GlobalChoiceName synapselinkexternaltablestate_statuscode

statuscode Choices/Options

Value Details
1 Label: Active
State:0
TransitionData: None
2 Label: Inactive
State:1
TransitionData: None

SynapseDatabaseName

Property Value
Description Synapse database name
DisplayName Synapse Database Name
IsValidForForm True
IsValidForRead True
LogicalName synapsedatabasename
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

synapselinkexternaltablestateId

Property Value
Description Unique identifier for entity instances
DisplayName Synapse Link External Table State
IsValidForForm False
IsValidForRead True
LogicalName synapselinkexternaltablestateid
RequiredLevel SystemRequired
Type Uniqueidentifier

SynapseWorkspaceName

Property Value
Description Synapse workspace name
DisplayName Synapse Workspace Name
IsValidForForm True
IsValidForRead True
LogicalName synapseworkspacename
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

TableState

Property Value
Description External table state
DisplayName Table State
IsValidForForm True
IsValidForRead True
LogicalName tablestate
RequiredLevel ApplicationRequired
Type Picklist
DefaultFormValue 0
GlobalChoiceName synapselinkexternaltablestate

TableState Choices/Options

Value Label
0 Not Created
1 Created
2 Failed
3 Deleted
4 In Progress

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

TrinoState

Property Value
Description State of Trino registration for an entity
DisplayName Trino State
IsValidForForm True
IsValidForRead True
LogicalName trinostate
RequiredLevel None
Type Picklist
DefaultFormValue 0
GlobalChoiceName synapselinkexternaltablestate

TrinoState Choices/Options

Value Label
0 Not Created
1 Created
2 Failed
3 Deleted
4 In Progress

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the record was created.
DisplayName Created On
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

CreatedOnBehalfBy

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
Type Lookup
Targets systemuser

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the record was modified.
DisplayName Modified On
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

ModifiedOnBehalfBy

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
Type Lookup
Targets systemuser

OrganizationId

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
Type Lookup
Targets organization

VersionNumber

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

lk_synapselinkexternaltablestate_createdby

One-To-Many Relationship: systemuser lk_synapselinkexternaltablestate_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_synapselinkexternaltablestate_createdonbehalfby

One-To-Many Relationship: systemuser lk_synapselinkexternaltablestate_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_synapselinkexternaltablestate_modifiedby

One-To-Many Relationship: systemuser lk_synapselinkexternaltablestate_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_synapselinkexternaltablestate_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_synapselinkexternaltablestate_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

organization_synapselinkexternaltablestate

One-To-Many Relationship: organization organization_synapselinkexternaltablestate

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organizationid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

synapselinkexternaltablestates

One-To-Many Relationship: datalakefolder synapselinkexternaltablestates

Property Value
ReferencedEntity datalakefolder
ReferencedAttribute datalakefolderid
ReferencingAttribute datalakefolder
ReferencingEntityNavigationPropertyName datalakefolder
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

synapselinkexternaltablestate_AsyncOperations

Many-To-One Relationship: asyncoperation synapselinkexternaltablestate_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName synapselinkexternaltablestate_AsyncOperations
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

synapselinkexternaltablestate_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure synapselinkexternaltablestate_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName synapselinkexternaltablestate_BulkDeleteFailures
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

synapselinkexternaltablestate_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord synapselinkexternaltablestate_DuplicateBaseRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
ReferencedEntityNavigationPropertyName synapselinkexternaltablestate_DuplicateBaseRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

synapselinkexternaltablestate_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord synapselinkexternaltablestate_DuplicateMatchingRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
ReferencedEntityNavigationPropertyName synapselinkexternaltablestate_DuplicateMatchingRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

synapselinkexternaltablestate_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder synapselinkexternaltablestate_MailboxTrackingFolders

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName synapselinkexternaltablestate_MailboxTrackingFolders
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

synapselinkexternaltablestate_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess synapselinkexternaltablestate_PrincipalObjectAttributeAccesses

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName synapselinkexternaltablestate_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

synapselinkexternaltablestate_ProcessSession

Many-To-One Relationship: processsession synapselinkexternaltablestate_ProcessSession

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName synapselinkexternaltablestate_ProcessSession
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

synapselinkexternaltablestate_SyncErrors

Many-To-One Relationship: syncerror synapselinkexternaltablestate_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName synapselinkexternaltablestate_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
synapselinkexternaltablestate