KBARTICLE: Knowledge Article
Knowledge base article for documenting solutions, workarounds, procedures, and FAQs for IT support.
Default definition. This article describes the default
KBARTICLE definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches KBARTICLE.Entity properties
| Property | Value |
|---|---|
| Entity code | KBARTICLE |
| Display name | Knowledge Article |
| Plural | Knowledge Articles |
| Level | 50900 |
Use cases
KBARTICLE provides a searchable knowledge base for IT support staff and end users. Articles link to ITPROBLEM (root cause documentation) and SVCCAT (service procedures). TICKET references articles via knowledgeArticle field, enabling a Related Tickets panel via stockRecord.
Fields
Article Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Title |
articleType | enum | Yes | Article Type Valid ids: 1 (How-To), 2 (Troubleshooting), 3 (FAQ), 4 (Policy), 5 (Procedure), 6 (Reference). |
status | enum | Yes | Status Valid ids: 1 (Draft), 2 (In Review), 3 (Published), 4 (Archived). |
summary | text (multi-line) | Yes | Summary |
scribdEmbed | text (multi-line) | Paste the iframe embed code from Scribd. When set, the Scribd document is shown instead of the article content. |
Classification
| Field | Type | Required | Notes |
|---|---|---|---|
category | enum | Category Valid ids: 1 (Hardware), 2 (Software), 3 (Network), 4 (Access/Permissions), 5 (Email), 6 (Security), 7 (General). | |
applicableTo | enum | Applicable To Valid ids: 1 (End Users), 2 (IT Staff), 3 (All). | |
keywords | text | Keywords | |
relatedProblem | reference → ITPROBLEM | Related Problem | |
relatedService | reference → SVCCAT | Related Service |
Ownership
| Field | Type | Required | Notes |
|---|---|---|---|
author | reference → user | Yes | Author |
reviewer | reference → user | Reviewer | |
publishedDate | date | Published Date | |
lastReviewedDate | date | Last Reviewed | |
nextReviewDate | date | Next Review Date | |
version | text | Version |
Feedback & Analytics
| Field | Type | Required | Notes |
|---|---|---|---|
viewCount | number | View Count Read only. | |
linkedTicketCount | number | Linked Tickets Read only. | |
averageRating | number | Average usefulness rating (1-5) from linked ticket resolutions Read only. | |
ratingCount | number | Ratings Read only. | |
helpfulYes | number | Helpful (Yes) Read only. | |
helpfulNo | number | Helpful (No) Read only. |
Article Content
| Field | Type | Required | Notes |
|---|---|---|---|
content | text (HTML) | Content |
Activity. Activity timeline panel attached.
Relationships
- Lookups:
relatedProblempoints at aITPROBLEMrecord.relatedServicepoints at aSVCCATrecord. - Related lists:
TICKET.
Creating a Knowledge Article via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "KBARTICLE",
"level": 50900,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"articleType": "1",
"status": "1",
"summary": "Example text."
}Listing Knowledge Articles records
# All knowledge articles in your tenant
GET /v1/entities/KBARTICLE/SUB