# Guided Help Guided Help APIs ## Get Available Casebases Releases - [GET /portals/{portalID}/gh/casebasereleases](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/getallcasebasesreleases.md): ## Overview The Get Available Casebases Releases API retrieves all Casebase Releases associated with a portal. ## Get Details of a Casebase Release - [GET /portals/{portalID}/gh/casebasereleases/{casebaseReleaseID}](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/getcasebasereleasebyid.md): ## Overview The Get Details of a Casebase Release API retrieves details of Casebase Release. ## Get Cluster Details of a Casebase Release - [GET /portals/{portalID}/gh/casebasereleases/{casebaseReleaseID}/clusters](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/getclusterbycasebasereleaseid.md): ## Overview The Get Cluster Details of a Casebase Release API retrieves cluster details of Casebase Release. ## Get All Profiles Available in Portal - [GET /portals/{portalID}/gh/profiles](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/getallprofilesinportal.md): ## Overview The Get All Profiles Available in Portal API retrieves all Guided Help profiles associated with a portal. ## Start a Guided Help Search - [POST /portals/{portalID}/gh/search](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/startghsearch.md): ## 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. ## Perform a Step in a Guided Help Search - [PUT /portals/{portalID}/gh/search](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/stepghsearch.md): ## 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. ## Get All Cases of a Cluster in Release - [GET /portals/{portalID}/gh/casebasereleases/{casebaseReleaseID}/clusters/{clusterID}/cases](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/getallcases.md): ## 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. ## Get Details of a Case - [GET /portals/{portalID}/gh/casebasereleases/{casebaseReleaseID}/cases/{caseID}](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/getcasebyid.md): ## Overview The Get Details of a Case API retrieves details of a case in a release. ## Prerequisites * A Guided Help search session for the provided Casebase Release must be in progress before this API is invoked. ## Accept Solution - [POST /portals/{portalID}/gh/cases/{caseID}/accept](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/acceptghsolution.md): ## Overview The Accept Solution API can be used to accept and add positive score to a solution of a Guided Help case. ## Prerequisites * A Guided Help search session must be started before invoking this API. ## Reject Solution - [POST /portals/{portalID}/gh/cases/{caseID}/reject](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/rejectghsolution.md): ## Overview The Reject Solution API can be used to reject and add negative score to a solution of a Guided Help case. ## Prerequisites * A Guided Help search session must be started before invoking this API. ## Create Quickpick - [POST /portals/{portalID}/gh/quickpicks](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/createquickpick.md): ## 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 * XEgainTenantId * xEgainActivityId * XInteractionId ## 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 Quickpicks for a Portal - [GET /portals/{portalID}/gh/quickpicks](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/getallquickpicks.md): ## Overview The Get All Quickpicks for a Portal API retrieves details of quickpicks created for the Casebase. ## Conditions If "getLastSavedQuickPickForInteraction" query parameter is passed as "Yes" then one of below must be passed in request header. * X-ext-integration-id * X-egain-activity-id * X-ext-interaction-id Either casebaseID or getLastSavedQuickPickForInteraction must be passed in request. ## Resume a Quickpick - [POST /portals/{portalID}/gh/quickpicks/{quickpickID}](https://apidev.egain.com/apis/v4/knowledge/portalmgr/api-bundled/guided-help/restorequickpick.md): ## 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.