Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Synapse link schedules
Messages
The following table lists the messages for the Synapse Link Schedule (synapselinkschedule) 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 |
|---|---|---|
AssociateEvent: True |
Associate records | Associate records |
CreateEvent: True |
POST /synapselinkschedulesSee Create |
Create records |
CreateMultipleEvent: True |
CreateMultiple | CreateMultipleRequest |
DeleteEvent: True |
DELETE /synapselinkschedules(synapselinkscheduleid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
IsValidStateTransitionEvent: False |
IsValidStateTransition | IsValidStateTransitionRequest |
RetrieveEvent: True |
GET /synapselinkschedules(synapselinkscheduleid)See Retrieve |
Retrieve records |
RetrieveMultipleEvent: True |
GET /synapselinkschedulesSee Query data |
Query data |
SetStateEvent: True |
PATCH /synapselinkschedules(synapselinkscheduleid)Update the statecode and statuscode properties. |
SetStateRequest |
UpdateEvent: True |
PATCH /synapselinkschedules(synapselinkscheduleid)See Update |
Update records |
UpdateMultipleEvent: True |
UpdateMultiple | UpdateMultipleRequest |
UpsertEvent: False |
PATCH /synapselinkschedules(synapselinkscheduleid)See Upsert a table row |
UpsertRequest |
UpsertMultipleEvent: False |
UpsertMultiple | UpsertMultipleRequest |
Properties
The following table lists selected properties for the Synapse Link Schedule (synapselinkschedule) table.
| Property | Value |
|---|---|
| DisplayName | Synapse Link Schedule |
| DisplayCollectionName | Synapse Link Schedules |
| SchemaName | synapselinkschedule |
| CollectionSchemaName | synapselinkschedules |
| EntitySetName | synapselinkschedules |
| LogicalName | synapselinkschedule |
| LogicalCollectionName | synapselinkschedules |
| PrimaryIdAttribute | synapselinkscheduleid |
| PrimaryNameAttribute | name |
| TableType | Standard |
| OwnershipType | OrganizationOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- EntityName
- ImportSequenceNumber
- IsCustomizable
- name
- OverriddenCreatedOn
- profile
- RecurrenceInterval
- RecurrenceUnit
- StartTime
- statecode
- statuscode
- synapselinkscheduleId
- TimeZoneRuleVersionNumber
- Type
- UniqueName
- UTCConversionTimeZoneCode
EntityName
| Property | Value |
|---|---|
| Description | Entity name, if schedule is entity specific |
| DisplayName | Entity Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | entityname |
| RequiredLevel | None |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
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 |
IsCustomizable
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Is Customizable |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | iscustomizable |
| RequiredLevel | SystemRequired |
| Type | ManagedProperty |
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 |
profile
| Property | Value |
|---|---|
| Description | Unique identifier for Synapse Link Profile associated with Synapse Link Schedule. |
| DisplayName | Profile |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | profile |
| RequiredLevel | SystemRequired |
| Type | Lookup |
| Targets | synapselinkprofile |
RecurrenceInterval
| Property | Value |
|---|---|
| Description | Recurrence interval |
| DisplayName | Recurrence Interval |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | recurrenceinterval |
| RequiredLevel | ApplicationRequired |
| Type | Integer |
| MaxValue | 999999 |
| MinValue | 0 |
RecurrenceUnit
| Property | Value |
|---|---|
| Description | Recurrence unit |
| DisplayName | Recurrence Unit |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | recurrenceunit |
| RequiredLevel | ApplicationRequired |
| Type | Picklist |
| DefaultFormValue | -1 |
| GlobalChoiceName | synapselinkschedulerecurrenceunit |
RecurrenceUnit Choices/Options
| Value | Label |
|---|---|
| 0 | None |
| 1 | Minute |
| 2 | Hour |
| 3 | Day |
| 4 | Week |
| 5 | Month |
| 6 | Year |
StartTime
| Property | Value |
|---|---|
| Description | Start time |
| DisplayName | Start Time |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | starttime |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | True |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Auto |
| SourceTypeMask | 0 |
statecode
| Property | Value |
|---|---|
| Description | Status of the Synapse Link Schedule |
| DisplayName | Status |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
| DefaultFormValue | |
| GlobalChoiceName | synapselinkschedule_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 Schedule |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
| DefaultFormValue | |
| GlobalChoiceName | synapselinkschedule_statuscode |
statuscode Choices/Options
| Value | Details |
|---|---|
| 1 | Label: Active State:0 TransitionData: None |
| 2 | Label: Inactive State:1 TransitionData: None |
synapselinkscheduleId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | Synapse Link Schedule |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | synapselinkscheduleid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
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 |
Type
| Property | Value |
|---|---|
| Description | Schedule type |
| DisplayName | Type |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | type |
| RequiredLevel | SystemRequired |
| Type | Picklist |
| DefaultFormValue | -1 |
| GlobalChoiceName | synapselinkscheduletype |
Type Choices/Options
| Value | Label |
|---|---|
| 0 | Snapshot |
| 1 | IncrementalUpdate |
UniqueName
| Property | Value |
|---|---|
| Description | Unique name |
| DisplayName | Unique Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | uniquename |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
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.
- ComponentIdUnique
- ComponentState
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OrganizationId
- OverwriteTime
- SolutionId
- SupportingSolutionId
- VersionNumber
ComponentIdUnique
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Row id unique |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ComponentState
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
| DefaultFormValue | |
| GlobalChoiceName | componentstate |
ComponentState Choices/Options
| Value | Label |
|---|---|
| 0 | Published |
| 1 | Unpublished |
| 2 | Deleted |
| 3 | Deleted Unpublished |
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 |
IsManaged
| Property | Value |
|---|---|
| Description | Indicates whether the solution component is part of a managed solution. |
| DisplayName | Is Managed |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ismanaged |
| RequiredLevel | SystemRequired |
| Type | Boolean |
| GlobalChoiceName | ismanaged |
| DefaultValue | False |
| True Label | Managed |
| False Label | Unmanaged |
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 |
OverwriteTime
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
SolutionId
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SupportingSolutionId
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | False |
| LogicalName | supportingsolutionid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
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_synapselinkschedule_createdby
- lk_synapselinkschedule_createdonbehalfby
- lk_synapselinkschedule_modifiedby
- lk_synapselinkschedule_modifiedonbehalfby
- organization_synapselinkschedule
- profileschedules
lk_synapselinkschedule_createdby
One-To-Many Relationship: systemuser lk_synapselinkschedule_createdby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdby |
| ReferencingEntityNavigationPropertyName | createdby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_synapselinkschedule_createdonbehalfby
One-To-Many Relationship: systemuser lk_synapselinkschedule_createdonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | createdonbehalfby |
| ReferencingEntityNavigationPropertyName | createdonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_synapselinkschedule_modifiedby
One-To-Many Relationship: systemuser lk_synapselinkschedule_modifiedby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedby |
| ReferencingEntityNavigationPropertyName | modifiedby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
lk_synapselinkschedule_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_synapselinkschedule_modifiedonbehalfby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | modifiedonbehalfby |
| ReferencingEntityNavigationPropertyName | modifiedonbehalfby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
organization_synapselinkschedule
One-To-Many Relationship: organization organization_synapselinkschedule
| Property | Value |
|---|---|
| ReferencedEntity | organization |
| ReferencedAttribute | organizationid |
| ReferencingAttribute | organizationid |
| ReferencingEntityNavigationPropertyName | organizationid |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
profileschedules
One-To-Many Relationship: synapselinkprofile profileschedules
| Property | Value |
|---|---|
| ReferencedEntity | synapselinkprofile |
| ReferencedAttribute | synapselinkprofileid |
| ReferencingAttribute | profile |
| ReferencingEntityNavigationPropertyName | profile |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: CascadeDelete: CascadeMerge: NoCascadeReparent: CascadeRollupView: NoCascadeShare: CascadeUnshare: Cascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
- synapselinkschedule_AsyncOperations
- synapselinkschedule_BulkDeleteFailures
- synapselinkschedule_DuplicateBaseRecord
- synapselinkschedule_DuplicateMatchingRecord
- synapselinkschedule_MailboxTrackingFolders
- synapselinkschedule_PrincipalObjectAttributeAccesses
- synapselinkschedule_ProcessSession
- synapselinkschedule_SyncErrors
synapselinkschedule_AsyncOperations
Many-To-One Relationship: asyncoperation synapselinkschedule_AsyncOperations
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | synapselinkschedule_AsyncOperations |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
synapselinkschedule_BulkDeleteFailures
Many-To-One Relationship: bulkdeletefailure synapselinkschedule_BulkDeleteFailures
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | synapselinkschedule_BulkDeleteFailures |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
synapselinkschedule_DuplicateBaseRecord
Many-To-One Relationship: duplicaterecord synapselinkschedule_DuplicateBaseRecord
| Property | Value |
|---|---|
| ReferencingEntity | duplicaterecord |
| ReferencingAttribute | baserecordid |
| ReferencedEntityNavigationPropertyName | synapselinkschedule_DuplicateBaseRecord |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
synapselinkschedule_DuplicateMatchingRecord
Many-To-One Relationship: duplicaterecord synapselinkschedule_DuplicateMatchingRecord
| Property | Value |
|---|---|
| ReferencingEntity | duplicaterecord |
| ReferencingAttribute | duplicaterecordid |
| ReferencedEntityNavigationPropertyName | synapselinkschedule_DuplicateMatchingRecord |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
synapselinkschedule_MailboxTrackingFolders
Many-To-One Relationship: mailboxtrackingfolder synapselinkschedule_MailboxTrackingFolders
| Property | Value |
|---|---|
| ReferencingEntity | mailboxtrackingfolder |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | synapselinkschedule_MailboxTrackingFolders |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
synapselinkschedule_PrincipalObjectAttributeAccesses
Many-To-One Relationship: principalobjectattributeaccess synapselinkschedule_PrincipalObjectAttributeAccesses
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| ReferencedEntityNavigationPropertyName | synapselinkschedule_PrincipalObjectAttributeAccesses |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
synapselinkschedule_ProcessSession
Many-To-One Relationship: processsession synapselinkschedule_ProcessSession
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | synapselinkschedule_ProcessSession |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
synapselinkschedule_SyncErrors
Many-To-One Relationship: syncerror synapselinkschedule_SyncErrors
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| ReferencedEntityNavigationPropertyName | synapselinkschedule_SyncErrors |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference
synapselinkschedule