Documentation is now available for the Fall 2020 Update release!

Get list of KB categories

This endpoint is used to retrieve list of knowledge base categories.

Leave Feedback

URL

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

Sample URLs

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

Parameters

All parameters are optional:

FieldDefault ValueDescription
stateDefines the current state of the category. Example: ACTIVE, INACTIVE.
clientIdDefines the ID of the client and is used in Partner login.
isParentfalseDefines the list of parent categories. If selected TRUE, only parent categories are listed.
pageNo1Description of the knowledge base category.
pageSize20Defines the parent category.
sortNameidDefines if the results are to be sorted by Id or Name.
isDescendingOrderfalseDefines 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
}