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.
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.
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.
Shows the ID of the article.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Article
description
Shows the ID of the article.
isPrimaryKey
true
dataFormat
guid
sourceName
kbarticleid
Traits
List of traits for the kbArticleId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.identifiedBy
names a specifc identity attribute to use with an entity
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"systemrequired"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Article
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Shows the ID of the article.
entity
a reference to the constant entity holding the list of localized text
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"kbarticleid"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Choose the template that you want to use as a base for creating the new article.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Base Template
description
Choose the template that you want to use as a base for creating the new article.
dataFormat
guid
sourceName
kbarticletemplateid
Traits
List of traits for the kbArticleTemplateId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"systemrequired"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Base Template
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Choose the template that you want to use as a base for creating the new article.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Unique identifier of the organization associated with the article.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Organization
description
Unique identifier of the organization associated with the article.
dataFormat
guid
sourceName
organizationid
Traits
List of traits for the organizationId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"systemrequired"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Organization
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier of the organization associated with the article.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Choose the subject of the article to assist with article searches. You can configure subjects under Business Management in the Settings area.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Subject
description
Choose the subject of the article to assist with article searches. You can configure subjects under Business Management in the Settings area.
dataFormat
guid
sourceName
subjectid
Traits
List of traits for the subjectId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"subject"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"systemrequired"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Subject
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Choose the subject of the article to assist with article searches. You can configure subjects under Business Management in the Settings area.
entity
a reference to the constant entity holding the list of localized text
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"subjectid"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Shows the article content and formatting, stored as XML.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Article XML
description
Shows the article content and formatting, stored as XML.
dataFormat
string
maximumLength
1073741823
isNullable
true
sourceName
articlexml
Traits
List of traits for the articleXml attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Article XML
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Shows the article content and formatting, stored as XML.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"articlexml"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter
Value
Data type
Explanation
ordinal
"5"
integer
is.constrained
maximum length or value constraints
Type a subject or descriptive name for the article to assist with article searches.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Title
description
Type a subject or descriptive name for the article to assist with article searches.
dataFormat
string
maximumLength
500
isNullable
true
sourceName
title
Traits
List of traits for the title attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"required"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Title
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Type a subject or descriptive name for the article to assist with article searches.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"title"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter
Value
Data type
Explanation
ordinal
"7"
integer
is.constrained
maximum length or value constraints
Knowledge base article number.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Number
description
Knowledge base article number.
dataFormat
string
maximumLength
100
isNullable
true
sourceName
number
Traits
List of traits for the number attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Number
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Knowledge base article number.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"number"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter
Value
Data type
Explanation
ordinal
"8"
integer
is.constrained
maximum length or value constraints
Description of the content of the knowledge base article.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Content
description
Description of the content of the knowledge base article.
dataFormat
string
maximumLength
1073741823
isNullable
true
sourceName
content
Traits
List of traits for the content attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Content
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Description of the content of the knowledge base article.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"content"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter
Value
Data type
Explanation
ordinal
"9"
integer
is.constrained
maximum length or value constraints
Type additional information that describes the knowledge base article.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Description
description
Type additional information that describes the knowledge base article.
dataFormat
string
maximumLength
2000
isNullable
true
sourceName
description
Traits
List of traits for the description attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Description
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Type additional information that describes the knowledge base article.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"description"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter
Value
Data type
Explanation
ordinal
"10"
integer
is.constrained
maximum length or value constraints
Comments regarding the knowledge base article.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Comments
description
Comments regarding the knowledge base article.
dataFormat
string
maximumLength
100000
isNullable
true
sourceName
comments
Traits
List of traits for the comments attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Comments
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Comments regarding the knowledge base article.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"comments"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter
Value
Data type
Explanation
ordinal
"11"
integer
is.constrained
maximum length or value constraints
Date and time when the knowledge base article was created.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Created On
description
Date and time when the knowledge base article was created.
dataFormat
dateTime
isNullable
true
sourceName
createdon
Traits
List of traits for the createdOn attribute are listed below.
is.dataFormat.date means.measurement.date is.dataFormat.time means.measurement.time means.measurement.date.creation is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Created On
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Date and time when the knowledge base article was created.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"createdon"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Unique identifier of the user who created the knowledge base article.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Created By
description
Unique identifier of the user who created the knowledge base article.
dataFormat
guid
isNullable
true
sourceName
createdby
Traits
List of traits for the createdBy attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Created By
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier of the user who created the knowledge base article.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Unique identifier of the user who last modified the knowledge base article.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Modified By
description
Unique identifier of the user who last modified the knowledge base article.
dataFormat
guid
isNullable
true
sourceName
modifiedby
Traits
List of traits for the modifiedBy attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Modified By
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier of the user who last modified the knowledge base article.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Date and time when the knowledge base article was last modified.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Modified On
description
Date and time when the knowledge base article was last modified.
dataFormat
dateTime
isNullable
true
sourceName
modifiedon
Traits
List of traits for the modifiedOn attribute are listed below.
is.dataFormat.date means.measurement.date is.dataFormat.time means.measurement.time means.measurement.date.modify is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Modified On
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Date and time when the knowledge base article was last modified.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"modifiedon"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
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.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Status
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.
dataFormat
int32
sourceName
statecode
valueConstrainedToList
true
defaultValue
languageTag
displayText
attributeValue
en
Draft
1
en
Unapproved
2
en
Published
3
Traits
List of traits for the stateCode attribute are listed below.
is.dataFormat.integer does.haveDefault
An attribute has a default value
Parameter
Value
Data type
Explanation
default
languageTag
displayText
attributeValue
en
Draft
1
en
Unapproved
2
en
Published
3
any
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
means.entityState
the attribute represents the current state of the entity.
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"systemrequired"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Status
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
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.
entity
a reference to the constant entity holding the list of localized text
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"statecode"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Select the article's status.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Status Reason
description
Select the article's status.
dataFormat
int32
isNullable
true
sourceName
statuscode
defaultValue
languageTag
displayText
attributeValue
correlatedValue
en
Draft
1
1
en
Unapproved
2
2
en
Published
3
3
Traits
List of traits for the statusCode attribute are listed below.
is.dataFormat.integer is.constrainedList.correlated
the values of an attribute are taken from or looked up from a fixed list of possibilities that represent correlated status
does.haveDefault
An attribute has a default value
Parameter
Value
Data type
Explanation
default
languageTag
displayText
attributeValue
correlatedValue
en
Draft
1
1
en
Unapproved
2
2
en
Published
3
3
any
is.correlatedWith
the attribute value is correlated with the sourceAttribute
Parameter
Value
Data type
Explanation
sourceAttribute
"stateCode"
attributeName
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Status Reason
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Select the article's status.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"statuscode"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Title of the knowledge base article.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Title
description
Title of the knowledge base article.
dataFormat
int64
isNullable
true
sourceName
versionnumber
Traits
List of traits for the versionNumber attribute are listed below.
is.dataFormat.integer is.dataFormat.big is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Title
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Title of the knowledge base article.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"versionnumber"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Keywords to be used for searches in knowledge base articles.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Key Words
description
Keywords to be used for searches in knowledge base articles.
dataFormat
string
maximumLength
100000
isNullable
true
sourceName
keywords
Traits
List of traits for the keyWords attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Key Words
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Keywords to be used for searches in knowledge base articles.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"keywords"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter
Value
Data type
Explanation
ordinal
"20"
integer
is.constrained
maximum length or value constraints
Unique identifier of the data import or data migration that created this record.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Import Sequence Number
description
Unique identifier of the data import or data migration that created this record.
dataFormat
int32
maximumValue
2147483647
minimumValue
-2147483648
isNullable
true
sourceName
importsequencenumber
Traits
List of traits for the importSequenceNumber attribute are listed below.
is.dataFormat.integer is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Import Sequence Number
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier of the data import or data migration that created this record.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"importsequencenumber"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter
Value
Data type
Explanation
ordinal
"33"
integer
is.constrained
maximum length or value constraints
Date and time that the record was migrated.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Record Created On
description
Date and time that the record was migrated.
dataFormat
dateTime
isNullable
true
sourceName
overriddencreatedon
Traits
List of traits for the overriddenCreatedOn attribute are listed below.
is.dataFormat.date means.measurement.date is.dataFormat.time means.measurement.time means.measurement.date.creation is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Record Created On
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Date and time that the record was migrated.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"overriddencreatedon"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Unique identifier of the delegate user who created the article.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Created By (Delegate)
description
Unique identifier of the delegate user who created the article.
dataFormat
guid
isNullable
true
sourceName
createdonbehalfby
Traits
List of traits for the createdOnBehalfBy attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Created By (Delegate)
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier of the delegate user who created the article.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Unique identifier of the delegate user who last modified the kbarticle.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Modified By (Delegate)
description
Unique identifier of the delegate user who last modified the kbarticle.
dataFormat
guid
isNullable
true
sourceName
modifiedonbehalfby
Traits
List of traits for the modifiedOnBehalfBy attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Modified By (Delegate)
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Unique identifier of the delegate user who last modified the kbarticle.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
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.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Language
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.
dataFormat
string
maximumValue
2147483647
minimumValue
0
isNullable
true
sourceName
languagecode
Traits
List of traits for the languageCode attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array means.reference.language is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Language
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
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.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"languagecode"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter
Value
Data type
Explanation
ordinal
"45"
integer
is.constrained
maximum length or value constraints
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.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Exchange Rate
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.
dataFormat
decimal
maximumValue
100000000000
minimumValue
1E-10
isNullable
true
sourceName
exchangerate
Traits
List of traits for the exchangeRate attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Exchange Rate
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
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.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"exchangerate"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter
Value
Data type
Explanation
ordinal
"46"
integer
is.constrained
maximum length or value constraints
Parameter
Value
Data type
Explanation
minimumValue
"1E-10"
decimal
maximumValue
"100000000000"
decimal
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Choose the local currency for the record to make sure budgets are reported in the correct currency.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Currency
description
Choose the local currency for the record to make sure budgets are reported in the correct currency.
dataFormat
guid
isNullable
true
sourceName
transactioncurrencyid
Traits
List of traits for the transactionCurrencyId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid means.identity.entityId is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter
Value
Data type
Explanation
style
"single"
string
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Currency
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Choose the local currency for the record to make sure budgets are reported in the correct currency.
entity
a reference to the constant entity holding the list of localized text
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
For internal use only.
First included in: applicationCommon/Article (this entity)
Properties
Name
Value
displayName
Entity Image Id
description
For internal use only.
dataFormat
guid
isNullable
true
sourceName
entityimageid
Traits
List of traits for the entityImageId attribute are listed below.
is.dataFormat.character is.dataFormat.big is.dataFormat.array is.dataFormat.guid is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter
Value
Data type
Explanation
level
"none"
string
values can be: 'systemrequired', 'required', 'recommended', 'none'
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Entity Image Id
entity
a reference to the constant entity holding the list of localized text
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
For internal use only.
entity
a reference to the constant entity holding the list of localized text
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter
Value
Data type
Explanation
name
"entityimageid"
string
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.