Resume a Quickpick
Overview
The Resume a Quickpick API can be used to restore (resume) a specific quickpick.
Prerequisites
- A Guided Help session for the Casebase must be started before invoking this API.
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 quickpick.
^[1-9]\d*$1 <= length <= 19Query Parameters
The language that describes the details of 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.
Value in
- "en-US"
- "fr-FR"
- "en-GB"
- "es-ES"
- "it-IT"
- "nl-NL"
- "da-DA"
- "sv-SE"
- "pt-PT"
- "fi-FI"
- "no-NB"
- "no-NN"
- "ja-JA"
- "de-DE"
- "pt-BR"
- "zh-CN"
- "zh-TW"
- "ko-KO"
- "ru-RU"
- "el-EL"
- "tr-TR"
- "pl-PL"
- "cs-CS"
- "sk-SK"
- "hu-HU"
- "sr-SR"
- "ar-SA"
- "hr-HR"
- "ro-RO"
- "th-TH"
- "de-AT"
- "vi-VN"
- "id-ID"
- "ms-MY"
- "fil-PH"
- "fr-CA"
- "hi-IN"
- "uk-UA"
- "bg-BG"
- "sl-SI"
- "xx-XX"
Custom attributes to be fetched.
Possible values are:
- question.custom.<name> where <name> is the internal name of custom attribute of question. 'question' is used as a prefix to distinguish question's custom attribute from other objects custom attributes.
^question\.custom\.[^,]+(?:,question\.custom\.[^,]+)*$1 <= length <= 4000Header 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
application/json
curl -X POST "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/gh/quickpicks/11?ghCustomAdditionalAttributes=question.custom.score" \ -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"{ "casebase": { "name": "Financial Vertical Bot", "id": "202201000000002", "status": "live", "casebaseId": "202201000000002", "profiles": [ { "profile": [ { "name": "system profile", "id": "100100000000001" } ] } ] }, "actionSearch": [ { "acceptCount": 0, "hasAdditionalInfo": true, "metadata": [], "caseId": "1000003892", "passedThresholdValue": false, "rejectCount": 0, "score": 50, "type": "control" }, { "acceptCount": 0, "hasAdditionalInfo": true, "metadata": [], "articleId": "PROD-2202", "caseId": "1000003897", "passedThresholdValue": false, "rejectCount": 0, "shortName": "Main Article", "score": 50, "type": "article", "articleTypeAttributes": { "typeName": "General" } } ], "answeredQuestion": [ { "title": "Question 1", "type": "list", "format": "radioButton", "hasAdditionalInfo": false, "hasAction": false, "previousAnswer": [ { "depth": -1, "isInvisible": false, "text": "Benefits of Membership", "id": "1000001001" } ], "validAnswer": [ { "depth": 1, "isInvisible": false, "text": "yes", "id": "1000003848" }, { "depth": 1, "isInvisible": false, "text": "no", "id": "1000003849" } ], "metadata": [], "customAttributes": [], "id": "100000385200000" } ], "caseSearch": [ { "acceptCount": 0, "action": [], "additionalInfo": true, "metadata": [], "answeredQuestion": [], "passedThresholdValue": false, "rejectCount": 0, "score": 50, "shortName": "Case4", "title": "Main Article", "caseId": "1000003897" }, { "acceptCount": 0, "action": [], "additionalInfo": true, "metadata": [], "answeredQuestion": [], "passedThresholdValue": false, "rejectCount": 0, "score": 50, "shortName": "Case1", "title": "Action", "caseId": "1000003892" } ], "dynamicSearch": [], "unansweredQuestion": [ { "title": "Question 2", "type": "list", "format": "radioButton", "shortName": "Q2", "hasAdditionalInfo": true, "hasAction": false, "validAnswer": [ { "depth": 1, "isInvisible": false, "text": "yes", "id": "1000003854" }, { "depth": 1, "isInvisible": false, "text": "no", "id": "1000003855" } ], "metadata": [], "customAttributes": [], "id": "100000385800000" } ], "startupQuestion": [], "targetClusters": [ { "id": "100000384300000" }, { "id": "100000384400000" } ]}Create Quickpick POST
## Overview The Create Quickpick API can be used to create a new quickpick(bookmark) for current Guided Help search session. Note: If "linkToActivity" attribute is passed as true in request body then one of below must be passed in header * <code>XEgainTenantId</code> * <code>xEgainActivityId</code> * <code>XInteractionId</code> ## Prerequisites * A Guided Help search session must be in progress before this API is invoked. * QuickPick can only be created for a live release of a Casebase.
Get All Bookmarks for a Portal GET
## Overview The Get All Bookmarks for a Portal API returns all bookmarks for a portal. Only the topic bookmarks that are available in the scope of the portal are returned. ## Permissions * The user must have the __View Author Portal__ action to access the authoring view. * The user must have the __View Staging Portal__ action to access the staging view.

