Get Pending Article Compliances

Overview

  • This API allows to retrieve articles in a portal for which compliance is pending by the logged in user.
  • Only those articles in the portal will be returned which are:
    • Available for current user profile.
    • Displayable. An article is displayable if 'Include in browse on portals' property of the article type of the article is enabled.
  • Results will be sorted in ascending order of compliance due date.
SecurityoAuthUser
Request
path Parameters
portalID
required
number
Example: 202200000001001
query Parameters
$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/compliance/pending
Request samples
Response samples
application/json
{
  • "article": [
    ],
  • "overdue": 0,
  • "paginationInfo": {
    }
}