msdyn_knowledgeharvestplan EntityType
Stores configuration settings for knowledge harvesting per source entity.
- Entity set path:
- [organization URI]/api/data/v9.2/msdyn_knowledgeharvestplans
- Base type:
- crmbaseentity
- Display name:
- Knowledge Harvest Plan
- Primary key:
- msdyn_knowledgeharvestplanid
- Primary name column:
- msdyn_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
|
||||||||||||||||||
| 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 last modified. Display name: Modified On Read only
|
||||||||||||||||||
| msdyn_additionaldetails | Edm.String |
Display name: Additional details |
||||||||||||||||||
| msdyn_backfillfromoption | Edm.Int32 |
Time range for backfilling records when the harvest plan starts. Display name: Backfill From Option
Default options
|
||||||||||||||||||
| msdyn_conditions | Edm.String |
JSON-serialized KnowledgeHarvestConditionsSetting containing condition expressions and FetchXML filters. Display name: Conditions |
||||||||||||||||||
| msdyn_fieldmappings | Edm.String |
JSON-serialized field mapping configuration that maps source entity fields to knowledge article fields. Display name: Field Mappings |
||||||||||||||||||
| msdyn_frequencytype | Edm.Int32 |
Defines the schedule type for harvesting: Realtime, Once, or Recurring. Display name: Frequency Type
Default options
|
||||||||||||||||||
| msdyn_harvesteligibilityconditionid | Edm.Guid |
Reference to the harvest eligibility condition for this plan. Display name: Harvest Eligibility Condition |
||||||||||||||||||
| msdyn_harvestingdatatype | Edm.Int32 |
Indicates what type of entity this harvest plan is harvesting from Display name: harvestingdatatype
Default options
|
||||||||||||||||||
| msdyn_harvestsourceentity | Edm.String |
Display name: Knowledge Harvest Source Entity |
||||||||||||||||||
| msdyn_harvesttype | Edm.String |
Defines the schedule types for harvesting. Multiple values can be combined (for example Realtime + Once, or Recurring + Once). Display name: Harvest Type
Default options
|
||||||||||||||||||
| msdyn_isautopublishenabled | Edm.Boolean |
Indicates whether harvested articles are automatically published without manual review. Display name: Is Auto Publish Enabled
Default options
|
||||||||||||||||||
| msdyn_isinternal | Edm.Boolean |
Indicates whether harvested articles are marked as internal. Display name: Is Internal
Default options
|
||||||||||||||||||
| msdyn_isupdatekbarticleenabled | Edm.Boolean |
Indicates whether existing knowledge articles can be updated (versioned) during harvesting. Display name: Is Update KB Article Enabled
Default options
|
||||||||||||||||||
| msdyn_keeprunningoption | Edm.Int32 |
Ongoing execution behavior for the harvest plan. Display name: Keep Running Option
Default options
|
||||||||||||||||||
| msdyn_knowledgearticletemplateid | Edm.Guid |
Reference to the knowledge article template used for harvesting. Display name: Knowledge Article Template |
||||||||||||||||||
| msdyn_knowledgeharvestplanid | Edm.Guid |
Unique identifier for entity instances Display name: Knowledge Harvest Plan Id |
||||||||||||||||||
| msdyn_lastruntime | Edm.DateTimeOffset |
Display name: Last Run Time |
||||||||||||||||||
| msdyn_localizationlanguagecode | Edm.String |
language code used for harvested knowledge articles (e.g. en-US). Display name: Localization Language Code |
||||||||||||||||||
| msdyn_name | Edm.String |
Name of the harvest plan. Display name: Name |
||||||||||||||||||
| msdyn_nextruntime | Edm.DateTimeOffset |
Display name: Next Run Time |
||||||||||||||||||
| msdyn_priorityorder | Edm.Int32 |
Display name: Priority Order |
||||||||||||||||||
| msdyn_recurringtype | Edm.Int32 |
Defines the recurring schedule pattern: Daily, Weekly, Bi-weekly, or Monthly. Display name: Recurring Type
Default options
|
||||||||||||||||||
| msdyn_versioning | Edm.String |
Version identifier for tracking customer edits to this harvest plan. Display name: Versioning |
||||||||||||||||||
| 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 |
Display name: Status
Default options
|
||||||||||||||||||
| statuscode | Edm.Int32 |
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 last 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_knowledgeharvestplan_createdby |
| createdonbehalfby | systemuser | lk_msdyn_knowledgeharvestplan_createdonbehalfby |
| modifiedby | systemuser | lk_msdyn_knowledgeharvestplan_modifiedby |
| modifiedonbehalfby | systemuser | lk_msdyn_knowledgeharvestplan_modifiedonbehalfby |
| ownerid | principal | owner_msdyn_knowledgeharvestplan |
| owningbusinessunit | businessunit | business_unit_msdyn_knowledgeharvestplan |
| owningteam | team | team_msdyn_knowledgeharvestplan |
| owninguser | systemuser | user_msdyn_knowledgeharvestplan |
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_knowledgeharvestplan_AsyncOperations | asyncoperation | regardingobjectid_msdyn_knowledgeharvestplan |
| msdyn_knowledgeharvestplan_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_msdyn_knowledgeharvestplan |
| msdyn_knowledgeharvestplan_historicalcaseharvestrun | msdyn_historicalcaseharvestrun | msdyn_knowledgeharvestplanid |
| msdyn_knowledgeharvestplan_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_msdyn_knowledgeharvestplan |
| msdyn_knowledgeharvestplan_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_msdyn_knowledgeharvestplan |
| msdyn_knowledgeharvestplan_ProcessSession | processsession | regardingobjectid_msdyn_knowledgeharvestplan |
| msdyn_knowledgeharvestplan_SyncErrors | syncerror | regardingobjectid_msdyn_knowledgeharvestplan |
Operations
The following operations can be used with the msdyn_knowledgeharvestplan entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| DeleteMultiple | 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 |