Start a Guided Help search

Overview

This API can be used to start a guided help search session.

PreCondition

  • 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.

Request Body

Request body is required for this operation. 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.

A guided help profile can also be specified while starting the session. This is used to filter the results of search. If this is not passed in the request, default profile of the portal is used.

Questions can also be answered at time of starting the search session.

SecurityoAuthUser or oAuthCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
number
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" "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
header Parameters
Content-Type
required
string
Default: application/json

Media type sent by the client.

Enum: "application/json" "application/xml" "application/x-www-form-urlencoded" "multipart/form-data" "text/plain"
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.

Request Body schema: application/x-www-form-urlencoded
casebaseId
number

ID of the casebase being search

profileId
number

ID of the profile used in guided help session

Array of objects (SessionContextVariable)
isStartOverSearch
number

To restart the current search, set the parameter isStartOverSearch to 1.

filterId
number

The ID of the profile used to find the database. 0 means return the latest release whose releaseId=casebaseId. 1 means return the Live release whose casebaseId=casebaseId. Any other value is treated as the value of an actual profile assigned to a casebase. A live release with this profile will be retrieved.

ghsArticleId
number

Id of the guided help session article used for starting search.

revertLastState
string

To go a step back in the current guided help session.If passed this will revert the last state of guided help search and will send it a step back.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

post/portals/{portalID}/gh/search
Request samples
application/x-www-form-urlencoded
casebaseId=217701000000001
Response samples
application/json
{
  • "casebase": {
    },
  • "actionSearch": [ ],
  • "answeredQuestion": [ ],
  • "caseSearch": [ ],
  • "dynamicSearch": [ ],
  • "unansweredQuestion": [
    ],
  • "startupQuestion": [
    ],
  • "targetClusterId": [
    ],
  • "link": [
    ]
}