Comply With an Article
Overview
The Comply with an Article API allows the user to comply with an article by passing the Article's ID, which marks it as read by the user.
Prerequisites
- The user must be an agent and:
- Be available in the portal.
- Be available for the current user profile.
- Have the Article's compliance policy enabled.
- If the Article has Access Tags, then it must be available for the agent's current user profile.
- If the Article has Publish Views, then at least one edition of the Article must be available for the agent's current user profile.
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
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.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20The ID of the Article.An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20Header Parameters
A unique numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9The 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.
^[\w\W]+$length <= 40A 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.
^[\w\W]+$length <= 40The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
Value in
- "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"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996/comply" \ -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" \ -H "Accept-Language: en-US"Get Acknowledged Article Compliances GET
## 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.
My Subscription GET
## Overview The My Subscription API allows authenticated users and agents to retrieve the list of articles to which they are subscribed.

