synapselinkschedule EntityType

Synapse link schedules

Entity Set Path
[organization URI]/api/data/v9.2/synapselinkschedules
Base Type
crmbaseentity
Display Name
Synapse Link Schedule
Primary Key
synapselinkscheduleid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
componentidunique Edm.Guid

For internal use only.

Display Name: Row id unique

Read Only
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
entityname Edm.String

Entity name, if schedule is entity specific

Display Name: Entity Name

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

iscustomizable BooleanManagedProperty

For internal use only.

Display Name: Is Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Values Label
1 Managed
0 Unmanaged
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

The name of the custom entity.

Display Name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
recurrenceinterval Edm.Int32

Recurrence interval

Display Name: Recurrence Interval

recurrenceunit Edm.Int32

Recurrence unit

Display Name: Recurrence Unit

Default Options
Values Label
0 None
1 Minute
2 Hour
3 Day
4 Week
5 Month
6 Year
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
starttime Edm.DateTimeOffset

Start time

Display Name: Start Time

statecode Edm.Int32

Status of the Synapse Link Schedule

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Synapse Link Schedule

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive
synapselinkscheduleid Edm.Guid

Unique identifier for entity instances

Display Name: Synapse Link Schedule

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

type Edm.Int32

Schedule type

Display Name: Type

Default Options
Values Label
0 Snapshot
1 IncrementalUpdate
uniquename Edm.String

Unique name

Display Name: Unique Name

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_organizationid_value organizationid

Unique identifier for the organization

_profile_value profile

Unique identifier for Synapse Link Profile associated with Synapse Link Schedule.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_synapselinkschedule_createdby
createdonbehalfby systemuser lk_synapselinkschedule_createdonbehalfby
modifiedby systemuser lk_synapselinkschedule_modifiedby
modifiedonbehalfby systemuser lk_synapselinkschedule_modifiedonbehalfby
organizationid organization organization_synapselinkschedule
profile synapselinkprofile profileschedules

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
synapselinkschedule_AsyncOperations asyncoperation regardingobjectid_synapselinkschedule
synapselinkschedule_BulkDeleteFailures bulkdeletefailure regardingobjectid_synapselinkschedule
synapselinkschedule_DuplicateBaseRecord duplicaterecord baserecordid_synapselinkschedule
synapselinkschedule_DuplicateMatchingRecord duplicaterecord duplicaterecordid_synapselinkschedule
synapselinkschedule_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_synapselinkschedule
synapselinkschedule_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_synapselinkschedule
synapselinkschedule_ProcessSession processsession regardingobjectid_synapselinkschedule
synapselinkschedule_SyncErrors syncerror regardingobjectid_synapselinkschedule

Operations

The following operations can be used with the synapselinkschedule entity type.

Name Binding
CreateMultiple Not Bound
IsValidStateTransition Not Bound
UpdateMultiple Not Bound

See also