Find Articles for Find & Replace

Overview

  • This API allows users to find articles having phrase in its content in a Folder or its subfolders.
  • Only articles having 'Edit article' permission on folder will be returned.
  • If Article result has checked-out article then Article checked-out by only current user will be returned.
  • Article result will be sorted by name.
  • Article result will be paginated.

Permissions

  • User having 'Perform Find and Replace' action will be able to access this api.
  • This role will be added to the Knowledge Base Manager user role.
SecurityoAuthUser or oAuthClient
Request
query Parameters
$lang
required
string

The knowledge base language used for retrieving response. Must be a language enabled in the system.

Enum: "en-US" "en-GB" "fr-FR" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "sv-SE" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR"
$pagenum
string

Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
Default value: 1

$pagesize
string

Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
Default value: 10

filter[folder]
required
number

ID of the folder

Example: filter[folder]=40960000000100
phrase
required
string [ 0 .. 255 ] characters

Articles having this match string in its content will be returned.

Example: phrase=television
includeSubFolders
string

Flag to search in sub folders. Allowed values are 'yes' and 'no'.

Enum: "yes" "no"
Example: includeSubFolders=yes
matchCase
string

Flag to match case during search. Allowed values are 'yes' and 'no'

Enum: "yes" "no"
Example: matchCase=no
matchWords
string

Flag to match whole word during search. Allowed values are 'yes' and 'no'

Enum: "yes" "no"
Example: matchWords=no
Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/articles/find
Request samples
Response samples
application/json
{
  • "link": {
    },
  • "paginationInfo": {
    },
  • "article": [
    ]
}