Get All Articles

Overview

Get Articles for Folder, Topic, Case, Classifications or Related Articles

Permissions

  • User must have 'View Folder' permission on the parent folder of the articles.

Note

  • Query parameters folderId, topicId, caseId, classificationId, relatedArticleId are mutually exclusive. Only one of them can be used at a time.
SecurityoAuthUser or oAuthClient
Request
query Parameters
filter[folder]
string

folder id

Example: filter[folder]=409700000001010
filter[case]
string

case id of case base

Example: filter[case]=409700000002081
filter[topic]
string

topic id

Example: filter[topic]=409700000001010
filter[classification]
string

classification id

Example: filter[classification]=409700000001010
filter[relatedArticle]
string

Id of the article for will all related articles will be returned

Example: filter[relatedArticle]=409700000001010
$attribute
string

article attributes to be returned. comma separated input

Enum: "id" "lastModified" "created" "suggestionState" "folder" "lock" "language" "attachments" "name" "versionNumber" "articleState" "availabilityDate" "expirationDate" "description" "imageUrl" "department" "articleType" "linkAlias" "path" "suggestionResolutionCode" "currentReviewStage" "previousReviewStage" "currentWorkflow" "ownedBy" "lockedBy" "expiryDateTimeZone" "availabilityDateTimeZone" "returnArticleStateInfo" "all"
filter[includeArticleTypes]
string

Attributes to filter articles based on their type. If provided, the returned artilces will have types as provided in this filter Provide comma seperatd article type.

Example: filter[includeArticleTypes]=409700000001010,409700000001011,409700000001012
filter[excludeArticleTypes]
string

Attributes to filter articles based on their type. If provided, the returned artilces will have types other than those provided in this filter Provide comma seperatd article type.

Example: filter[excludeArticleTypes]=409700000001010,409700000001011,409700000001012
filter[name]
string

Article Name starts with specified text

Example: filter[name]=Policy
$lang
string

The knowledge base language used for retrieving the response. This must be a language that is made available to the user. If this parameter is not passed, then the default language of the system is used.

Enum: "en-US" "en-GB" "fr-FR" "fi-FI" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DA" "ru-RU" "zh-CN" "sv-SE" "no-NB" "no-NN" "zh-TW" "tr-TR" "pl-PL" "cs-CS" "hu-HU" "ar-SA" "ro-RO" "ja-JA" "ko-KO" "el-EL" "xx-XX"
Example: $lang=en-US
$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

$sort
string

article attributes to be sorted. comma separated input

Enum: "id" "name" "createdAt" "createdBy" "lastModifiedAt" "lastModifiedBy" "owner" "description" "checkedOutBy" "articleType" "folderName"
$order
string

Common query parameter $order.

Enum: "asc" "desc"
Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Preconditions failed

500

Internal server error

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