Perform a Step in a Guided Help Search
Overview
The Perform a Step in a Guided Help Search API can be used to answer one or more questions (perform a step) in Guided Help search.
Prerequisites
- A Guided Help session must be in progress before this API is invoked.
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 <= 20Query 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 media type sent by the client.
"application/json"Value in
- "application/json"
The 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"
Request Body
application/json
The numerical ID of the Casebase.
^[1-9]\d*$15 <= length <= 15Pre-answered Questions in Guided Help search
1 <= items <= 500The ID of the guided help profile. 1 will always be the system profile.
^1$|^[1-9]\d{9,15}$1 <= length <= 15Session variables used to give Guided Help additional context.
Restart the current Guided Help search with the existing context along with session variable context.
Use current live release snapshot of the Casebase otherwise use the authoring release.
Numeric ID of the guided help session article used for starting search.
^[1-9]\d*$15 <= length <= 15Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/gh/search?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 "Content-Type: application/json" \ -H "Accept-Language: en-US" \ -H "Content-Type: application/json" \ -d '{ "casebaseId": "202201000000002", "questions": [ { "id": "1000000322", "answers": [ { "id": "1000000303" } ] }, { "id": "1000000327", "answers": [ { "id": "1000000842" } ] }, { "id": "1000001006", "answers": [ { "id": "1000001001" } ] } ], "useLiveRelease": true }'{ "casebase": { "name": "Financial Vertical Bot", "status": "author", "casebaseId": "202201000000002", "profiles": [ { "profile": [ { "name": "system profile", "id": "100100000000001" } ] } ], "id": "202201000000002", "searchSettings": { "closeSessionOnAccept": true, "closeSessionOnReject": true } }, "actionSearch": [ { "acceptCount": 0, "additionalInfo": true, "metadata": [ { "title": "", "additionalInformation": "", "action": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<iAutomatedAction><iContextSwitchCommandList><iContextSwitchAdd><iTargetClusterIdList><iId>1000000259</iId></iTargetClusterIdList></iContextSwitchAdd></iContextSwitchCommandList></iAutomatedAction>" } ], "articleId": "", "caseId": "1000000332", "passedThreshold": true, "rejectCount": 0, "score": 100, "type": "control", "articleTypeAttributes": { "typeName": "General", "useStructuredAuthoring": false }, "id": "1000000265" }, { "acceptCount": 0, "additionalInfo": true, "metadata": [ { "title": "", "additionalInformation": "", "action": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<iAutomatedAction><iContextSwitchCommandList><iContextSwitchAdd><iTargetClusterIdList><iId>1000000402</iId></iTargetClusterIdList></iContextSwitchAdd></iContextSwitchCommandList></iAutomatedAction>" } ], "articleId": "", "caseId": "1000000864", "passedThreshold": true, "rejectCount": 0, "score": 100, "type": "control", "articleTypeAttributes": { "typeName": "General", "useStructuredAuthoring": false }, "id": "1000000834" }, { "acceptCount": 0, "additionalInfo": true, "metadata": [ { "title": "", "additionalInformation": "", "action": "<p>For more information about all of the great benefits of becoming a [Sample Company Name] member, visit Member Benefits via [Sample Link to Account]. You can also connect with a customer service representative via [Sample Main Customer Support Phone Number], our regular business hours are [Insert Customer Hours].</p>" } ], "articleId": "PROD-2827", "alternateId": "PROD-2827", "caseId": "1000001087", "passedThreshold": true, "rejectCount": 0, "shortName": "Member Benefits Information", "score": 100, "type": "article", "articleTypeAttributes": { "typeName": "General", "useStructuredAuthoring": false }, "id": "1000001086" } ], "answeredQuestion": [ { "title": "What about your membership do you want to learn more about?", "type": "enumerated", "format": "dropdown", "shortName": "Q002 - What about membership?", "hasAdditionalInfo": false, "hasAction": false, "previousAnswer": [ { "depth": -1, "isInvisible": false, "text": "Benefits of Membership", "id": "1000001001" } ], "validAnswer": [ { "depth": 1, "isInvisible": false, "text": "Becoming a Member", "id": "1000001000" }, { "depth": 1, "isInvisible": false, "text": "Benefits of Membership", "id": "1000001001" }, { "depth": 1, "isInvisible": false, "text": "Discontinuing Membership", "id": "1000001002" } ], "metadata": [ { "title": "", "additionalInformation": "", "action": "" } ], "customAttribute": [], "answerSource": "user", "id": "1000001006" }, { "title": "[ML]Label", "type": "enumerated", "format": "dropdown", "shortName": "Classifier", "hasAdditionalInfo": false, "hasAction": false, "previousAnswer": [ { "depth": -1, "isInvisible": false, "text": "Membership", "id": "1000000842" } ], "validAnswer": [ { "depth": 1, "isInvisible": false, "text": "None", "id": "1000000272" }, { "depth": 1, "isInvisible": false, "text": "Membership", "id": "1000000842" }, { "depth": 1, "isInvisible": false, "text": "Online Banking", "id": "1000000843" }, { "depth": 1, "isInvisible": false, "text": "Checking and Savings", "id": "1000000844" }, { "depth": 1, "isInvisible": false, "text": "Debit Card", "id": "1000000845" }, { "depth": 1, "isInvisible": false, "text": "Credit Card", "id": "1000000846" }, { "depth": 1, "isInvisible": false, "text": "Loans", "id": "1000000847" }, { "depth": 1, "isInvisible": false, "text": "Something Else", "id": "1000000848" }, { "depth": 1, "isInvisible": false, "text": "Chat with an Agent", "id": "1000002048" } ], "action": [ { "type": "article", "shortName": "AnswerAs label", "rejectCount": 0, "articleId": "202200000002790", "acceptCount": 0, "metadata": [ { "title": "", "additionalInformation": "", "action": "{ \"function\": \"auto-answer\",\n \"var-name\": \"label\",\n \"action\": {\n \"action-type\": \"\",\n \"name\": \"\",\n \"_comment\": \"modify the number and type of parameters below to match the arguments that you want to pass to the data link\",\n \"parameters\": []\n }\n}" } ] } ], "metadata": [ { "title": "", "additionalInformation": "", "action": "" } ], "customAttribute": [], "answerSource": "user", "id": "1000000327" }, { "title": "[ML]Label Confidence", "type": "enumerated", "format": "dropdown", "shortName": "ML1", "hasAdditionalInfo": false, "hasAction": false, "previousAnswer": [ { "depth": -1, "isInvisible": false, "text": "HIGH", "id": "1000000303" } ], "validAnswer": [ { "depth": 1, "isInvisible": false, "text": "HIGH", "id": "1000000303" }, { "depth": 1, "isInvisible": false, "text": "MEDIUM", "id": "1000000304" }, { "depth": 1, "isInvisible": false, "text": "LOW", "id": "1000000305" }, { "depth": 1, "isInvisible": false, "text": "NA", "id": "1000000306" } ], "metadata": [ { "title": "", "additionalInformation": "", "action": "" } ], "customAttribute": [], "answerSource": "user", "id": "1000000322" } ], "caseSearch": [ { "acceptCount": 0, "action": [ { "type": "article", "shortName": "Member Benefits Information", "rejectCount": 0, "articleId": "202200000002827", "acceptCount": 0, "metadata": [ { "title": "", "additionalInformation": "", "action": "<p>For more information about all of the great benefits of becoming a [Sample Company Name] member, visit Member Benefits via [Sample Link to Account]. You can also connect with a customer service representative via [Sample Main Customer Support Phone Number], our regular business hours are [Insert Customer Hours].</p>" } ] } ], "additionalInfo": false, "metadata": [], "passedThreshold": true, "rejectCount": 0, "score": 100, "shortName": "Case56", "title": "Member Benefits Information", "id": "1000001087" } ], "dynamicSearch": [], "unansweredQuestion": [], "startupQuestion": [], "targetClusters": [ { "id": "1000000258" }, { "id": "1000000259" }, { "id": "1000000402" } ]}Start a Guided Help Search POST
## Overview The Start a Guided Help search can be used to start a search session in the Guided Help. A Guided Help profile can also be specified while starting the session and it is used to filter the results of search. If this is not passed in the request, the default profile of the portal is used. Questions can also be answered at time of starting the search session. A Guided Help search session can be started in following ways: * Launch session for a specific Casebase Release. * Launch session for a Casebase and specify the release type. * Use a Guided Help session Article and pass the required session parameters. ## Prerequisites * A Guided Help profile must be assigned to the user. * Casebase Release passed in the request must be associated with the portal passed in URI.
Get All Cases of a Cluster in Release GET
## Overview The Get All Cases of a Cluster in Release API retrieves all cases in cluster of a Casebase Release. A Case is a group of Questions, Articles, and control actions that work together to guide users through a series of questions and scenarios in a Guided Help session. ## Prerequisites A Guided Help search session for the provided Casebase Release must be in progress before this API is invoked.

