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

Describes the client ID or msp ID of the tenant

clientIds
array

Defines the list of Client IDs. This is mandatory for a MSP tenant with CLIENT scope.

createdBy
object

createdBy.email
createdBy.firstName
createdBy.id
createdBy.lastName
createdBy.loginName
createdBy.mobileNumber
createdBy.phoneNumber
createdDate
string

description
string

Description of the knowledge base category.

id
string

name
string

Name of the knowledge base category.

parentCategory
object

Defines the parent category.

parentCategory.id
path
string

scope
string

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

state
string

updatedBy
object

updatedBy.email
updatedBy.firstName
updatedBy.id
updatedBy.lastName
updatedBy.loginName
updatedBy.mobileNumber
updatedBy.phoneNumber
updatedDate
string

{
  "category": {
    "id": "KB0000000002",
    "name": "Client"
  },
  "content": "New Template Content Changes",
  "state": "PUBLISHED",
  "subject": "New Template Created"
}

Responses

OK

clientIds
array

Defines the list of Client IDs. This is mandatory for a MSP tenant with CLIENT scope.

createdBy
object

createdBy.email
createdBy.firstName
createdBy.id
createdBy.lastName
createdBy.loginName
createdBy.mobileNumber
createdBy.phoneNumber
createdDate
string

description
string

Description of the knowledge base category.

id
string

name
string

Name of the knowledge base category.

parentCategory
object

Defines the parent category.

parentCategory.id
path
string

scope
string

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

state
string

updatedBy
object

updatedBy.email
updatedBy.firstName
updatedBy.id
updatedBy.lastName
updatedBy.loginName
updatedBy.mobileNumber
updatedBy.phoneNumber
updatedDate
string

{
  "category": {
    "description": "Client",
    "id": "KB0000000002",
    "name": "Client",
    "path": "Client",
    "state": "ACTIVE"
  },
  "content": "New Template Content Changes",
  "createdBy": {
    "email": "user@testsite.com",
    "firstName": "OpsRamp API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "createdTime": "2019-05-14T08:45:49+0000",
  "id": "KB0000000042",
  "shared": false,
  "state": "PUBLISHED",
  "subject": "New Template Created",
  "updatedBy": {
    "email": "user@testsite.com",
    "firstName": "OpsRamp API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "updatedTime": "2019-05-14T08:45:49+0000"
}