msdyn_schedule EntityType
Generic refresh schedule
- Entity Set Path
- [organization URI]/api/data/v9.2/msdyn_schedules
- Base Type
- crmbaseentity
- Display Name
- Schedule
- Primary Key
- msdyn_scheduleid
- Primary Key Attribute
- msdyn_schedule
- 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
|
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display Name: Created On Read Only
|
||||||||||
| 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
|
||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display Name: Modified On Read Only
|
||||||||||
| msdyn_callbackurl | Edm.String |
Callback Url Display Name: Callback Url |
||||||||||
| msdyn_isactive | Edm.Boolean |
IsActive option set Display Name: IsActive
Default Options
|
||||||||||
| msdyn_nextrefreshtime | Edm.DateTimeOffset |
Next expected refresh time Display Name: NextRefreshTime |
||||||||||
| msdyn_refentityname | Edm.String |
Reference name of consuming entity Display Name: Reference Entity Name |
||||||||||
| msdyn_referenceid | Edm.Guid |
Reference id of consuming entity Display Name: Reference Entity Id |
||||||||||
| msdyn_refreshpayload | Edm.String |
Refresh payload Display Name: Refresh payload |
||||||||||
| msdyn_refreshperiod | Edm.String |
Refresh period for interval based Display Name: RefreshPeriod |
||||||||||
| msdyn_schedule | Edm.String |
Schedule Display Name: Schedule |
||||||||||
| msdyn_scheduledisabledreason | Edm.String |
Schedule Refresh disabled reason if any Display Name: Schedule disabled reason |
||||||||||
| msdyn_scheduleid | Edm.Guid |
Unique identifier for entity instances Display Name: Schedule |
||||||||||
| msdyn_schedulerefreshtype | Edm.Int32 |
Dataflow schedule refresh type Display Name: ScheduleRefreshType
Default Options
|
||||||||||
| msdyn_startdatetime | Edm.DateTimeOffset |
Initial start date time Display Name: StartDateTime |
||||||||||
| msdyn_timebasedrefreshperiod | Edm.String |
Refresh period for time based. Display Name: TimeBasedRefreshPeriod |
||||||||||
| msdyn_timezoneid | Edm.String |
Dataflow Time zone id Display Name: TimeZoneId |
||||||||||
| 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
|
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display Name: Solution Read Only
|
||||||||||
| statecode | Edm.Int32 |
Status of the Schedule Display Name: Status
Default Options
|
||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Schedule Display Name: Status Reason
Default Options
|
||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number |
||||||||||
| 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. |
| _ownerid_value | ownerid |
Owner Id |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier for the business unit that owns the record |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
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_msdyn_schedule_createdby |
| createdonbehalfby | systemuser | lk_msdyn_schedule_createdonbehalfby |
| modifiedby | systemuser | lk_msdyn_schedule_modifiedby |
| modifiedonbehalfby | systemuser | lk_msdyn_schedule_modifiedonbehalfby |
| msdyn_scheduleidref | msdyn_dataflow | msdyn_dataflow_dataflowschedule |
| ownerid | principal | owner_msdyn_schedule |
| owningbusinessunit | businessunit | business_unit_msdyn_schedule |
| owningteam | team | team_msdyn_schedule |
| owninguser | systemuser | user_msdyn_schedule |
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 |
|---|---|---|
| msdyn_schedule_AsyncOperations | asyncoperation | regardingobjectid_msdyn_schedule |
| msdyn_schedule_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_msdyn_schedule |
| msdyn_schedule_DuplicateBaseRecord | duplicaterecord | baserecordid_msdyn_schedule |
| msdyn_schedule_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_msdyn_schedule |
| msdyn_schedule_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_msdyn_schedule |
| msdyn_schedule_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_msdyn_schedule |
| msdyn_schedule_ProcessSession | processsession | regardingobjectid_msdyn_schedule |
| msdyn_schedule_SyncErrors | syncerror | regardingobjectid_msdyn_schedule |
Operations
The following operations can be used with the msdyn_schedule entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| PurgeRetainedContent | Not Bound |
| Retain | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |