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

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

(Optional) Description of the knowledge base category.

id
string

name
string

Name of the knowledge base category.

parentCategory
object

(Optional) 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

{
  "clientIds": [
    "client_9"
  ],
  "description": "test",
  "name": "Hello there",
  "parentCategory": {
    "id": "KBC0000000076"
  },
  "scope": "CLIENT"
}
{
  "description": "Category",
  "name": "Test API category"
}

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

(Optional) Description of the knowledge base category.

id
string

name
string

Name of the knowledge base category.

parentCategory
object

(Optional) 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

{
  "clientIds": [
    "client_9"
  ],
  "createdBy": {
    "email": "helpdesk@opsramp.com",
    "firstName": "OpsRamp API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "createdDate": "2019-05-20T07:00:01+0000",
  "description": "test",
  "id": "KBC0000000077",
  "name": "Hello there",
  "parentCategory": {
    "id": "KBC0000000076",
    "name": "Test API category"
  },
  "path": "Hello there",
  "scope": "CLIENT",
  "state": "ACTIVE",
  "updatedBy": {
    "email": "helpdesk@opsramp.com",
    "firstName": "OpsRamp API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "updatedDate": "2019-05-20T07:00:01+0000"
}
{
  "createdBy": {
    "email": "helpdesk@opsramp.com",
    "firstName": "OpsRamp API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "createdDate": "2019-05-20T06:44:44+0000",
  "description": "Category",
  "id": "KBC0000000076",
  "name": "Test API category",
  "path": "Test API category",
  "state": "ACTIVE",
  "updatedBy": {
    "email": "helpdesk@opsramp.com",
    "firstName": "OpsRamp API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "updatedDate": "2019-05-20T06:44:44+0000"
}