Knowledge Base Page Resource

A knowledge base page is a page created in the context of the knowledge base. This page belongs to a category or a subcategory.

Changelog

2024.2.6

Added deletedAt property to pages for soft deletion.
Added coverImage property to our knowledge base pages.

Endpoints

Representations

JSON Properties

Name	Type	Description
EID	EID	Unique entity identifier
creatorEID	EID	Unique identifier of the page creator
networkEID	EID	Unique identifier of the network
title	string	The title of the page
icon	string	The name of the icon of the page
body	string	The body of the page
status	string	The status of the page. Can be draft, published, or processing
recipients	array	List of recipient objects (groups or network)
recipients[i].EID	EID	EID of the recipient (group or network)
recipients[i].type	string	`group` or `network`
numRecipients	int	The number of recipients
createdAt	datetime	Read-only The date the page was created.
pageType	string	The page type. It should be knowledge_base
knowledgeBaseCategories	array	List of knowledge base categories EIDs.

Links

Relation	Resource	Description
recipients	recipient	Recipient
attachments	attachment	Attachment
files	attachment	Files
images	attachment	Images
videos	attachment	Videos

Example (page)

{
    "_links": {
    "recipients": [
      {
        "href": "/networks/FEDCBA0987654321/"
      }
    ],
    "attachments": {
      "href": "/networks/FEDCBA0987654321/messages/?eid=1234567890ABCDEF"
    },
    "files": {
      "href": "/networks/FEDCBA0987654321/messages/?eid=1234567890ABCDEF"
    },
    "images": {
      "href": "/networks/FEDCBA0987654321/messages/?eid=1234567890ABCDEF"
    },
    "videos": {
      "href": "/networks/FEDCBA0987654321/messages/?eid=1234567890ABCDEF"
    },
    "self": {
      "href": "/networks/FEDCBA0987654321/pages/1234567890ABCDEF/"
    }
    },
    "EID": "1234567890ABCDEF",
    "creatorEID": "1234567890FEDCAB",
    "title": "Auto",
    "icon": "car",
    "body": "<p>Body here</p>",
    "status": "published",
    "networkEID": "FEDCBA0987654321",
    "recipients": [
    {
      "EID": "FEDCBA0987654321",
      "type": "network"
    }
    ],
    "numRecipients": 1,
    "createdAt": "2024-11-28T11:43:49.671+00:00",
    "pageType": "knowledge_base",
    "knowledgeBaseCategories": [
    "FEDCBA0123456789"
    ]
}