Get list of articles

This endpoint is used to get list of articles.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/kb/articlesList?categoryId=&pageNo={pageNo}&pageSize={pageSize}

Sample URLs

https://{api-url}/api/v2/tenants/client_11/kb/articlesList?categoryId=&pageNo=1&pageSize=20

Status code

200 OK

Sample response

{
    "results": [
        {
            "id": "KB0000000037",
            "subject": "Test Ticket Ignore",
            "content": "Test Ticket Ignore",
            "createdTime": "2019-05-10T11:43:32+0000",
            "updatedTime": "2019-05-10T11:43:32+0000",
            "createdBy": {
                "id": "USR0000000007",
                "loginName": "rgu@gmail.com",
                "lastName": "Director",
                "firstName": "RGU",
                "email": "dev@opsramp.com",
                "phoneNumber": "9123456789",
                "mobileNumber": "9123456789"
            },
            "updatedBy": {
                "id": "USR0000000007",
                "loginName": "rgu@gmail.com",
                "lastName": "Director",
                "firstName": "RGU",
                "email": "dev@opsramp.com",
                "phoneNumber": "9123456789",
                "mobileNumber": "9123456789"
            },
            "shared": false,
            "category": {
                "id": "KB0000000001",
                "name": "Data",
                "description": "New Category",
                "path": "Data",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000036",
            "subject": "Need to update the Kafka Server Details",
            "content": "Modify the Queirs Ann Data",
            "createdTime": "2019-05-08T10:55:26+0000",
            "updatedTime": "2019-05-10T07:22:44+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "shared": true,
            "category": {
                "id": "KBC0000000018",
                "name": "Cassandra",
                "description": "",
                "path": "My Category>>DataBase>>Cassandra",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED",
            "attachments": [
                {
                    "id": 23,
                    "name": "MetricNames.txt",
                    "createdDate": "2019-05-10T07:22:48+0000",
                    "createdBy": {
                        "id": "USR0000000009",
                        "loginName": "Client_User",
                        "lastName": "User",
                        "firstName": "Client",
                        "email": "dev@opsramp.com",
                        "phoneNumber": ""
                    },
                    "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/23"
                }
            ],
            "expiryDate": "2019-07-28T18:30:00+0000",
            "linkedArticles": [
                {
                    "id": "KB0000000035",
                    "subject": "All Data",
                    "shared": false
                }
            ]
        },
        {
            "id": "KB0000000035",
            "subject": "All Data",
            "content": "All Data",
            "createdTime": "2019-05-08T09:23:19+0000",
            "updatedTime": "2019-05-08T09:26:17+0000",
            "createdBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KBC0000000018",
                "name": "Cassandra",
                "description": "",
                "path": "My Category>>DataBase>>Cassandra",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED",
            "attachments": [
                {
                    "id": 12,
                    "name": "bustkt.pdf",
                    "createdDate": "2019-05-08T09:26:17+0000",
                    "createdBy": {
                        "id": "USR0000000009",
                        "loginName": "Client_User",
                        "lastName": "User",
                        "firstName": "Client",
                        "email": "dev@opsramp.com",
                        "phoneNumber": ""
                    },
                    "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000035/resources/12"
                },
                {
                    "id": 13,
                    "name": "CloudIndexes",
                    "createdDate": "2019-05-08T09:26:23+0000",
                    "createdBy": {
                        "id": "USR0000000009",
                        "loginName": "Client_User",
                        "lastName": "User",
                        "firstName": "Client",
                        "email": "dev@opsramp.com",
                        "phoneNumber": ""
                    },
                    "contentURL": "https://api.opsramp.com/api/v2/tenants/client_11/article/KB0000000035/resources/13"
                }
            ]
        },
        {
            "id": "KB0000000034",
            "subject": "Oracle",
            "content": "Oracle",
            "createdTime": "2019-05-08T09:23:00+0000",
            "updatedTime": "2019-05-08T09:23:00+0000",
            "createdBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KBC0000000017",
                "name": "Oracle",
                "description": "",
                "path": "My Category>>DataBase>>Oracle",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000033",
            "subject": "Sql",
            "content": "Sql",
            "createdTime": "2019-05-08T09:22:41+0000",
            "updatedTime": "2019-05-08T09:22:41+0000",
            "createdBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KBC0000000016",
                "name": "MySql",
                "description": "",
                "path": "My Category>>DataBase>>MySql",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000032",
            "subject": "Cql Commands",
            "content": "Cql Commands",
            "createdTime": "2019-05-08T09:21:20+0000",
            "updatedTime": "2019-05-08T09:21:20+0000",
            "createdBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KBC0000000018",
                "name": "Cassandra",
                "description": "",
                "path": "My Category>>DataBase>>Cassandra",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000031",
            "subject": "C3 Article",
            "content": "C3 Article .",
            "createdTime": "2019-05-07T08:53:32+0000",
            "updatedTime": "2019-05-07T09:22:40+0000",
            "createdBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KBC0000000011",
                "name": "C3",
                "description": "",
                "path": "C3",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000029",
            "subject": "CAt2",
            "content": "Cat",
            "createdTime": "2019-05-07T07:22:05+0000",
            "updatedTime": "2019-05-07T07:25:55+0000",
            "createdBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": true,
            "category": {
                "id": "KB0000000005",
                "name": "Sub Client 2",
                "description": "Sub Client 2",
                "path": "Sub Client 2",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000023",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T10:41:28+0000",
            "updatedTime": "2019-05-03T10:41:29+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000022",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T10:40:07+0000",
            "updatedTime": "2019-05-03T10:40:07+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000021",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T10:38:55+0000",
            "updatedTime": "2019-05-03T10:38:56+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000020",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T10:25:32+0000",
            "updatedTime": "2019-05-03T10:25:32+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000019",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T10:24:13+0000",
            "updatedTime": "2019-05-03T10:24:13+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000016",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T10:00:19+0000",
            "updatedTime": "2019-05-03T10:00:19+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED",
            "linkedArticles": [
                {
                    "id": "KB0000000009",
                    "subject": "Test Ticket Ignore",
                    "shared": false
                },
                {
                    "id": "KB0000000008",
                    "subject": "New Article12",
                    "shared": false
                },
                {
                    "id": "KB0000000004",
                    "subject": "Test Aticlet 2",
                    "shared": false
                }
            ]
        },
        {
            "id": "KB0000000015",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T10:00:00+0000",
            "updatedTime": "2019-05-03T10:00:00+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED",
            "linkedArticles": [
                {
                    "id": "KB0000000009",
                    "subject": "Test Ticket Ignore",
                    "shared": false
                },
                {
                    "id": "KB0000000008",
                    "subject": "New Article12",
                    "shared": false
                }
            ]
        },
        {
            "id": "KB0000000014",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T09:56:21+0000",
            "updatedTime": "2019-05-03T09:56:21+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED",
            "linkedArticles": [
                {
                    "id": "KB0000000009",
                    "subject": "Test Ticket Ignore",
                    "shared": false
                }
            ]
        },
        {
            "id": "KB0000000013",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T09:55:26+0000",
            "updatedTime": "2019-05-03T09:55:26+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED",
            "linkedArticles": [
                {
                    "id": "KB0000000009",
                    "subject": "Test Ticket Ignore",
                    "shared": false
                }
            ]
        },
        {
            "id": "KB0000000011",
            "subject": "Test Ticket Ignore API",
            "content": "test",
            "createdTime": "2019-05-03T09:51:43+0000",
            "updatedTime": "2019-05-03T09:51:57+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000008",
            "subject": "New Article12",
            "content": "New Articlesdssd test",
            "createdTime": "2019-04-26T07:19:39+0000",
            "updatedTime": "2019-04-29T10:16:31+0000",
            "createdBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "id": "KB0000000004",
            "subject": "Test Aticlet 2",
            "content": "Test Aticlet 2111",
            "createdTime": "2019-04-24T05:57:35+0000",
            "updatedTime": "2019-04-29T10:24:50+0000",
            "createdBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "shared": true,
            "category": {
                "id": "KB0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED",
            "linkedArticles": [
                {
                    "id": "KB0000000003",
                    "subject": "Article 1",
                    "shared": false
                }
            ]
        }
    ],
    "totalResults": 21,
    "orderBy": "id",
    "pageNo": 1,
    "pageSize": 20,
    "totalPages": 2,
    "nextPage": true,
    "nextPageNo": 2,
    "previousPageNo": 0,
    "descendingOrder": true
}