Accept Solution

Overview

This API can be used to accept and add positive score to a solution of a guided help case.

PreCondition

A Guided help search session must be started before invoking this API.

Request Body

Request body is required for this API. Request body must contain following attributes:

  • ACTION_NAME - Name of the action(solution) being accepted.
  • PR - Id of the profile in use.
  • CB - Id of the release being accessed.
SecurityoAuthUser or oAuthCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
caseID
required
number

ID of the solution case.

Example: 1000005730
header Parameters
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
ACTION_NAME
required
string

name of the solution

CB
required
number

ID of the casebase release

PR
required
number

ID of the profile in use

Responses
201

Rating added

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

post/portals/{portalID}/gh/cases/{caseID}/accept
Request samples
application/x-www-form-urlencoded
ACTION_NAME=HPE%20Solution%20Article.&CB=202201000000002&PR=1
Response samples
application/json

Required query parameter is missing

{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}