Get Latest Version of All Articles For Folder

Overview

  • This API returns the latest version of all articles for the given folder.

Permissions

  • The requesting user must have 'View Articles' permissions on requested folder to view articles.
SecurityoAuthUser or oAuthClient
Request
query Parameters
filter[folder]
required
string

folder id

Example: filter[folder]=409700000001010
$attribute
string

article attributes to be returned. comma separated input

Enum: "id" "lastModified" "created" "suggestionState" "folder" "lock" "language" "name" "versionNumber" "articleState" "availabilityDate" "expirationDate" "description" "keywords" "summary" "additionalInfo" "label" "imageUrl" "department" "articleType" "notes" "macro" "linkAlias" "availableEditions" "path" "personalization" "classification" "suggestionResolutionCode" "currentReviewStage" "previousReviewStage" "currentWorkflow" "ownedBy" "lockedBy" "expiryDateTimeZone" "availabilityDateTimeZone" "returnArticleStateInfo" "all"
expandMacros
string

This is an optional query parameter. Allowed values are 'yes' or 'no'. If 'expandMacros=yes', then it will expand all the macros in the result.

Enum: "no" "yes"
Example: expandMacros=no
$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" "description" "createdAt" "createdBy" "lastModifiedAt" "lastModifiedBy" "owner" "checkedOutBy" "workflowName" "reviewStageName" "previousStageName" "currentStageTime" "lastReviewedBy" "articleType" "folderName" "departmentName"
$order
string

Common query parameter $order.

Enum: "asc" "desc"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

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