Documentation is now available for the Fall 2020 Update release!

Create KB category

This endpoint is used to create a knowledge base category.

Leave Feedback

URL

POST https://api.opsramp.com/api/v2/tenants/{tenantId}/kb/category/create

Sample URLs

https://{api-url}/api/v2/tenants/client_5/agentPolicies/1/devices

Parameters

FieldData TypeDescription
nameStringName of the knowledge base category.
scopeStringDefines 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
clientIdsStringDefines the list of Client IDs. This is mandatory for a MSP tenant with CLIENT scope.
descriptionString(Optional) Description of the knowledge base category.
parentCategoryString(Optional) Defines the parent category.

Status code

200 OK

Create partner category

Sample request

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

Sample response

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

Create client category

Sample request

{
      "name" : "Test API category",
      "description" : "Category"
}

Sample response

{
    "id": "KBC0000000076",
    "name": "Test API category",
    "description": "Category",
    "createdBy": {
        "id": "USR0000000002",
        "loginName": "opsramp_api_user",
        "lastName": " ",
        "firstName": "OpsRamp API User",
        "email": "helpdesk@opsramp.com"
    },
    "updatedBy": {
        "id": "USR0000000002",
        "loginName": "opsramp_api_user",
        "lastName": " ",
        "firstName": "OpsRamp API User",
        "email": "helpdesk@opsramp.com"
    },
    "path": "Test API category",
    "state": "ACTIVE",
    "createdDate": "2019-05-20T06:44:44+0000",
    "updatedDate": "2019-05-20T06:44:44+0000"
}