Guided Help

Accept Solution

POST
/knowledge/portalmgr/v4/portals/{portalID}/gh/cases/{caseID}/accept

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.

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Path Parameters

portalID*string

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.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20
caseID*string

The numerical ID of the Case for which details is to be fetched.

Match^[1-9]\d*$
Length10 <= length <= 15

Header Parameters

x-egain-activity-id?string

A unique numeric interaction identifier from eGain.

Match^[0-9]{4,9}$
Length4 <= length <= 9
x-ext-integration-id?string

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.

Match^[\w\W]+$
Lengthlength <= 40
x-ext-interaction-id?string

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

Match^[\w\W]+$
Lengthlength <= 40
Accept-Language*string

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

id*CasebaseReleaseId

The numerical ID of the Casebase Release.

Match^[1-9]\d*$
Length15 <= length <= 15
name*string

name of the case or article

Match^[\w\W]+$
Length1 <= length <= 255
profileId*ProfileId

The ID of the guided help profile. 1 will always be the system profile.

Match^1$|^[1-9]\d{9,15}$
Length1 <= length <= 15

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/cases/1000001085/accept" \  -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" \  -H "Content-Type: application/json" \  -d '{    "id": "120000001201010",    "name": "HPE Solution Article",    "profileId": "120450120000001"  }'
Empty