KBPUBLIC: Public Article
Public-facing knowledge base article for the customer support portal. Separate from KBARTICLE which is for internal ITSM use.
Default definition. This article describes the default
KBPUBLIC 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 KBPUBLIC.Entity properties
| Property | Value |
|---|---|
| Entity code | KBPUBLIC |
| Display name | Public Article |
| Plural | Public Articles |
| Level | 52400 |
Use cases
KBPUBLIC is the public portal counterpart to KBARTICLE. Articles with status Published are served on the portal. Categories come from KBCATPUBLIC via objectLookup.
Fields
Article Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Title |
slug | text | Lowercase, hyphenated identifier used in the article URL. Generated automatically from the title when first saved. Editing this changes the URL. old links will break. | |
articleType | enum | 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 | reference → KBCATPUBLIC | Category | |
keywords | text | Keywords | |
sortOrder | number | Lower numbers appear first within the category on the public portal. Leave blank to fall back to published date (newest first). |
Ownership
| Field | Type | Required | Notes |
|---|---|---|---|
author | reference → user | Yes | Author |
publishedDate | date | Published Date |
Analytics
| Field | Type | Required | Notes |
|---|---|---|---|
viewCount | number | View Count Read only. | |
averageRating | number | Avg. Rating 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:
categorypoints at aKBCATPUBLICrecord.
Creating a Public Article via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "KBPUBLIC",
"level": 52400,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"status": "1",
"summary": "Example text.",
"author": ""
} Listing Public Articles records
# All public articles in your tenant
GET /v1/entities/KBPUBLIC/SUB