Endpoint
/api/v2/tenants/{tenantId}/kb/templatesList
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

Query Parameters
categoryId
string

Name of the knowledge base category.

subject
string

Defines the subject of the knowledge base article.

content
string

Defines the content of the article.

state
string

Defines the published status of the article. Example: PUBLISH, DRAFT

attachments
string

Defines the details of attachments of the article.

expiryDate
string

Defines the expiry date of the article. Date format: yyyy-MM-ddTHH:mm:ssZ. Example: 2019-07-07T09:19:47 0000 (GMT)

linkedArticles
string

Defines the list of linked articles of the article.

pageNo
integer

pageSize
integer

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

result
object

Name of the knowledge base category.

result.clientIds
Defines the list of Client IDs. This is mandatory for a MSP tenant with CLIENT scope.
result.createdBy
result.createdDate
result.description
Description of the knowledge base category.
result.id
result.name
Name of the knowledge base category.
result.parentCategory
Defines the parent category.
result.path
result.scope
Defines the scope of the knowledge base category: For a MSP tenant, scope is either PARTNER or CLIENT For a CLIENT tenant, scope is not applicable
result.state
result.updatedBy
result.updatedDate
totalPages
integer

totalResults
integer

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