Share via


kbarticle EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Structured content that is part of the knowledge base.

Entity Set path:[organization URI]/api/data/v8.2/kbarticles

Base Type: crmbaseentity EntityType

Display Name: Article

Primary Key: kbarticleid

Primary Name Attribute: title

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to kbarticle

Operations using the kbarticle entity type.

Properties

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

Name

Type

Details

articlexml

Edm.String

Description: Shows the article content and formatting, stored as XML.

Display Name: Article XML

comments

Edm.String

Description: Comments regarding the knowledge base article.

Display Name: Comments

content

Edm.String

Description: Description of the content of the knowledge base article.

Display Name: Content

Read-only property

createdon

Edm.DateTimeOffset

Description: Date and time when the knowledge base article was created.

Display Name: Created On

Read-only property

description

Edm.String

Description: Type additional information that describes the knowledge base article.

Display Name: Description

entityimage

Edm.Binary

Description: The default image for the entity.

Display Name: Entity Image

entityimage_timestamp

Edm.Int64

Description:

Read-only property

entityimage_url

Edm.String

Description:

Read-only property

entityimageid

Edm.Guid

Description: For internal use only.

Display Name: Entity Image Id

Read-only property

exchangerate

Edm.Decimal

Description: Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.

Display Name: Exchange Rate

Read-only property

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

kbarticleid

Edm.Guid

Description: Shows the ID of the article.

Display Name: Article

keywords

Edm.String

Description: Keywords to be used for searches in knowledge base articles.

Display Name: Key Words

languagecode

Edm.Int32

Description: Select which language the article must be available in. This list is based on the list of language packs that are installed in your Microsoft Dynamics 365 environment.

Display Name: Language

modifiedon

Edm.DateTimeOffset

Description: Date and time when the knowledge base article was last modified.

Display Name: Modified On

Read-only property

number

Edm.String

Description: Knowledge base article number.

Display Name: Number

Read-only property

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

statecode

Edm.Int32

Description: Shows whether the knowledge base article is in draft, unapproved, or published status. Published articles are read-only and can't be edited unless they are unpublished.

Default Options:

1 : Draft
2 : Unapproved
3 : Published

Display Name: Status

statuscode

Edm.Int32

Description: Select the article's status.

Default Options:

1 : Draft
2 : Unapproved
3 : Published

Display Name: Status Reason

title

Edm.String

Description: Type a subject or descriptive name for the article to assist with article searches.

Display Name: Title

versionnumber

Edm.Int64

Description: Title of the knowledge base article.

Display Name: Title

Read-only property

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 Retrieve data about lookup properties

Name

Single-valued navigation property

Description

_createdby_value

createdby

Unique identifier of the user who created the knowledge base article.

_createdonbehalfby_value

createdonbehalfby

Unique identifier of the delegate user who created the article.

_kbarticletemplateid_value

kbarticletemplateid

Choose the template that you want to use as a base for creating the new article.

_modifiedby_value

modifiedby

Unique identifier of the user who last modified the knowledge base article.

_modifiedonbehalfby_value

modifiedonbehalfby

Unique identifier of the delegate user who last modified the kbarticle.

_organizationid_value

organizationid

Unique identifier of the organization associated with the article.

_subjectid_value

subjectid

Choose the subject of the article to assist with article searches. You can configure subjects under Business Management in the Settings area.

_transactioncurrencyid_value

transactioncurrencyid

Choose the local currency for the record to make sure budgets are reported in the correct currency.

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 EntityType

lk_kbarticlebase_createdby

createdonbehalfby

systemuser EntityType

lk_kbarticle_createdonbehalfby

kbarticletemplateid

kbarticletemplate EntityType

kb_article_template_kb_articles

modifiedby

systemuser EntityType

lk_kbarticlebase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_kbarticle_modifiedonbehalfby

organizationid

organization EntityType

organization_kb_articles

subjectid

subject EntityType

subject_kb_articles

transactioncurrencyid

transactioncurrency EntityType

TransactionCurrency_KbArticle

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

KbArticle_Annotation

annotation EntityType

objectid_kbarticle

KbArticle_AsyncOperations

asyncoperation EntityType

regardingobjectid_kbarticle

KbArticle_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_kbarticle

kbarticle_comments

kbarticlecomment EntityType

kbarticleid

KbArticle_DuplicateBaseRecord

duplicaterecord EntityType

baserecordid_kbarticle

KbArticle_DuplicateMatchingRecord

duplicaterecord EntityType

duplicaterecordid_kbarticle

kbarticle_incidents

incident EntityType

kbarticleid

KbArticle_SharepointDocumentLocation

sharepointdocumentlocation EntityType

regardingobjectid_kbarticle

KbArticle_SyncErrors

syncerror EntityType

regardingobjectid_kbarticle_syncerror

Operations bound to kbarticle

The following operations are bound to the kbarticle entity type.

Name

Bound to

SearchByBodyKbArticle Function

Collection

SearchByKeywordsKbArticle Function

Collection

SearchByTitleKbArticle Function

Collection

Operations using the kbarticle entity type.

The following operations use the kbarticle entity type in a parameter or return type.

Name

How used

Description

RetrieveByTopIncidentProductKbArticle Function

ReturnType

Retrieves the top-ten articles about a specified product from the knowledge base of articles for the organization

RetrieveByTopIncidentSubjectKbArticle Function

ReturnType

Retrieves the top-ten articles about a specified subject from the knowledge base of articles for your organization.

SearchByBodyKbArticle Function

entityset Parameter

Searches for knowledge base articles that contain the specified body text.

SearchByBodyKbArticle Function

ReturnType

Searches for knowledge base articles that contain the specified body text.

SearchByKeywordsKbArticle Function

entityset Parameter

Searches for knowledge base articles that contain the specified keywords.

SearchByKeywordsKbArticle Function

ReturnType

Searches for knowledge base articles that contain the specified keywords.

SearchByTitleKbArticle Function

entityset Parameter

Searches for knowledge base articles that contain the specified title.

SearchByTitleKbArticle Function

ReturnType

Searches for knowledge base articles that contain the specified title.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright