Search articles

This endpoint is used to search for the list of articles in a knowledge base category.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/kb/articles/search

Sample URLs

https://{api-url}/api/v2/tenants/client_11/kb/articles/search?pageNo=1&pageSize=20&queryString=state:Published+categoryId:KBC0000000002

Parameters

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
queryString={queryString}NA

NA indicates that the value is not applicable.

Query variables

Query VariableValuesDescription
idKnowledge base article identification number.
subjectDatabaseSubject of the knowledge base article.
contentSample ContentContent of the knowledge base article.
statesPublished, Expired, Trash, DraftCurrent status of the article.
categoryIdKBC0000000002ID of the knowledge base category.
categoryNameClientName of the knowledge base category.
startExpiryDateyyyy-MM-ddTHH:mm:ssZFilter the articles based on their expiry date.
startExpiryDate denotes the starting range of the article expiry date.
Example: 2019-02-24T09:19:47 0000 (GMT)
endExpiryDateyyyy-MM-ddTHH:mm:ssZFilter the articles based on their expiry date. endExpiryDate denotes the ending range of the article expiry date.
Example: 2019-02-25T10:20:47 0000 (GMT)

Status code

200 OK

Sample response

{
    "results": [
        {
            "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": "john@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "john@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "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": "john@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "john@opsramp.com",
                "phoneNumber": ""
            },
            "shared": true,
            "category": {
                "id": "KBC0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "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": "john@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000009",
                "loginName": "Client_User",
                "lastName": "User",
                "firstName": "Client",
                "email": "john@opsramp.com",
                "phoneNumber": ""
            },
            "shared": false,
            "category": {
                "id": "KBC0000000018",
                "name": "Cassandra",
                "description": "",
                "path": "My Category>>DataBase>>Cassandra",
                "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": "john@opsramp.com",
                "phoneNumber": ""
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": true,
            "category": {
                "id": "KBC0000000005",
                "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": "john@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "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": "john@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "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": "john@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "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": "john@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "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": "john@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "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": "john@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "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": "john@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "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": "john@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "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": "john@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        },
        {
            "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": "john@opsramp.com"
            },
            "updatedBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "john@opsramp.com"
            },
            "shared": false,
            "category": {
                "id": "KBC0000000002",
                "name": "Client",
                "description": "Client",
                "path": "Client",
                "state": "ACTIVE"
            },
            "state": "PUBLISHED"
        }
    ],
    "totalResults": 14,
    "orderBy": "id",
    "pageNo": 1,
    "pageSize": 20,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": true
}