Get list of KB categories

URL

GET https://api.vistanet.jp/api/v2/tenants/{tenantId}/kb/categorylist?pageNo={pageNo}&pageSize={pageSize}

Sample URLs

https://api.vistanet.jp//api/v2//tenants/client_11/kb/categorylist/?pageNo=1&pageSize=10

Parameters

All parameters are optional:

Field	Default Value	Description
state		Defines the current state of the category. Example: ACTIVE, INACTIVE.
clientId		Defines the ID of the client and is used in Partner login.
isParent	false	Defines the list of parent categories. If selected TRUE, only parent categories are listed.
pageNo	1	Description of the knowledge base category.
pageSize	20	Defines the parent category.
sortName	id	Defines if the results are to be sorted by Id or Name.
isDescendingOrder	false	Defines the order to display the results in either ascending or descending order.

Status code

200 OK

Sample response

{
    "results": [
        {
            "id": "KBC0000000078",
            "name": "API category updated",
            "description": "sample description",
            "path": "API category updated>>API category updated",
            "state": "ACTIVE"
        },
        {
            "id": "KBC0000000077",
            "name": "API category updated",
            "description": "sample description",
            "path": "API category updated",
            "state": "ACTIVE"
        },
        {
            "id": "KBC0000000076",
            "name": "Test API category",
            "description": "Category",
            "path": "Test API category",
            "state": "ACTIVE"
        },
        {
            "id": "KBC0000000067",
            "name": "test ",
            "description": "",
            "path": "test ",
            "state": "ACTIVE"
        },
        {
            "id": "KBC0000000066",
            "name": "test ",
            "description": "hekllo",
            "path": "test ",
            "state": "ACTIVE"
        },
        {
            "id": "KBC0000000065",
            "name": "test ",
            "description": "everything to be updated",
            "path": "test ",
            "state": "ACTIVE"
        },
        {
            "id": "KBC0000000064",
            "name": "test ",
            "path": "test >>test ",
            "state": "ACTIVE"
        },
        {
            "id": "KBC0000000063",
            "name": "test ",
            "description": "everything to be updated",
            "path": "test ",
            "state": "ACTIVE"
        },
        {
            "id": "KBC0000000062",
            "name": "test ",
            "description": "Hello there",
            "path": "test >>test ",
            "state": "ACTIVE"
        },
        {
            "id": "KBC0000000061",
            "name": "test ",
            "description": "Hello there",
            "path": "test ",
            "state": "ACTIVE"
        }
    ],
    "totalResults": 37,
    "orderBy": "id",
    "pageNo": 1,
    "pageSize": 10,
    "totalPages": 4,
    "nextPage": true,
    "nextPageNo": 2,
    "previousPageNo": 0,
    "descendingOrder": true
}