Get list of templates

This endpoint is used to get the list of knowledge base templates.

Leave Feedback

URL

GET https://api.opsramp.com/api/v2//tenants/{clientId}/kb/templatesList?categoryId=&pageNo={pageNo}&pageSize={pageSize}

Sample URLs

https://api.opsramp.com//api/v2//tenants/client_11/kb/templatesList?categoryId=&pageNo=1&pageSize=20

Parameters

FieldData TypeDescription
categoryStringName of the knowledge base category.
subjectStringDefines the subject of the knowledge base article.
contentStringDefines the content of the article.
stateString(Optional) Defines the published status of the article.
Example: PUBLISH, DRAFT
attachmentsString(Optional) Defines the details of attachments of the article.
expiryDateString(Optional) Defines the expiry date of the article. Date format: yyyy-MM-ddTHH:mm:ssZ.
Example: 2019-07-07T09:19:47 0000 (GMT)
linkedArticlesString(Optional) Defines the list of linked articles of the article.

Status code

200 OK

Sample response

{
    "results": [
        {
            "id": "KB0000000041",
            "subject": "Test Details Updated",
            "content": "Test Details Updated",
            "createdTime": "2019-05-14T07:35:52+0000",
            "updatedTime": "2019-05-14T08:42:36+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "lakshmi.balla@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000040",
            "subject": "Need to update the Kafka Server Details",
            "content": "Modify the Queirs Ann Data",
            "createdTime": "2019-05-14T07:17:30+0000",
            "updatedTime": "2019-05-14T07:17:30+0000",
            "createdBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KBC0000000018",
                "name": "Cassandra",
                "description": "",
                "path": "My Category>>DataBase>>Cassandra",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000039",
            "subject": "Need to update the Kafka Server Details",
            "content": "Modify the Queirs Ann Data",
            "createdTime": "2019-05-14T07:16:18+0000",
            "updatedTime": "2019-05-14T07:16:44+0000",
            "createdBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KBC0000000018",
                "name": "Cassandra",
                "description": "",
                "path": "My Category>>DataBase>>Cassandra",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000038",
            "subject": "Test",
            "content": "Templates",
            "createdTime": "2019-05-14T07:14:11+0000",
            "updatedTime": "2019-05-14T07:15:44+0000",
            "createdBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KBC0000000011",
                "name": "C3",
                "description": "",
                "path": "C3",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000017",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T10:01:24+0000",
            "updatedTime": "2019-05-03T10:01:24+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "lakshmi.balla@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "lakshmi.balla@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000007",
            "subject": "TEMP@",
            "content": "sdfsdfdsf",
            "createdTime": "2019-04-24T06:31:32+0000",
            "updatedTime": "2019-04-26T09:04:59+0000",
            "createdBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KB0000000008",
                "name": "Temp2",
                "description": "",
                "path": "Sub Client 2>>Temp2",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000006",
            "subject": "Article 1",
            "content": "Article 1",
            "createdTime": "2019-04-24T06:18:20+0000",
            "updatedTime": "2019-04-24T06:18:25+0000",
            "createdBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000002",
            "subject": "Databaase",
            "content": "Test",
            "createdTime": "2019-04-24T04:30:48+0000",
            "updatedTime": "2019-04-24T04:30:48+0000",
            "createdBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "lakshmi.balla@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KB0000000001",
                "name": "Data",
                "description": "New Category",
                "path": "Data",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        }
    ],
    "totalResults": 8,
    "orderBy": "id",
    "pageNo": 1,
    "pageSize": 20,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": true
}