Get Directly Related Articles

Overview

  • This API allows users to get only related articles for an article Id.

Permissions

  • Articles in folders (personal or shared): 'View folder' permission is required.
Request
path Parameters
ID
required
number

Article Id

Example: 40960000000012
query Parameters
$attribute
string

article attributes to be returned. comma separated input

Enum: "id" "name" "description" "lastModified" "folder" "department" "path" "all"
$lang
required
string

The knowledge base language used for retrieving response. Must be a language accessible to user.

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

500

Internal server error

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