kbarticletemplate EntityType
Template for a knowledge base article that contains the standard attributes of an article.
- Entity set path:
- [organization URI]/api/data/v9.2/kbarticletemplates
- Base type:
- crmbaseentity
- Display name:
- Article Template
- Primary key:
- kbarticletemplateid
- Primary name column:
- title
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| componentstate | Edm.Int32 |
For internal use only. Display name: Component State Read only
Default options
|
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the knowledge base article template was created. Display name: Created On Read only
|
||||||||||
| description | Edm.String |
Description of the knowledge base article template. Display name: Description |
||||||||||
| formatxml | Edm.String |
XML format of the knowledge base article template. Display name: Format XML |
||||||||||
| importsequencenumber | Edm.Int32 |
Unique identifier of the data import or data migration that created this record. Display name: Import Sequence Number |
||||||||||
| introducedversion | Edm.String |
Version in which the form is introduced. Display name: Introduced Version |
||||||||||
| isactive | Edm.Boolean |
Information about whether the knowledge base article is active. Display name: Status
Default options
|
||||||||||
| iscustomizable | BooleanManagedProperty |
Information that specifies whether this component can be customized. Display name: Customizable |
||||||||||
| ismanaged | Edm.Boolean |
Read only
Default options
|
||||||||||
| kbarticletemplateid | Edm.Guid |
Unique identifier of the knowledge base article template. Display name: Article Template |
||||||||||
| kbarticletemplateidunique | Edm.Guid |
For internal use only. Read only
|
||||||||||
| languagecode | Edm.Int32 |
Language of the Article Template Display name: Language |
||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the knowledge base article template was last modified. Display name: Modified On Read only
|
||||||||||
| 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
|
||||||||||
| structurexml | Edm.String |
XML structure of the knowledge base article. Display name: Structure XML |
||||||||||
| title | Edm.String |
Title of the knowledge base article template. Display name: Title |
||||||||||
| versionnumber | Edm.Int64 |
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 knowledge base article template. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the kbarticletemplate. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who last modified the knowledge base article template. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who last modified the kbarticletemplate. |
| _organizationid_value | organizationid |
Unique identifier of the organization associated with the template. |
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_kbarticletemplatebase_createdby |
| createdonbehalfby | systemuser | lk_kbarticletemplate_createdonbehalfby |
| modifiedby | systemuser | lk_kbarticletemplatebase_modifiedby |
| modifiedonbehalfby | systemuser | lk_kbarticletemplate_modifiedonbehalfby |
| organizationid | organization | organization_kb_article_templates |
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 |
|---|---|---|
| kb_article_template_kb_articles | kbarticle | kbarticletemplateid |
| KbArticleTemplate_AsyncOperations | asyncoperation | regardingobjectid_kbarticletemplate |
| KbArticleTemplate_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_kbarticletemplate |
| KbArticleTemplate_ProcessSessions | processsession | regardingobjectid_kbarticletemplate |
| KbArticleTemplate_SyncErrors | syncerror | regardingobjectid_kbarticletemplate_syncerror |