Get Articles List By Id

Overview

This API allows a user to fetch details of an article list configured in portal.

SecurityoAuthUser or oAuthCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
listID
required
number

ID of the list to be fetched

Example: 1003
query Parameters
topicId
number

ID of the topic to filter articles returned in the list.

Example: topicId=202200000001037
$attribute
string

Common query parameter $attribute. Below attributes of articles are returned.

Enum: "articleMacro" "availabilityDate" "averageRating" "contentText" "orderNumber" "suggestionType" "timesRated" "availableEditions" "content" "parentFolderId" "parentFolderType" "articleTypeAttributes"
Example: $attribute=articleMacro
$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" "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"
Example: $lang=en-US
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

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

Unique identifier for tenant.

X-egain-activity-id
integer

Numeric unique identifier of interaction from eGain.

X-interaction-id
string

Unique identifier for interaction from other CRM applications.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/portals/{portalID}/articlelists/{listID}
Request samples
Response samples
application/json
{
  • "articleList": [
    ]
}