Get All Profiles Available in Portal
Overview
The Get All Profiles Available in Portal API retrieves all Guided Help profiles associated with a portal.
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
Filter by Casebase Release
^[1-9]\d{14}$Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
int641 <= value <= 9991Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
int641 <= value <= 7510Header Parameters
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"
The 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 numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9A 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 <= 40Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/gh/profiles" \ -H "Accept-Language: en-US" \ -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "x-egain-activity-id: 59237" \ -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176"{ "profile": [ { "name": "system profile", "id": "100100000000001" } ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 10 }}Get Cluster Details of a Casebase Release GET
## Overview The Get Cluster Details of a Casebase Release API retrieves cluster details of Casebase Release.
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.

