Get Suggestion by status

Overview

This API allows eGain users and authenticated customers to retrieve their own suggestions based on suggestion status. For this API to execute successfully:

  • The setting "Manage Suggestion" must be enabled for the portal specified in the URL.
  • If the user is a customer, the setting “Allow customer access” must be enabled for the portal.
SecurityoAuthUser or oAuthCustomer
Request
path Parameters
portalID
required
number

Bookmark object type in the bookmark folder that is being reordered.

Example: 202200000001001
query Parameters
$lang
string

The knowledge base language used for retrieving the response. This must be a language that is made available to the user. If this parameter is not passed, then the default language of the system is used.

Enum: "en-US" "en-GB" "fr-FR" "fi-FI" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DA" "ru-RU" "zh-CN" "sv-SE" "no-NB" "no-NN" "zh-TW" "tr-TR" "pl-PL" "cs-CS" "hu-HU" "ar-SA" "ro-RO" "ja-JA" "ko-KO" "el-EL" "xx-XX"
Example: $lang=en-US
filter[status]
required
string

Type of resource to be fetched.

Enum: "suggested" "pending" "declined" "approved"
Example: filter[status]=suggested
$sort
string

Objects returned in server response are sorted based on the attribute supplied under $sort.

Enum: "id" "name"
$order
string

Common query parameter $order.

Enum: "asc" "desc"
$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}/suggestions
Request samples
Response samples
application/json
{
  • "suggestion": [
    ],
  • "paginationInfo": {
    }
}