Accept Solution
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 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 <= 20The numerical ID of the Case for which details is to be fetched.
^[1-9]\d*$10 <= length <= 15Header 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 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 Release.
^[1-9]\d*$15 <= length <= 15name of the case or article
^[\w\W]+$1 <= length <= 255The ID of the guided help profile. 1 will always be the system profile.
^1$|^[1-9]\d{9,15}$1 <= length <= 15Response 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" }'Get Details of a Case GET
## 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.
Reject Solution POST
## 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.

