Knowledge bases / List
Returns all Knowledge bases.
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/knowledge_bases
Method: GET
Authorisation: Minimum role: USER
Request Arguments
Request body example
Response object
Response status: 200 (OK)
Response type:
DTO_knowledge_base[]
Wrapper: DTO_response_wrap_get_many
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_standard_filter
| Name | Type | ReadOnly | Description |
|---|
| sort_by_key | String | | Sort by key |
| response_field_keys | String[] | | Only return the fields specified |
| filters | String[] | | Each string needs to be structured: filters=field_key:operator:value1|value2|value3
Only used to store filters for passing along as querystring |
| include_aggregations | Boolean | | Include aggregations |
| include_imported | Boolean | | Include imported |
| search | String | | Search |
| sort_order | ENUM sort_order | | Sort order |
| take | Int32 | | Take |
| page | Int32 | | Page |
DTO_knowledge_base
| Name | Type | ReadOnly | Description |
|---|
| created_by | DTO_reference_user | ReadOnly | Created by |
| last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
| category | DTO_reference | | Category |
| group_access | DTO_group_access[] | | Group access |
| sys_tags | DTO_reference[] | | Label can be used on POST/PUT to create new tags |
| sys_attachments | DTO_reference_attachment[] | | Sys attachments |
| id | Int32 | ReadOnly | Id |
| unique_key | String | | Unique key |
| created | DateTime | ReadOnly | Created |
| last_updated | DateTime | ReadOnly | Last updated |
| sys_subject | String | | Sys subject |
| sys_content_rich | DTO_rich_text | | Sys content rich |
| sys_content_rich_draft | DTO_rich_text | | Sys content rich draft |
| published | Boolean | | Published |
| view_count | Int32 | | View count |
| rate_up_count | Int32 | | Rate up count |
| rate_down_count | Int32 | | Rate down count |
| privacy | ENUM privacy | | Privacy |
| highest_group_permission | ENUM group_permission | ReadOnly | Highest group permission |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|
| profile_pic | String | ReadOnly | Profile pic |
| email | String | ReadOnly | Email |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
DTO_reference
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | | The id of the reference |
| label | Object | ReadOnly | Name/Label from referenced object. |
DTO_group_access
| Name | Type | ReadOnly | Description |
|---|
| permission | ENUM group_permission | | Permission |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
DTO_reference_attachment
| Name | Type | ReadOnly | Description |
|---|
| size_kb | Int32 | ReadOnly | Size kb |
| status | ENUM attachment_status | ReadOnly | Status |
| status_message | String | ReadOnly | Status message |
| download_url | String | ReadOnly | Download url |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
DTO_rich_text
| Name | Type | ReadOnly | Description |
|---|
| plain_preview | String | ReadOnly | Plain preview |
| html | String | | Html |
| editorjs | DTO_editorjs | | Editorjs |
| read_minutes | Int32 | | Read minutes |
DTO_editorjs
| Name | Type | ReadOnly | Description |
|---|
| time | Int64 | | Time |
| version | String | | Version |
| blocks | DTO_editorjs_block[] | | Blocks |
DTO_editorjs_block
| Name | Type | ReadOnly | Description |
|---|
| id | String | | Id |
| type | String | | Type |
| data | Object | | Data |
ENUM group_permission
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | READ | Read only |
| 2 | EDIT | Edit |
| 3 | FULL | Full |
ENUM attachment_status
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | UNAVAILABLE | UNAVAILABLE, processing in progress |
| 2 | OK | OK |
| 3 | WARNING | WARNING |
| 4 | ERROR | ERROR |
ENUM sort_order
| Value | Name | Description |
|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
ENUM privacy
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | PRIVATE | PRIVATE |
| 2 | PUBLIC | PUBLIC |
