Resume a Quickpick

Overview

This API can be used to restore(resume) a specific quickpick.

PreCondition

A Guided help session for the casebase must be started before invoking this API.

SecurityoAuthUser or oAuthCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
quickpickID
required
number

ID of the quickpickID which is being restored

Example: 150
query Parameters
casebaseID
number

Release ID of the casebase which is being accessed.

Example: casebaseID=202201000000008
$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
$attribute
string

Additional attributes to be fetched.

Example: $attribute=question.answerSource, question.custom.name
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

post/portals/{portalID}/gh/quickpicks/{quickpickID}
Request samples
Response samples
application/json
{
  • "actionSearch": [
    ],
  • "answeredQuestion": [
    ],
  • "caseSearch": [
    ],
  • "dynamicSearch": [ ],
  • "unansweredQuestion": [
    ],
  • "startupQuestion": [ ],
  • "targetClusterId": [
    ]
}