Get All Article Versions

Overview

  • This API allows user to all the versions of an article in specified language.

Permissions

  • 'View Article' permission on article's parent folder is required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
ID
required
string

The ID of the article for which the operation is performed. Both numeric and alternate ID formats are supported.

Examples:
A readable article ID.
PROD-2268
A numeric article ID.
202200000002268
query Parameters
$lang
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

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
$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"
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/articles/{ID}/versions
Request samples
Response samples
application/json
{
  • "article": {
    }
}