Endpoint
/api/v2/tenants/{tenantId}/kb/articlesList
Path Parameters
tenantIdstring
Query Parameters
pageNointeger
pageSizeinteger
categoryIdstring
Responses
OK
descendingOrderboolean
nextPageboolean
orderBystring
pageNointeger
pageSizeinteger
previousPageNointeger
resultsarray
Child Parameters
- results.attachments
- results.category
- Name of the knowledge base category.
- results.content
- Defines the content of the article.
- results.createdBy
- results.createdTime
- results.expiryDate
- (Optional) Defines the expiry date of the article. Date format: yyyy-MM-ddTHH:mm:ssZ. Example: 2019-07-07T09:19:47 0000 (GMT)
- results.id
- results.linkedArticles
- (Optional) Defines the list of linked articles of the article.
- results.shared
- results.state
- (Optional) Defines the published status of the article. Example: PUBLISH, DRAFT
- results.subject
- Defines the subject of the knowledge base article.
- results.updatedBy
- results.updatedTime
totalPagesinteger
totalResultsinteger
{
"descendingOrder": true,
"nextPage": true,
"nextPageNo": 2,
"orderBy": "id",
"pageNo": 1,
"pageSize": 20,
"previousPageNo": 0,
"results": [
{
"category": {
"description": "New Category",
"id": "KB0000000001",
"name": "Data",
"path": "Data",
"state": "ACTIVE"
},
"content": "Test Ticket Ignore",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "RGU",
"id": "USR0000000007",
"lastName": "Director",
"loginName": "rgu@gmail.com",
"mobileNumber": "9123456789",
"phoneNumber": "9123456789"
},
"createdTime": "2019-05-10T11:43:32+0000",
"id": "KB0000000037",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "RGU",
"id": "USR0000000007",
"lastName": "Director",
"loginName": "rgu@gmail.com",
"mobileNumber": "9123456789",
"phoneNumber": "9123456789"
},
"updatedTime": "2019-05-10T11:43:32+0000"
},
{
"attachments": [
{
"contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/23",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"createdDate": "2019-05-10T07:22:48+0000",
"id": 23,
"name": "MetricNames.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-28T18:30:00+0000",
"id": "KB0000000036",
"linkedArticles": [
{
"id": "KB0000000035",
"shared": false,
"subject": "All Data"
}
],
"shared": true,
"state": "PUBLISHED",
"subject": "Need to update the Kafka Server Details",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"updatedTime": "2019-05-10T07:22:44+0000"
},
{
"attachments": [
{
"contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000035/resources/12",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"createdDate": "2019-05-08T09:26:17+0000",
"id": 12,
"name": "bustkt.pdf"
},
{
"contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000035/resources/13",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"createdDate": "2019-05-08T09:26:23+0000",
"id": 13,
"name": "CloudIndexes"
}
],
"category": {
"description": "",
"id": "KBC0000000018",
"name": "Cassandra",
"path": "My Category\u003e\u003eDataBase\u003e\u003eCassandra",
"state": "ACTIVE"
},
"content": "All Data",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"createdTime": "2019-05-08T09:23:19+0000",
"id": "KB0000000035",
"shared": false,
"state": "PUBLISHED",
"subject": "All Data",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"updatedTime": "2019-05-08T09:26:17+0000"
},
{
"category": {
"description": "",
"id": "KBC0000000017",
"name": "Oracle",
"path": "My Category\u003e\u003eDataBase\u003e\u003eOracle",
"state": "ACTIVE"
},
"content": "Oracle",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"createdTime": "2019-05-08T09:23:00+0000",
"id": "KB0000000034",
"shared": false,
"state": "PUBLISHED",
"subject": "Oracle",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"updatedTime": "2019-05-08T09:23:00+0000"
},
{
"category": {
"description": "",
"id": "KBC0000000016",
"name": "MySql",
"path": "My Category\u003e\u003eDataBase\u003e\u003eMySql",
"state": "ACTIVE"
},
"content": "Sql",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"createdTime": "2019-05-08T09:22:41+0000",
"id": "KB0000000033",
"shared": false,
"state": "PUBLISHED",
"subject": "Sql",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"updatedTime": "2019-05-08T09:22:41+0000"
},
{
"category": {
"description": "",
"id": "KBC0000000018",
"name": "Cassandra",
"path": "My Category\u003e\u003eDataBase\u003e\u003eCassandra",
"state": "ACTIVE"
},
"content": "Cql Commands",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"createdTime": "2019-05-08T09:21:20+0000",
"id": "KB0000000032",
"shared": false,
"state": "PUBLISHED",
"subject": "Cql Commands",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"updatedTime": "2019-05-08T09:21:20+0000"
},
{
"category": {
"description": "",
"id": "KBC0000000011",
"name": "C3",
"path": "C3",
"state": "ACTIVE"
},
"content": "C3 Article .",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"createdTime": "2019-05-07T08:53:32+0000",
"id": "KB0000000031",
"shared": false,
"state": "PUBLISHED",
"subject": "C3 Article",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"updatedTime": "2019-05-07T09:22:40+0000"
},
{
"category": {
"description": "Sub Client 2",
"id": "KB0000000005",
"name": "Sub Client 2",
"path": "Sub Client 2",
"state": "ACTIVE"
},
"content": "Cat",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp",
"id": "USR0000000003",
"lastName": "Admin",
"loginName": "superadmin",
"phoneNumber": ""
},
"createdTime": "2019-05-07T07:22:05+0000",
"id": "KB0000000029",
"shared": true,
"state": "PUBLISHED",
"subject": "CAt2",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-07T07:25:55+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T10:41:28+0000",
"id": "KB0000000023",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:41:29+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T10:40:07+0000",
"id": "KB0000000022",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:40:07+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T10:38:55+0000",
"id": "KB0000000021",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:38:56+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T10:25:32+0000",
"id": "KB0000000020",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:25:32+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T10:24:13+0000",
"id": "KB0000000019",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:24:13+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T10:00:19+0000",
"id": "KB0000000016",
"linkedArticles": [
{
"id": "KB0000000009",
"shared": false,
"subject": "Test Ticket Ignore"
},
{
"id": "KB0000000008",
"shared": false,
"subject": "New Article12"
},
{
"id": "KB0000000004",
"shared": false,
"subject": "Test Aticlet 2"
}
],
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:00:19+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T10:00:00+0000",
"id": "KB0000000015",
"linkedArticles": [
{
"id": "KB0000000009",
"shared": false,
"subject": "Test Ticket Ignore"
},
{
"id": "KB0000000008",
"shared": false,
"subject": "New Article12"
}
],
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:00:00+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T09:56:21+0000",
"id": "KB0000000014",
"linkedArticles": [
{
"id": "KB0000000009",
"shared": false,
"subject": "Test Ticket Ignore"
}
],
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T09:56:21+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T09:55:26+0000",
"id": "KB0000000013",
"linkedArticles": [
{
"id": "KB0000000009",
"shared": false,
"subject": "Test Ticket Ignore"
}
],
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T09:55:26+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T09:51:43+0000",
"id": "KB0000000011",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T09:51:57+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "New Articlesdssd test",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp",
"id": "USR0000000003",
"lastName": "Admin",
"loginName": "superadmin",
"phoneNumber": ""
},
"createdTime": "2019-04-26T07:19:39+0000",
"id": "KB0000000008",
"shared": false,
"state": "PUBLISHED",
"subject": "New Article12",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp",
"id": "USR0000000003",
"lastName": "Admin",
"loginName": "superadmin",
"phoneNumber": ""
},
"updatedTime": "2019-04-29T10:16:31+0000"
},
{
"category": {
"description": "Client",
"id": "KB0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "Test Aticlet 2111",
"createdBy": {
"email": "dev@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"createdTime": "2019-04-24T05:57:35+0000",
"id": "KB0000000004",
"linkedArticles": [
{
"id": "KB0000000003",
"shared": false,
"subject": "Article 1"
}
],
"shared": true,
"state": "PUBLISHED",
"subject": "Test Aticlet 2",
"updatedBy": {
"email": "dev@opsramp.com",
"firstName": "OpsRamp",
"id": "USR0000000003",
"lastName": "Admin",
"loginName": "superadmin",
"phoneNumber": ""
},
"updatedTime": "2019-04-29T10:24:50+0000"
}
],
"totalPages": 2,
"totalResults": 21
}