KnowledgeBase_KnowledgeBase
You need the Manage multiple knowledge bases permission to manage knowledge bases.
KnowledgeBase_KnowledgeBases
- KnowledgeBase_KnowledgeBases Manage
GET kb/knowledgeBases
GET kb/knowledgeBases/{id}
POST kb/knowledgeBases
PUT kb/knowledgeBases/{id}
DELETE kb/knowledgeBases/{id}
Model
KnowledgeBase_KnowledgeBase JSON Format
KnowledgeBase_KnowledgeBase is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the knowledage base. |
name |
string | Name of the knowledage base. |
homePageType |
string | Allowed values are "category", "customPage". |
homePageId |
guid | Id of the home page. |
visibility |
string | Allowed values are "private", "public". |
status |
string | Allowed values are "closed", "open". |
ifAllowRateHelpfulOrNotHelpful |
bool | Time when the custom page was last modified. |
customUrl |
string | |
customDomain |
string | |
ifRemovePoweredBy |
bool | Whether to remove the PoweredBy or not. |
images |
integer | Counts of the image belong to the knowledge base. |
articles |
integer | Counts of the article belong to the knowledge base. |
customPages |
integer | Counts of the custom page belong to the knowledge base. |
Endpoint
Get the list of KnowledgeBase_KnowledgeBases
GET kb/knowledgeBases
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "design". |
Response:
An array of KnowledgeBase_KnowledgeBase
Example
Sample Request:
curl https://api15.comm100.io/v4/kb/knowledgeBases \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get a single KnowledgeBase_KnowledgeBase
GET kb/knowledgeBases/{id}
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "design". |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/kb/knowledgeBases/7eb475fe-ea75-4ae7-a7da-fe25ad2891fa \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Create a new KnowledgeBase_KnowledgeBase
POST kb/knowledgeBases
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string | body | yes | Name of the knowledage base. |
homePageType |
string | body | no | Allowed values are "category", "customPage". |
homePageId |
guid | body | yes | Id of the home page. |
visibility |
string | body | no | Allowed values are "private", "public". |
status |
string | body | no | Allowed values are "closed", "open". |
ifAllowRateHelpfulOrNotHelpful |
bool | body | no | Time when the custom page was last modified. |
customUrl |
string | body | no | |
customDomain |
string | body | no | |
ifRemovePoweredBy |
bool | body | no | Whether to remove the PoweredBy or not. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/kb/knowledgeBases \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"name":"Knowledge Base","homePageType":"category","homePageId":"00000000-0000-0000-0000-000000000000","visibility":"public","status":"open","ifAllowRateHelpfulOrNotHelpful":true,"customUrl":"","customDomain":"","ifRemovePoweredBy":true}'
Response:
HTTP/1.1 201 Created
Update the KnowledgeBase_KnowledgeBase
PUT kb/knowledgeBases/{id}
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
name |
string | body | yes | Name of the knowledage base. |
homePageType |
string | body | no | Allowed values are "category", "customPage". |
homePageId |
guid | body | yes | Id of the home page. |
visibility |
string | body | no | Allowed values are "private", "public". |
status |
string | body | no | Allowed values are "closed", "open". |
ifAllowRateHelpfulOrNotHelpful |
bool | body | no | Time when the custom page was last modified. |
customUrl |
string | body | no | |
customDomain |
string | body | no | |
ifRemovePoweredBy |
bool | body | no | Whether to remove the PoweredBy or not. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/kb/knowledgeBases/7eb475fe-ea75-4ae7-a7da-fe25ad2891fa \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"name":"Knowledge Base","homePageType":"category","homePageId":"00000000-0000-0000-0000-000000000000","visibility":"public","status":"open","ifAllowRateHelpfulOrNotHelpful":true,"customUrl":"","customDomain":"","ifRemovePoweredBy":true}'
Response:
HTTP/1.1 200 OK
Remove the KnowledgeBase_KnowledgeBase
DELETE kb/knowledgeBases/{id}
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/kb/knowledgeBases/7eb475fe-ea75-4ae7-a7da-fe25ad2891fa \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content