Get Acknowledged Article Compliances

Request

Overview

The Get Acknowledged Article Compliances API retrieves all compliance-enabled articles in a portal that have been read by the current user in the last 60 days. Results are sorted in descending order of the acknowledgement date.

Prerequisites

The Article compliances that are returned must be:
- Available for the current user profile.
- Displayable. An article is displayable when the "Include in browse on portals" property is enabled for the article.
- Acknowledged within the last 60 days.
- Only the latest version of a republished compliance article will be shown.
- Results will be sorted in descending order of acknowledgment date.

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

Query

complianceArticleResultAdditionalAttributesArray of strings

The attributes of an Article to be returned in addition to the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.

Default Attributes

These Article attributes are always returned:

Name	Description
id	The ID of the Article.
name	The name of the Article.
updateSummary	Summary of the Article update.
articleType	The Article Type and its attributes.
createdBy	The ID, first name, middle name and last name of the user that created the Article.
createdDate	The date that the Article was created.
hasAttachments	True: The Article has one or more attachments. False: The Article does not have any attachments.
languageCode	The language code of the Article language.
modifiedBy	The ID, first name, middle name and last name of the user that last modified the Article.
modifiedDate	The date that the Article was last modified on.
link	The link object, used to retrieve the details of the Article.
versionId	The ID of the Article version that is returned.

Items Enum:"averageRating""articleSummary""customAttributes""description""imageURL""isSubscribed""timesRated""topicBreadcrumb""ownedBy""ownedBy.userName"

Examples:

Single

An additional attribute to be returned.

complianceArticleResultAdditionalAttributes=["averageRating"]

Multiple

Additional attributes to be returned.

complianceArticleResultAdditionalAttributes=["ownedBy","ownedBy.userName"]

All

All additional attributes to be returned.

complianceArticleResultAdditionalAttributes=["all"]

articleResultExtendedAttributesArray of strings

Specifies extended attributes of an Article Result to be returned in the response. This parameter is used for specific metadata fields that are not included in the default response or the standard additional attributes list.

Note: The list of supported values for this parameter may be expanded in the future as more fields are added to the article result schema.

Name	Description
availabilityDate	The date and time when the article becomes available for viewing.

Items Value:"availabilityDate"

Examples:

Single

Returns the availability date for the article result.

articleResultExtendedAttributes=["availabilityDate"]

$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

$pagenuminteger, (int64), [ 1 .. 999 ]

Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.

Default:1

$pagesizeinteger, (int64), [ 1 .. 75 ]

Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.

Default:10

Headers

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

Accept-Languagestringrequired

The Language locale accepted by the 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"

Example:en-US

curl -i -X GET \
  'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/articles/compliance/acknowledged?complianceArticleResultAdditionalAttributes=averageRating&articleResultExtendedAttributes=availabilityDate&%24lang=en-US&%24pagenum=1&%24pagesize=10' \
  -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

articleArray of objects(ArticleResult)

Article details

paginationInfoobject(PaginationInfo)

Response

{
  "article": [
    { … }
  ],
  "paginationInfo": {
    "count": 1,
    "pagenum": 1,
    "pagesize": 10
  }
}