Endpoint
/api/v2/tenants/{tenantId}/kb/articles/searchPath Parameters
tenantIdstring
Query Parameters
pageNointeger
pageSizeinteger
queryStringstring
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": false,
"orderBy": "id",
"pageNo": 1,
"pageSize": 20,
"previousPageNo": 0,
"results": [
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "New Articlesdssd test",
"createdBy": {
"email": "john@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": "john@opsramp.com",
"firstName": "OpsRamp",
"id": "USR0000000003",
"lastName": "Admin",
"loginName": "superadmin",
"phoneNumber": ""
},
"updatedTime": "2019-04-29T10:16:31+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "Test Aticlet 2111",
"createdBy": {
"email": "john@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"createdTime": "2019-04-24T05:57:35+0000",
"id": "KB0000000004",
"shared": true,
"state": "PUBLISHED",
"subject": "Test Aticlet 2",
"updatedBy": {
"email": "john@opsramp.com",
"firstName": "OpsRamp",
"id": "USR0000000003",
"lastName": "Admin",
"loginName": "superadmin",
"phoneNumber": ""
},
"updatedTime": "2019-04-29T10:24:50+0000"
},
{
"category": {
"description": "",
"id": "KBC0000000018",
"name": "Cassandra",
"path": "My Category\u003e\u003eDataBase\u003e\u003eCassandra",
"state": "ACTIVE"
},
"content": "Cql Commands",
"createdBy": {
"email": "john@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": "john@opsramp.com",
"firstName": "Client",
"id": "USR0000000009",
"lastName": "User",
"loginName": "Client_User",
"phoneNumber": ""
},
"updatedTime": "2019-05-08T09:21:20+0000"
},
{
"category": {
"description": "Sub Client 2",
"id": "KBC0000000005",
"name": "Sub Client 2",
"path": "Sub Client 2",
"state": "ACTIVE"
},
"content": "Cat",
"createdBy": {
"email": "john@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": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-07T07:25:55+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "john@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": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:41:29+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "john@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": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:40:07+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "john@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": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:38:56+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "john@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": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:25:32+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "john@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": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:24:13+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T10:00:19+0000",
"id": "KB0000000016",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:00:19+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T10:00:00+0000",
"id": "KB0000000015",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T10:00:00+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T09:56:21+0000",
"id": "KB0000000014",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T09:56:21+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"createdTime": "2019-05-03T09:55:26+0000",
"id": "KB0000000013",
"shared": false,
"state": "PUBLISHED",
"subject": "Test Ticket Ignore API",
"updatedBy": {
"email": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T09:55:26+0000"
},
{
"category": {
"description": "Client",
"id": "KBC0000000002",
"name": "Client",
"path": "Client",
"state": "ACTIVE"
},
"content": "test",
"createdBy": {
"email": "john@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": "john@opsramp.com",
"firstName": "OpsRamp API User",
"id": "USR0000000002",
"lastName": " ",
"loginName": "opsramp_api_user"
},
"updatedTime": "2019-05-03T09:51:57+0000"
}
],
"totalPages": 1,
"totalResults": 14
}