Get Articles In Topic

Overview

  • This API allows the articles in a topic that are browsable to be retrieved.

Permission

  • Only those articles with an article type where the value of the “Include in browse on portals” attribute is Yes are returned.
  • Agents without a user profile and customers in a portal without a default user profile only have access to articles:
    • Without any access tags
    • Without any publish views
    • With a publish view without any tags
  • Agents with a user profile and customers in a portal with a default user profile have access to articles:
    • Without any access tag
    • Without any publish views
    • With a publish view without any tags
    • With access tags included in the user profile
    • With publish views with tags included in the user profile
  • Agents with the following actions can view updates to articles currently being processed in workflows:
    • View Author Portal – allows agents to view updates to articles at any stage in a workflow
    • View Staging Portal – allows agents to view updates to articles in the Staging stage or a subsequent stage in a workflow
SecurityoAuthUser or oAuthCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
query Parameters
filter[topic]
required
string

topicId or readable topicId

Examples:
Providing readable topic id.
filter[topic]=PROD-1037
Providing numeric topic id.
filter[topic]=202200000001037
$attribute
string

The fields of the article to be returned.

Enum: "articleMacro" "availabilityDate" "averageRating" "contentText" "orderNumber" "suggestionType" "timesRated" "availableEditions" "articleTypeAttributes" "milestone" "all"
Example: $attribute=articleMacro
filter[tags]
string

A comma separated list of Tag / Tag Group IDs. Tag IDs and Tag Group IDs can be mixed together.

Example: filter[tags]=202200000001177,202200000001185
workflowMilestone
string

For agents with the View Author Portal or View Staging Portal actions, this determines which version of the article is returned; the most recent published version or the updated version currently being processed in a workflow.

Enum: "staging" "authoring" "publish"
Example: workflowMilestone=publish
$lang
string

The knowledge base language used for retrieving response. Must be a language accessible to user. If this parameter is not passed, 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
$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

$rangestart
string

Range parameter that specifies the starting index of the range of results to be returned. Used in conjunction with $rangesize.
Default value: 1

$rangesize
string

Range parameter that specifies the number (range) of results to be returned. Used in conjunction with $rangestart.
Default value: 10

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}/articles
Request samples
Response samples
application/json
{
  • "article": [
    ],
  • "paginationInfo": {
    }
}