Get Details of a Given Category

Get all the details on a given Category Id

Path Parameters

  • tenantIdstringrequired

    Describes the client ID or msp ID of the tenant

  • categoryIdstringrequired

    Specifies the unique category identifier in the knowledge base

Responses

  • idstring

  • namestring

    Name of the knowledge base category.

  • pathstring

  • statestring

  • createdByobject

  • updatedByobject

  • createdDatestring

  • updatedDatestring

  • scopestring

    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

    Enum:
    PARTNERCLIENT
  • clientIdsarray of strings

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

  • parentCategoryobject

    Defines the parent category.

  • descriptionstring

    Description of the knowledge base category.

Response Samples

{
  "id": "KBC0000000077",
  "name": "API category updated",
  "description": "sample description",
  "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": "API category updated",
  "state": "ACTIVE",
  "createdDate": "2019-05-20T07:00:01+0000",
  "updatedDate": "2019-05-20T07:31:28+0000"
}