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

articleId
string

Responses

OK

attachments
array

attachments.contentURL
attachments.createdBy
attachments.createdDate
attachments.id
attachments.name
category
object

Name of the knowledge base category.

category.clientIds
Defines the list of Client IDs. This is mandatory for a MSP tenant with CLIENT scope.
category.createdBy
category.createdDate
category.description
(Optional) Description of the knowledge base category.
category.id
category.name
Name of the knowledge base category.
category.parentCategory
(Optional) Defines the parent category.
category.path
category.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
category.state
category.updatedBy
category.updatedDate
content
string

Defines the content of the article.

createdBy
object

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

expiryDate
string

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

id
string

linkedArticles
array

(Optional) Defines the list of linked articles of the article.

linkedArticles.id
linkedArticles.shared
linkedArticles.subject
shared
boolean

state
string

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

subject
string

Defines the subject of the knowledge base article.

updatedBy
object

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

{
  "attachments": [
    {
      "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/14",
      "createdBy": {
        "email": "dev@opsramp.com",
        "firstName": "OpsRamp API User",
        "id": "USR0000000002",
        "lastName": " ",
        "loginName": "opsramp_api_user"
      },
      "createdDate": "2019-05-08T10:55:27+0000",
      "id": 14,
      "name": "2.txt"
    },
    {
      "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/15",
      "createdBy": {
        "email": "dev@opsramp.com",
        "firstName": "OpsRamp API User",
        "id": "USR0000000002",
        "lastName": " ",
        "loginName": "opsramp_api_user"
      },
      "createdDate": "2019-05-08T10:55:36+0000",
      "id": 15,
      "name": "1.txt"
    },
    {
      "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/20",
      "createdBy": {
        "email": "john@opsramp.com",
        "firstName": "OpsRamp",
        "id": "USR0000000003",
        "lastName": "Admin",
        "loginName": "superadmin",
        "phoneNumber": ""
      },
      "createdDate": "2019-05-10T05:53:15+0000",
      "id": 20,
      "name": "bustkt.pdf"
    },
    {
      "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/21",
      "createdBy": {
        "email": "dev@opsramp.com",
        "firstName": "OpsRamp",
        "id": "USR0000000003",
        "lastName": "Admin",
        "loginName": "superadmin",
        "phoneNumber": ""
      },
      "createdDate": "2019-05-10T05:53:33+0000",
      "id": 21,
      "name": "bustkt.pdf"
    },
    {
      "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/22",
      "createdBy": {
        "email": "dev@opsramp.com",
        "firstName": "OpsRamp API User",
        "id": "USR0000000002",
        "lastName": " ",
        "loginName": "opsramp_api_user"
      },
      "createdDate": "2019-05-10T06:01:23+0000",
      "id": 22,
      "name": "queries.txt"
    }
  ],
  "category": {
    "description": "",
    "id": "KBC0000000018",
    "name": "Cassandra",
    "path": "My Category\u003e\u003eDataBase\u003e\u003eCassandra",
    "state": "ACTIVE"
  },
  "content": "Modify the Queirs Ann Data",
  "createdBy": {
    "email": "dev@opsramp.com",
    "firstName": "OpsRamp API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "createdTime": "2019-05-08T10:55:26+0000",
  "expiryDate": "2019-07-29T07:00:00+0000",
  "id": "KB0000000036",
  "linkedArticles": [
    {
      "id": "KB0000000035",
      "sharedArticle": false,
      "subject": "All Data"
    }
  ],
  "shared": false,
  "state": "PUBLISHED",
  "subject": "Need to update the Kafka Server Details",
  "updatedBy": {
    "email": "dev@opsramp.com",
    "firstName": "OpsRamp",
    "id": "USR0000000003",
    "lastName": "Admin",
    "loginName": "superadmin",
    "phoneNumber": ""
  },
  "updatedTime": "2019-05-10T05:53:33+0000"
}
Endpoint
/api/v2/tenants/{tenantId}/kb/article/{articleId}
Path Parameters
tenantId
string

articleId
string

attachments
array

attachments.contentURL
attachments.createdBy
attachments.createdDate
attachments.id
attachments.name
category
object

Name of the knowledge base category.

category.clientIds
Defines the list of Client IDs. This is mandatory for a MSP tenant with CLIENT scope.
category.createdBy
category.createdDate
category.description
(Optional) Description of the knowledge base category.
category.id
category.name
Name of the knowledge base category.
category.parentCategory
(Optional) Defines the parent category.
category.path
category.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
category.state
category.updatedBy
category.updatedDate
content
string

Defines the content of the article.

createdBy
object

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

expiryDate
string

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

id
string

linkedArticles
array

(Optional) Defines the list of linked articles of the article.

linkedArticles.id
linkedArticles.shared
linkedArticles.subject
shared
boolean

state
string

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

subject
string

Defines the subject of the knowledge base article.

updatedBy
object

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

{
  "attachments": [
    {
      "file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
      "name": "queries.txt"
    }
  ],
  "content": "Modify the Queirs Ann Data",
  "subject": "Need to update the Kafka Server Details"
}

Responses

OK

attachments
array

attachments.contentURL
attachments.createdBy
attachments.createdDate
attachments.id
attachments.name
category
object

Name of the knowledge base category.

category.clientIds
Defines the list of Client IDs. This is mandatory for a MSP tenant with CLIENT scope.
category.createdBy
category.createdDate
category.description
(Optional) Description of the knowledge base category.
category.id
category.name
Name of the knowledge base category.
category.parentCategory
(Optional) Defines the parent category.
category.path
category.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
category.state
category.updatedBy
category.updatedDate
content
string

Defines the content of the article.

createdBy
object

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

expiryDate
string

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

id
string

linkedArticles
array

(Optional) Defines the list of linked articles of the article.

linkedArticles.id
linkedArticles.shared
linkedArticles.subject
shared
boolean

state
string

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

subject
string

Defines the subject of the knowledge base article.

updatedBy
object

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

{
  "attachments": [
    {
      "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/14",
      "createdBy": {
        "email": "dev@opsramp.com",
        "firstName": "OpsRamp API User",
        "id": "USR0000000002",
        "lastName": " ",
        "loginName": "opsramp_api_user"
      },
      "createdDate": "2019-05-08T10:55:27+0000",
      "id": 14,
      "name": "2.txt"
    },
    {
      "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/15",
      "createdBy": {
        "email": "dev@opsramp.com",
        "firstName": "OpsRamp API User",
        "id": "USR0000000002",
        "lastName": " ",
        "loginName": "opsramp_api_user"
      },
      "createdDate": "2019-05-08T10:55:36+0000",
      "id": 15,
      "name": "1.txt"
    },
    {
      "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/20",
      "createdBy": {
        "email": "john@opsramp.com",
        "firstName": "OpsRamp",
        "id": "USR0000000003",
        "lastName": "Admin",
        "loginName": "superadmin",
        "phoneNumber": ""
      },
      "createdDate": "2019-05-10T05:53:15+0000",
      "id": 20,
      "name": "bustkt.pdf"
    },
    {
      "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/21",
      "createdBy": {
        "email": "dev@opsramp.com",
        "firstName": "OpsRamp",
        "id": "USR0000000003",
        "lastName": "Admin",
        "loginName": "superadmin",
        "phoneNumber": ""
      },
      "createdDate": "2019-05-10T05:53:33+0000",
      "id": 21,
      "name": "bustkt.pdf"
    },
    {
      "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/22",
      "createdBy": {
        "email": "dev@opsramp.com",
        "firstName": "OpsRamp API User",
        "id": "USR0000000002",
        "lastName": " ",
        "loginName": "opsramp_api_user"
      },
      "createdDate": "2019-05-10T06:01:23+0000",
      "id": 22,
      "name": "queries.txt"
    }
  ],
  "category": {
    "description": "",
    "id": "KBC0000000018",
    "name": "Cassandra",
    "path": "My Category\u003e\u003eDataBase\u003e\u003eCassandra",
    "state": "ACTIVE"
  },
  "content": "Modify the Queirs Ann Data",
  "createdBy": {
    "email": "dev@opsramp.com",
    "firstName": "OpsRamp API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "createdTime": "2019-05-08T10:55:26+0000",
  "expiryDate": "2019-07-29T07:00:00+0000",
  "id": "KB0000000036",
  "linkedArticles": [
    {
      "id": "KB0000000035",
      "shared": false,
      "subject": "All Data"
    }
  ],
  "shared": false,
  "state": "PUBLISHED",
  "subject": "Need to update the Kafka Server Details",
  "updatedBy": {
    "email": "dev@opsramp.com",
    "firstName": "OpsRamp",
    "id": "USR0000000003",
    "lastName": "Admin",
    "loginName": "superadmin",
    "phoneNumber": ""
  },
  "updatedTime": "2019-05-10T05:53:33+0000"
}