Get Article Versions By IDs

Request

Overview

The Get Article Versions By IDs API retrieves a published version of an Article in a portal, including its content, identified by its version ID.
- Up to two version IDs may be supplied as a comma-separated list to retrieve two versions in a single call.
Only published versions are returned.
- A requested version that is not published is omitted from the response.
The versions that are returned, and the content shown for each version, honor the logged-in user's profile and personalized view of the Article, consistent with how Article content is personalized across the portal.
- A requested version that the user's assigned user profile does not grant access to is omitted.
- The optional publishViewId query parameter returns the editions for a specific publish view. If it is not provided, the publish view from the logged-in user's assigned user profile is used.
Each version lists the editions available to the user under availableEditions. A version may have zero or more editions.
- Content is always returned on the version content field (omitted when blank), matching Get Article.
- When the version has editions, the edition that supplied that content is marked with isContentEdition: true; other editions omit the flag.
- When the version has no editions, content is the base version content and availableEditions is empty.

Security

oAuthUser(Required scopes: ) or oAuthOnBehalfOfUser(Required scopes: )

Path

portalIDstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

The ID of the portal being accessed.

A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Example:PROD-1000

articleIDstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

The ID of the Article.

An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.

Example:PROD-2996

versionIDsstring, [ 7 .. 41 ] characters^([a-zA-Z0-9]{2,4}-\d{4,15})(,([a-zA-Z0-9]{2,...required

A comma-separated list of one or two article version IDs.

Each version ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits. A maximum of two version IDs may be requested in a single call.

Examples:

Single version

A single article version ID.

PROD-2884

Multiple versions

Two article version IDs retrieved in a single call.

PROD-2884,PROD-2883

Query

publishViewIdstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$

The ID of the publish view for which editions are returned. If not provided, the publish view from the logged-in user's assigned user profile is used.

A publish view ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Example:publishViewId=PROD-3203

$langstring(languageCode)

The language used for a resource. Resources available in different languages may differ from each other. If $lang is not passed, then the portal's default language is used.

Enum:"en-US""fr-FR""en-GB""es-ES""it-IT""nl-NL""da-DA""sv-SE""pt-PT""fi-FI"

Example:$lang=en-US

Headers

Accept-Languagestringrequired

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

Enum:"en-US""en-GB""es-ES""fr-FR""it-IT""de-DE""nl-NL""pt-BR""pt-PT""da-DK"

Example:en-US

x-egain-activity-idstring, [ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example:59237

x-ext-integration-idstring, <= 40 characters^[\w\W]+$

The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.

Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.

The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

Examples:

uuid

3155180e-0c13-43e9-9c38-e9045bcbf176

hex

00Dbn00000IxGnx

x-ext-interaction-idstring, <= 40 characters^[\w\W]+$

A unique interaction identifier from other CRM applications.

Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.

The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

Examples:

uuid

3155180e-0c13-43e9-9c38-e9045bcbf176

hex

00Dbn00000IxGnx

curl -i -X GET \
  'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996/versions/PROD-2884?publishViewId=PROD-3203&%24lang=en-US' \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-egain-activity-id: 59237' \
  -H 'x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176' \
  -H 'x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176'

Responses

Success

Bodyapplication/json

versionsArray of objects, [ 1 .. 2 ] items(Version)

The requested article versions, in the order the IDs were supplied.

Response

{
  "versions": [
    { … },
    { … }
  ]
}